CFGFilePaths Class Reference
+ Inheritance diagram for CFGFilePaths:

Public Member Functions

 CFGFilePaths (QWidget *parent=0)
 
void readSettings ()
 Reimplement this to read settings from config into widgets. More...
 
Validation validate ()
 Validate settings on this page. More...
 
- Public Member Functions inherited from ConfigPage
 ConfigPage (QWidget *parent=NULL)
 
bool allowSave ()
 Does this page allow to save the new settings? More...
 
bool areSettingsAlreadyRead ()
 true if settings for this page have already been loaded at least once. More...
 
void read ()
 Read configuration from persistence to page contents. More...
 
bool save ()
 Save configuration from page contents to persistence. More...
 
void setAllowSave (bool b)
 Change whether settings on this page can be stored in persisting configuration. More...
 
virtual QString title () const
 Page title, by default returns the same string as name(). More...
 

Protected Slots

void btnAddWadPath_Click ()
 
void btnRemoveWadPath_Click ()
 

Protected Member Functions

void addPath (const FileSearchPath &fileSearchPath)
 
QIcon icon () const
 Reimplement this to return a displayable icon for the ConfigPage. More...
 
bool isPathAlreadyDefined (const QString &path)
 
QString name () const
 Reimplement this to return a list-displayable name for this ConfigPage. More...
 
void saveSettings ()
 Reimplement this to write settings to config from widgets. More...
 

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. More...
 
void validationRequested ()
 Request that the page should be (re-)validated. More...
 

Detailed Description

Definition at line 33 of file cfgfilepaths.h.

Member Function Documentation

QIcon CFGFilePaths::icon ( ) const
protectedvirtual

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 124 of file cfgfilepaths.cpp.

QString CFGFilePaths::name ( ) const
inlineprotectedvirtual

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

Implements ConfigPage.

Definition at line 51 of file cfgfilepaths.h.

void CFGFilePaths::readSettings ( )
virtual

Reimplement this to read settings from config into widgets.

Implements ConfigPage.

Definition at line 155 of file cfgfilepaths.cpp.

void CFGFilePaths::saveSettings ( )
protectedvirtual

Reimplement this to write settings to config from widgets.

Implements ConfigPage.

Definition at line 166 of file cfgfilepaths.cpp.

ConfigPage::Validation CFGFilePaths::validate ( )
virtual

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 immediatelly 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 184 of file cfgfilepaths.cpp.


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