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/listacc.h>

Inheritance diagram for IlvStIPropertiesAccessor:

Public Member Functions
	IlvStIPropertiesAccessor (IlvStIPropertyAccessor accessor=0, IlvStIAccessor::UpdateMode updateMode=IlvStIAccessor::Inherited, IlvStIAccessor::BuildMode buildMode=IlvStIAccessor::None, const char name=0)
	Initializes a new 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 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...

Protected Member Functions inherited from IlvStIPropertyAccessor
	IlvStIPropertyAccessor (const char *name=0, UpdateMode updateMode=NoUpdate, BuildMode buildMode=None)
	Initializes an instance of `IlvStIPropertyAccessor`. More...

virtual void	applyValue (IlvStIProperty *prop)
	Called to change the property of the inspected object. More...

virtual IlvStIProperty *	copyProperty (const IlvStIProperty *property)
	Called to copy the property when the accessor is in copy mode. More...

virtual IlBoolean	getValidateOnApply () const
	Returns `IlTrue` if validation is performed. More...

Protected Member Functions inherited from IlvStIAccessor
	IlvStIAccessor (const char *name=0, UpdateMode mode=NoUpdate, BuildMode build=None)
	Initializes a new instance of the `IlvStIAccessor` class. More...

Protected Attributes
IlArray	_properties
	compilers

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...

Public Types inherited from IlvStIAccessor
enum	BuildMode { , Create, Copy }
	This enumeration type defines the build mode of the inspected properties. More...

enum	DependencyMode { InitializeAfter, InitializeBefore, ApplyBefore, ApplyAfter, NoApply, Default, InitializeAndApplyBefore }
	This enumeration type specifies when the dependent accessor is initialized and applied. properties. More...

enum	UpdateMode { NoUpdate, OnApply, Immediate, Inherited }
	This enumeration type specifies when the accessor must update the inspected property. The provided modes are mutually exclusive. More...

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::IlvStIPropertiesAccessor	(	IlvStIPropertyAccessor *	accessor = `0`,
		IlvStIAccessor::UpdateMode	updateMode = `IlvStIAccessor::Inherited`,
		IlvStIAccessor::BuildMode	buildMode = `IlvStIAccessor::None`,
		const char *	name = `0`
	)

Initializes a new 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

◆ createDefaultProperty()

virtual IlvStIProperty* IlvStIPropertiesAccessor::createDefaultProperty ( ) const

protectedvirtual

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.

◆ deleteNewProperty()

virtual void IlvStIPropertiesAccessor::deleteNewProperty ( IlvStIProperty * property )

protectedvirtual

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.

◆ findFirstEditor()

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.

◆ get()

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.

◆ getOriginalValue()

virtual IlvStIProperty* IlvStIPropertiesAccessor::getOriginalValue ( )

protectedvirtual

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.

◆ initialize()

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.

◆ set()

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.

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IlvStIPropertiesAccessor()

Member Function Documentation

◆ createDefaultProperty()

◆ deleteNewProperty()

◆ findFirstEditor()

◆ get()

◆ getOriginalValue()

◆ initialize()

◆ set()