Clarisse 5.0 SP8 SDK  5.0.5.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | List of all members
OfAction Class Reference

Class defining an action that invokes a customizable callback when a specific event occurs (like a key event). More...

Inheritance diagram for OfAction:
CoreBaseObject CoreBaseType

Public Types

typedef int(* Callback )(const OfAction &action, OfObject &object, void *data)
 

Public Member Functions

 OfAction (const CoreString &name)
 
 OfAction (const OfAction &action)
 
const CoreStringget_name () const
 
const CoreStringget_ui_name () const
 
void set_ui_name (const CoreString &ui_name)
 
bool is_state () const
 
void set_state ()
 
void set_callback (Callback cb)
 
Callback get_callback () const
 
int call (OfObject &object, void *data)
 
virtual size_t get_memory_size () const override
 
- Public Member Functions inherited from CoreBaseObject
bool is_kindof (const CoreBaseObject &object) const
 
CoreString get_class_info_name () const
 
const unsigned long & get_class_info_id () const
 
virtual bool is_kindof (const CoreClassInfo &cinfo) const
 
virtual const CoreClassInfoget_class_info () const
 
template<class T >
T * cast ()
 
template<class T >
const T * cast () const
 
- Public Member Functions inherited from CoreBaseType
bool is_kindof (const CoreClassInfo &cinfo) const
 

Static Public Member Functions

static void make_callback_name (CoreString &name, OfAttr *attr, OfAction *action)
 
- Static Public Member Functions inherited from CoreBaseObject
static const CoreClassInfoclass_info ()
 
template<class T >
static T * cast (CoreBaseObject *object)
 
template<class T >
static const T * cast (const CoreBaseObject *object)
 
- Static Public Member Functions inherited from CoreBaseType
static const CoreClassInfoclass_info ()
 Get the type descriptor of this instance.
 

Detailed Description

Class defining an action that invokes a customizable callback when a specific event occurs (like a key event).

Member Typedef Documentation

typedef int(* OfAction::Callback)(const OfAction &action, OfObject &object, void *data)

Callback invoked when the OfAction is triggered.

Parameters
actionThe OfAction that was triggered.
objectThe OfObject that owns the OfAction.
dataOptional blind data for the callback.
Returns
1 on action success, 0 on error.