IlvStIPropertyListAccessor Class Reference

Inspector class. This class defines an accessor to a list of properties. It lets you add, remove, or modify a property in a list. More...

#include <ivstudio/inspectors/insppnl.h>

Inheritance diagram for IlvStIPropertyListAccessor:

List of all members.

Public Member Functions
	IlvStIPropertyListAccessor (IlvStIPropertyAccessor *accessor=0, IlvStIAccessor::UpdateMode updateMode=IlvStIAccessor::Inherited, IlvStIAccessor::BuildMode buildMode=IlvStIAccessor::None, const char *name=0)
	Initializes an instance of IlvStIPropertiesListAccessor.
Protected Member Functions
virtual void	addProperty (IlvStIProperty *prop, IlUInt index)
	Adds the property to the list.
virtual IlvStIProperty *	createProperty (IlUInt index, IlAny data=0) const
	Called to create a new property that will be added to the list.
virtual void	deleteProperty (IlvStIProperty *prop, IlUInt index)
	Called when a property is deleted.
virtual IlvStIProperty **	getInitialProperties (IlUInt &)
	Called when the accessor is initialized and returns an array containing the initial list of properties.
virtual void	moveProperty (IlvStIProperty *prop, IlUInt previousIndex, IlUInt newIndex)
	Called when a property changes of position.
virtual void	replaceProperty (IlvStIProperty *origProperty, IlvStIProperty *newProperty, IlUInt index)
	Replaces a property by another property.

---

Detailed Description

Inspector class. This class defines an accessor to a list of properties. It lets you add, remove, or modify a property in a list.

Library: ivstudio

See also:

IlvStICombinedAccessor, IlvStIPropertiesAccessor.

---

Constructor & Destructor Documentation

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

Initializes an instance of IlvStIPropertiesListAccessor.

Parameters:

	accessor	The accessor to the object that contains the list 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 IlvStIPropertyListAccessor::addProperty	(	IlvStIProperty *	prop,
		IlUInt	index
	)			[protected, virtual]

Adds the property to the list.

Called when the apply method of the accessor is invoked.

Parameters:

	prop	The property.
	index	The insertion position.

virtual IlvStIProperty* IlvStIPropertyListAccessor::createProperty	(	IlUInt	index,
		IlAny	data = 0
	)			const [protected, virtual]

Called to create a new property that will be added to the list.

Parameters:

	index	The insertion position of the property in the list.
	data	Comes from the list editor which requested that a new property be added to the list. For information about list editors, see IlvStIPropertyListEditor. This parameter allows you to create properties of various types. For example, in a gadget item list inspector, you could add either a gadget item representing a string or a bitmap.

Returns:

The created property.

virtual void IlvStIPropertyListAccessor::deleteProperty	(	IlvStIProperty *	prop,
		IlUInt	index
	)			[protected, virtual]

Called when a property is deleted.

Is called when the apply method of the accessor is invoked to delete the item stored in the property from the list. The item to be deleted is the one located at the indicated position. For example, to delete a list item, a string list accessor calls the IlvStringList::removeItem method from inside this method. The parameter passed to this method is the gadget item contained in the property parameter.

Parameters:

	prop	The property which contains the item.
	index	The item position.

virtual IlvStIProperty** IlvStIPropertyListAccessor::getInitialProperties

(

IlUInt &

)

[protected, virtual]

Called when the accessor is initialized and returns an array containing the initial list of properties.

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

Parameters:

count

The property count.

Returns:

An array containing the initial list of properties.

virtual void IlvStIPropertyListAccessor::moveProperty	(	IlvStIProperty *	prop,
		IlUInt	previousIndex,
		IlUInt	newIndex
	)			[protected, virtual]

Called when a property changes of position.

Is called when the apply method of the accessor is invoked to move the property. By overriding this method, you can, for example, add the object stored in property at the new position and remove it from the position specified by the following expression:
oldPosition + (newPosition < oldPosition ? 1 : 0)

Parameters:

	prop	The property.
	previousIndex	The initial position of the property.
	newIndex	The new position of the property.

virtual void IlvStIPropertyListAccessor::replaceProperty	(	IlvStIProperty *	origProperty,
		IlvStIProperty *	newProperty,
		IlUInt	index
	)			[protected, virtual]

Replaces a property by another property.

Is called when the apply method of the accessor is invoked. By default, this method destroys the initial property and adds the new property.

Parameters:

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