Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members | Related Pages

prefspage Class Reference

A notebook page for a preferences sub-group. More...

#include <prefsdlg.h>

List of all members.

Public Member Functions

 prefspage (wxWindow *parent, config *cfg, int cols=2)
 Create a new prefs page in the dialog and add to the notebook.
void addBoolean (wxString prompt, wxString prefsPath)
 Add a boolean option to the grid.
void addInteger (wxString prompt, wxString prefsPath, int min=0, int max=100)
 Add an integer rags selection option to the grid.
void addText (wxString prompt, wxString prefsPath)
 Add a text input to the grid.
void addChoice (wxString prompt, wxString prefsPath, wxArrayString choices)
 Add a choice selector drop down option to the grid.
void addColour (wxString prompt, wxString prefsPath)
 Add a colour select option to the grid.
bool saveSettings ()
 Writes the settings in the controls to the config object.

Protected Member Functions

wxGBPosition nextPos ()
 Helper func to track the next grid position.

Protected Attributes

int ncols
int row
int col
int border
wxGridBagSizer * sizer
ctrlHash controls
configconf


Detailed Description

A notebook page for a preferences sub-group.


Constructor & Destructor Documentation

prefspage::prefspage wxWindow *  parent,
config cfg,
int  cols = 2
 

Create a new prefs page in the dialog and add to the notebook.

Parameters:
parent the parent id
cfg the config object
cols the number of columns in the grid


Member Function Documentation

void prefspage::addBoolean wxString  prompt,
wxString  prefsPath
 

Add a boolean option to the grid.

Parameters:
prompt the prompt string
prefsPath the path to the config item

void prefspage::addChoice wxString  prompt,
wxString  prefsPath,
wxArrayString  choices
 

Add a choice selector drop down option to the grid.

Parameters:
prompt the prompt string
prefsPath the path to the config item
choices the available choices

void prefspage::addColour wxString  prompt,
wxString  prefsPath
 

Add a colour select option to the grid.

Parameters:
prompt the prompt string
prefsPath the path to the config item

void prefspage::addInteger wxString  prompt,
wxString  prefsPath,
int  min = 0,
int  max = 100
 

Add an integer rags selection option to the grid.

Parameters:
prompt the prompt string
prefsPath the path to the config item
min the minimum acceptable value
max the maximum acceptable value

void prefspage::addText wxString  prompt,
wxString  prefsPath
 

Add a text input to the grid.

Parameters:
prompt the prompt string
prefsPath the path to the config item

wxGBPosition prefspage::nextPos  )  [protected]
 

Helper func to track the next grid position.

bool prefspage::saveSettings  ) 
 

Writes the settings in the controls to the config object.


Member Data Documentation

int prefspage::border [protected]
 

int prefspage::col [protected]
 

config* prefspage::conf [protected]
 

ctrlHash prefspage::controls [protected]
 

int prefspage::ncols [protected]
 

int prefspage::row [protected]
 

wxGridBagSizer* prefspage::sizer [protected]
 


The documentation for this class was generated from the following files:
Generated on Fri Mar 10 12:32:03 2006 for MonkeyFish by  doxygen 1.4.4