CFGWadseekerGeneral Class Reference
+ Inheritance diagram for CFGWadseekerGeneral:

Public Member Functions

 CFGWadseekerGeneral (QWidget *parent=nullptr)
 
QIcon icon () const override
 Reimplement this to return a displayable icon for the ConfigPage.
 
QString name () const override
 Reimplement this to return a list-displayable name for this ConfigPage.
 
QString title () const override
 Page title, by default returns the same string as name().
 
Validation validate () override
 Validate settings on this page.
 
- Public Member Functions inherited from ConfigPage
 ConfigPage (QWidget *parent=nullptr)
 
bool allowSave ()
 Does this page allow to save the new settings?
 
bool areSettingsAlreadyRead ()
 true if settings for this page have already been loaded at least once.
 
void read ()
 Read configuration from persistence to page contents.
 
void reject ()
 
bool save ()
 Save configuration from page contents to persistence.
 
void setAllowSave (bool b)
 Change whether settings on this page can be stored in persisting configuration.
 

Protected Member Functions

void fillTargetDirectoryComboBox ()
 
void readSettings () override
 Reimplement this to read settings from config into widgets.
 
void saveSettings () override
 Reimplement this to write settings to config from widgets.
 
void showEvent (QShowEvent *) override
 
- Protected Member Functions inherited from ConfigPage
void reject_default ()
 

Additional Inherited Members

- Public Types inherited from ConfigPage
enum  Validation { VALIDATION_OK, VALIDATION_ERROR }
 Result of validate() More...
 
- Signals inherited from ConfigPage
void appearanceChanged ()
 Emit to tell Doomseeker to redraw certain widgets.
 
void restartNeeded ()
 Emit to tell Doomseeker to ask the user for a restart.
 
void validationRequested ()
 Request that the page should be (re-)validated.
 

Detailed Description

Definition at line 30 of file cfgwadseekergeneral.h.

Member Function Documentation

QIcon CFGWadseekerGeneral::icon ( ) const
inlineoverridevirtual

Reimplement this to return a displayable icon for the ConfigPage.

If there is no QIcon associated with this page just return a QIcon object with argument-less constructor.

Implements ConfigPage.

Definition at line 38 of file cfgwadseekergeneral.h.

QString CFGWadseekerGeneral::name ( ) const
inlineoverridevirtual

Reimplement this to return a list-displayable name for this ConfigPage.

Implements ConfigPage.

Definition at line 42 of file cfgwadseekergeneral.h.

void CFGWadseekerGeneral::readSettings ( )
overrideprotectedvirtual

Reimplement this to read settings from config into widgets.

Implements ConfigPage.

Definition at line 103 of file cfgwadseekergeneral.cpp.

void CFGWadseekerGeneral::saveSettings ( )
overrideprotectedvirtual

Reimplement this to write settings to config from widgets.

Implements ConfigPage.

Definition at line 112 of file cfgwadseekergeneral.cpp.

QString CFGWadseekerGeneral::title ( ) const
inlineoverridevirtual

Page title, by default returns the same string as name().

Reimplemented from ConfigPage.

Definition at line 46 of file cfgwadseekergeneral.h.

ConfigPage::Validation CFGWadseekerGeneral::validate ( )
overridevirtual

Validate settings on this page.

If settings seem to be configured incorrectly (paths point to missing directories or files, data is missing, etc.), the page can decide to notify the user about a problem. Validation result determines how the problem notification will be displayed by Doomseeker in the configuration dialog box. Still, the page itself must also take care to precisely pinpoint the reason of the failure. When user navigates to the page, it must be immediately visible what caused the problem and why.

This is used purely for notification purposes. User should not be blocked from saving the configuration even if validation fails spectacularly.

This method can be called at any time by Doomseeker and must not block. It's expected that all checks will be light-weight.

A page can also decide to validate itself at any time. This is done by emitting the validationRequested() signal, upon which Doomseeker will call validate().

Returns
Return result of validation. Default implementation always returns VALIDATION_OK.

Reimplemented from ConfigPage.

Definition at line 125 of file cfgwadseekergeneral.cpp.


The documentation for this class was generated from the following files: