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

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

#include <omGraphicsGUINumberField.h>

Public Attributes

Function< void(NumberField &knob)> startEdit
 A function object that is called whenever an attached number field has started to be changed by the user. More...
 
Function< void(NumberField &knob)> endEdit
 A function object that is called whenever an attached number field has finished being changed by the user. More...
 
Function< Bool(NumberField &knob, Double newValue)> edit
 A function object that is called whenever an attached number field is changed 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 NumberField events.

Any number-field-related event that might be processed has an appropriate callback function object. Each callback function is called by the number field whenever such an event is received. If a callback function in the delegate is not initialized, a number field ignores it.

Member Data Documentation

Function<void ( NumberField& knob )> om::graphics::gui::objects::NumberField::Delegate::startEdit

A function object that is called whenever an attached number field has started to be changed by the user.

Function<void ( NumberField& knob )> om::graphics::gui::objects::NumberField::Delegate::endEdit

A function object that is called whenever an attached number field has finished being changed by the user.

Function<Bool ( NumberField& knob, Double newValue )> om::graphics::gui::objects::NumberField::Delegate::edit

A function object that is called whenever an attached number field is changed by the user.

The delegate function has the option to allow or disallow the change to the slider's value by returning TRUE to allow or FALSE to not allow the change.

UserData om::graphics::gui::objects::NumberField::Delegate::data

An object that stores an opaque pointer to delegate data.


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