qgscustomization.h

/***************************************************************************
                             qgscustomization.h  - Customization
                             -------------------
    begin                : 2011-04-01
    copyright            : (C) 2011 Radim Blazek
    email                : radim dot blazek 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 QGSCUSTOMIZATION_H
#define QGSCUSTOMIZATION_H

#include "ui_qgscustomizationdialogbase.h"

#include <QDialog>
#include <QDomNode>

#include "qgis_app.h"

class QString;
class QWidget;
class QTreeWidgetItem;
class QEvent;
class QMouseEvent;
class QSettings;

class APP_EXPORT QgsCustomizationDialog : public QMainWindow, private Ui::QgsCustomizationDialogBase
{
    Q_OBJECT
  public:
    QgsCustomizationDialog( QWidget *parent, QSettings *settings );
    ~QgsCustomizationDialog();

    // get item by path
    QTreeWidgetItem *item( const QString &path, QTreeWidgetItem *widgetItem = nullptr );

    //

    // return current item state for given path
    bool itemChecked( const QString &path );
    // set item state for given path
    void setItemChecked( const QString &path, bool on );

    // recursively save tree item to settings
    void itemToSettings( const QString &path, QTreeWidgetItem *item, QSettings *settings );
    // recursively save settings to tree items
    void settingsToItem( const QString &path, QTreeWidgetItem *item, QSettings *settings );

    // save current tree to settings
    void treeToSettings( QSettings *settings );

    // restore current tree from settings
    void settingsToTree( QSettings *settings );

    // switch widget item in tree
    bool switchWidget( QWidget *widget, QMouseEvent *event );

    // Get path of the widget
    QString widgetPath( QWidget *widget, const QString &path = QString() );

    void setCatch( bool on );
    bool catchOn();

  private slots:
    //void on_btnQgisUser_clicked();

    // Save to settings
    void ok();
    void apply();

    void cancel();

    // Reset values from settings
    void reset();

    // Save to settings to file
    void on_actionSave_triggered( bool checked );

    // Load settings from file
    void on_actionLoad_triggered( bool checked );

    void on_actionExpandAll_triggered( bool checked );
    void on_actionCollapseAll_triggered( bool checked );
    void on_actionSelectAll_triggered( bool checked );

    void on_mCustomizationEnabledCheckBox_toggled( bool checked );

  private:
    void init();
    QTreeWidgetItem *createTreeItemWidgets();
    QTreeWidgetItem *readWidgetsXmlNode( const QDomNode &node );

    QString mLastDirSettingsName;
    QSettings *mSettings = nullptr;
};

class APP_EXPORT QgsCustomization : public QObject
{
    Q_OBJECT

  public:
    enum Status
    {
      NotSet    = 0,
      User      = 1, // Set by user
      Default   = 2  // Default customization loaded and set
    };

    //! Returns the instance pointer, creating the object on the first call
    static QgsCustomization *instance();

    void openDialog( QWidget *parent );
    static void customizeWidget( QWidget *widget, QEvent *event, QSettings *settings );
    static void customizeWidget( const QString &path, QWidget *widget, QSettings *settings );
    static void removeFromLayout( QLayout *layout, QWidget *widget );

    void updateMainWindow( QMenu *toolBarMenu );

    // make sure to enable/disable before creating QgisApp in order to get it customized (or not)
    void setEnabled( bool enabled ) { mEnabled = enabled; }
    bool isEnabled() const { return mEnabled; }

    void setSettings( QSettings *settings ) { mSettings = settings ;}

    // Return the path to the splash screen
    QString splashPath();

    // Load and set default customization
    void loadDefault();

    // Internal Qt widget which has to bes kipped in paths
    static QStringList sInternalWidgets;

    QString statusPath() { return mStatusPath; }

  public slots:
    void preNotify( QObject *receiver, QEvent *event, bool *done );

  protected:
    QgsCustomization();
    ~QgsCustomization();
    QgsCustomizationDialog *pDialog = nullptr;

    bool mEnabled;
    QSettings *mSettings = nullptr;
    QString mStatusPath;

    void updateMenu( QMenu *menu, QSettings *settings );
    void createTreeItemMenus();
    void createTreeItemToolbars();
    void createTreeItemDocks();
    void createTreeItemStatus();
    void addTreeItemMenu( QTreeWidgetItem *parentItem, QMenu *menu );
    void addTreeItemActions( QTreeWidgetItem *parentItem, const QList<QAction *> &actions );
    QList<QTreeWidgetItem *> mMainWindowItems;
    friend class QgsCustomizationDialog; // in order to access mMainWindowItems

  private slots:

  private:
    static QgsCustomization *sInstance;

};
#endif // QGSCUSTOMIZATION_H