Class: QgsDockWidget

class qgis.gui.QgsDockWidget(parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = 0)

Bases: PyQt5.QtWidgets.QDockWidget

Constructor for QgsDockWidget.

Parameters
  • parent (QWidget = None) – parent widget

  • flags (Union[Qt.WindowFlags) – window flags

QgsDockWidget(title: str, parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = 0) 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.

Methods

actionEvent

changeEvent

childEvent

closeEvent

connectNotify

contextMenuEvent

create

customEvent

destroy

disconnectNotify

dragEnterEvent

dragLeaveEvent

dragMoveEvent

dropEvent

enterEvent

event

focusInEvent

focusNextChild

focusNextPrevChild

focusOutEvent

focusPreviousChild

hideEvent

initPainter

initStyleOption

inputMethodEvent

isSignalConnected

isUserVisible

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

keyPressEvent

keyReleaseEvent

leaveEvent

metric

mouseDoubleClickEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

moveEvent

nativeEvent

paintEvent

receivers

resizeEvent

sender

senderSignalIndex

setToggleVisibilityAction

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

setUserVisible

Sets the dock widget as visible to a user, ie both shown and raised to the front.

sharedPainter

showEvent

param event

tabletEvent

timerEvent

toggleUserVisible

Toggles whether the dock is user visible.

toggleVisibilityAction

Returns the action linked to the dock.

updateMicroFocus

wheelEvent

Signals

closed

Emitted when dock widget is closed.

closedStateChanged

Emitted when dock widget is closed (or opened).

opened

Emitted when dock widget is opened.

openedStateChanged

Emitted when dock widget is opened (or closed).

actionEvent()
changeEvent()
childEvent()
closeEvent(self, QCloseEvent)
closed

Emitted when dock widget is closed.

See also

opened() [signal]

closedStateChanged

Emitted when dock widget is closed (or opened).

Parameters

wasClosed (bool) – will be True if dock widget was closed, or False if dock widget was opened

See also

closed()

See also

openedStateChanged() [signal]

connectNotify()
contextMenuEvent()
create()
customEvent()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enterEvent()
event()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
initPainter()
initStyleOption()
inputMethodEvent()
isSignalConnected()
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

setUserVisible()

Return type

bool

keyPressEvent()
keyReleaseEvent()
leaveEvent()
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
opened

Emitted when dock widget is opened.

See also

closed() [signal]

openedStateChanged

Emitted when dock widget is opened (or closed).

Parameters

wasOpened (bool) – will be True if dock widget was opened, or False if dock widget was closed

See also

opened() [signal]

paintEvent()
receivers()
resizeEvent()
sender()
senderSignalIndex()
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).

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, 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()

sharedPainter()
showEvent(self, event: QShowEvent)
Parameters

event (QShowEvent) –

tabletEvent()
timerEvent()
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

setUserVisible()

See also

isUserVisible()

New in version 3.2.

toggleVisibilityAction(self) → QAction

Returns the action linked to the dock.

New in version 3.4.

Return type

QAction

updateMicroFocus()
wheelEvent()