QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
qgsdockwidget.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsdockwidget.h
3 ---------------
4 begin : June 2016
5 copyright : (C) 2016 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17#ifndef QGSDOCKWIDGET_H
18#define QGSDOCKWIDGET_H
19
20#include <QDockWidget>
21#include "qgis_gui.h"
22#include "qgis_sip.h"
23
30class GUI_EXPORT QgsDockWidget : public QDockWidget
31{
32 Q_OBJECT
33
34 public:
35
41 explicit QgsDockWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags flags = Qt::WindowFlags() );
42
49 explicit QgsDockWidget( const QString &title, QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags flags = Qt::WindowFlags() );
50
57 bool isUserVisible() const;
58
66 void setToggleVisibilityAction( QAction *action );
67
74 QAction *toggleVisibilityAction();
75
76 public slots:
77
94 void setUserVisible( bool visible );
95
105 void toggleUserVisible();
106
107 protected:
108
109 void closeEvent( QCloseEvent * ) override;
110 void showEvent( QShowEvent *event ) override;
111
112 signals:
113
119 void closed();
120
127 void closedStateChanged( bool wasClosed );
128
134 void opened();
135
142 void openedStateChanged( bool wasOpened );
143
144 private slots:
145
146 void handleVisibilityChanged( bool visible );
147
148 private:
149
150 bool mVisibleAndActive = false;
151
152 QAction *mAction = nullptr;
153
154};
155#endif //QGSDOCKWIDGET_H
QgsDockWidget subclass with more fine-grained control over how the widget is closed or opened.
Definition: qgsdockwidget.h:31
void closed()
Emitted when dock widget is closed.
void closedStateChanged(bool wasClosed)
Emitted when dock widget is closed (or opened).
void opened()
Emitted when dock widget is opened.
void openedStateChanged(bool wasOpened)
Emitted when dock widget is opened (or closed).
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53