QGIS API Documentation  2.99.0-Master (f867b65)
Public Slots | Signals | Public Member Functions | Protected Member Functions | List of all members
QgsDockWidget Class Reference

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

#include <qgsdockwidget.h>

Inheritance diagram for QgsDockWidget:
Inheritance graph
[legend]

Public Slots

bool isUserVisible () const
 Returns true if the dock is both opened and raised to the front (ie not hidden by any other tabs. More...
 
void setUserVisible (bool visible)
 Sets the dock widget as visible to a user, ie both shown and raised to the front. More...
 

Signals

void closed ()
 Emitted when dock widget is closed. More...
 
void closedStateChanged (bool wasClosed)
 Emitted when dock widget is closed (or opened). More...
 
void opened ()
 Emitted when dock widget is opened. More...
 
void openedStateChanged (bool wasOpened)
 Emitted when dock widget is opened (or closed). More...
 

Public Member Functions

 QgsDockWidget (QWidget *parent=nullptr, Qt::WindowFlags flags=0)
 Constructor for QgsDockWidget. More...
 
 QgsDockWidget (const QString &title, QWidget *parent=nullptr, Qt::WindowFlags flags=0)
 Constructor for QgsDockWidget. More...
 

Protected Member Functions

virtual void closeEvent (QCloseEvent *) override
 
virtual void showEvent (QShowEvent *event) override
 

Detailed Description

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

Since
QGIS 2.16

Definition at line 30 of file qgsdockwidget.h.

Constructor & Destructor Documentation

◆ QgsDockWidget() [1/2]

QgsDockWidget::QgsDockWidget ( QWidget *  parent = nullptr,
Qt::WindowFlags  flags = 0 
)
explicit

Constructor for QgsDockWidget.

Parameters
parentparent widget
flagswindow flags

Definition at line 22 of file qgsdockwidget.cpp.

◆ QgsDockWidget() [2/2]

QgsDockWidget::QgsDockWidget ( const QString &  title,
QWidget *  parent = nullptr,
Qt::WindowFlags  flags = 0 
)
explicit

Constructor for QgsDockWidget.

Parameters
titledock title
parentparent widget
flagswindow flags

Definition at line 29 of file qgsdockwidget.cpp.

Member Function Documentation

◆ closed

void QgsDockWidget::closed ( )
signal

Emitted when dock widget is closed.

See also
closedStateChanged()
opened()

◆ closedStateChanged

void QgsDockWidget::closedStateChanged ( bool  wasClosed)
signal

Emitted when dock widget is closed (or opened).

Parameters
wasClosedwill be true if dock widget was closed, or false if dock widget was opened
See also
closed()
openedStateChanged()

◆ closeEvent()

void QgsDockWidget::closeEvent ( QCloseEvent *  e)
overrideprotectedvirtual

Definition at line 60 of file qgsdockwidget.cpp.

◆ isUserVisible

bool QgsDockWidget::isUserVisible ( ) const
slot

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

See also
setUserVisible()

Definition at line 55 of file qgsdockwidget.cpp.

◆ opened

void QgsDockWidget::opened ( )
signal

Emitted when dock widget is opened.

See also
openedStateChanged()
closed()

◆ openedStateChanged

void QgsDockWidget::openedStateChanged ( bool  wasOpened)
signal

Emitted when dock widget is opened (or closed).

Parameters
wasOpenedwill be true if dock widget was opened, or false if dock widget was closed
See also
closedStateChanged()
opened()

◆ setUserVisible

void QgsDockWidget::setUserVisible ( bool  visible)
slot

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

Parameters
visibleset 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()

Definition at line 36 of file qgsdockwidget.cpp.

◆ showEvent()

void QgsDockWidget::showEvent ( QShowEvent *  event)
overrideprotectedvirtual

Reimplemented in QgsBrowserDockWidget.

Definition at line 68 of file qgsdockwidget.cpp.


The documentation for this class was generated from the following files: