QGIS API Documentation  3.13.0-Master (5a3b1ced84)
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 
31 class GUI_EXPORT QgsDockWidget : public QDockWidget
32 {
33  Q_OBJECT
34 
35  public:
36 
42  explicit QgsDockWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags flags = nullptr );
43 
50  explicit QgsDockWidget( const QString &title, QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags flags = nullptr );
51 
58  bool isUserVisible() const;
59 
67  void setToggleVisibilityAction( QAction *action );
68 
75  QAction *toggleVisibilityAction();
76 
77  public slots:
78 
93  void setUserVisible( bool visible );
94 
104  void toggleUserVisible();
105 
106  protected:
107 
108  void closeEvent( QCloseEvent * ) override;
109  void showEvent( QShowEvent *event ) override;
110 
111  signals:
112 
118  void closed();
119 
126  void closedStateChanged( bool wasClosed );
127 
133  void opened();
134 
141  void openedStateChanged( bool wasOpened );
142 
143  private slots:
144 
145  void handleVisibilityChanged( bool visible );
146 
147  private:
148 
149  bool mVisibleAndActive = false;
150 
151  QAction *mAction = nullptr;
152 
153 };
154 #endif //QGSDOCKWIDGET_H
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53
QgsDockWidget subclass with more fine-grained control over how the widget is closed or opened...
Definition: qgsdockwidget.h:31