qgspanelwidget.h

Go to the documentation of this file.

/***************************************************************************
    qgspanelwidget.h
    ---------------------
    begin                : June 2016
    copyright            : (C) 2016 by Nathan Woodrow
    email                :
 ***************************************************************************
 *                                                                         *
 *   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 QGSPANELWIDGET_H
#define QGSPANELWIDGET_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QKeyEvent>
#include <QStack>
#include <QWidget>
 
class QMenu;

class GUI_EXPORT QgsPanelWidget : public QWidget
{
    Q_OBJECT
  public:
    QgsPanelWidget( QWidget *parent = nullptr );

    void setPanelTitle( const QString &panelTitle ) { mPanelTitle = panelTitle; }

    QString panelTitle() const { return mPanelTitle; }

    void connectChildPanels( const QList<QgsPanelWidget *> &panels );

    void connectChildPanel( QgsPanelWidget *panel );

    virtual void setDockMode( bool dockMode );

    virtual bool applySizeConstraintsToStack() const;

    bool dockMode() const { return mDockMode; }

    void setAutoDelete( bool autoDelete ) { mAutoDelete = autoDelete; }

    bool autoDelete() const { return mAutoDelete; }

    static QgsPanelWidget *findParentPanel( QWidget *widget );

    virtual QString menuButtonTooltip() const;

    virtual QMenu *menuButtonMenu();
 
  signals:

    void panelAccepted( QgsPanelWidget *panel );

    void showPanel( QgsPanelWidget *panel );

    Q_DECL_DEPRECATED void widgetChanged() SIP_DEPRECATED;

    void changed();
 
  public slots:

    void openPanel( QgsPanelWidget *panel );

    void acceptPanel();
 
  protected:
    void keyPressEvent( QKeyEvent *event ) override;
 
  private:
    bool mAutoDelete = true;
    QString mPanelTitle;
    bool mDockMode = false;
    bool mForwardChangedSignal = false;
};
 

class GUI_EXPORT QgsPanelWidgetWrapper : public QgsPanelWidget
{
    Q_OBJECT
  public:
    QgsPanelWidgetWrapper( QWidget *widget, QWidget *parent = nullptr );

    QWidget *widget() { return mWidget; }
 
  private:
    QWidget *mWidget = nullptr;
};
 
#endif // QGSPANELWIDGET_H