IlvStIPropertyTreeAccessor Class Reference

Inspector class. This class defines an accessor to a tree-like structure of properties. It lets you add, remove, or modify a property in the tree. More...

#include <ivstudio/inspectors/insppnl.h>

Inheritance diagram for IlvStIPropertyTreeAccessor:

Public Member Functions
	IlvStIPropertyTreeAccessor (IlvStIPropertyAccessor *accessor=0, IlvStIAccessor::UpdateMode=IlvStIAccessor::Inherited, IlvStIAccessor::BuildMode=IlvStIAccessor::None, const char *name=0)
	Constructor. More...
Public Member Functions inherited from IlvStIPropertiesAccessor
	IlvStIPropertiesAccessor (IlvStIPropertyAccessor *accessor=0, IlvStIAccessor::UpdateMode updateMode=IlvStIAccessor::Inherited, IlvStIAccessor::BuildMode buildMode=IlvStIAccessor::None, const char *name=0)
	Initializes an instance of IlvStIPropertiesAccessor. More...
virtual IlvStIEditor *	findFirstEditor () const
	Returns the first editor owned by the accessor. More...
virtual IlvStIProperty *	get ()
	Returns the object's property. More...
virtual IlBoolean	initialize ()
	Called to initialize the accessor according to the inspected data. More...
virtual void	set (const IlvStIProperty *, IlvStIEditor *)
	Sets the current property to the property. More...
Public Member Functions inherited from IlvStICombinedAccessor
	IlvStICombinedAccessor (IlvStIPropertyAccessor *accessor=0, UpdateMode updateMode=NoUpdate, BuildMode buildMode=None, const char *name=0)
	Initializes a new instance of the class IlvStICombinedAccessor. More...
IlvStIPropertyAccessor *	getObjectAccessor () const
	Returns the accessor to the object to which this accessor applies. More...
virtual UpdateMode	getUpdateMode () const
	Returns the update mode for the accessor. More...
Public Member Functions inherited from IlvStIPropertyAccessor
virtual IlvStIError *	check () const
	Validates the accessor value. More...
virtual IlvStIError *	checkValue (const IlvStIProperty *prop) const
	Checks the value for a property. More...
IlvStIPrecondition *	getPrecondition () const
	Returns the precondition. More...
IlvStIPropertyAccessor *	getPreviewAccessor () const
	Returns the preview accessor. More...
PropertyStatus	getPropertyStatus () const
	Returns the status of the current stored property. More...
IlvStIValidator *	getValidator () const
	Returns the validator used by the checkValue method. More...
virtual IlBoolean	isReadOnly () const
	Returns IlTrue if the current property is read-only. More...
virtual IlBoolean	isReadWrite () const
	Returns IlTrue if the current property has read and write access. More...
void	setPrecondition (IlvStIPrecondition *precond)
	Sets the precondition. More...
void	setPreviewAccessor (IlvStIPropertyAccessor *accessor)
	Sets the preview accessor. More...
void	setValidator (IlvStIValidator *validator)
	Sets the validator to the accessor. More...
Public Member Functions inherited from IlvStIAccessor
void	addDependentAccessor (IlvStIAccessor *acc, DependencyMode mode=Default)
	Adds a dependent accessor with the specified dependency mode. More...
void	addEditor (IlvStIEditor *edt)
	Adds the specified editor to the editors stored by the accessor. More...
virtual IlBoolean	apply ()
	Called to apply all the changes made to the accessor. More...
virtual IlvStIError *	checkAll (const IlvStIAccessor **accessor, IlBoolean modifiedOnly=IlTrue) const
	Checks the accessor and its hierarchical tree of dependencies. More...
IlvStIAccessor *	findDependentAccessor (const char *name) const
	Searches an dependent accessor. More...
IlvStIEditor *	findEditor (const char *name) const
	Searches the specified editor inside all dependent accessors. More...
BuildMode	getBuildMode () const
	Returns the building mode for the accessor. More...
IlvStIAccessor *	getDependentAccessor (const char *name) const
	Returns the dependent accessor whose name is specified. More...
IlvStIAccessor **	getDependentAccessors (IlUInt &count) const
	Returns all direct dependent accessors. More...
IlvStIEditor *	getEditor (IlUInt index) const
	Returns the editor stored at the wished position. More...
IlUInt	getNumberOfEditors () const
	Returns the number of editors stored by the accessor. More...
IlBoolean	isModified () const
	Returns IlTrue if the accessor has been modified. More...
void	lock ()
	Locks the accessor once. More...
IlBoolean	removeDependentAccessor (IlvStIAccessor *acc)
	Removes the specified dependent accessor. More...
IlBoolean	removeEditor (IlvStIEditor *edt)
	Removes the specified editor from the accessor. More...
void	setBuildMode (BuildMode mode)
	Sets the building mode for the accessor. More...
void	setUpdateMode (UpdateMode updateMode)
	Sets the update mode for the accessor. More...
void	unLock ()
	Unlocks the accessor once. More...
Public Member Functions inherited from IlvStNamedObject
const char *	getName () const
	Returns the name of the object. More...
virtual void	setName (const char *name)
	Sets the name of the object. More...

Protected Member Functions
virtual void	addProperty (IlvStIProperty *prop, const IlvStIProperty *parent, IlUInt index)
	Called when a property is added. More...
virtual IlvStIProperty *	createProperty (const IlvStIProperty *parent, IlUInt childPosition, IlAny=0) const
	Called to create a new property. More...
virtual void	deleteChildrenProperty (IlvStIProperty *property, IlvStIProperty *parent)
	Called when a property is deleted. More...
virtual IlUInt	getChildPosition (const IlvStIProperty *prop, const IlvStIProperty *parent) const
	Returns the position of the child property. More...
virtual IlvStIProperty **	getInitialChildrenProperties (IlUInt &count, const IlvStIProperty *prop=0) const
	Called when the accessor is initialized and returns an array containing the initial children of the property. More...
virtual void	replaceProperty (IlvStIProperty *origProperty, IlvStIProperty *newProperty, const IlvStIProperty *parent, IlUInt index)
	Called when a property is repalced by another. More...
Protected Member Functions inherited from IlvStIPropertiesAccessor
virtual IlvStIProperty *	createDefaultProperty () const
	Called to create a default property. More...
virtual void	deleteNewProperty (IlvStIProperty *property)
	Deletes the property. More...
virtual IlvStIProperty *	getOriginalValue ()
	Called to retrieve the property from the inspected object. More...

Additional Inherited Members
Public Types inherited from IlvStIPropertyAccessor
enum	PropertyStatus { Uninitialized, Inaccessible, ReadWrite, ReadOnly }
	This enumeration type defines the status of the property stored in the object. This status is set when the accessor is initialized via the get method. More...

Detailed Description

Inspector class. This class defines an accessor to a tree-like structure of properties. It lets you add, remove, or modify a property in the tree.

Library: ivstudio

See Also

IlvStICombinedAccessor, IlvStIPropertiesAccessor.

Constructor & Destructor Documentation

IlvStIPropertyTreeAccessor::IlvStIPropertyTreeAccessor	(	IlvStIPropertyAccessor *	accessor = 0,
		IlvStIAccessor::UpdateMode	= IlvStIAccessor::Inherited,
		IlvStIAccessor::BuildMode	= IlvStIAccessor::None,
		const char *	name = 0
	)

Constructor.

Parameters

accessor	The accessor to the object that contains the tree of properties.
updateMode	The update mode of the accessor.
buildMode	The update mode of the accessor.
name	The accessor name.

Member Function Documentation

virtual void IlvStIPropertyTreeAccessor::addProperty ( IlvStIProperty *  prop, const IlvStIProperty *  parent, IlUInt  index  )

protectedvirtual

Called when a property is added.

Is called when the apply method of the accessor is invoked to add the property to the parent at the indicated position.

Parameters

prop	The new property.
parent	The parent of the new property.
index	The insertion position of the new property.

virtual IlvStIProperty* IlvStIPropertyTreeAccessor::createProperty ( const IlvStIProperty *  parent, IlUInt  childPosition, IlAny  = 0  ) const

protectedvirtual

Called to create a new property.

Is called to create a new property that will be added to the list of the parent.

Parameters

parent	The parent of the new property.
index	The insertion position of the new property.
data	Comes from the tree editor, which requested that a new property be added to the tree. For information about tree editors, see IlvStIPropertyTreeEditor. This parameter allows you to create properties of various types. For example, in the pop-up menu inspector, you can add either a menu item or a separator to the inspected pop-up menu.

virtual void IlvStIPropertyTreeAccessor::deleteChildrenProperty ( IlvStIProperty *  property, IlvStIProperty *  parent  )

protectedvirtual

Called when a property is deleted.

Is called when the apply method of the accessor is invoked to delete the property, which was created by the getInitialChildrenProperties method. For example, to delete a tree gadget item, a tree gadget accessor calls the IlvTreeGadget::removeItem method from inside this method. The parameter passed to this method is the tree gadget item contained in the property parameter.

Parameters

property	The property.
parent	The parent of the property.

virtual IlUInt IlvStIPropertyTreeAccessor::getChildPosition ( const IlvStIProperty *  prop, const IlvStIProperty *  parent  ) const

protectedvirtual

Returns the position of the child property.

Returns the position of the child property, relative to its parent property.

Parameters

prop	The child property.
parent	The parent property.

Returns

The position of the child property.

virtual IlvStIProperty** IlvStIPropertyTreeAccessor::getInitialChildrenProperties ( IlUInt &  count, const IlvStIProperty *  prop = 0  ) const

protectedvirtual

Called when the accessor is initialized and returns an array containing the initial children of the property.

Once it has been used, the returned array is deleted.

Parameters

count	The property count.
prop	The property.

Returns

An array containing the initial children of the property.

virtual void IlvStIPropertyTreeAccessor::replaceProperty ( IlvStIProperty *  origProperty, IlvStIProperty *  newProperty, const IlvStIProperty *  parent, IlUInt  index  )

protectedvirtual

Called when a property is repalced by another.

Is called when the apply method of the accessor is invoked to replace the initial property, located at the items list of the parent, with another property. By default, this method destroys the initial property and adds the new property.

Parameters

origProperty	The initial property.
newProperty	The new property.
parent	The parent of the initial property.
index	The position of the initial property.