QGIS API Documentation  3.0.2-Girona (307d082)
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.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 
57  bool isUserVisible() const;
58 
59  public slots:
60 
74  void setUserVisible( bool visible );
75 
76  protected:
77 
78  void closeEvent( QCloseEvent * ) override;
79  void showEvent( QShowEvent *event ) override;
80 
81  signals:
82 
88  void closed();
89 
96  void closedStateChanged( bool wasClosed );
97 
103  void opened();
104 
111  void openedStateChanged( bool wasOpened );
112 
113  private slots:
114 
115  void handleVisibilityChanged( bool visible );
116 
117  private:
118 
119  bool mVisibleAndActive = false;
120 
121 };
122 #endif //QGSDOCKWIDGET_H
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:46
QgsDockWidget subclass with more fine-grained control over how the widget is closed or opened...
Definition: qgsdockwidget.h:31