Om  1.0.0
A universal framework for multimedia simulation
Public Attributes | List of all members
om::gui::objects::RenderView::Delegate Class Reference

A class that contains function objects that recieve RenderView events. More...

#include <omGUIRenderView.h>

Public Attributes

Function< void(RenderView &, const Size2D &)> resized
 A function object that is called whenever an attached RenderView is resized. More...
 
Function< void(RenderView &, const Vector2i &)> moved
 A function object that is called whenever an attached RenderView is moved. More...
 
Function< void(RenderView &, const input::TextEvent &)> textEvent
 A function object called whenever the user enters text in the render view (usually via keyboard). More...
 
Function< void(RenderView &, const input::KeyEvent &)> keyEvent
 A function object called whenever an attached render view receives a keyboard event. More...
 
Function< void(RenderView &, const input::MouseMotionEvent &)> mouseMotionEvent
 A function object called whenever an attached render view receives a mouse-motion event. More...
 
Function< void(RenderView &, const input::MouseButtonEvent &)> mouseButtonEvent
 A function object called whenever an attached render view receives a mouse-button event. More...
 
Function< void(RenderView &, const input::MouseWheelEvent &)> mouseWheelEvent
 A function object called whenever an attached render view receives a mouse-wheel event. More...
 
UserData data
 An object that stores an opaque pointer to delegate data. More...
 

Detailed Description

A class that contains function objects that recieve RenderView events.

Any RenderView-related event that might be processed has an appropriate callback function object. Each callback function is called by the GUI event thread whenever such an event is received. If a callback function in the delegate is not initialized, the RenderView simply ignores it and doesn't call the function.

It must be noted that the callback functions are asynchronous and not thread-safe. Thus, it is necessary to perform any additional synchronization externally.

Member Data Documentation

Function<void ( RenderView&, const Size2D& )> om::gui::objects::RenderView::Delegate::resized

A function object that is called whenever an attached RenderView is resized.

The RenderView provides the desired new size of the view as a (width, height) pair.

Function<void ( RenderView&, const Vector2i& )> om::gui::objects::RenderView::Delegate::moved

A function object that is called whenever an attached RenderView is moved.

The RenderView provides the desired new position of the view as a 2D vector.

Function<void ( RenderView&, const input::TextEvent& )> om::gui::objects::RenderView::Delegate::textEvent

A function object called whenever the user enters text in the render view (usually via keyboard).

Function<void ( RenderView&, const input::KeyEvent& )> om::gui::objects::RenderView::Delegate::keyEvent

A function object called whenever an attached render view receives a keyboard event.

Function<void ( RenderView&, const input::MouseMotionEvent& )> om::gui::objects::RenderView::Delegate::mouseMotionEvent

A function object called whenever an attached render view receives a mouse-motion event.

Function<void ( RenderView&, const input::MouseButtonEvent& )> om::gui::objects::RenderView::Delegate::mouseButtonEvent

A function object called whenever an attached render view receives a mouse-button event.

Function<void ( RenderView&, const input::MouseWheelEvent& )> om::gui::objects::RenderView::Delegate::mouseWheelEvent

A function object called whenever an attached render view receives a mouse-wheel event.

UserData om::gui::objects::RenderView::Delegate::data

An object that stores an opaque pointer to delegate data.


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