Classes

struct CreationSource
An optional property of the VObjectCreation()'s CreationContext telling why the object was created, meaning: which slot requested the creation of this object. More...
struct Progress
Helper class for following the progress of some slow activity. More...

Public Types

bool activate ()
Activate the current notifier object to receive notification callbacks.
virtual void attachPostfix (const RefPtr< VSlot > &DestSlot)
virtual bool attachPrefix (const RefPtr< VParameter > &ProvidedParam, const RefPtr< VSlot > &DestSlot)
The attach() function is called whenever a parameter is attached to the slot of an object.
virtual void changeParameter (const WeakPtr< VParameter > &ModifiedParam, const RefPtr< ValuePool > &Context, const WeakPtr< VValueBase > &NewValue, const string &member)
virtual void createVObject (const RefPtr< VObject > &vobj, const Intercube &CreationContext, const WeakPtr< VCreatorBase > &crec)
Virtual action of a notifyer object which is hereby informed about the new creation of an object.
virtual void deleteVObject (const string &name)
Virtual action of a notifier object which is hereby informed about the deletion of an object.
virtual bool progress (progress_id_t Pid, const string &name, int CurrentValue, int MaxValue)
Implement display of some progress.
virtual void status (const string &name)
VActionNotifier ()
Constructs a notify callback object.
virtual void warn (const string &name)
~VActionNotifier ()
Destructor.

static void AttachParameterPostfix (const RefPtr< VSlot > &DestSlot)
static bool AttachParameterPrefix (const RefPtr< VParameter > &ProvidedParam, const RefPtr< VSlot > &DestSlot)
Announce the intended attachment the provided parameter to the given Slot.
static void ChangeParameter (const WeakPtr< VParameter > &ModifiedParam, const RefPtr< ValuePool > &Context, const WeakPtr< VValueBase > &NewValue, const string &member)
static progress_id_t getNewProgressID ()
Get new progress identifier.
static bool ProgressInfo (progress_id_t Pid, const string &name, int CurrentValue, int MaxValue)
Display some progress.
static bool ProgressInfo (progress_id_t Pid, const string &name)
static void StatusInfo (const string &name)
static void VObjectCreation (const RefPtr< VObject > &vobj, const Intercube &CreationContext, const WeakPtr< VCreatorBase > &crec=NullPtr())
When a new VObject is created, call all of the registered Notifier objects.
static void VObjectCreation (const RefPtr< VObject > &vobj, const WeakPtr< VCreatorBase > &crec=NullPtr())
static void VObjectDeletion (const string &name)
Global call to inform that an object has been deleted.
static void Warning (const string &name)

Notifier object for actions.

Certain actions in VISH may be recorded through instances of VActionNotifier's. Events in VISH are broadcasted to all such instances.

Wizt::VActionNotifier::VActionNotifier ( )

Constructs a notify callback object.

It will not receive notification callbacks until the activate() function is called.

bool Wizt::VActionNotifier::activate ( )

Activate the current notifier object to receive notification callbacks.

Note:: This function must be called only after a strong reference pointer has been established to hold this object alive.

bool Wizt::VActionNotifier::attachPrefix	(	const RefPtr< VParameter > &	ProvidedParam,
		const RefPtr< VSlot > &	DestSlot
	)		`[virtual]`

The attach() function is called whenever a parameter is attached to the slot of an object.

It is called just before this attachment takes place.

Parameters:

DestSlot	The slot within object VObjDst whose parameter will be modified.
ProvidedParam	The parameter that will replace the one in the slot

void Wizt::VActionNotifier::createVObject	(	const RefPtr< VObject > &	vobj,
		const Intercube &	CreationContext,
		const WeakPtr< VCreatorBase > &	crec
	)		`[virtual]`

Virtual action of a notifyer object which is hereby informed about the new creation of an object.

Parameters:

CreationContext	Some context information specific to this creation. It may hold arbitrary Interfaces.
crec	The Creator object. It may be Null if the VObject was created by other means.

bool Wizt::VActionNotifier::ProgressInfo	(	progress_id_t	Pid,
		const string &	name,
		int	CurrentValue,
		int	MaxValue
	)		`[static]`

Display some progress.

Parameters:

Pid	A unique ID per progress.
name	Some informative text to be displayed with this progress.
CurrentValue	Current value, if it's same as MaxValue then this progress is finished.
MaxValue	Maximal value.

void Wizt::VActionNotifier::VObjectCreation	(	const RefPtr< VObject > &	vobj,
		const Intercube &	CreationContext,
		const WeakPtr< VCreatorBase > &	crec = `NullPtr()`
	)		`[static]`

When a new VObject is created, call all of the registered Notifier objects.

Parameters:

CreationContext	Some context information specific to this creation.
crec	The Creator object. It may be Null if the VObject was created by other means.

void Wizt::VActionNotifier::VObjectDeletion ( const string & name ) [static]

Global call to inform that an object has been deleted.

This call is automatically issued by the VObject::remove() call.

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