IlvStIPropertiesAccessor Class Reference

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

#include <ivstudio/inspectors/insppnl.h>

Inheritance diagram for IlvStIPropertiesAccessor:

List of all members.

Public Member Functions
	IlvStIPropertiesAccessor (IlvStIPropertyAccessor *accessor=0, IlvStIAccessor::UpdateMode updateMode=IlvStIAccessor::Inherited, IlvStIAccessor::BuildMode buildMode=IlvStIAccessor::None, const char *name=0)
	Initializes an instance of IlvStIPropertiesAccessor.
virtual IlvStIEditor *	findFirstEditor () const
	Returns the first editor owned by the accessor.
virtual IlvStIProperty *	get ()
	Returns the object's property.
virtual IlBoolean	initialize ()
	Called to initialize the accessor according to the inspected data.
virtual void	set (const IlvStIProperty *, IlvStIEditor *)
	Sets the current property to the property.
Protected Member Functions
virtual IlvStIProperty *	createDefaultProperty () const
	Called to create a default property.
virtual void	deleteNewProperty (IlvStIProperty *property)
	Deletes the property.
virtual IlvStIProperty *	getOriginalValue ()
	Called to retrieve the property from the inspected object.

---

Detailed Description

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

Library: ivstudio

See also:

IlvStICombinedAccessor

---

Constructor & Destructor Documentation

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

Initializes an instance of IlvStIPropertiesAccessor.

Parameters:

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

---

Member Function Documentation

virtual IlvStIProperty* IlvStIPropertiesAccessor::createDefaultProperty

(

)

const [protected, virtual]

Called to create a default property.

Is called only when the create mode is set (see IlvStIAccessor::BuildMode) to create a default property when no property has been found in the inspected object.

Returns:

A default property.

Reimplemented from IlvStICombinedAccessor.

virtual void IlvStIPropertiesAccessor::deleteNewProperty

(

IlvStIProperty *

property

)

[protected, virtual]

Deletes the property.

Deletes the property which was created by the createProperty method. The default implementation of the method unlocks the property.

Parameters:

property

The property.

virtual IlvStIEditor* IlvStIPropertiesAccessor::findFirstEditor

(

)

const [virtual]

Returns the first editor owned by the accessor.

Returns:

The first editor owned by the accessor, if any. Otherwise, it returns the first editor found in the nearest dependent accessor. For example, if calling the check method generates an error, you can use this function to find the editor associated with the checked accessor and give it the focus so that the user can modify it. It returns 0 if no editors with the specified name is found.

Reimplemented from IlvStIAccessor.

virtual IlvStIProperty* IlvStIPropertiesAccessor::get

(

)

[virtual]

Returns the object's property.

Returns:

The object's property, which is stored in the IlvStIProperty object.

Reimplemented from IlvStIPropertyAccessor.

virtual IlvStIProperty* IlvStIPropertiesAccessor::getOriginalValue

(

)

[protected, virtual]

Called to retrieve the property from the inspected object.

Is called by the get method to retrieve the property from the inspected object. Because the get method performs internal operations, such as handling the building mode, we recommend that you redefine the getOriginalValue method instead of the get method.

Returns:

The original value.

Reimplemented from IlvStICombinedAccessor.

virtual IlBoolean IlvStIPropertiesAccessor::initialize

(

)

[virtual]

Called to initialize the accessor according to the inspected data.

By default, this method only initializes all dependent accessors.

Returns:

IlTrue if successfull, otherwise return IlFalse.

Reimplemented from IlvStICombinedAccessor.

virtual void IlvStIPropertiesAccessor::set	(	const IlvStIProperty *	prop,
		IlvStIEditor *	editor
	)			[virtual]

Sets the current property to the property.

Sets the current property to the property provided as the parameter. The specified editor is the one that changed the property. All the editors that the accessor contains are reinitialized following this modification, except for the calling editor.

Parameters:

	prop	The new property.
	editor	The editor which must be not reinitialized.

Reimplemented from IlvStICombinedAccessor.