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

Public Member Functions
	Fieldmodulenotifier (cmzn_fieldmodulenotifier_id in_fieldmodulenotifier_id)

	Fieldmodulenotifier (const Fieldmodulenotifier &fieldmoduleNotifier)

Fieldmodulenotifier &	operator= (const Fieldmodulenotifier &fieldmoduleNotifier)

bool	isValid () const

cmzn_fieldmodulenotifier_id	getId () const

int	setCallback (Fieldmodulecallback &callback)

int	clearCallback ()

Protected Attributes
cmzn_fieldmodulenotifier_id	id

Detailed Description

Manages individual user notification of changes with a field module.

Member Function Documentation

int OpenCMISS::Zinc::Fieldmodulenotifier::clearCallback ( )

inline

Stop and clear field module callback. This will stop the callback and also remove the callback function from the fieldmodule notifier.

cmzn_fieldmodulenotifier_id OpenCMISS::Zinc::Fieldmodulenotifier::getId ( ) const

inline

Return the C handle of the Fieldmodulenotifier object.

Returns: C handle of Fieldmodulenotifier if this objects is valid, 0 otherwise.

bool OpenCMISS::Zinc::Fieldmodulenotifier::isValid ( ) const

inline

Check if this is a valid Fieldmodulenotifier object.

int OpenCMISS::Zinc::Fieldmodulenotifier::setCallback ( Fieldmodulecallback & callback )

inline

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

Parameters

callback	function to be called when event is triggered.
user_data_in	Void pointer to user object. User must ensure this object's lifetime exceeds the duration for which callbacks are active.

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