qgsdockablewidgethelper.h

Go to the documentation of this file.

/***************************************************************************
  qgsdockablewidgethelper.h
  --------------------------------------
  Date                 : January 2022
  Copyright            : (C) 2022 by Belgacem Nedjima
  Email                : belgacem dot nedjima 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 QGSDOCKABLEWIDGETHELPER_H
#define QGSDOCKABLEWIDGETHELPER_H
 
#include "qgis_gui.h"
#include "qgsgui.h"
#include "qgssettingsentryenumflag.h"
#include "qgssettingsentryimpl.h"
 
#include <QDialog>
#include <QDomElement>
#include <QMainWindow>
#include <QPointer>
#include <QString>
#include <QToolButton>
 
using namespace Qt::StringLiterals;
 
#define SIP_NO_FILE
 
class QgsDockWidget;

 
class GUI_EXPORT QgsNonRejectableDialog : public QDialog
{
    Q_OBJECT
  public:
    explicit QgsNonRejectableDialog( QWidget *parent = nullptr, Qt::WindowFlags f = Qt::WindowFlags() );
    void reject() override;
};

class GUI_EXPORT QgsDockableWidgetHelper : public QObject
{
    static inline QgsSettingsTreeNode *sTtreeDockConfigs = QgsGui::sTtreeWidgetGeometry->createNamedListNode( u"docks"_s ) SIP_SKIP;
 
    static const QgsSettingsEntryBool *sSettingsIsDocked SIP_SKIP;
    static const QgsSettingsEntryVariant *sSettingsDockGeometry SIP_SKIP;
    static const QgsSettingsEntryVariant *sSettingsDialogGeometry SIP_SKIP;
    static const QgsSettingsEntryEnumFlag<Qt::DockWidgetArea> *sSettingsDockArea SIP_SKIP;
 
    Q_OBJECT
  public:
    enum class OpeningMode : int
    {
      RespectSetting, 
      ForceDocked,    
      ForceDialog,    
    };
 
    enum class Option : int
    {
      RaiseTab = 1 << 1,        
      PermanentWidget = 1 << 2, 
    };
    Q_ENUM( Option )
    Q_DECLARE_FLAGS( Options, Option )
 
    
    QgsDockableWidgetHelper(
      const QString &windowTitle,
      QWidget *widget,
      QMainWindow *ownerWindow,
      const QString &dockId,
      const QStringList &tabifyWith = QStringList(),
      OpeningMode openingMode = OpeningMode::RespectSetting,
      bool defaultIsDocked = false,
      Qt::DockWidgetArea defaultDockArea = Qt::DockWidgetArea::RightDockWidgetArea,
      Options options = Options()
    );
 
    ~QgsDockableWidgetHelper() override;

    bool isDocked() const { return mIsDocked; }

    void writeXml( QDomElement &viewDom );
    void readXml( const QDomElement &viewDom );

    void setWidget( QWidget *widget );
    QWidget *widget() { return mWidget; }

    QgsDockWidget *dockWidget();
    QDialog *dialog();

    void setWindowTitle( const QString &title );
    QString windowTitle() const { return mWindowTitle; }

    void setDockObjectName( const QString &name );
    QString dockObjectName() const;

    bool isUserVisible() const;

    QToolButton *createDockUndockToolButton();

    QAction *createDockUndockAction( const QString &title, QWidget *parent );
 
    bool eventFilter( QObject *watched, QEvent *event ) override;
 
    static std::function<void( Qt::DockWidgetArea, QDockWidget *, const QStringList &, bool )> sAddTabifiedDockWidgetFunction;
    static std::function<QString()> sAppStylesheetFunction;
 
    static QMainWindow *sOwnerWindow;
 
  signals:
    void closed();
 
    void dockModeToggled( bool docked );
 
    void visibilityChanged( bool isVisible );
 
  public slots:
    void toggleDockMode( bool docked );
 
    void setUserVisible( bool visible );
 
  private:
    void setupDockWidget( const QStringList &tabSiblings = QStringList() );
 
    bool mIsDocked = true;
    QWidget *mWidget = nullptr;
 
    QPointer<QDialog> mDialog;
    QRect mDialogGeometry;
 
    QPointer<QgsDockWidget> mDock;
    QRect mDockGeometry;
    bool mIsDockFloating = true;
    Qt::DockWidgetArea mDockArea = Qt::RightDockWidgetArea;
 
    QString mWindowTitle;
    QString mObjectName;
    QMainWindow *mOwnerWindow = nullptr;
 
    QStringList mTabifyWith;
    Options mOptions;
 
    // Unique identifier of dock
    QString mUuid;
 
 
    const QString mSettingKeyDockId;
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsDockableWidgetHelper::Options )
 
 

 
#endif // QGSDOCKABLEWIDGETHELPER_H