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

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

#include <omGraphicsGUITagView.h>

Public Attributes

Function< Bool(TagView &, const UTF8String &tagText)> newTag
 A function object that is called whenever the user wants to add a new tag to the view. More...
 
Function< Bool(TagView &, Index tagIndex)> removeTag
 A function object that is called whenever the user wants to remove a tag from the view. More...
 
UserData data
 An object that stores an opaque pointer to delegate data. More...
 

Detailed Description

A class that contains function objects that recieve TagView events.

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

Member Data Documentation

Function<Bool ( TagView&, const UTF8String& tagText )> om::graphics::gui::objects::TagView::Delegate::newTag

A function object that is called whenever the user wants to add a new tag to the view.

The delegate returns whether or not to allow the tag. If not, the tag view will reject the proprosed tag.

Function<Bool ( TagView&, Index tagIndex )> om::graphics::gui::objects::TagView::Delegate::removeTag

A function object that is called whenever the user wants to remove a tag from the view.

The delegate returns whether or not to allow the tag removal. If not, the tag view is unchanged.

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

An object that stores an opaque pointer to delegate data.


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