omUIOptions Class Reference
[USER INTERFACE classes of the OpenMAIA Library]

#include <omUIOptions.h>

Inheritance diagram for omUIOptions:

Public Member Functions
	omUIOptions ()
virtual void	Init ()
bool	SetParameter (wxString, wxString)
wxString	GetParameter (wxString)
wxString	GenerateOptionsXMLString ()
Data Fields
int	screenWidth
	Current screen width in pixel.
int	screenHeight
	Current screen height in pixel.
wxString	keyboardName
	name of current keyboard
bool	scanReverseDirection
int	actionKey
int	leftKey
int	rightKey
int	upKey
int	downKey
bool	grabKeys
bool	actionOnPress
bool	soundEnabled
	flag (default: true)
bool	serialEnabled
wxString	serialPort
bool	joystickEnabled
bool	keyboardEnabled
bool	autoscan
bool	joystick
bool	direct
int	scanTime
int	scanLoopsNumber
bool	delayAfterClick
bool	delayAfterAction
bool	delayAfterEndBlock
int	scanResumeFrom
bool	exitBlockAfterClick

---

Detailed Description

This class contains all generic options in a maialike application. The class can be extended and a subclass can be used instead of it.

All generic objects in the api structure use this class to store options.

---

Constructor & Destructor Documentation

omUIOptions::omUIOptions (   )

---

Member Function Documentation

wxString omUIOptions::GenerateOptionsXMLString (   )

Generate a string containting an XML rapresantation of the options stored in the structure. Returns: The XML String Reimplemented from omOptions. Reimplemented in maiaOptions.

wxString omUIOptions::GetParameter (  wxString  name  )

Get value of a parameter specified by its name. Parameters: name  Name of the parameter. Returns: value of the parameter as wxString Reimplemented from omOptions.

void omUIOptions::Init (   )  [virtual]

Initialize the class. This function is called after that all objects are istantiated Reimplemented from omOptions.

bool omUIOptions::SetParameter (  wxString  name, wxString  value )

Set a parameter value. Parameters: name  Parameter Name value  Parameter value. Returns: true if this class has a parameter called 'name', false if not. Reimplemented from omOptions.

---

Field Documentation

int omUIOptions::actionKey

key code of the action key

bool omUIOptions::actionOnPress

true, the action is taken on button press false, the action is taken on button release

bool omUIOptions::autoscan

autoscan flag

bool omUIOptions::delayAfterAction

True if you want a little delay after a key is actioned this means that after you press the action key on a leaf you got a delay

bool omUIOptions::delayAfterClick

True if you want a little delay after the key is pressed

bool omUIOptions::delayAfterEndBlock

True if you want a time delay before exit from a scan block

bool omUIOptions::direct

direct pointing flag

int omUIOptions::downKey

direction key codes

bool omUIOptions::exitBlockAfterClick

True if you want to immediatly exit after user click the button

bool omUIOptions::grabKeys

true if command keys are grabbed and not repeated to the operating system

bool omUIOptions::joystick

joystick flag

bool omUIOptions::joystickEnabled

listen to game joystick check

bool omUIOptions::keyboardEnabled

listen to keyboard as action keys

wxString omUIOptions::keyboardName

name of current keyboard

int omUIOptions::leftKey

direction key codes

int omUIOptions::rightKey

direction key codes

int omUIOptions::scanLoopsNumber

number of scan loops before exit

int omUIOptions::scanResumeFrom

which node resume when go to up block? You can RESUMEFROMFIRST, RESUMEFROMTHIS, RESUMEFROMNEXT

bool omUIOptions::scanReverseDirection

Direction of scan: false - scan from left to right (default) true - scan from right to left

int omUIOptions::scanTime

Scan timing in milliseconds

int omUIOptions::screenHeight

Current screen height in pixel.

int omUIOptions::screenWidth

Current screen width in pixel.

bool omUIOptions::serialEnabled

listen to serial port flag

wxString omUIOptions::serialPort

serial port

bool omUIOptions::soundEnabled

flag (default: true)

int omUIOptions::upKey

direction key codes

---

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

• omUIOptions.h
• omUIOptions.cpp

 

Created with doxygen on: Tue Jun 8 13:59:50 2004 Copyright © by Luca Clivio