qgsdockwidget.h

Go to the documentation of this file.

/***************************************************************************
                             qgsdockwidget.h
                             ---------------
    begin                : June 2016
    copyright            : (C) 2016 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSDOCKWIDGET_H
#define QGSDOCKWIDGET_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QDockWidget>

 
class GUI_EXPORT QgsDockWidget : public QDockWidget
{
    Q_OBJECT
 
  public:

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

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

    bool isUserVisible() const;

    void setToggleVisibilityAction( QAction *action );

    QAction *toggleVisibilityAction();
 
  public slots:

    void setUserVisible( bool visible );

    void toggleUserVisible();
 
  protected:
    void closeEvent( QCloseEvent * ) override;
    void showEvent( QShowEvent *event ) override;
 
  signals:

    void closed();

    void closedStateChanged( bool wasClosed );

    void opened();

    void openedStateChanged( bool wasOpened );
 
  private slots:
 
    void handleVisibilityChanged( bool visible );
 
  private:
    bool mVisibleAndActive = false;
 
    QAction *mAction = nullptr;
};
#endif //QGSDOCKWIDGET_H