maiaKeyboard Class Reference

#include <maiaKeyboard.h>

Inheritance diagram for maiaKeyboard:

Public Member Functions
	maiaKeyboard (wxWindow *, int)
void	Init ()
void	Reload ()
void	AtStartDocument ()
void	AtEndDocument ()
void	AtStartTag (wxString, omXMLParameters)
void	AtEndTag (wxString)
void	Start ()
void	Stop ()
void	SetCurrentButton (omObject *)
omObject *	GetCurrentButton ()
void	Action ()
void	GoDown ()
void	GoUp ()
void	GoLeft ()
void	GoRight ()
void	LoadKeyboard (wxString)
Private Member Functions
void	Notify ()
void	LinkConnectedButtons ()
Private Attributes
bool	lastAutoscan
bool	lastJoystick
	Last status of devices actiovation.
bool	autoscan
bool	joystick
	Current status of devices actiovation.
int	scanTick
	scan tick in milliseconds
bool	reachKey
	true if in reaching key data state
maiaButtonData *	currentKeyData
	used when fill the tree
wxWindow *	parentWindow
	parent window of all buttons
std::vector< omUIButton * >	buttons
	Contain list of buttons. Filled in AtEndTag().
omObject *	currentButton
	Pointer to current button selected by the cursor.
maiaOptions *	opts
	Application options.

---

Detailed Description

This class handles a maia keyboard with some MaiaButtons objects stored in a tree structure. The class is an implementation of MaiaGenericKeyboard class that is gives general methods and structures. Virtual methods of MaiaGenericKeyboard are implemented here.

---

Constructor & Destructor Documentation

maiaKeyboard::maiaKeyboard (  wxWindow *  p, int  tick )

Call the constructor of the parent class Parameters: p  Parent window of all the buttons (may be null) tick  Scan interval in milliseconds

---

Member Function Documentation

void maiaKeyboard::Action (   )  [virtual]

Process Action event. Reimplemented from omUIKeyboard.

void maiaKeyboard::AtEndDocument (   )  [virtual]

This method implement the vitual function of omUIKeyboard class. The method activate the keyboard to let possible to catch events and transmit them to the root Reimplemented from omXMLParser.

void maiaKeyboard::AtEndTag (  wxString  name  )  [virtual]

This method implement the vitual function of MaiaGenericKeyboard class. The method parse the tag and if necessary close open jobs (ex insert a button in the structure). Parameters: name  tag name Reimplemented from omXMLParser.

void maiaKeyboard::AtStartDocument (   )  [virtual]

This method implement the virtual function of MaiaGenericKeyboard class. The method creates the root node of the tree Reimplemented from omXMLParser.

void maiaKeyboard::AtStartTag (  wxString  name, omXMLParameters  p )  [virtual]

This method implement the vitual function of MaiaGenericKeyboard class. The method parse the tag name to fill correctly the tree. Parameters: name  tag name p  parameters of the tag Reimplemented from omXMLParser.

omObject * maiaKeyboard::GetCurrentButton (   )

Get the current button. Returns: pointer to current button or NULL

void maiaKeyboard::GoDown (   )  [virtual]

Process GoDown event. Reimplemented from omObject.

void maiaKeyboard::GoLeft (   )  [virtual]

Process GoLeft event. Reimplemented from omObject.

void maiaKeyboard::GoRight (   )  [virtual]

Process GoRight event. Reimplemented from omObject.

void maiaKeyboard::GoUp (   )  [virtual]

Process GoUp event. Reimplemented from omObject.

void maiaKeyboard::Init (   )  [virtual]

Do post constructor initialization Reimplemented from omUIKeyboard.

void maiaKeyboard::LinkConnectedButtons (   )  [private]

Link each button with closer upper,lower,left and right button

void maiaKeyboard::LoadKeyboard (  wxString  keyb  )  [virtual]

Load the keyboard using MaiaGenericKeyboard function Reimplemented from omUIKeyboard.

void maiaKeyboard::Notify (   )  [private]

Implement Notify method of the timer pass the tick signal to the root node.

void maiaKeyboard::Reload (   )  [virtual]

Reload options after parameters change Reimplemented from omUIKeyboard.

void maiaKeyboard::SetCurrentButton (  omObject *  current  )

Set the current button. Used in joystick mode navigation. Parameters: current  pointer to current button

void maiaKeyboard::Start (   )  [virtual]

Start automatic scan mode Reimplemented from omObject.

void maiaKeyboard::Stop (   )  [virtual]

Stop automatic scan mode Reimplemented from omObject.

---

Field Documentation

bool maiaKeyboard::autoscan [private]

std::vector<omUIButton *> maiaKeyboard::buttons [private]

Contain list of buttons. Filled in AtEndTag().

omObject* maiaKeyboard::currentButton [private]

Pointer to current button selected by the cursor.

maiaButtonData* maiaKeyboard::currentKeyData [private]

used when fill the tree

bool maiaKeyboard::joystick [private]

Current status of devices actiovation.

bool maiaKeyboard::lastAutoscan [private]

bool maiaKeyboard::lastJoystick [private]

Last status of devices actiovation.

maiaOptions* maiaKeyboard::opts [private]

Application options. Reimplemented from omUIKeyboard.

wxWindow* maiaKeyboard::parentWindow [private]

parent window of all buttons

bool maiaKeyboard::reachKey [private]

true if in reaching key data state

int maiaKeyboard::scanTick [private]

scan tick in milliseconds

---

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

• maiaKeyboard.h
• maiaKeyboard.cpp

 

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