qgsgui.h

Go to the documentation of this file.

/***************************************************************************
                         qgsgui.h
                         --------
    begin                : May 2017
    copyright            : (C) 2017 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 QGSGUI_H
#define QGSGUI_H
 
#include <memory>
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgssettingstree.h"
 
#include <QString>
#include <QWidget>
 
using namespace Qt::StringLiterals;
 
class QgsSettingsRegistryGui;
class QgsEditorWidgetRegistry;
class QgsShortcutsManager;
class QgsLayerTreeEmbeddedWidgetRegistry;
class QgsMapLayerActionRegistry;
class QgsSourceSelectProviderRegistry;
class QgsNative;
class QgsLayoutItemGuiRegistry;
class QgsAnnotationItemGuiRegistry;
class QgsAdvancedDigitizingToolsRegistry;
class QgsWidgetStateHelper;
class QgsProcessingGuiRegistry;
class QgsProcessingFavoriteAlgorithmManager;
class QgsProcessingRecentAlgorithmLog;
class QgsWindowManagerInterface;
class QgsDataItemGuiProviderRegistry;
class QgsProviderGuiRegistry;
class QgsProject;
class QgsProjectStorageGuiRegistry;
class QgsNumericFormatGuiRegistry;
class QgsCodeEditorColorSchemeRegistry;
class QgsMessageBar;
class QgsSubsetStringEditorProviderRegistry;
class QgsProviderSourceWidgetProviderRegistry;
class QgsRelationWidgetRegistry;
class QgsMapToolShapeRegistry;
class QgsHistoryProviderRegistry;
class QgsSensorGuiRegistry;
class QgsSettingsEditorWidgetRegistry;
class QgsInputControllerManager;
class QgsStoredQueryManager;

class GUI_EXPORT QgsGui : public QObject
{
    Q_OBJECT
 
  public:
    static inline QgsSettingsTreeNode *sTtreeWidgetGeometry = QgsSettingsTree::sTreeApp->createChildNode( u"widget-geometry"_s ) SIP_SKIP;
    static inline QgsSettingsTreeNode *sTtreeWidgetLastUsedValues = QgsSettingsTree::sTreeApp->createChildNode( u"widget-last-used-values"_s ) SIP_SKIP;

    enum ProjectCrsBehavior
    {
      UseCrsOfFirstLayerAdded = 1, 
      UsePresetCrs = 2,            
    };
    Q_ENUM( ProjectCrsBehavior )
 
    QgsGui( const QgsGui &other ) = delete;
    QgsGui &operator=( const QgsGui &other ) = delete;

    static QgsGui *instance();

    SIP_SKIP static QgsNative *nativePlatformInterface();

    static QgsSettingsRegistryGui *settingsRegistryGui() SIP_KEEPREFERENCE;

    static QgsEditorWidgetRegistry *editorWidgetRegistry() SIP_KEEPREFERENCE;

    static QgsSourceSelectProviderRegistry *sourceSelectProviderRegistry() SIP_KEEPREFERENCE;

    static QgsShortcutsManager *shortcutsManager();

    static QgsLayerTreeEmbeddedWidgetRegistry *layerTreeEmbeddedWidgetRegistry() SIP_KEEPREFERENCE;

    static QgsMapLayerActionRegistry *mapLayerActionRegistry() SIP_KEEPREFERENCE;

    static QgsLayoutItemGuiRegistry *layoutItemGuiRegistry() SIP_KEEPREFERENCE;

    static QgsAnnotationItemGuiRegistry *annotationItemGuiRegistry() SIP_KEEPREFERENCE;

    static QgsAdvancedDigitizingToolsRegistry *advancedDigitizingToolsRegistry() SIP_KEEPREFERENCE;

    static QgsProcessingGuiRegistry *processingGuiRegistry() SIP_KEEPREFERENCE;

    static QgsNumericFormatGuiRegistry *numericFormatGuiRegistry() SIP_KEEPREFERENCE;

    static QgsCodeEditorColorSchemeRegistry *codeEditorColorSchemeRegistry() SIP_KEEPREFERENCE;

    static QgsProcessingRecentAlgorithmLog *processingRecentAlgorithmLog();

    static QgsProcessingFavoriteAlgorithmManager *processingFavoriteAlgorithmManager();

    static QgsDataItemGuiProviderRegistry *dataItemGuiProviderRegistry() SIP_KEEPREFERENCE;

    static QgsProjectStorageGuiRegistry *projectStorageGuiRegistry() SIP_KEEPREFERENCE;

    static QgsProviderGuiRegistry *providerGuiRegistry() SIP_KEEPREFERENCE;

    static QgsSensorGuiRegistry *sensorGuiRegistry() SIP_KEEPREFERENCE;

    static QgsSubsetStringEditorProviderRegistry *subsetStringEditorProviderRegistry() SIP_KEEPREFERENCE;

    static QgsProviderSourceWidgetProviderRegistry *sourceWidgetProviderRegistry() SIP_KEEPREFERENCE;

    static QgsRelationWidgetRegistry *relationWidgetRegistry() SIP_KEEPREFERENCE;

    static QgsMapToolShapeRegistry *mapToolShapeRegistry() SIP_SKIP;

    static QgsHistoryProviderRegistry *historyProviderRegistry() SIP_KEEPREFERENCE;

    static QgsSettingsEditorWidgetRegistry *settingsEditorWidgetRegistry() SIP_KEEPREFERENCE;

    static void enableAutoGeometryRestore( QWidget *widget, const QString &key = QString() );

    static QgsWindowManagerInterface *windowManager();

    static void setWindowManager( QgsWindowManagerInterface *manager SIP_TRANSFER );

    static QgsInputControllerManager *inputControllerManager() SIP_KEEPREFERENCE;

    static QgsStoredQueryManager *storedQueryManager() SIP_KEEPREFERENCE;

    enum HigFlag SIP_ENUM_BASETYPE( IntFlag )
    {
      HigMenuTextIsTitleCase = 1 << 0,   
      HigDialogTitleIsTitleCase = 1 << 1 
    };
    Q_DECLARE_FLAGS( HigFlags, HigFlag )
 
    
    static QgsGui::HigFlags higFlags();
 
    ~QgsGui() override;

    static QColor sampleColor( QPoint point );

    static QScreen *findScreenAt( QPoint point );

    static bool allowExecutionOfEmbeddedScripts( QgsProject *project, QgsMessageBar *messageBar = nullptr ) SIP_SKIP;

    static void initCalloutWidgets() SIP_SKIP;

    static void initPlotWidgets() SIP_SKIP;

    static bool hasWebEngine();

    static QSize iconSize( Qgis::UserInterfaceIconType iconType = Qgis::UserInterfaceIconType::MainWindowToolbar );

    void emitOptionsChanged() SIP_SKIP;

    static QString applicationStyleSheet();

    void setApplicationStyleSheet( const QString &styleSheet ) SIP_SKIP;
 
  signals:

    void optionsChanged();

    void applicationStyleSheetChanged( const QString &styleSheet );
 
  private:
    QgsGui();
 
    std::unique_ptr<QgsSettingsRegistryGui> mSettingsRegistryGui;
    std::unique_ptr<QgsProviderGuiRegistry> mProviderGuiRegistry;
    std::unique_ptr<QgsWidgetStateHelper> mWidgetStateHelper;
    std::unique_ptr<QgsNative> mNative;
    std::unique_ptr<QgsEditorWidgetRegistry> mEditorWidgetRegistry;
    std::unique_ptr<QgsSourceSelectProviderRegistry> mSourceSelectProviderRegistry;
    std::unique_ptr<QgsShortcutsManager> mShortcutsManager;
    std::unique_ptr<QgsLayerTreeEmbeddedWidgetRegistry> mLayerTreeEmbeddedWidgetRegistry;
    std::unique_ptr<QgsMapLayerActionRegistry> mMapLayerActionRegistry;
    std::unique_ptr<QgsLayoutItemGuiRegistry> mLayoutItemGuiRegistry;
    std::unique_ptr<QgsAnnotationItemGuiRegistry> mAnnotationItemGuiRegistry;
    std::unique_ptr<QgsAdvancedDigitizingToolsRegistry> mAdvancedDigitizingToolsRegistry;
    std::unique_ptr<QgsProcessingGuiRegistry> mProcessingGuiRegistry;
    std::unique_ptr<QgsProcessingFavoriteAlgorithmManager> mProcessingFavoriteAlgorithmManager;
    std::unique_ptr<QgsProcessingRecentAlgorithmLog> mProcessingRecentAlgorithmLog;
    std::unique_ptr<QgsNumericFormatGuiRegistry> mNumericFormatGuiRegistry;
    std::unique_ptr<QgsDataItemGuiProviderRegistry> mDataItemGuiProviderRegistry;
    std::unique_ptr<QgsCodeEditorColorSchemeRegistry> mCodeEditorColorSchemeRegistry;
    std::unique_ptr<QgsProjectStorageGuiRegistry> mProjectStorageGuiRegistry;
    std::unique_ptr<QgsSubsetStringEditorProviderRegistry> mSubsetStringEditorProviderRegistry;
    std::unique_ptr<QgsProviderSourceWidgetProviderRegistry> mProviderSourceWidgetProviderRegistry;
    std::unique_ptr<QgsRelationWidgetRegistry> mRelationEditorRegistry;
    std::unique_ptr<QgsMapToolShapeRegistry> mShapeMapToolRegistry;
    std::unique_ptr<QgsHistoryProviderRegistry> mHistoryProviderRegistry;
    std::unique_ptr<QgsSensorGuiRegistry> mSensorGuiRegistry;
    std::unique_ptr<QgsSettingsEditorWidgetRegistry> mSettingsEditorRegistry;
    std::unique_ptr<QgsInputControllerManager> mInputControllerManager;
    std::unique_ptr<QgsStoredQueryManager> mStoredQueryManager;
    std::unique_ptr<QgsWindowManagerInterface> mWindowManager;
 
    QString mApplicationStyleSheet;
 
#ifdef SIP_RUN
    QgsGui( const QgsGui &other );
#endif
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsGui::HigFlags )
 
#endif // QGSGUI_H