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

#include <omUIKeyboard.h>

Inheritance diagram for omUIKeyboard:

Public Member Functions
	omUIKeyboard ()
virtual void	Init ()
virtual void	Reload ()
void	Show ()
bool	IsYourWindow (void *)
virtual void	LoadKeyboard (wxString)
virtual void	Action ()
virtual void	Tick ()
virtual void	RepaintKeyboard ()
Protected Attributes
omUITreeNode *	rootNode
omUITreeNode *	currentNode
omUIOptions *	opts
bool	active

---

Detailed Description

This class rapresent a generic Open Maia virtual keyboard structure with the XML parser using the gnome libxml2 library. There are some virtual functions called by the parser. These functions must be overridden to handle application specific keyboard. See MaiaKeyboard as an example.

---

Constructor & Destructor Documentation

omUIKeyboard::omUIKeyboard (   )

Construct the class by inizializating the XML parser. This class need gnome libxml2 library and headers.

---

Member Function Documentation

void omUIKeyboard::Action (   )  [virtual]

Pass the action signal to the tree structure Reimplemented from omObject. Reimplemented in maiaKeyboard.

void omUIKeyboard::Init (   )  [virtual]

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

bool omUIKeyboard::IsYourWindow (  void *  wh  )  [virtual]

Check if the passed window handler belong to the associated leaf or to any child leaf. The handler is a void * so this method is not system dependent. Parameters: wh  window handler to check Returns: true if wh is handler of leaf or any child leaf, false otehrwise Reimplemented from omObject.

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

Load keyboard from XML file using omXMLParser to parse it . This functions stops all timers associated with the omUIApplication, remember to restart the timers if needed. Parameters: keyb  name of XML file describing the keyboard Reimplemented in maiaKeyboard.

void omUIKeyboard::Reload (   )  [virtual]

Reload option values. Reimplemented from omObject. Reimplemented in maiaKeyboard.

void omUIKeyboard::RepaintKeyboard (   )  [virtual]

Repaint the keyboard

void omUIKeyboard::Show (   )

Show the keyboard on the screen

void omUIKeyboard::Tick (   )  [virtual]

Force the Tick() signal from outside the class Reimplemented from omObject.

---

Field Documentation

bool omUIKeyboard::active [protected]

omUITreeNode* omUIKeyboard::currentNode [protected]

omUIOptions* omUIKeyboard::opts [protected]

Reimplemented in maiaKeyboard.

omUITreeNode* omUIKeyboard::rootNode [protected]

---

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

• omUIKeyboard.h
• omUIKeyboard.cpp

 

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