nullOption Class Reference

Implements an option that just displays a message. More...

#include <wxOptions.h>

Inheritance diagram for nullOption:

Inheritance graph
[legend]
Collaboration diagram for nullOption:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 nullOption (const wxString &description)
void DoDisplay (wxOptionSizer *sizer, wxWindow *parent)
 you should override the following functions:
void OnWindowDestroy ()
 When this is called, then you should save out any values stored in controls, as they will be destroyed soon.
bool DoSave ()
 Save any values to the config that needs to be saved.
bool Enable (bool enable)
 Enable/disable any controls that need to be enabled/disabled.


Detailed Description

Implements an option that just displays a message.

TODO: Somehow span both columns...

Definition at line 216 of file wxOptions.h.


Constructor & Destructor Documentation

nullOption::nullOption ( const wxString &  description  )  [inline]

Definition at line 218 of file wxOptions.h.


Member Function Documentation

void nullOption::DoDisplay ( wxOptionSizer sizer,
wxWindow *  parent 
) [inline, virtual]

you should override the following functions:

This is called when the option is going to be displayed. You should add your controls to a sizer, and then wait for OnWindowDestroy() to be called. If you need to get the value of a control (ie, a textbox), then you should keep pointers to them around. However, do not delete the controls, since they are owned by the parent dialog and will be automatically deleted.

Parameters:
sizer is a wxOptionSizer that has two columns that your controls should be added to
parent is a reference to the parent window that you should pass to your child controls.

Implements wxOption.

Definition at line 220 of file wxOptions.h.

void nullOption::OnWindowDestroy (  )  [inline, virtual]

When this is called, then you should save out any values stored in controls, as they will be destroyed soon.

Implements wxOption.

Definition at line 229 of file wxOptions.h.

bool nullOption::DoSave (  )  [inline, virtual]

Save any values to the config that needs to be saved.

Please note that this will _not_ always be called. It is only called if DoDisplay() was called for your option

Implements wxOption.

Definition at line 230 of file wxOptions.h.

bool nullOption::Enable ( bool  enable  )  [inline, virtual]

Enable/disable any controls that need to be enabled/disabled.

Don't bother doing this with static labels, that just seems like it would be annoying and useless.

Implements wxOption.

Definition at line 231 of file wxOptions.h.


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

Generated on Sun Jul 27 17:26:15 2008 for Roadnav by  doxygen 1.5.5