Public Member Functions

bool activateNotification () const
Allow the owner of this InputBase to retrieve notification events when the value is changed.
void AddUndoAction (const RefPtr< VUndoAction > &what, int MaxActions=20)
const WeakPtr< VParameter > & getOwner () const
void notify (const ValueNotifierList *Source, const Wizt::ValuePoolPtr &) const
Emit a notification event to all ValueNotifiers listening on the certain variable.
void setOwner (const WeakPtr< VParameter > &Owner)
void touch (const RefPtr< ValuePool > &VP) const
VInputBase (const WeakPtr< VParameter > &owner)
Construct a new input base type.
~VInputBase ()
Destructor.

Protected Member Functions

virtual bool SyncFromContextValue (const RefPtr< ValuePool > &GhostValues, const string &member)=0
Set the local instance with a value from the global one.

Detailed Description

Base class for objects providing an input of any kind.

It extends the ValueNotifier class by a reference to a VParameter base class.

Note:: Call activateNotification() after construction.

Constructor & Destructor Documentation

Wizt::VInputBase::VInputBase ( const WeakPtr< VParameter > & owner )

Construct a new input base type.

The creation preferences of the owner might influence the properties of this input, for instance if the "local" property is found in the creation preferences of the owner, then a context-local variable is created.

Note:: Call activateNotification() after construction

Member Function Documentation

bool Wizt::VInputBase::activateNotification ( ) const

Allow the owner of this InputBase to retrieve notification events when the value is changed.

Note:: The function MUST NOT be called until this has been assigned to a strong reference pointer! In particular, it MUST NOT be called in the constructor!!

void Wizt::VInputBase::notify	(	const ValueNotifierList *	Source,
		const Wizt::ValuePoolPtr &	Ctx
	)		const

Emit a notification event to all ValueNotifiers listening on the certain variable.

Parameters:

Source The notification event is only broadcasted if the owner is not the source of the event.

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

ocean/plankton/VInput.hpp
ocean/plankton/VInput.cpp