API reference - Class QMdiArea

ActivationHistoryOrder

Signature: [static,const] QMdiArea_WindowOrder ActivationHistoryOrder

Description: Enum constant QMdiArea::ActivationHistoryOrder

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

CreationOrder

Signature: [static,const] QMdiArea_WindowOrder CreationOrder

Description: Enum constant QMdiArea::CreationOrder

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

DontMaximizeSubWindowOnActivation

Signature: [static,const] QMdiArea_AreaOption DontMaximizeSubWindowOnActivation

Description: Enum constant QMdiArea::DontMaximizeSubWindowOnActivation

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

StackingOrder

Signature: [static,const] QMdiArea_WindowOrder StackingOrder

Description: Enum constant QMdiArea::StackingOrder

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

SubWindowView

Signature: [static,const] QMdiArea_ViewMode SubWindowView

Description: Enum constant QMdiArea::SubWindowView

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

TabbedView

Signature: [static,const] QMdiArea_ViewMode TabbedView

Description: Enum constant QMdiArea::TabbedView

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

_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 arg1)

Description: Virtual method void QMdiArea::actionEvent(QActionEvent *)

This method can be reimplemented in a derived class.

activateNextSubWindow

Signature: void activateNextSubWindow

Description: Method void QMdiArea::activateNextSubWindow()

activatePreviousSubWindow

Signature: void activatePreviousSubWindow

Description: Method void QMdiArea::activatePreviousSubWindow()

activationOrder

Signature: [const] QMdiArea_WindowOrder activationOrder

Description: Method QMdiArea::WindowOrder QMdiArea::activationOrder()

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

activationOrder=

Signature: void activationOrder= (const QMdiArea_WindowOrder order)

Description: Method void QMdiArea::setActivationOrder(QMdiArea::WindowOrder order)

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

activeSubWindow

Signature: [const] QMdiSubWindow ptr activeSubWindow

Description: Method QMdiSubWindow *QMdiArea::activeSubWindow()

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

activeSubWindow=

Signature: void activeSubWindow= (QMdiSubWindow ptr window)

Description: Method void QMdiArea::setActiveSubWindow(QMdiSubWindow *window)

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

addSubWindow

Signature: QMdiSubWindow ptr addSubWindow (QWidget ptr widget, Qt_QFlags_WindowType flags = 0)

Description: Method QMdiSubWindow *QMdiArea::addSubWindow(QWidget *widget, QFlags<Qt::WindowType> flags)

background

Signature: [const] QBrush background

Description: Method QBrush QMdiArea::background()

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

background=

Signature: void background= (const QBrush background)

Description: Method void QMdiArea::setBackground(const QBrush &background)

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

cascadeSubWindows

Signature: void cascadeSubWindows

Description: Method void QMdiArea::cascadeSubWindows()

changeEvent

Signature: void changeEvent (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

childEvent

Signature: void childEvent (QChildEvent ptr childEvent)

Description: Virtual method void QMdiArea::childEvent(QChildEvent *childEvent)

This method can be reimplemented in a derived class.

closeActiveSubWindow

Signature: void closeActiveSubWindow

Description: Method void QMdiArea::closeActiveSubWindow()

closeAllSubWindows

Signature: void closeAllSubWindows

Description: Method void QMdiArea::closeAllSubWindows()

closeEvent

Signature: void closeEvent (QCloseEvent ptr arg1)

Description: Virtual method void QMdiArea::closeEvent(QCloseEvent *)

This method can be reimplemented in a derived class.

contextMenuEvent

Signature: void contextMenuEvent (QContextMenuEvent ptr arg1)

Description: Virtual method void QMdiArea::contextMenuEvent(QContextMenuEvent *)

This method can be reimplemented in a derived class.

currentSubWindow

Signature: [const] QMdiSubWindow ptr currentSubWindow

Description: Method QMdiSubWindow *QMdiArea::currentSubWindow()

customContextMenuRequested

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

Description: Signal declaration for QMdiArea::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 arg1)

Description: Virtual method void QMdiArea::customEvent(QEvent *)

This method can be reimplemented in a derived class.

destroyed

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

Description: Signal declaration for QMdiArea::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 (string signal)

Description: Virtual method void QMdiArea::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

documentMode

Signature: [const] bool documentMode

Description: Method bool QMdiArea::documentMode()

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

documentMode=

Signature: void documentMode= (bool enabled)

Description: Method void QMdiArea::setDocumentMode(bool enabled)

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

dragEnterEvent

Signature: void dragEnterEvent (QDragEnterEvent ptr arg1)

Description: Virtual method void QMdiArea::dragEnterEvent(QDragEnterEvent *)

This method can be reimplemented in a derived class.

dragLeaveEvent

Signature: void dragLeaveEvent (QDragLeaveEvent ptr arg1)

Description: Virtual method void QMdiArea::dragLeaveEvent(QDragLeaveEvent *)

This method can be reimplemented in a derived class.

dragMoveEvent

Signature: void dragMoveEvent (QDragMoveEvent ptr arg1)

Description: Virtual method void QMdiArea::dragMoveEvent(QDragMoveEvent *)

This method can be reimplemented in a derived class.

drawFrame

Signature: void drawFrame (QPainter ptr arg1)

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

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

dropEvent

Signature: void dropEvent (QDropEvent ptr arg1)

Description: Virtual method void QMdiArea::dropEvent(QDropEvent *)

This method can be reimplemented in a derived class.

emit_customContextMenuRequested

Signature: void emit_customContextMenuRequested (const QPoint pos)

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

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = 0)

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

Call this method to emit this signal.

emit_subWindowActivated

Signature: void emit_subWindowActivated (QMdiSubWindow ptr arg1)

Description: Emitter for signal void QMdiArea::subWindowActivated(QMdiSubWindow *)

Call this method to emit this signal.

enabledChange

Signature: void enabledChange (bool arg1)

Description: Virtual method void QMdiArea::enabledChange(bool)

This method can be reimplemented in a derived class.

enterEvent

Signature: void enterEvent (QEvent ptr arg1)

Description: Virtual method void QMdiArea::enterEvent(QEvent *)

This method can be reimplemented in a derived class.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QMdiArea::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

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

Description: Virtual method bool QMdiArea::eventFilter(QObject *object, QEvent *event)

This method can be reimplemented in a derived class.

focusInEvent

Signature: void focusInEvent (QFocusEvent ptr arg1)

Description: Virtual method void QMdiArea::focusInEvent(QFocusEvent *)

This method can be reimplemented in a derived class.

focusNextChild

Signature: bool focusNextChild

Description: Method bool QMdiArea::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 QMdiArea::focusNextPrevChild(bool next)

This method can be reimplemented in a derived class.

focusOutEvent

Signature: void focusOutEvent (QFocusEvent ptr arg1)

Description: Virtual method void QMdiArea::focusOutEvent(QFocusEvent *)

This method can be reimplemented in a derived class.

focusPreviousChild

Signature: bool focusPreviousChild

Description: Method bool QMdiArea::focusPreviousChild()

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

fontChange

Signature: void fontChange (const QFont arg1)

Description: Virtual method void QMdiArea::fontChange(const QFont &)

This method can be reimplemented in a derived class.

heightForWidth

Signature: [const] int heightForWidth (int arg1)

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

This method can be reimplemented in a derived class.

hideEvent

Signature: void hideEvent (QHideEvent ptr arg1)

Description: Virtual method void QMdiArea::hideEvent(QHideEvent *)

This method can be reimplemented in a derived class.

inputMethodEvent

Signature: void inputMethodEvent (QInputMethodEvent ptr arg1)

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

This method can be reimplemented in a derived class.

inputMethodQuery

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

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

This method can be reimplemented in a derived class.

keyPressEvent

Signature: void keyPressEvent (QKeyEvent ptr arg1)

Description: Virtual method void QMdiArea::keyPressEvent(QKeyEvent *)

This method can be reimplemented in a derived class.

keyReleaseEvent

Signature: void keyReleaseEvent (QKeyEvent ptr arg1)

Description: Virtual method void QMdiArea::keyReleaseEvent(QKeyEvent *)

This method can be reimplemented in a derived class.

languageChange

Signature: void languageChange

Description: Virtual method void QMdiArea::languageChange()

This method can be reimplemented in a derived class.

leaveEvent

Signature: void leaveEvent (QEvent ptr arg1)

Description: Virtual method void QMdiArea::leaveEvent(QEvent *)

This method can be reimplemented in a derived class.

metric

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

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

This method can be reimplemented in a derived class.

minimumSizeHint

Signature: [const] QSize minimumSizeHint

Description: Virtual method QSize QMdiArea::minimumSizeHint()

This method can be reimplemented in a derived class.

mouseDoubleClickEvent

Signature: void mouseDoubleClickEvent (QMouseEvent ptr arg1)

Description: Virtual method void QMdiArea::mouseDoubleClickEvent(QMouseEvent *)

This method can be reimplemented in a derived class.

mouseMoveEvent

Signature: void mouseMoveEvent (QMouseEvent ptr arg1)

Description: Virtual method void QMdiArea::mouseMoveEvent(QMouseEvent *)

This method can be reimplemented in a derived class.

mousePressEvent

Signature: void mousePressEvent (QMouseEvent ptr arg1)

Description: Virtual method void QMdiArea::mousePressEvent(QMouseEvent *)

This method can be reimplemented in a derived class.

mouseReleaseEvent

Signature: void mouseReleaseEvent (QMouseEvent ptr arg1)

Description: Virtual method void QMdiArea::mouseReleaseEvent(QMouseEvent *)

This method can be reimplemented in a derived class.

moveEvent

Signature: void moveEvent (QMoveEvent ptr arg1)

Description: Virtual method void QMdiArea::moveEvent(QMoveEvent *)

This method can be reimplemented in a derived class.

new

Signature: [static] new QMdiArea new (QWidget ptr parent = 0)

Description: Constructor QMdiArea::QMdiArea(QWidget *parent)

This method creates an object of class QMdiArea.

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

paintEngine

Signature: [const] QPaintEngine ptr paintEngine

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

This method can be reimplemented in a derived class.

paintEvent

Signature: void paintEvent (QPaintEvent ptr paintEvent)

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

This method can be reimplemented in a derived class.

paletteChange

Signature: void paletteChange (const QPalette arg1)

Description: Virtual method void QMdiArea::paletteChange(const QPalette &)

This method can be reimplemented in a derived class.

qt_create

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

Description: Method void QMdiArea::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 QMdiArea::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 QMdiArea::receivers(const char *signal)

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

removeSubWindow

Signature: void removeSubWindow (QWidget ptr widget)

Description: Method void QMdiArea::removeSubWindow(QWidget *widget)

resetInputContext

Signature: void resetInputContext

Description: Method void QMdiArea::resetInputContext()

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

resizeEvent

Signature: void resizeEvent (QResizeEvent ptr resizeEvent)

Description: Virtual method void QMdiArea::resizeEvent(QResizeEvent *resizeEvent)

This method can be reimplemented in a derived class.

scrollContentsBy

Signature: void scrollContentsBy (int dx, int dy)

Description: Virtual method void QMdiArea::scrollContentsBy(int dx, int dy)

This method can be reimplemented in a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QMdiArea::sender()

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

setActivationOrder

Signature: void setActivationOrder (const QMdiArea_WindowOrder order)

Description: Method void QMdiArea::setActivationOrder(QMdiArea::WindowOrder order)

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

setActiveSubWindow

Signature: void setActiveSubWindow (QMdiSubWindow ptr window)

Description: Method void QMdiArea::setActiveSubWindow(QMdiSubWindow *window)

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

setBackground

Signature: void setBackground (const QBrush background)

Description: Method void QMdiArea::setBackground(const QBrush &background)

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

setDocumentMode

Signature: void setDocumentMode (bool enabled)

Description: Method void QMdiArea::setDocumentMode(bool enabled)

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

setOption

Signature: void setOption (const QMdiArea_AreaOption option, bool on = true)

Description: Method void QMdiArea::setOption(QMdiArea::AreaOption option, bool on)

setTabPosition

Signature: void setTabPosition (const QTabWidget_TabPosition position)

Description: Method void QMdiArea::setTabPosition(QTabWidget::TabPosition position)

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

setTabShape

Signature: void setTabShape (const QTabWidget_TabShape shape)

Description: Method void QMdiArea::setTabShape(QTabWidget::TabShape shape)

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

setViewMode

Signature: void setViewMode (const QMdiArea_ViewMode mode)

Description: Method void QMdiArea::setViewMode(QMdiArea::ViewMode mode)

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

setViewportMargins

(1) Signature: void setViewportMargins (int left, int top, int right, int bottom)

Description: Method void QMdiArea::setViewportMargins(int left, int top, int right, int bottom)

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

(2) Signature: void setViewportMargins (const QMargins margins)

Description: Method void QMdiArea::setViewportMargins(const QMargins &margins)

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

setVisible

Signature: void setVisible (bool visible)

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

This method can be reimplemented in a derived class.

setupViewport

Signature: void setupViewport (QWidget ptr viewport)

Description: Method void QMdiArea::setupViewport(QWidget *viewport)

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

showEvent

Signature: void showEvent (QShowEvent ptr showEvent)

Description: Virtual method void QMdiArea::showEvent(QShowEvent *showEvent)

This method can be reimplemented in a derived class.

sizeHint

Signature: [const] QSize sizeHint

Description: Virtual method QSize QMdiArea::sizeHint()

This method can be reimplemented in a derived class.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

styleChange

Signature: void styleChange (QStyle arg1)

Description: Virtual method void QMdiArea::styleChange(QStyle &)

This method can be reimplemented in a derived class.

subWindowActivated

Signature: [signal] void subWindowActivated (QMdiSubWindow ptr arg1)

Description: Signal declaration for QMdiArea::subWindowActivated(QMdiSubWindow *)

You can bind a procedure to this signal.

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

subWindowList

Signature: [const] QMdiSubWindow ptr[] subWindowList (const QMdiArea_WindowOrder order = QMdiArea::CreationOrder)

Description: Method QList<QMdiSubWindow *> QMdiArea::subWindowList(QMdiArea::WindowOrder order)

tabPosition

Signature: [const] QTabWidget_TabPosition tabPosition

Description: Method QTabWidget::TabPosition QMdiArea::tabPosition()

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

tabPosition=

Signature: void tabPosition= (const QTabWidget_TabPosition position)

Description: Method void QMdiArea::setTabPosition(QTabWidget::TabPosition position)

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

tabShape

Signature: [const] QTabWidget_TabShape tabShape

Description: Method QTabWidget::TabShape QMdiArea::tabShape()

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

tabShape=

Signature: void tabShape= (const QTabWidget_TabShape shape)

Description: Method void QMdiArea::setTabShape(QTabWidget::TabShape shape)

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

tabletEvent

Signature: void tabletEvent (QTabletEvent ptr arg1)

Description: Virtual method void QMdiArea::tabletEvent(QTabletEvent *)

This method can be reimplemented in a derived class.

testOption

Signature: [const] bool testOption (const QMdiArea_AreaOption opton)

Description: Method bool QMdiArea::testOption(QMdiArea::AreaOption opton)

tileSubWindows

Signature: void tileSubWindows

Description: Method void QMdiArea::tileSubWindows()

timerEvent

Signature: void timerEvent (QTimerEvent ptr timerEvent)

Description: Virtual method void QMdiArea::timerEvent(QTimerEvent *timerEvent)

This method can be reimplemented in a derived class.

tr

(1) Signature: [static] string tr (string s, string c = 0)

Description: Static method QString QMdiArea::tr(const char *s, const char *c)

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

(2) Signature: [static] string tr (string s, string c, int n)

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

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

trUtf8

(1) Signature: [static] string trUtf8 (string s, string c = 0)

Description: Static method QString QMdiArea::trUtf8(const char *s, const char *c)

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

(2) Signature: [static] string trUtf8 (string s, string c, int n)

Description: Static method QString QMdiArea::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 QMdiArea::updateMicroFocus()

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

viewMode

Signature: [const] QMdiArea_ViewMode viewMode

Description: Method QMdiArea::ViewMode QMdiArea::viewMode()

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

viewMode=

Signature: void viewMode= (const QMdiArea_ViewMode mode)

Description: Method void QMdiArea::setViewMode(QMdiArea::ViewMode mode)

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

viewportEvent

Signature: bool viewportEvent (QEvent ptr event)

Description: Virtual method bool QMdiArea::viewportEvent(QEvent *event)

This method can be reimplemented in a derived class.

wheelEvent

Signature: void wheelEvent (QWheelEvent ptr arg1)

Description: Virtual method void QMdiArea::wheelEvent(QWheelEvent *)

This method can be reimplemented in a derived class.

windowActivationChange

Signature: void windowActivationChange (bool arg1)

Description: Virtual method void QMdiArea::windowActivationChange(bool)

This method can be reimplemented in a derived class.