IlvStICombinedAccessor Class Reference

Inspector class. More...

#include <ivstudio/inspectors/genacces.h>

Inheritance diagram for IlvStICombinedAccessor:

List of all members.

Public Member Functions
	IlvStICombinedAccessor (IlvStIPropertyAccessor *accessor=0, UpdateMode updateMode=NoUpdate, BuildMode buildMode=None, const char *name=0)
	Initializes a new instance of the class IlvStICombinedAccessor.
IlvStIPropertyAccessor *	getObjectAccessor () const
	Returns the accessor to the object to which this accessor applies.
virtual UpdateMode	getUpdateMode () const
	Returns the update mode for the accessor.
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 IlvStIProperty *	getOriginalValue ()
	Called to retrieve the property from the inspected object.

---

Detailed Description

Inspector class.

Library: ivstudio

The IlvStICombinedAccessor accessors let you inspect objects that are returned by another accessor. For example, to inspect a list of names, you create a list accessor to get the item selected in the list, and a name accessor that gets the name of the selected item through the list accessor. When the selection changes, the list accessor is modified and initializes the name accessor that depends on it.
Combined accessors can be reused. Thus, the same IlvStICombinedAccessor to a gadget item can be used to inspect either the gadget item of a message label or the gadget item of a list, such as IlvStringList.

See also:

IlvStIPropertyAccessor, IlvStIAccessor

---

Constructor & Destructor Documentation

IlvStICombinedAccessor::IlvStICombinedAccessor	(	IlvStIPropertyAccessor *	accessor = 0,
		UpdateMode	updateMode = NoUpdate,
		BuildMode	buildMode = None,
		const char *	name = 0
	)

Initializes a new instance of the class IlvStICombinedAccessor.

Initializes a new instance of the class IlvStICombinedAccessor and adds it to the hierarchical tree of dependencies of the specified accessor. This accessor can be retrieved later by calling the member function getObjectAccessor.

Parameters:

	accessor	The accessor which is linked to this accessor.
	updateMode	The update mode.
	buildMode	The build mode.
	name	The accessor name.

---

Member Function Documentation

virtual IlvStIProperty* IlvStICombinedAccessor::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 IlvStIPropertyAccessor.

Reimplemented in IlvStIPropertiesAccessor.

IlvStIPropertyAccessor* IlvStICombinedAccessor::getObjectAccessor

(

)

const

Returns the accessor to the object to which this accessor applies.

Returns:

The accessor to the object to which this accessor applies.

virtual IlvStIProperty* IlvStICombinedAccessor::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 IlvStIPropertyAccessor.

Reimplemented in IlvStIInspectedObjectAccessor, and IlvStIPropertiesAccessor.

virtual UpdateMode IlvStICombinedAccessor::getUpdateMode

(

)

const [virtual]

Returns the update mode for the accessor.

Returns:

The update mode for the accessor.

Reimplemented from IlvStIAccessor.

virtual IlBoolean IlvStICombinedAccessor::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 IlvStIPropertyAccessor.

Reimplemented in IlvStIPropertiesAccessor.

virtual void IlvStICombinedAccessor::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 IlvStIPropertyAccessor.

Reimplemented in IlvStIPropertiesAccessor.