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

#include <omUIActionQueue.h>

Inheritance diagram for omUIActionQueue:

Public Member Functions
	omUIActionQueue (int)
void	Put (omCommand)
bool	Get (omCommand *)
void	Start ()
void	Stop ()
Private Member Functions
void	Notify ()
Private Attributes
std::list< omCommand > *	l
	Events list.
int	timeTick
	Timer period in milliseconds.

---

Detailed Description

This object is used to queue the events generated by the user. The events are usually generated by the virtual keyboard and put in the queue using Put() method. Events than can be extracted from the queue with Pop() method. The queue has a timer that can be used for event pooling. If you use the event pooling when events are found are passed to the application commandParser object.

---

Constructor & Destructor Documentation

omUIActionQueue::omUIActionQueue (  int  tick  )

The constructor. Create an empty list. ATTENTION!! appKeyboard field in inter variable must be initialized to the correct value to work properly Parameters: tick  timer interval for event check in milliseconds

---

Member Function Documentation

bool omUIActionQueue::Get (  omCommand *  rv  )

Get an element from the start of list. Parameters: rv  pointer the omMessage object that will store the result Returns: The first element of the queue.

void omUIActionQueue::Notify (   )  [private]

Override the norify method of the wxTimer superclass Check for event in the queue and execute them

void omUIActionQueue::Put (  omCommand  c  )

Put an element to the end of list. Parameters: c  Maia Command code to add to the back of the queue.

void omUIActionQueue::Start (   )  [virtual]

Start check events Reimplemented from omObject.

void omUIActionQueue::Stop (   )  [virtual]

Stop check events Reimplemented from omObject.

---

Field Documentation

std::list<omCommand >* omUIActionQueue::l [private]

Events list.

int omUIActionQueue::timeTick [private]

Timer period in milliseconds.

---

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

• omUIActionQueue.h
• omUIActionQueue.cpp

 

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