QGIS API Documentation  3.27.0-Master (e113457133)
qgsoptionswidgetfactory.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsoptionswidgetfactory.h
3  -------------------------------
4  Date : March 2017
5  Copyright : (C) 2017 Nyall Dawson
6  Email : nyall dot dawson at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSOPTIONSWIDGETFACTORY_H
17 #define QGSOPTIONSWIDGETFACTORY_H
18 
19 #include <QListWidgetItem>
20 #include "qgis_gui.h"
21 #include "qgis_sip.h"
23 
30 class GUI_EXPORT QgsOptionsPageWidget : public QWidget
31 {
32  Q_OBJECT
33 
34  public:
35 
39  QgsOptionsPageWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr )
40  : QWidget( parent )
41  {}
42 
53  virtual QString helpKey() const { return QString(); }
54 
59  QHash<QWidget *, QgsOptionsDialogHighlightWidget *> registeredHighlightWidgets() {return mHighlightWidgets;} SIP_SKIP
60 
70  virtual bool isValid() { return true; }
71 
72  public slots:
73 
78  virtual void apply() = 0;
79 
80  protected:
81 
88  {
89  mHighlightWidgets.insert( highlightWidget->widget(), highlightWidget );
90  }
91 
92  private:
93  QHash<QWidget *, QgsOptionsDialogHighlightWidget *> mHighlightWidgets;
94 
95 
96 };
97 
104 // NOTE - this is a QObject so we can detect its destruction and avoid
105 // QGIS crashing when a plugin crashes/exits without deregistering a factory
106 class GUI_EXPORT QgsOptionsWidgetFactory : public QObject
107 {
108  Q_OBJECT
109 
110  public:
111 
114 
116  QgsOptionsWidgetFactory( const QString &title, const QIcon &icon )
117  : mTitle( title )
118  , mIcon( icon )
119  {}
120 
126  virtual QIcon icon() const { return mIcon; }
127 
132  void setIcon( const QIcon &icon ) { mIcon = icon; }
133 
138  virtual QString title() const { return mTitle; }
139 
144  void setTitle( const QString &title ) { mTitle = title; }
145 
158  virtual QString pagePositionHint() const { return QString(); }
159 
169  virtual QStringList path() const { return QStringList(); }
170 
176  virtual QgsOptionsPageWidget *createWidget( QWidget *parent = nullptr ) const = 0 SIP_FACTORY;
177 
178  private:
179  QString mTitle;
180  QIcon mIcon;
181 
182 
183 };
184 
185 #endif // QGSOPTIONSWIDGETFACTORY_H
Container for a widget to be used to search text in the option dialog If the widget type is handled,...
Base class for widgets for pages included in the options dialog.
QgsOptionsPageWidget(QWidget *parent=nullptr)
Constructor for QgsOptionsPageWidget.
QHash< QWidget *, QgsOptionsDialogHighlightWidget * > registeredHighlightWidgets()
Returns the registered highlight widgets used to search and highlight text in options dialogs.
void registerHighlightWidget(QgsOptionsDialogHighlightWidget *highlightWidget)
Register a highlight widget to be used to search and highlight text in options dialogs.
virtual QString helpKey() const
Returns the optional help key for the options page.
virtual bool isValid()
Validates the current state of the widget.
virtual void apply()=0
Called to permanently apply the settings shown in the options page (e.g.
A factory class for creating custom options pages.
void setTitle(const QString &title)
Set the title for the interface.
QgsOptionsWidgetFactory(const QString &title, const QIcon &icon)
Constructor.
void setIcon(const QIcon &icon)
Set the icon to show in the interface for the factory object.
virtual QStringList path() const
Returns the path to place the widget page at, for options dialogs which are structured using a tree v...
virtual QgsOptionsPageWidget * createWidget(QWidget *parent=nullptr) const =0
Factory function to create the widget on demand as needed by the options dialog.
virtual QIcon icon() const
The icon that will be shown in the UI for the panel.
virtual QString title() const
The title of the panel.
virtual QString pagePositionHint() const
Returns a tab name hinting at where this page should be inserted into the options properties tab list...
QgsOptionsWidgetFactory()=default
Constructor.
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53
#define SIP_SKIP
Definition: qgis_sip.h:126
#define SIP_FACTORY
Definition: qgis_sip.h:76