omgui::EventLoop Class Reference

#include <omgui/eventloop.h>

List of all members.


Detailed Description

This class represents the event loop for the application. Its implementation is dependant on the system, but its purpose is to control the events system from one central location. This object allows you to start and stop the event loop, giving you fine control over how your application processes events from both the system and omgui's own event system if you need it.

Public Member Functions

 EventLoop ()
bool is_running () const
void run ()
void run_once ()
void run_until ()
void stop ()
 ~EventLoop ()

Private Attributes

std::auto_ptr
< omgui::api::EventLoop
m_impl

Constructor & Destructor Documentation

omgui::EventLoop::EventLoop (  ) 

omgui::EventLoop::~EventLoop (  ) 


Member Function Documentation

bool omgui::EventLoop::is_running (  )  const

Returns:
Whether or not the event loop is running.

void omgui::EventLoop::run (  ) 

Runs the event loop until it is stopped.

void omgui::EventLoop::run_once (  ) 

Runs a single iteration of the event loop and returns.

void omgui::EventLoop::run_until (  ) 

Runs the event loop until no events remain to be processed and then returns

void omgui::EventLoop::stop (  ) 

Stops the running loop.


Member Data Documentation


doxygen SourceForge.net Logo