om::graphics::gui::objects::TextField::Delegate Class Reference

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

#include <omGraphicsGUITextField.h>

Public Attributes
Function< Bool(TextField &)>	startEdit
	A function object that is called whenever the user starts to edit the text in a text field. More...
Function< void(TextField &)>	edit
	A function object that is called whenever the user changes the text in a text field. More...
Function< Bool(TextField &)>	endEdit
	A function object that is called whenever the user is finished editing the text in a text field. More...
Function< void(TextField &)>	abortEdit
	A function object that is called whenever the user is aborts 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.

Member Data Documentation

Function<Bool ( TextField& )> om::graphics::gui::objects::TextField::Delegate::startEdit

A function object that is called whenever the user starts to edit the text in a text field.

The delegate returns whether or not to allow editing. If not, the text field will refuse to be edited.

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

A function object that is called whenever the user changes the text in a 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<Bool ( TextField& )> om::graphics::gui::objects::TextField::Delegate::endEdit

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. The delegate returns whether or not to keep the edit. If not kept, the contents will revert to the state before edit.

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

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

This method will be called whenever the user presses the escape key or removes focus from an edit-safe text field, indicating that they do not want to edit the field.

UserData om::graphics::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:

• omGraphicsGUITextField.h