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

A class that contains function objects that recieve text field events. More...

#include <omGUITextField.h>

Public Attributes

Function< void(TextField &)> edit
 A function object that is called whenever the user changes the text in the text field. More...
 
Function< void(TextField &)> finishEdit
 A function object that is called whenever the user is finished editing the text in a text field. More...
 
UserData data
 An object that stores an opaque pointer to delegate data. More...
 

Detailed Description

A class that contains function objects that recieve text field events.

Any text field-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 text field 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 ( TextField& )> om::gui::objects::TextField::Delegate::edit

A function object that is called whenever the user changes the text in the text field.

Every time that the user presses a key or does anything to change the contents of the text field, this method is called.

Function<void ( TextField& )> om::gui::objects::TextField::Delegate::finishEdit

A function object that is called whenever the user is finished editing the text in a text field.

This method will be called whenever the user presses the return key or removes focus from the text field, indicating that they are finished editing the field

UserData om::gui::objects::TextField::Delegate::data

An object that stores an opaque pointer to delegate data.


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