Class: QgsDockWidget

A QDockWidget subclass with more fine-grained control over how the widget is closed or opened.

Class Hierarchy

Inheritance diagram of qgis.gui.QgsDockWidget

Base classes

QDockWidget

QWidget

QObject

QPaintDevice

Subclasses

QgsAdvancedDigitizingDockWidget

A dockable widget used to handle the CAD tools on top of a selection of map tools.

QgsBrowserDockWidget

A dock widget containing a QgsBrowserWidget for navigating and managing data sources.
class qgis.gui.QgsDockWidget[source]

Bases: QDockWidget

__init__(parent: QWidget | None = None, flags: Qt.WindowFlags | Qt.WindowType = Qt.WindowFlags())

Constructor for QgsDockWidget.

Parameters:

  • parent (Optional[QWidget] = None) – parent widget

  • flags (Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags()) – window flags

__init__(title: str | None, parent: QWidget | None = None, flags: Qt.WindowFlags | Qt.WindowType = Qt.WindowFlags())

Constructor for QgsDockWidget.

Parameters:

  • title (Optional[str]) – dock title

  • parent (Optional[QWidget] = None) – parent widget

  • flags (Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags()) – window flags

signal closed[source]

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

signal closedStateChanged[source]

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

isUserVisible(self) → bool[source]

Returns True if the dock is both opened and raised to the front (ie not hidden by any other tabs.

See also

setUserVisible()

See also

toggleUserVisible()

Return type:

bool

signal opened[source]

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

signal openedStateChanged[source]

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

setToggleVisibilityAction(self, action: QAction | None)[source]

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

toggleVisibilityAction()

Added in version 3.4.

Parameters:

action (Optional[QAction])

setUserVisible(self, visible: bool)[source]

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, or False 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

isUserVisible()

See also

toggleUserVisible()

toggleUserVisible(self)[source]

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

setUserVisible()

See also

isUserVisible()

Added in version 3.2.

toggleVisibilityAction(self) → QAction | None[source]

Returns the action linked to the dock.

See also

setToggleVisibilityAction()

Added in version 3.4.

Return type:

Optional[QAction]