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

#include <omUICommandParser.h>

Inheritance diagram for omUICommandParser:

Public Member Functions
	omUICommandParser ()
void	Init ()
virtual bool	ParseAction (omCommand)
virtual void	EndParsing ()
	to implement
virtual void	StartExecutor ()
virtual void	StopExecutor ()
Protected Attributes
omExecutor *	executor
	Pointer to the executor.
omUIKeyboard *	keyboard
	Pointer to the virtual keyboard object.

---

Detailed Description

User Interface Application Command Parser.

This class is a generic User Interface Application Command Parser. This class is used to handle events generated from the virtual keyboard, from the connector and eventually from the device drivers. This class parses some actions and contain an executor that make some device emulations if the application need to emulate functions. The emulator may be disabled if the application is only a user interface and doesn't make any emulation.
This class handles executor start and stop. These methods starts and stops internal executor but also uses the connector object of the UI application to send the start and stop message through the TCP connections. This is the list of command parsed by the class:

• EmulateString - string emulation
• EnterClick - Enter emulation
• CapsLockClick - Caps emulation
• BackSpaceClick - BS emulation
• EmulateSymbol - Symbol emulation
  • lt - < symbol
  • gt - > symbol
  • dq - " symbol
• MoveMouseLeft, MoveMouseRight, MoveMouseUp, MoveMouseDown - mouse movement emulations
• LeftClick, CentralClick, RightClick - mouse button click emulations
• LeftDragOrDrop, CentralDragOrDrop, RightDragOrDrop - mouse button push or pop emulations
  
  A class descendig from this class may reimplement ParseAction() method to parse specifi actions of the application and may call the parent method to parse generic actions. ParseAction return value true if the action is found and false if is not found.

Todo:

• Implement start and stop execution through the TCP connections.
• Implement the disable of the executor.

---

Constructor & Destructor Documentation

omUICommandParser::omUICommandParser (   )

Build the class. Instantiate the executor and initialize to null the pointer to the virtual keyboard.

---

Member Function Documentation

void omUICommandParser::EndParsing (   )  [virtual]

to implement

void omUICommandParser::Init (   )  [virtual]

Make post construction initialization. Initialize virtual keyboard pointer to application virtual keyboard. Reimplemented from omObject. Reimplemented in maiaCommandParser.

bool omUICommandParser::ParseAction (  omCommand  m  )  [virtual]

Parse a message coming from agent's event queue Parameters: m  message to parse Returns: true if message was parsed, false otherwhise Reimplemented in maiaCommandParser.

void omUICommandParser::StartExecutor (   )  [virtual]

Start the executor. Todo: implement TCP/IP message sending Reimplemented from omObject.

void omUICommandParser::StopExecutor (   )  [virtual]

Stop the executor. Todo: implement TCP/IP message sending Reimplemented from omObject.

---

Field Documentation

omExecutor* omUICommandParser::executor [protected]

Pointer to the executor.

omUIKeyboard* omUICommandParser::keyboard [protected]

Pointer to the virtual keyboard object. Reimplemented in maiaCommandParser.

---

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

• omUICommandParser.h
• omUICommandParser.cpp

 

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