SkyGI::EventQueue Class Reference

Inheritance diagram for SkyGI::EventQueue:[legend]Collaboration diagram for SkyGI::EventQueue:[legend]List of all members.

Public Member Functions
	EventQueue ()
bool	AddIdleHandler (IdleHandler *pIdleHandler)
bool	RemoveIdleHandler (IdleHandler *pIdleHandler)
bool	AddSource (EventSource *pEventSource)
bool	RemoveSource (EventSource *pEventSource)
bool	Process (int iTimeOutInMsec=-1)
bool	Quit (int iReturnCode=-1)
bool	GetExitCode (int &iExitCode)
bool	Wait (int iTimeOutInMsec=-1)
int	Run ()
bool	Idle ()
bool	ProcessIdleHandlers ()

---

Detailed Description

EventQueue

Description:

And EventQueue waits for events on one or more EventSources. An EventSource can be a Message, a DesktopCommunicationMessage, a DataExchangePort, Files, etc... The Application and EventThread class create such an EventQueue implicity.
Note: This Class is used by the Application Class to wait for GUI events. Application::Run justs calls EventQueue::Run to wait for and process events.

---

Constructor & Destructor Documentation

EventQueue::EventQueue

(

)

---

Member Function Documentation

bool EventQueue::AddIdleHandler

(

IdleHandler *

pIdleHandler

)

Add an idle handler

Description:

Adds an IdleHandler derived object to this EventQueue. Whenever there are no events in this EventQueue the IdleHandler::OnIdle function gets called.
This IdleHandler can be used to perform idle work. The EventQueue will call OnIdle as long as there are no Events to process and as long as OnIdle returns true.

See also:

IdleHandler::OnIdle

bool EventQueue::RemoveIdleHandler

(

IdleHandler *

pIdleHandler

)

bool EventQueue::AddSource

(

EventSource *

pEventSource

)

bool EventQueue::RemoveSource

(

EventSource *

pEventSource

)

bool EventQueue::Process

(

int

iTimeOutInMsec = -1

)

bool EventQueue::Quit

(

int

iReturnCode = -1

)

bool EventQueue::GetExitCode

(

int &

iExitCode

)

bool EventQueue::Wait

(

int

iTimeOutInMsec = -1

)

int EventQueue::Run

(

)

bool EventQueue::Idle

(

)

bool EventQueue::ProcessIdleHandlers

(

)

---