om::gui::objects::Button::Delegate Class Reference

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

#include <omGUIButton.h>

Public Attributes
Function< void(Button &)>	select
	A function object that is called whenever an attached button is selected by the user. More...
Function< void(Button &)>	press
	A function object that is called whenever an attached button is pressed by the user. More...
Function< void(Button &)>	release
	A function object that is called whenever an attached button is released by the user. More...
UserData	data
	An object that stores an opaque pointer to delegate data. More...

Detailed Description

A class that contains function objects that recieve button events.

Any button-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 button 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<void ( Button& )> om::gui::objects::Button::Delegate::select

A function object that is called whenever an attached button is selected by the user.

This means that the user has put the button into its 'on' state.

Function<void ( Button& )> om::gui::objects::Button::Delegate::press

A function object that is called whenever an attached button is pressed by the user.

Function<void ( Button& )> om::gui::objects::Button::Delegate::release

A function object that is called whenever an attached button is released by the user.

UserData om::gui::objects::Button::Delegate::data

An object that stores an opaque pointer to delegate data.

---

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

• omGUIButton.h