wxEventLoopBase

Methods

• Dispatch
  Dispatches the next event in the windowing system event queue.
• DispatchTimeout
  Dispatch an event but not wait longer than the specified timeout for it.
• Exit
  Exit from the loop with the given exit code.
• IsEventAllowedInsideYield
  Returns true if the given event category is allowed inside a YieldFor() call (i.e.
• IsMain
  Returns true if this is the main loop executed by wxApp::OnRun().
• IsOk
  Use this to check whether the event loop was successfully created before using it.
• IsRunning
  Return true if this event loop is currently running.
• IsYielding
  Returns true if called from inside Yield() or from inside YieldFor().
• OnExit
  This function is called before the event loop terminates, whether this happens normally (because of Exit() call) or abnormally (because of an exception thrown from inside the loop).
• Pending
  Return true if any events are available.
• ProcessIdle
  This virtual function is called when the application becomes idle and normally just sends wxIdleEvent to all interested parties.
• Run
  Start the event loop, return the exit code when it is finished.
• WakeUp
  Called by wxWidgets to wake up the event loop even if it is currently blocked inside Dispatch().
• WakeUpIdle
  Makes sure that idle events are sent again.
• Yield
  Yields control to pending messages in the windowing system.
• YieldFor
  Works like Yield() with onlyIfNeeded == true, except that it allows the caller to specify a mask of the wxEventCategory values which indicates which events should be processed and which should instead be "delayed" (i.e.

Static Methods

• GetActive
  Return the currently active (running) event loop.
• SetActive
  Set currently active (running) event loop.

Dispatch

bool Dispatch ( )

Dispatches the next event in the windowing system event queue.

DispatchTimeout

integer DispatchTimeout ( integer $timeout )

Dispatch an event but not wait longer than the specified timeout for it.

Exit

Exit ( integer $rc )

Exit from the loop with the given exit code.

GetActive

static wxEventLoopBase& GetActive ( )

Return the currently active (running) event loop.

IsEventAllowedInsideYield

bool IsEventAllowedInsideYield ( wxEventCategory $cat )

Returns true if the given event category is allowed inside a YieldFor() call (i.e.

IsMain

bool IsMain ( )

Returns true if this is the main loop executed by wxApp::OnRun().

IsOk

bool IsOk ( )

Use this to check whether the event loop was successfully created before using it.

IsRunning

bool IsRunning ( )

Return true if this event loop is currently running.

IsYielding

bool IsYielding ( )

Returns true if called from inside Yield() or from inside YieldFor().

OnExit

OnExit ( )

This function is called before the event loop terminates, whether this happens normally (because of Exit() call) or abnormally (because of an exception thrown from inside the loop).

Pending

bool Pending ( )

Return true if any events are available.

ProcessIdle

bool ProcessIdle ( )

This virtual function is called when the application becomes idle and normally just sends wxIdleEvent to all interested parties.

Run

integer Run ( )

Start the event loop, return the exit code when it is finished.

SetActive

static SetActive ( wxEventLoopBase &$loop )

Set currently active (running) event loop.

WakeUp

WakeUp ( )

Called by wxWidgets to wake up the event loop even if it is currently blocked inside Dispatch().

WakeUpIdle

WakeUpIdle ( )

Makes sure that idle events are sent again.

Yield

bool Yield ( bool $onlyIfNeeded=false )

Yields control to pending messages in the windowing system.

YieldFor

bool YieldFor ( integer $eventsToProcess )

Works like Yield() with onlyIfNeeded == true, except that it allows the caller to specify a mask of the wxEventCategory values which indicates which events should be processed and which should instead be "delayed" (i.e.