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:

List of all members.

Public Member Functions
	IlvStIPropertyTreeAccessor (IlvStIPropertyAccessor *accessor=0, IlvStIAccessor::UpdateMode=IlvStIAccessor::Inherited, IlvStIAccessor::BuildMode=IlvStIAccessor::None, const char *name=0)
	Constructor.
Protected Member Functions
virtual void	addProperty (IlvStIProperty *prop, const IlvStIProperty *parent, IlUInt index)
	Called when a property is added.
virtual IlvStIProperty *	createProperty (const IlvStIProperty *parent, IlUInt childPosition, IlAny=0) const
	Called to create a new property.
virtual void	deleteChildrenProperty (IlvStIProperty *property, IlvStIProperty *parent)
	Called when a property is deleted.
virtual IlUInt	getChildPosition (const IlvStIProperty *prop, const IlvStIProperty *parent) const
	Returns the position of the child property.
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.
virtual void	replaceProperty (IlvStIProperty *origProperty, IlvStIProperty *newProperty, const IlvStIProperty *parent, IlUInt index)
	Called when a property is repalced by another.

---

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
	)			[protected, virtual]

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 [protected, virtual]

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
	)			[protected, virtual]

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 [protected, virtual]

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 [protected, virtual]

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
	)			[protected, virtual]

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.