CreateServerDialogPage Class Referenceabstract

Base class to be used by plugins to define custom pages in Create Server dialog. More...

#include <createserverdialogpage.h>

+ Inheritance diagram for CreateServerDialogPage:

Public Member Functions

 CreateServerDialogPage (CreateServerDialog *pParentDialog, const QString &name)
 
virtual QStringList generateGameRunParameters ()=0
 Generates game run parameters basing on the page's contents. More...
 
virtual bool loadConfig (Ini &ini)=0
 Loads variables that are stored in the config into the GUI. More...
 
const QString & name () const
 
virtual bool saveConfig (Ini &ini)=0
 Saves variables defined by this page to a config. More...
 
virtual bool validate ()
 Validates contents of the page before the saveConfig(). More...
 

Protected Member Functions

QDialog * parentDialog ()
 

Detailed Description

Base class to be used by plugins to define custom pages in Create Server dialog.

Definition at line 38 of file createserverdialogpage.h.

Member Function Documentation

virtual QStringList CreateServerDialogPage::generateGameRunParameters ( )
pure virtual

Generates game run parameters basing on the page's contents.

These parameters are passed as arguments to the executable when the game process is started.

virtual bool CreateServerDialogPage::loadConfig ( Ini ini)
pure virtual

Loads variables that are stored in the config into the GUI.

This config is saved by Doomseeker when it calls saveConfig() method.

Returns
Return true on success.
virtual bool CreateServerDialogPage::saveConfig ( Ini ini)
pure virtual

Saves variables defined by this page to a config.

This config is loaded by Doomseeker when it calls loadConfig() method.

Returns
Return true on success.
bool CreateServerDialogPage::validate ( )
virtual

Validates contents of the page before the saveConfig().

Should return true on validation success or false otherwise. This may be used to modify the page contents, appearance or behavior. Validation is run before the game is run. No validation is performed before saveConfig() or after loadConfig().

Pages must take care of displaying their own error messages.

Default behavior assumes that no validation is needed and always returns true.

Returns
Return true on validation success or false on failure.

Definition at line 59 of file createserverdialogpage.cpp.


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