OpenCMISS-Zinc C++ API Documentation
Public Member Functions | Protected Attributes | List of all members
OpenCMISS::Zinc::Glyphmodulenotifier Class Reference

Manages individual user notification of changes with a glyph module. More...

#include <glyph.hpp>

Public Member Functions

 Glyphmodulenotifier (cmzn_glyphmodulenotifier_id in_glyphmodulenotifier_id)
 
 Glyphmodulenotifier (const Glyphmodulenotifier &glyphmoduleNotifier)
 
Glyphmodulenotifieroperator= (const Glyphmodulenotifier &glyphmoduleNotifier)
 
bool isValid () const
 
cmzn_glyphmodulenotifier_id getId () const
 
int setCallback (Glyphmodulecallback &callback)
 
int clearCallback ()
 

Protected Attributes

cmzn_glyphmodulenotifier_id id
 

Detailed Description

Manages individual user notification of changes with a glyph module.

Manages individual user notification of changes with a glyph module.

Member Function Documentation

int OpenCMISS::Zinc::Glyphmodulenotifier::clearCallback ( )
inline

Stop and clear glyph module callback. This will stop the callback and also remove the callback function from the glyphmodule notifier.

Returns
Status OpenCMISS::Zinc::OK on success, any other value on failure.
cmzn_glyphmodulenotifier_id OpenCMISS::Zinc::Glyphmodulenotifier::getId ( ) const
inline

Return the C handle of the Glyphmodulenotifier object.

Returns
C handle of Glyphmodulenotifier if this objects is valid, 0 otherwise.
bool OpenCMISS::Zinc::Glyphmodulenotifier::isValid ( ) const
inline

Check if this is a valid Glyphmodulenotifier object.

Returns
Status True if object is valid, false otherwise.
int OpenCMISS::Zinc::Glyphmodulenotifier::setCallback ( Glyphmodulecallback callback)
inline

Assign the callback function and user data for the glyphmodule notifier. This function also starts the callback.

See also
cmzn_glyphmodulenotifier_callback_function
Parameters
callbackfunction to be called when event is triggered.
user_data_inVoid pointer to user object. User must ensure this object's lifetime exceeds the duration for which callbacks are active.
Returns
Status OpenCMISS::Zinc::OK on success, any other value on failure.

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