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

#include <omUIApplication.h>

Public Member Functions
virtual bool	OnInit ()
	This is the main of the user interface application.
Data Fields
omUIObjects	objects
	maia application objects pointers
Private Member Functions
void	SetPath (wxString)
void	SetErrorHandlers ()
void	SDSetErrorHandlers ()
	System dependent SetErrorHandlers.

---

Detailed Description

This class specify a generic OpenMAIA User Interface Application.

This class is used as a main class for an OpenMAIA User Interface Application. A user interface is used by the disabled user to intercat with the OpenMAIA System.
Generally a user interfac application is composed by some objects (see picture). This class contains the pointers to the super objects used in the user interface application.

• The omUIKeyboard object is used to store keyboard data structure.
  The keyboard is rapresented by a collection of buttons stored in a tree data structure. Every Node of the tree is a omUITreeNode object and every leaf is a omUIButton object.
• omUIGrantFocus2User object is used to grant that the OpenMAIA buttons don't steal the focus to the user.
• omUIActionQueue is used as an event queue. The keyboard generates events and pass them to the queue. The queue pass the events with FIFO method to the omUICommandParser object
• omUICommandParser is the object that analizes events coming from the queue, from the devices eventually handled and from the connector.
• omConnector is used to receive and send message to the agency via TCP/IP connection. When messages are received they are parsed and passed to the omUICommandParser object. Other objects can send messages to the agency using SendMessage method of the instantied omConnector object.
• omUIOptions store all user interface application options.

All objects are instantiated in the omUIApplication::OnInit method. omUIApplication::objects attribute is used to store the pointers to the instantiated objects.

Every Class that include <libopenmaiaui.h> header can obtain the pointer to an object used in the user interface application with a command like the following one:

omConnector *connector = (omConnector) wxGetApp().objects.connector;

NOTE!! To link the correct wxApp pointer you need to implement the application using omUIApplication object.

---

Member Function Documentation

bool omUIApplication::OnInit (   )  [virtual]

This is the main of the user interface application.

void omUIApplication::SDSetErrorHandlers (   )  [private]

System dependent SetErrorHandlers.

void omUIApplication::SetErrorHandlers (   )  [private]

This funcions catch wiindow error handlers like set focus error and show error

void omUIApplication::SetPath (  wxString  profile  )  [private]

Sets the path of the application moving to the top of the installation dir Parameters: profile  profile path

---

Field Documentation

omUIObjects omUIApplication::objects

maia application objects pointers Objects container. Used to store pointers to objects used in the application

---

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

• omUIApplication.h
• omUIApplication.cpp
• maia.cpp

 

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