Main Page | Modules | Class Hierarchy | Data Structures | File List | Data Fields | Globals | Related Pages

openmaiaOptions Class Reference
[openmaia application objects]

#include <openmaiaOptions.h>

Inheritance diagram for openmaiaOptions:

omXMLParser omObject

Public Member Functions

 openmaiaOptions ()
wxString GenerateOptionsXMLString ()
wxString GenerateProfileOptionsXMLString ()
void AtStartDocument ()
void AtEndDocument ()
void AtStartTag (wxString, omXMLParameters)
void AtEndTag (wxString)
void LoadOptions (wxString)

Data Fields

wxArrayString agentsToStart
wxString selectedProfile
wxString lastSelectedProfile
bool autostartProfileFlag
wxString profileToAutostart
bool autoiconize
bool startServerFlag
bool connectToServerFlag
wxString serverToConnect
int portToConnect
wxString language

Detailed Description

This class is used by the openmaia application to handle options stored into its xML file. The class can be used to read and write the xml file.


Constructor & Destructor Documentation

openmaiaOptions::openmaiaOptions  ) 
 

The constructor initializes all the variables


Member Function Documentation

void openmaiaOptions::AtEndDocument  )  [virtual]
 

This method is called by the parser when an end of document is found. This is a virtual method and must be overridden to implement specific functions. This function is public because is called externally by the C functions of the parser. The user must not call this function by hand.

Reimplemented from omXMLParser.

void openmaiaOptions::AtEndTag wxString  n  )  [virtual]
 

This method is called by the parser when a tag close event is found. This is a virtual method and must be overridden to implement specific functions. This function is public because is called externally by the C functions of the parser. The user must not call this function by hand.

Parameters:
n name of the tag

Reimplemented from omXMLParser.

void openmaiaOptions::AtStartDocument  )  [virtual]
 

This method is called by the parser when a start of document is found. This is a virtual method and must be overridden to implement specific functions. The rootNode private variable must be initialized here. This function is public because is called externally by the C functions of the parser. The user must not call this function by hand.

Reimplemented from omXMLParser.

void openmaiaOptions::AtStartTag wxString  n,
omXMLParameters  p
[virtual]
 

This method is called by the parser when a tag open event is found. This is a virtual method and must be overridden to implement specific functions. This function is public because is called externally by the C functions of the parser. The user must not call this function by hand.

Parameters:
n name of the tag
p pars of the tag.

Reimplemented from omXMLParser.

wxString openmaiaOptions::GenerateOptionsXMLString  ) 
 

Generate a string containg a dump of the new XML configure file based on current value of options. This file store global options to be saved in DATA_PATH/openmaia/openmaia.conf

wxString openmaiaOptions::GenerateProfileOptionsXMLString  ) 
 

void openmaiaOptions::LoadOptions wxString   ) 
 


Field Documentation

wxArrayString openmaiaOptions::agentsToStart
 

bool openmaiaOptions::autoiconize
 

bool openmaiaOptions::autostartProfileFlag
 

bool openmaiaOptions::connectToServerFlag
 

wxString openmaiaOptions::language
 

wxString openmaiaOptions::lastSelectedProfile
 

int openmaiaOptions::portToConnect
 

wxString openmaiaOptions::profileToAutostart
 

wxString openmaiaOptions::selectedProfile
 

wxString openmaiaOptions::serverToConnect
 

bool openmaiaOptions::startServerFlag
 


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