API reference - Class QFrame

Box

Signature: [static,const] QFrame_Shape Box

Description: Enum constant QFrame::Box

Python specific notes:
The object exposes a readable attribute 'Box'. This is the getter.

HLine

Signature: [static,const] QFrame_Shape HLine

Description: Enum constant QFrame::HLine

Python specific notes:
The object exposes a readable attribute 'HLine'. This is the getter.

NoFrame

Signature: [static,const] QFrame_Shape NoFrame

Description: Enum constant QFrame::NoFrame

Python specific notes:
The object exposes a readable attribute 'NoFrame'. This is the getter.

Panel

Signature: [static,const] QFrame_Shape Panel

Description: Enum constant QFrame::Panel

Python specific notes:
The object exposes a readable attribute 'Panel'. This is the getter.

Plain

Signature: [static,const] QFrame_Shadow Plain

Description: Enum constant QFrame::Plain

Python specific notes:
The object exposes a readable attribute 'Plain'. This is the getter.

Raised

Signature: [static,const] QFrame_Shadow Raised

Description: Enum constant QFrame::Raised

Python specific notes:
The object exposes a readable attribute 'Raised'. This is the getter.

StyledPanel

Signature: [static,const] QFrame_Shape StyledPanel

Description: Enum constant QFrame::StyledPanel

Python specific notes:
The object exposes a readable attribute 'StyledPanel'. This is the getter.

Sunken

Signature: [static,const] QFrame_Shadow Sunken

Description: Enum constant QFrame::Sunken

Python specific notes:
The object exposes a readable attribute 'Sunken'. This is the getter.

VLine

Signature: [static,const] QFrame_Shape VLine

Description: Enum constant QFrame::VLine

Python specific notes:
The object exposes a readable attribute 'VLine'. This is the getter.

WinPanel

Signature: [static,const] QFrame_Shape WinPanel

Description: Enum constant QFrame::WinPanel

Python specific notes:
The object exposes a readable attribute 'WinPanel'. This is the getter.

_const_cast

Signature: [const] QFrame ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

actionEvent

Signature: void actionEvent (QActionEvent ptr event)

Description: Virtual method void QFrame::actionEvent(QActionEvent *event)

This method can be reimplemented in a derived class.

changeEvent

Signature: void changeEvent (QEvent ptr arg1)

Description: Virtual method void QFrame::changeEvent(QEvent *)

This method can be reimplemented in a derived class.

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QFrame::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

closeEvent

Signature: void closeEvent (QCloseEvent ptr event)

Description: Virtual method void QFrame::closeEvent(QCloseEvent *event)

This method can be reimplemented in a derived class.

contextMenuEvent

Signature: void contextMenuEvent (QContextMenuEvent ptr event)

Description: Virtual method void QFrame::contextMenuEvent(QContextMenuEvent *event)

This method can be reimplemented in a derived class.

create

Signature: void create (unsigned long long arg1 = 0, bool initializeWindow = true, bool destroyOldWindow = true)

Description: Method void QFrame::create(WId, bool initializeWindow, bool destroyOldWindow)

This method is protected and can only be called from inside a derived class.

customContextMenuRequested

Signature: [signal] void customContextMenuRequested (const QPoint pos)

Description: Signal declaration for QFrame::customContextMenuRequested(const QPoint &pos)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'customContextMenuRequested'. This is the getter.
The object exposes a writable attribute 'customContextMenuRequested'. This is the setter.

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QFrame::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

destroy

Signature: void destroy (bool destroyWindow = true, bool destroySubWindows = true)

Description: Method void QFrame::destroy(bool destroyWindow, bool destroySubWindows)

This method is protected and can only be called from inside a derived class.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QFrame::destroyed(QObject *)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QFrame::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

dragEnterEvent

Signature: void dragEnterEvent (QDragEnterEvent ptr event)

Description: Virtual method void QFrame::dragEnterEvent(QDragEnterEvent *event)

This method can be reimplemented in a derived class.

dragLeaveEvent

Signature: void dragLeaveEvent (QDragLeaveEvent ptr event)

Description: Virtual method void QFrame::dragLeaveEvent(QDragLeaveEvent *event)

This method can be reimplemented in a derived class.

dragMoveEvent

Signature: void dragMoveEvent (QDragMoveEvent ptr event)

Description: Virtual method void QFrame::dragMoveEvent(QDragMoveEvent *event)

This method can be reimplemented in a derived class.

drawFrame

Signature: void drawFrame (QPainter ptr arg1)

Description: Method void QFrame::drawFrame(QPainter *)

This method is protected and can only be called from inside a derived class.

dropEvent

Signature: void dropEvent (QDropEvent ptr event)

Description: Virtual method void QFrame::dropEvent(QDropEvent *event)

This method can be reimplemented in a derived class.

emit_customContextMenuRequested

Signature: void emit_customContextMenuRequested (const QPoint pos)

Description: Emitter for signal void QFrame::customContextMenuRequested(const QPoint &pos)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QFrame::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QFrame::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

emit_windowIconChanged

Signature: void emit_windowIconChanged (const QIcon icon)

Description: Emitter for signal void QFrame::windowIconChanged(const QIcon &icon)

Call this method to emit this signal.

emit_windowIconTextChanged

Signature: void emit_windowIconTextChanged (string iconText)

Description: Emitter for signal void QFrame::windowIconTextChanged(const QString &iconText)

Call this method to emit this signal.

emit_windowTitleChanged

Signature: void emit_windowTitleChanged (string title)

Description: Emitter for signal void QFrame::windowTitleChanged(const QString &title)

Call this method to emit this signal.

enterEvent

Signature: void enterEvent (QEvent ptr event)

Description: Virtual method void QFrame::enterEvent(QEvent *event)

This method can be reimplemented in a derived class.

event

Signature: bool event (QEvent ptr e)

Description: Virtual method bool QFrame::event(QEvent *e)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QFrame::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

focusInEvent

Signature: void focusInEvent (QFocusEvent ptr event)

Description: Virtual method void QFrame::focusInEvent(QFocusEvent *event)

This method can be reimplemented in a derived class.

focusNextChild

Signature: bool focusNextChild

Description: Method bool QFrame::focusNextChild()

This method is protected and can only be called from inside a derived class.

focusNextPrevChild

Signature: bool focusNextPrevChild (bool next)

Description: Virtual method bool QFrame::focusNextPrevChild(bool next)

This method can be reimplemented in a derived class.

focusOutEvent

Signature: void focusOutEvent (QFocusEvent ptr event)

Description: Virtual method void QFrame::focusOutEvent(QFocusEvent *event)

This method can be reimplemented in a derived class.

focusPreviousChild

Signature: bool focusPreviousChild

Description: Method bool QFrame::focusPreviousChild()

This method is protected and can only be called from inside a derived class.

frameRect

Signature: [const] QRect frameRect

Description: Method QRect QFrame::frameRect()

Python specific notes:
The object exposes a readable attribute 'frameRect'. This is the getter.

frameRect=

Signature: void frameRect= (const QRect arg1)

Description: Method void QFrame::setFrameRect(const QRect &)

Python specific notes:
The object exposes a writable attribute 'frameRect'. This is the setter.

frameShadow

Signature: [const] QFrame_Shadow frameShadow

Description: Method QFrame::Shadow QFrame::frameShadow()

Python specific notes:
The object exposes a readable attribute 'frameShadow'. This is the getter.

frameShadow=

Signature: void frameShadow= (const QFrame_Shadow arg1)

Description: Method void QFrame::setFrameShadow(QFrame::Shadow)

Python specific notes:
The object exposes a writable attribute 'frameShadow'. This is the setter.

frameShape

Signature: [const] QFrame_Shape frameShape

Description: Method QFrame::Shape QFrame::frameShape()

Python specific notes:
The object exposes a readable attribute 'frameShape'. This is the getter.

frameShape=

Signature: void frameShape= (const QFrame_Shape arg1)

Description: Method void QFrame::setFrameShape(QFrame::Shape)

Python specific notes:
The object exposes a writable attribute 'frameShape'. This is the setter.

frameStyle

Signature: [const] int frameStyle

Description: Method int QFrame::frameStyle()

Python specific notes:
The object exposes a readable attribute 'frameStyle'. This is the getter.

frameStyle=

Signature: void frameStyle= (int arg1)

Description: Method void QFrame::setFrameStyle(int)

Python specific notes:
The object exposes a writable attribute 'frameStyle'. This is the setter.

frameWidth

Signature: [const] int frameWidth

Description: Method int QFrame::frameWidth()

Python specific notes:
The object exposes a readable attribute 'frameWidth'. This is the getter.

hasHeightForWidth

Signature: [const] bool hasHeightForWidth

Description: Virtual method bool QFrame::hasHeightForWidth()

This method can be reimplemented in a derived class.

heightForWidth

Signature: [const] int heightForWidth (int arg1)

Description: Virtual method int QFrame::heightForWidth(int)

This method can be reimplemented in a derived class.

hideEvent

Signature: void hideEvent (QHideEvent ptr event)

Description: Virtual method void QFrame::hideEvent(QHideEvent *event)

This method can be reimplemented in a derived class.

initPainter

Signature: [const] void initPainter (QPainter ptr painter)

Description: Virtual method void QFrame::initPainter(QPainter *painter)

This method can be reimplemented in a derived class.

initStyleOption

Signature: [const] void initStyleOption (QStyleOptionFrame ptr option)

Description: Method void QFrame::initStyleOption(QStyleOptionFrame *option)

This method is protected and can only be called from inside a derived class.

inputMethodEvent

Signature: void inputMethodEvent (QInputMethodEvent ptr arg1)

Description: Virtual method void QFrame::inputMethodEvent(QInputMethodEvent *)

This method can be reimplemented in a derived class.

inputMethodQuery

Signature: [const] variant inputMethodQuery (const Qt_InputMethodQuery arg1)

Description: Virtual method QVariant QFrame::inputMethodQuery(Qt::InputMethodQuery)

This method can be reimplemented in a derived class.

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QFrame::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

keyPressEvent

Signature: void keyPressEvent (QKeyEvent ptr event)

Description: Virtual method void QFrame::keyPressEvent(QKeyEvent *event)

This method can be reimplemented in a derived class.

keyReleaseEvent

Signature: void keyReleaseEvent (QKeyEvent ptr event)

Description: Virtual method void QFrame::keyReleaseEvent(QKeyEvent *event)

This method can be reimplemented in a derived class.

leaveEvent

Signature: void leaveEvent (QEvent ptr event)

Description: Virtual method void QFrame::leaveEvent(QEvent *event)

This method can be reimplemented in a derived class.

lineWidth

Signature: [const] int lineWidth

Description: Method int QFrame::lineWidth()

Python specific notes:
The object exposes a readable attribute 'lineWidth'. This is the getter.

lineWidth=

Signature: void lineWidth= (int arg1)

Description: Method void QFrame::setLineWidth(int)

Python specific notes:
The object exposes a writable attribute 'lineWidth'. This is the setter.

metric

Signature: [const] int metric (const QPaintDevice_PaintDeviceMetric arg1)

Description: Virtual method int QFrame::metric(QPaintDevice::PaintDeviceMetric)

This method can be reimplemented in a derived class.

midLineWidth

Signature: [const] int midLineWidth

Description: Method int QFrame::midLineWidth()

Python specific notes:
The object exposes a readable attribute 'midLineWidth'. This is the getter.

midLineWidth=

Signature: void midLineWidth= (int arg1)

Description: Method void QFrame::setMidLineWidth(int)

Python specific notes:
The object exposes a writable attribute 'midLineWidth'. This is the setter.

minimumSizeHint

Signature: [const] QSize minimumSizeHint

Description: Virtual method QSize QFrame::minimumSizeHint()

This method can be reimplemented in a derived class.

mouseDoubleClickEvent

Signature: void mouseDoubleClickEvent (QMouseEvent ptr event)

Description: Virtual method void QFrame::mouseDoubleClickEvent(QMouseEvent *event)

This method can be reimplemented in a derived class.

mouseMoveEvent

Signature: void mouseMoveEvent (QMouseEvent ptr event)

Description: Virtual method void QFrame::mouseMoveEvent(QMouseEvent *event)

This method can be reimplemented in a derived class.

mousePressEvent

Signature: void mousePressEvent (QMouseEvent ptr event)

Description: Virtual method void QFrame::mousePressEvent(QMouseEvent *event)

This method can be reimplemented in a derived class.

mouseReleaseEvent

Signature: void mouseReleaseEvent (QMouseEvent ptr event)

Description: Virtual method void QFrame::mouseReleaseEvent(QMouseEvent *event)

This method can be reimplemented in a derived class.

moveEvent

Signature: void moveEvent (QMoveEvent ptr event)

Description: Virtual method void QFrame::moveEvent(QMoveEvent *event)

This method can be reimplemented in a derived class.

nativeEvent

Signature: bool nativeEvent (bytes eventType, void * message, long ptr result)

Description: Virtual method bool QFrame::nativeEvent(const QByteArray &eventType, void *message, long int *result)

This method can be reimplemented in a derived class.

new

Signature: [static] new QFrame new (QWidget ptr parent = nullptr, Qt_QFlags_WindowType f = Qt::WindowFlags())

Description: Constructor QFrame::QFrame(QWidget *parent, QFlags<Qt::WindowType> f)

This method creates an object of class QFrame.

Python specific notes:
This method is the default initializer of the object.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QFrame::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'objectNameChanged'. This is the getter.
The object exposes a writable attribute 'objectNameChanged'. This is the setter.

paintEngine

Signature: [const] QPaintEngine ptr paintEngine

Description: Virtual method QPaintEngine *QFrame::paintEngine()

This method can be reimplemented in a derived class.

paintEvent

Signature: void paintEvent (QPaintEvent ptr arg1)

Description: Virtual method void QFrame::paintEvent(QPaintEvent *)

This method can be reimplemented in a derived class.

qt_create

Signature: void qt_create (unsigned long long arg1 = 0, bool initializeWindow = true, bool destroyOldWindow = true)

Description: Method void QFrame::create(WId, bool initializeWindow, bool destroyOldWindow)

This method is protected and can only be called from inside a derived class.

qt_destroy

Signature: void qt_destroy (bool destroyWindow = true, bool destroySubWindows = true)

Description: Method void QFrame::destroy(bool destroyWindow, bool destroySubWindows)

This method is protected and can only be called from inside a derived class.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QFrame::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

redirected

Signature: [const] QPaintDevice ptr redirected (QPoint ptr offset)

Description: Virtual method QPaintDevice *QFrame::redirected(QPoint *offset)

This method can be reimplemented in a derived class.

resizeEvent

Signature: void resizeEvent (QResizeEvent ptr event)

Description: Virtual method void QFrame::resizeEvent(QResizeEvent *event)

This method can be reimplemented in a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QFrame::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QFrame::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setFrameRect

Signature: void setFrameRect (const QRect arg1)

Description: Method void QFrame::setFrameRect(const QRect &)

Python specific notes:
The object exposes a writable attribute 'frameRect'. This is the setter.

setFrameShadow

Signature: void setFrameShadow (const QFrame_Shadow arg1)

Description: Method void QFrame::setFrameShadow(QFrame::Shadow)

Python specific notes:
The object exposes a writable attribute 'frameShadow'. This is the setter.

setFrameShape

Signature: void setFrameShape (const QFrame_Shape arg1)

Description: Method void QFrame::setFrameShape(QFrame::Shape)

Python specific notes:
The object exposes a writable attribute 'frameShape'. This is the setter.

setFrameStyle

Signature: void setFrameStyle (int arg1)

Description: Method void QFrame::setFrameStyle(int)

Python specific notes:
The object exposes a writable attribute 'frameStyle'. This is the setter.

setLineWidth

Signature: void setLineWidth (int arg1)

Description: Method void QFrame::setLineWidth(int)

Python specific notes:
The object exposes a writable attribute 'lineWidth'. This is the setter.

setMidLineWidth

Signature: void setMidLineWidth (int arg1)

Description: Method void QFrame::setMidLineWidth(int)

Python specific notes:
The object exposes a writable attribute 'midLineWidth'. This is the setter.

setVisible

Signature: void setVisible (bool visible)

Description: Virtual method void QFrame::setVisible(bool visible)

This method can be reimplemented in a derived class.

sharedPainter

Signature: [const] QPainter ptr sharedPainter

Description: Virtual method QPainter *QFrame::sharedPainter()

This method can be reimplemented in a derived class.

showEvent

Signature: void showEvent (QShowEvent ptr event)

Description: Virtual method void QFrame::showEvent(QShowEvent *event)

This method can be reimplemented in a derived class.

sizeHint

Signature: [const] QSize sizeHint

Description: Virtual method QSize QFrame::sizeHint()

This method can be reimplemented in a derived class.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

tabletEvent

Signature: void tabletEvent (QTabletEvent ptr event)

Description: Virtual method void QFrame::tabletEvent(QTabletEvent *event)

This method can be reimplemented in a derived class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QFrame::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QFrame::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QFrame::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.

updateMicroFocus

Signature: void updateMicroFocus

Description: Method void QFrame::updateMicroFocus()

This method is protected and can only be called from inside a derived class.

wheelEvent

Signature: void wheelEvent (QWheelEvent ptr event)

Description: Virtual method void QFrame::wheelEvent(QWheelEvent *event)

This method can be reimplemented in a derived class.

windowIconChanged

Signature: [signal] void windowIconChanged (const QIcon icon)

Description: Signal declaration for QFrame::windowIconChanged(const QIcon &icon)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'windowIconChanged'. This is the getter.
The object exposes a writable attribute 'windowIconChanged'. This is the setter.

windowIconTextChanged

Signature: [signal] void windowIconTextChanged (string iconText)

Description: Signal declaration for QFrame::windowIconTextChanged(const QString &iconText)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'windowIconTextChanged'. This is the getter.
The object exposes a writable attribute 'windowIconTextChanged'. This is the setter.

windowTitleChanged

Signature: [signal] void windowTitleChanged (string title)

Description: Signal declaration for QFrame::windowTitleChanged(const QString &title)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'windowTitleChanged'. This is the getter.
The object exposes a writable attribute 'windowTitleChanged'. This is the setter.