KLayout Manual: Main Index » Class Index » API reference - Class QDockWidget

API reference - Class QDockWidget

Notation used in Ruby API documentation

Description: Binding of QDockWidget

Class hierarchy: QDockWidget » QWidget » QObject

Sub-classes: DockWidgetFeature

• Public constructors
• Public methods
• Public static methods and constants
• Protected methods (static, non-static and constructors)
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

Protected methods (static, non-static and constructors)

Deprecated methods (protected, public, static, non-static and constructors)

Detailed description

[static,const] new QDockWidget_DockWidgetFeature ptr AllDockWidgetFeatures

Description: Enum constant QDockWidget::AllDockWidgetFeatures

[static,const] new QDockWidget_DockWidgetFeature ptr DockWidgetClosable

Description: Enum constant QDockWidget::DockWidgetClosable

[static,const] new QDockWidget_DockWidgetFeature ptr DockWidgetFeatureMask

Description: Enum constant QDockWidget::DockWidgetFeatureMask

[static,const] new QDockWidget_DockWidgetFeature ptr DockWidgetFloatable

Description: Enum constant QDockWidget::DockWidgetFloatable

[static,const] new QDockWidget_DockWidgetFeature ptr DockWidgetMovable

Description: Enum constant QDockWidget::DockWidgetMovable

[static,const] new QDockWidget_DockWidgetFeature ptr DockWidgetVerticalTitleBar

Description: Enum constant QDockWidget::DockWidgetVerticalTitleBar

[static,const] new QDockWidget_DockWidgetFeature ptr NoDockWidgetFeatures

Description: Enum constant QDockWidget::NoDockWidgetFeatures

[static,const] new QDockWidget_DockWidgetFeature ptr Reserved

Description: Enum constant QDockWidget::Reserved

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.

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.

[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.

[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.

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.

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.

[virtual] void actionEvent(QActionEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[const] Qt_QFlags_DockWidgetArea allowedAreas

Description: Method QFlags<Qt::DockWidgetArea> QDockWidget::allowedAreas()

Python specific notes:

The object exposes a readable attribute 'allowedAreas'. This is the getter.

void allowedAreas=(const Qt_QFlags_DockWidgetArea areas)

Description: Method void QDockWidget::setAllowedAreas(QFlags<Qt::DockWidgetArea> areas)

Python specific notes:

The object exposes a writable attribute 'allowedAreas'. This is the setter.

[event] void allowedAreasChanged(const Qt_QFlags_DockWidgetArea allowedAreas)

Description: Signal declaration for QDockWidget::allowedAreasChanged(QFlags<Qt::DockWidgetArea> allowedAreas)

You can bind a procedure to this signal.

[virtual] void changeEvent(QEvent ptr event)

Description: Virtual method void QDockWidget::changeEvent(QEvent *event)

This method can be reimplemented in a derived class.

[virtual] void childEvent(QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] void closeEvent(QCloseEvent ptr event)

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

This method can be reimplemented in a derived class.

[virtual] void contextMenuEvent(QContextMenuEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[event] void customContextMenuRequested(const QPoint pos)

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

You can bind a procedure to this signal.

[virtual] void customEvent(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

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

You can bind a procedure to this signal.

[const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

[virtual] void disconnectNotify(string signal)

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

This method can be reimplemented in a derived class.

[event] void dockLocationChanged(const Qt_DockWidgetArea area)

Description: Signal declaration for QDockWidget::dockLocationChanged(Qt::DockWidgetArea area)

You can bind a procedure to this signal.

[virtual] void dragEnterEvent(QDragEnterEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] void dragLeaveEvent(QDragLeaveEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] void dragMoveEvent(QDragMoveEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] void dropEvent(QDropEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] void enabledChange(bool arg1)

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

This method can be reimplemented in a derived class.

[virtual] void enterEvent(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] bool event(QEvent ptr event)

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

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

Description: Virtual method bool QDockWidget::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

[const] QDockWidget_QFlags_DockWidgetFeature features

Description: Method QFlags<QDockWidget::DockWidgetFeature> QDockWidget::features()

Python specific notes:

The object exposes a readable attribute 'features'. This is the getter.

void features=(const QDockWidget_QFlags_DockWidgetFeature features)

Description: Method void QDockWidget::setFeatures(QFlags<QDockWidget::DockWidgetFeature> features)

Python specific notes:

The object exposes a writable attribute 'features'. This is the setter.

[event] void featuresChanged(const QDockWidget_QFlags_DockWidgetFeature features)

Description: Signal declaration for QDockWidget::featuresChanged(QFlags<QDockWidget::DockWidgetFeature> features)

You can bind a procedure to this signal.

[const] bool floating

Description: Method bool QDockWidget::isFloating()

Python specific notes:

The object exposes a readable attribute 'floating'. This is the getter.

void floating=(bool floating)

Description: Method void QDockWidget::setFloating(bool floating)

Python specific notes:

The object exposes a writable attribute 'floating'. This is the setter.

[virtual] void focusInEvent(QFocusEvent ptr arg1)

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

This method can be reimplemented in a derived class.

bool focusNextChild

Description: Method bool QDockWidget::focusNextChild()

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

[virtual] bool focusNextPrevChild(bool next)

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

This method can be reimplemented in a derived class.

[virtual] void focusOutEvent(QFocusEvent ptr arg1)

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

This method can be reimplemented in a derived class.

bool focusPreviousChild

Description: Method bool QDockWidget::focusPreviousChild()

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

[virtual] void fontChange(const QFont arg1)

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

This method can be reimplemented in a derived class.

[virtual,const] int heightForWidth(int arg1)

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

This method can be reimplemented in a derived class.

[virtual] void hideEvent(QHideEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[const] void initStyleOption(QStyleOptionDockWidget ptr option)

Description: Method void QDockWidget::initStyleOption(QStyleOptionDockWidget *option)

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

[virtual] void inputMethodEvent(QInputMethodEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual,const] QVariant inputMethodQuery(const Qt_InputMethodQuery arg1)

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

This method can be reimplemented in a derived class.

[const] bool isAreaAllowed?(const Qt_DockWidgetArea area)

Description: Method bool QDockWidget::isAreaAllowed(Qt::DockWidgetArea area)

[const] bool isFloating?

Description: Method bool QDockWidget::isFloating()

Python specific notes:

The object exposes a readable attribute 'floating'. This is the getter.

[const] bool is_const_object?

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

Use of this method is deprecated. Use _is_const_object? instead

[virtual] void keyPressEvent(QKeyEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] void keyReleaseEvent(QKeyEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] void languageChange

Description: Virtual method void QDockWidget::languageChange()

This method can be reimplemented in a derived class.

[virtual] void leaveEvent(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual,const] int metric(const QPaintDevice_PaintDeviceMetric arg1)

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

This method can be reimplemented in a derived class.

[virtual,const] QSize minimumSizeHint

Description: Virtual method QSize QDockWidget::minimumSizeHint()

This method can be reimplemented in a derived class.

[virtual] void mouseDoubleClickEvent(QMouseEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] void mouseMoveEvent(QMouseEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] void mousePressEvent(QMouseEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] void mouseReleaseEvent(QMouseEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] void moveEvent(QMoveEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[static] new QDockWidget new(string title,QWidget ptr parent = 0,const Qt_QFlags_WindowType flags = 0)

Description: Constructor QDockWidget::QDockWidget(const QString &title, QWidget *parent, QFlags<Qt::WindowType> flags)

This method creates an object of class QDockWidget.

Python specific notes:

This method is the default initializer of the object

[static] new QDockWidget new(QWidget ptr parent = 0,const Qt_QFlags_WindowType flags = 0)

Description: Constructor QDockWidget::QDockWidget(QWidget *parent, QFlags<Qt::WindowType> flags)

This method creates an object of class QDockWidget.

Python specific notes:

This method is the default initializer of the object

[virtual,const] QPaintEngine ptr paintEngine

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

This method can be reimplemented in a derived class.

[virtual] void paintEvent(QPaintEvent ptr event)

Description: Virtual method void QDockWidget::paintEvent(QPaintEvent *event)

This method can be reimplemented in a derived class.

[virtual] void paletteChange(const QPalette arg1)

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

This method can be reimplemented in a derived class.

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

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

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

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

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

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

[const] int receivers(string signal)

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

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

void resetInputContext

Description: Method void QDockWidget::resetInputContext()

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

[virtual] void resizeEvent(QResizeEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[const] QObject ptr sender

Description: Method QObject *QDockWidget::sender()

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

void setAllowedAreas(const Qt_QFlags_DockWidgetArea areas)

Description: Method void QDockWidget::setAllowedAreas(QFlags<Qt::DockWidgetArea> areas)

Python specific notes:

The object exposes a writable attribute 'allowedAreas'. This is the setter.

void setFeatures(const QDockWidget_QFlags_DockWidgetFeature features)

Description: Method void QDockWidget::setFeatures(QFlags<QDockWidget::DockWidgetFeature> features)

Python specific notes:

The object exposes a writable attribute 'features'. This is the setter.

void setFloating(bool floating)

Description: Method void QDockWidget::setFloating(bool floating)

Python specific notes:

The object exposes a writable attribute 'floating'. This is the setter.

void setTitleBarWidget(QWidget ptr widget)

Description: Method void QDockWidget::setTitleBarWidget(QWidget *widget)

Python specific notes:

The object exposes a writable attribute 'titleBarWidget'. This is the setter.

[virtual] void setVisible(bool visible)

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

This method can be reimplemented in a derived class.

void setWidget(QWidget ptr widget)

Description: Method void QDockWidget::setWidget(QWidget *widget)

Python specific notes:

The object exposes a writable attribute 'widget'. This is the setter.

[virtual] void showEvent(QShowEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual,const] QSize sizeHint

Description: Virtual method QSize QDockWidget::sizeHint()

This method can be reimplemented in a derived class.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] void styleChange(QStyle arg1)

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

This method can be reimplemented in a derived class.

[virtual] void tabletEvent(QTabletEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] void timerEvent(QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[const] QWidget ptr titleBarWidget

Description: Method QWidget *QDockWidget::titleBarWidget()

Python specific notes:

The object exposes a readable attribute 'titleBarWidget'. This is the getter.

void titleBarWidget=(QWidget ptr widget)

Description: Method void QDockWidget::setTitleBarWidget(QWidget *widget)

Python specific notes:

The object exposes a writable attribute 'titleBarWidget'. This is the setter.

[const] QAction ptr toggleViewAction

Description: Method QAction *QDockWidget::toggleViewAction()

[event] void topLevelChanged(bool topLevel)

Description: Signal declaration for QDockWidget::topLevelChanged(bool topLevel)

You can bind a procedure to this signal.

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

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

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

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

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

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

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

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

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

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

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

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

void updateMicroFocus

Description: Method void QDockWidget::updateMicroFocus()

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

[event] void visibilityChanged(bool visible)

Description: Signal declaration for QDockWidget::visibilityChanged(bool visible)

You can bind a procedure to this signal.

[virtual] void wheelEvent(QWheelEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[const] QWidget ptr widget

Description: Method QWidget *QDockWidget::widget()

Python specific notes:

The object exposes a readable attribute 'widget'. This is the getter.

void widget=(QWidget ptr widget)

Description: Method void QDockWidget::setWidget(QWidget *widget)

Python specific notes:

The object exposes a writable attribute 'widget'. This is the setter.

[virtual] void windowActivationChange(bool arg1)

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

This method can be reimplemented in a derived class.