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

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

#include <omGUIWindow.h>

Public Attributes

Function< Bool(Window &)> open
 A function object that is called whenever an attached window is made visible programmatically. More...
 
Function< Bool(Window &)> close
 A function object that is called whenever an attached window attempts to be closed. More...
 
Function< void(Window &, Bool)> setFocus
 A function object that is called whenever an attached window gains or loses focus. More...
 
Function< Bool(Window &, const Size2D &)> resize
 A function object that is called whenever an attached window's content area is about to be resized. More...
 
Function< void(Window &, const Size2D &)> resized
 A function object that is called whenever an attached window's content area has been resized. More...
 
Function< Bool(Window &, const Vector2i &)> move
 A function object that is called whenever an attached window is about to be moved. More...
 
Function< void(Window &, const Vector2i &)> moved
 A function object that is called whenever an attached window has been moved. More...
 
Function< void(Window &, const input::TextEvent &)> textEvent
 A function object called whenever the user enters text in the window (usually via keyboard). More...
 
Function< void(Window &, const input::KeyEvent &)> keyEvent
 A function object called whenever an attached window receives a keyboard event. More...
 
Function< void(Window &, const input::MouseMotionEvent &)> mouseMotionEvent
 A function object called whenever an attached window receives a mouse-motion event. More...
 
Function< void(Window &, const input::MouseButtonEvent &)> mouseButtonEvent
 A function object called whenever an attached window receives a mouse-button event. More...
 
Function< void(Window &, const input::MouseWheelEvent &)> mouseWheelEvent
 A function object called whenever an attached window receives a mouse-wheel event. More...
 

Detailed Description

A class that contains function objects that recieve window events.

Any window-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, a window simply ignores it.

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<Bool ( Window& )> om::gui::objects::Window::Delegate::open

A function object that is called whenever an attached window is made visible programmatically.

The delegate function may choose to return either a value of TRUE, indicating that the open operation is allowed, or a value of FALSE, indicating that the open operation should be ignored.

Function<Bool ( Window& )> om::gui::objects::Window::Delegate::close

A function object that is called whenever an attached window attempts to be closed.

The delegate function may choose to return either a value of TRUE, indicating that the close operation is allowed, or a value of FALSE, indicating that the close operation should be ignored.

Function<void ( Window&, Bool )> om::gui::objects::Window::Delegate::setFocus

A function object that is called whenever an attached window gains or loses focus.

The boolean parameter indicates whether or not the window now has focus. A value of TRUE indicates that the window just gained focus. A value of FALSE indicates that the window just lost focus.

Function<Bool ( Window&, const Size2D& )> om::gui::objects::Window::Delegate::resize

A function object that is called whenever an attached window's content area is about to be resized.

The delegate function may choose to return either a value of TRUE, indicating that the change in size is allowed, or a value of FALSE, indicating that the change in size should be ignored.

The window provides the desired new size of the window's content area.

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

A function object that is called whenever an attached window's content area has been resized.

The window provides the desired new size of the window's content area.

Function<Bool ( Window&, const Vector2i& )> om::gui::objects::Window::Delegate::move

A function object that is called whenever an attached window is about to be moved.

The delegate function may choose to return either a value of TRUE, indicating that the change in position is allowed, or a value of FALSE, indicating that the change in position should be ignored.

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

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

A function object that is called whenever an attached window has been moved.

The window provides the new position of the window as a 2D vector.

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

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

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

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

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

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

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

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

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

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


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