Class: QgsDockWidget¶
- class qgis.gui.QgsDockWidget(parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags())¶
Bases:
PyQt5.QtWidgets.QDockWidget
Constructor for QgsDockWidget.
- Parameters
parent – parent widget
flags – window flags
QgsDockWidget(title: str, parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags()) Constructor for QgsDockWidget.
- Parameters
title – dock title
parent – parent widget
flags – window flags
QgsDockWidget
subclass with more fine-grained control over how the widget is closed or opened.New in version 2.16:
Methods
Returns
True
if the dock is both opened and raised to the front (ie not hidden by any other tabs.Links an
action
to the dock, so that toggling the action will automatically set the dock's visibility to suit (and changing the dock visibility will update the action's state).Sets the dock widget as visible to a user, ie both shown and raised to the front.
- param event
Toggles whether the dock is user visible.
Returns the action linked to the dock.
Signals
Emitted when dock widget is closed.
Emitted when dock widget is closed (or opened).
Emitted when dock widget is opened.
Emitted when dock widget is opened (or closed).
- actionEvent(self, QActionEvent)¶
- changeEvent(self, QEvent)¶
- childEvent(self, QChildEvent)¶
- closeEvent(self, QCloseEvent)¶
- closedStateChanged¶
Emitted when dock widget is closed (or opened).
- Parameters
wasClosed (bool) – will be
True
if dock widget was closed, orFalse
if dock widget was opened
See also
See also
openedStateChanged()
[signal]
- connectNotify(self, QMetaMethod)¶
- contextMenuEvent(self, QContextMenuEvent)¶
- create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
- customEvent(self, QEvent)¶
- destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶
- disconnectNotify(self, QMetaMethod)¶
- dragEnterEvent(self, QDragEnterEvent)¶
- dragLeaveEvent(self, QDragLeaveEvent)¶
- dragMoveEvent(self, QDragMoveEvent)¶
- dropEvent(self, QDropEvent)¶
- enterEvent(self, QEvent)¶
- event(self, QEvent) bool ¶
- focusInEvent(self, QFocusEvent)¶
- focusNextChild(self) bool ¶
- focusNextPrevChild(self, bool) bool ¶
- focusOutEvent(self, QFocusEvent)¶
- focusPreviousChild(self) bool ¶
- hideEvent(self, QHideEvent)¶
- initPainter(self, QPainter)¶
- initStyleOption(self, QStyleOptionDockWidget)¶
- inputMethodEvent(self, QInputMethodEvent)¶
- isSignalConnected(self, QMetaMethod) bool ¶
- isUserVisible(self) bool ¶
Returns
True
if the dock is both opened and raised to the front (ie not hidden by any other tabs.See also
See also
- Return type
bool
- keyPressEvent(self, QKeyEvent)¶
- keyReleaseEvent(self, QKeyEvent)¶
- leaveEvent(self, QEvent)¶
- metric(self, QPaintDevice.PaintDeviceMetric) int ¶
- mouseDoubleClickEvent(self, QMouseEvent)¶
- mouseMoveEvent(self, QMouseEvent)¶
- mousePressEvent(self, QMouseEvent)¶
- mouseReleaseEvent(self, QMouseEvent)¶
- moveEvent(self, QMoveEvent)¶
- nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr) Tuple[bool, int] ¶
- openedStateChanged¶
Emitted when dock widget is opened (or closed).
- Parameters
wasOpened (bool) – will be
True
if dock widget was opened, orFalse
if dock widget was closed
See also
See also
opened()
[signal]
- paintEvent(self, QPaintEvent)¶
- receivers(self, PYQT_SIGNAL) int ¶
- resizeEvent(self, QResizeEvent)¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setToggleVisibilityAction(self, action: QAction)¶
Links an
action
to the dock, so that toggling the action will automatically set the dock’s visibility to suit (and changing the dock visibility will update the action’s state).See also
New in version 3.4.
- Parameters
action (QAction) –
- setUserVisible(self, visible: bool)¶
Sets the dock widget as visible to a user, ie both shown and raised to the front.
- Parameters
visible (bool) –
set to
True
to show the dock to the user, orFalse
to hide the dock. When setting a dock as user visible, the dock will be opened (if it is not already opened) and raised to the front. When setting as hidden, the following logic is used:hiding a dock which is open but not raised (ie hidden by another tab) will have no effect, and the dock will still be opened and hidden by the other tab
hiding a dock which is open and raised (ie, user visible) will cause the dock to be closed
hiding a dock which is closed has no effect and raises no signals
See also
See also
- showEvent(self, event: QShowEvent)¶
- Parameters
event (QShowEvent) –
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- toggleUserVisible(self)¶
Toggles whether the dock is user visible. If the dock is not currently user visible (i.e. opened and activated as a tab) then the dock will be opened and raised. If it is currently user visible it will be closed.
See also
See also
New in version 3.2.
- toggleVisibilityAction(self) QAction ¶
Returns the action linked to the dock.
See also
New in version 3.4.
- Return type
QAction
- updateMicroFocus(self)¶
- wheelEvent(self, QWheelEvent)¶