QGIS API Documentation  2.99.0-Master (e077efd)
qgsoptionsdialogbase.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsoptionsdialogbase.h - base vertical tabs option dialog
3 
4  ---------------------
5  begin : March 24, 2013
6  copyright : (C) 2013 by Larry Shaffer
7  email : larrys at dakcarto dot com
8  ***************************************************************************
9  * *
10  * This program is free software; you can redistribute it and/or modify *
11  * it under the terms of the GNU General Public License as published by *
12  * the Free Software Foundation; either version 2 of the License, or *
13  * (at your option) any later version. *
14  * *
15  ***************************************************************************/
16 
17 #ifndef QGSOPTIONSDIALOGBASE_H
18 #define QGSOPTIONSDIALOGBASE_H
19 
20 #include "qgisgui.h"
21 
22 #include <QDialog>
23 #include <QPointer>
24 #include <QSettings>
25 
26 class QDialogButtonBox;
27 class QListWidget;
28 class QStackedWidget;
29 class QSplitter;
30 
48 class GUI_EXPORT QgsOptionsDialogBase : public QDialog
49 {
50  Q_OBJECT
51 
52  public:
53 
60  QgsOptionsDialogBase( const QString& settingsKey, QWidget* parent = nullptr, Qt::WindowFlags fl = 0, QSettings* settings = nullptr );
62 
67  void initOptionsBase( bool restoreUi = true, const QString& title = QString() );
68 
69  // set custom QSettings pointer if dialog used outside QGIS (in plugin)
70  void setSettings( QSettings* settings );
71 
76  void restoreOptionsBaseUi( const QString& title = QString() );
77 
80  bool iconOnly() {return mIconOnly;}
81 
82  protected slots:
83  void updateOptionsListVerticalTabs();
84  void optionsStackedWidget_CurrentChanged( int indx );
85  void optionsStackedWidget_WidgetRemoved( int indx );
86  void warnAboutMissingObjects();
87 
88  protected:
89  void showEvent( QShowEvent* e ) override;
90  void paintEvent( QPaintEvent* e ) override;
91 
92  virtual void updateWindowTitle();
93 
94  QString mOptsKey;
95  bool mInit;
96  QListWidget* mOptListWidget;
97  QStackedWidget* mOptStackedWidget;
98  QSplitter* mOptSplitter;
99  QDialogButtonBox* mOptButtonBox;
100  QString mDialogTitle;
101  bool mIconOnly;
102  // pointer to app or custom, external QSettings
103  // QPointer in case custom settings obj gets deleted while dialog is open
104  QPointer<QSettings> mSettings;
106 };
107 
108 #endif // QGSOPTIONSDIALOGBASE_H
A base dialog for options and properties dialogs that offers vertical tabs.
QDialogButtonBox * mOptButtonBox
QStackedWidget * mOptStackedWidget
bool iconOnly()
Determine if the options list is in icon only mode.
QPointer< QSettings > mSettings