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

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

#include <omGUIMenu.h>

Public Attributes

Function< void(Menu &menu)> open
 A function object that is called whenever an attached menu is opened by the user. More...
 
Function< void(Menu &menu)> close
 A function object that is called whenever an attached menu is closed by the user. More...
 
Function< void(Menu &menu, Index itemIndex)> highlightItem
 A function object that is called whenever an item in a menu is highlighted. More...
 
Function< void(Menu &menu, Index itemIndex)> selectItem
 A function object that is called whenever an item in a menu is selected. More...
 
UserData data
 An object that stores an opaque pointer to delegate data. More...
 

Detailed Description

A class that contains function objects that recieve menu events.

Any menu-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 menu 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 ( Menu& menu )> om::gui::objects::Menu::Delegate::open

A function object that is called whenever an attached menu is opened by the user.

Function<void ( Menu& menu )> om::gui::objects::Menu::Delegate::close

A function object that is called whenever an attached menu is closed by the user.

Function<void ( Menu& menu, Index itemIndex )> om::gui::objects::Menu::Delegate::highlightItem

A function object that is called whenever an item in a menu is highlighted.

Function<void ( Menu& menu, Index itemIndex )> om::gui::objects::Menu::Delegate::selectItem

A function object that is called whenever an item in a menu is selected.

UserData om::gui::objects::Menu::Delegate::data

An object that stores an opaque pointer to delegate data.


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