1#ifndef DIALOGS_OPTIONSPAGE_H
2#define DIALOGS_OPTIONSPAGE_H
19 explicit OptionPageWidget(QWidget *parent =
nullptr, Qt::WindowFlags f = Qt::WindowFlags());
25 bool event(QEvent *)
override;
37 explicit OptionPage(QWidget *parentWindow =
nullptr);
40 QWidget *parentWindow()
const;
42 bool hasBeenShown()
const;
45 bool matches(
const QString &searchKeyWord);
46 const QStringList &errors()
const;
50 QStringList &errors();
53 std::unique_ptr<QWidget> m_widget;
54 QWidget *m_parentWindow;
56 bool m_keywordsInitialized;
57 QStringList m_keywords;
66 return m_parentWindow;
76 return m_widget !=
nullptr && m_shown;
118 QWidget *setupWidget()
override;
122 std::unique_ptr<UiClass> m_ui;
128template <
class UiClass>
148 m_ui.reset(
new UiClass);
150 m_ui->setupUi(widget);
166#define BEGIN_DECLARE_TYPEDEF_OPTION_PAGE(SomeClass) using SomeClass##Base = ::QtUtilities::OptionPage;
173#define BEGIN_DECLARE_OPTION_PAGE(SomeClass) \
174 BEGIN_DECLARE_TYPEDEF_OPTION_PAGE(SomeClass) \
175 class QT_UTILITIES_EXPORT SomeClass : public ::QtUtilities::OptionPage { \
177 explicit SomeClass(QWidget *parentWidget = nullptr); \
178 ~SomeClass() override; \
179 bool apply() override; \
180 void reset() override; \
189#define BEGIN_DECLARE_OPTION_PAGE_CUSTOM_CTOR(SomeClass) \
190 BEGIN_DECLARE_TYPEDEF_OPTION_PAGE(SomeClass) \
191 class QT_UTILITIES_EXPORT SomeClass : public ::QtUtilities::OptionPage { \
193 ~SomeClass() override; \
194 bool apply() override; \
195 void reset() override; \
202#define BEGIN_DECLARE_TYPEDEF_UI_FILE_BASED_OPTION_PAGE(SomeClass) \
206 using SomeClass##Base = ::QtUtilities::UiFileBasedOptionPage<Ui::SomeClass>;
213#define BEGIN_DECLARE_UI_FILE_BASED_OPTION_PAGE_CUSTOM_CTOR(SomeClass) \
214 BEGIN_DECLARE_TYPEDEF_UI_FILE_BASED_OPTION_PAGE(SomeClass) \
215 class QT_UTILITIES_EXPORT SomeClass : public ::QtUtilities::UiFileBasedOptionPage<Ui::SomeClass> { \
217 ~SomeClass() override; \
218 bool apply() override; \
219 void reset() override; \
228#define BEGIN_DECLARE_UI_FILE_BASED_OPTION_PAGE(SomeClass) \
229 BEGIN_DECLARE_UI_FILE_BASED_OPTION_PAGE_CUSTOM_CTOR(SomeClass) \
231 explicit SomeClass(QWidget *parentWidget = nullptr); \
239#define END_DECLARE_OPTION_PAGE \
248#define INSTANTIATE_UI_FILE_BASED_OPTION_PAGE(SomeClass) \
249 namespace QtUtilities { \
250 template class UiFileBasedOptionPage<Ui::SomeClass>; \
259#define INSTANTIATE_UI_FILE_BASED_OPTION_PAGE_NS(SomeNamespace, SomeClass) \
260 namespace QtUtilities { \
261 template class UiFileBasedOptionPage<::SomeNamespace::Ui::SomeClass>; \
269#define DECLARE_EXTERN_UI_FILE_BASED_OPTION_PAGE(SomeClass) \
270 namespace QtUtilities { \
274 extern template class UiFileBasedOptionPage<Ui::SomeClass>; \
283#define DECLARE_EXTERN_UI_FILE_BASED_OPTION_PAGE_NS(SomeNamespace, SomeClass) \
284 namespace SomeNamespace { \
289 namespace QtUtilities { \
290 extern template class UiFileBasedOptionPage<::SomeNamespace::Ui::SomeClass>; \
298#define DECLARE_SETUP_WIDGETS \
300 QWidget *setupWidget() override; \
309#define DECLARE_UI_FILE_BASED_OPTION_PAGE(SomeClass) \
310 BEGIN_DECLARE_UI_FILE_BASED_OPTION_PAGE(SomeClass) \
311 END_DECLARE_OPTION_PAGE
318#define DECLARE_OPTION_PAGE(SomeClass) \
319 BEGIN_DECLARE_OPTION_PAGE(SomeClass) \
320 DECLARE_SETUP_WIDGETS \
321 END_DECLARE_OPTION_PAGE
328#define DECLARE_UI_FILE_BASED_OPTION_PAGE_CUSTOM_SETUP(SomeClass) \
329 BEGIN_DECLARE_UI_FILE_BASED_OPTION_PAGE(SomeClass) \
330 DECLARE_SETUP_WIDGETS \
331 END_DECLARE_OPTION_PAGE
OptionPageWidget(QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
The OptionPage class is the base class for SettingsDialog pages.
QWidget * parentWindow() const
Returns the parent window of the option page.
virtual bool apply()=0
Applies altered settings.
const QStringList & errors() const
Returns the errors which haven been occurred when applying the changes.
virtual void reset()=0
Discards altered settings and resets relevant widgets.
virtual QWidget * setupWidget()=0
Creates the widget for the page.
bool hasBeenShown() const
Returns an indication whether the option page has been shown yet.
The SettingsDialog class provides a framework for creating settings dialogs with different categories...
UiClass * ui()
Provides the derived class access to the UI class.
UiFileBasedOptionPage(QWidget *parentWindow=nullptr)
Constructs a new UI file based option page.
void reset() override=0
Discards altered settings and resets relevant widgets.
~UiFileBasedOptionPage() override
Destroys the option page.
QWidget * setupWidget() override
Inflates the widget for the option page using the UI class.
bool apply() override=0
Applies altered settings.
#define QT_UTILITIES_EXPORT
Marks the symbol to be exported by the qtutilities library.