Views
Studio Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions | Protected Member Functions
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/listacc.h>

Inheritance diagram for IlvStIPropertyTreeAccessor:
IlvStIPropertiesAccessor IlvStICombinedAccessor IlvStIPropertyAccessor IlvStIAccessor IlvStNamedObject

Public Member Functions

 IlvStIPropertyTreeAccessor (IlvStIPropertyAccessor *accessor=0, IlvStIAccessor::UpdateMode updateMode=IlvStIAccessor::Inherited, IlvStIAccessor::BuildMode buildMode=IlvStIAccessor::None, const char *name=0)
 Initializes a new instance of IlvStIPropertyTreeAccessor. More...
 
- Public Member Functions inherited from 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. More...
 
virtual IlvStIEditorfindFirstEditor () const
 Returns the first editor owned by the accessor. More...
 
virtual IlvStIPropertyget ()
 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...
 
IlvStIPropertyAccessorgetObjectAccessor () 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 IlvStIErrorcheck () const
 Validates the accessor value. More...
 
virtual IlvStIErrorcheckValue (const IlvStIProperty *prop) const
 Checks the value for a property. More...
 
IlvStIPreconditiongetPrecondition () const
 Returns the precondition. More...
 
IlvStIPropertyAccessorgetPreviewAccessor () const
 Returns the preview accessor. More...
 
PropertyStatus getPropertyStatus () const
 Returns the status of the current stored property. More...
 
IlvStIValidatorgetValidator () 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 IlvStIErrorcheckAll (const IlvStIAccessor **accessor, IlBoolean modifiedOnly=IlTrue) const
 Checks the accessor and its hierarchical tree of dependencies. More...
 
IlvStIAccessorfindDependentAccessor (const char *name) const
 Searches an dependent accessor. More...
 
IlvStIEditorfindEditor (const char *name) const
 Searches the specified editor inside all dependent accessors. More...
 
BuildMode getBuildMode () const
 Returns the building mode for the accessor. More...
 
IlvStIAccessorgetDependentAccessor (const char *name) const
 Returns the dependent accessor whose name is specified. More...
 
IlvStIAccessor ** getDependentAccessors (IlUInt &count) const
 Returns all direct dependent accessors. More...
 
IlvStIEditorgetEditor (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 void addProperty (IlvStIProperty *property, const IlvStIProperty *parent, IlUInt index)
 Called when a property is added. More...
 
virtual IlvStIPropertycreateProperty (const IlvStIProperty *parent, IlUInt index, IlAny data=0) const
 Called to create a new property. More...
 
virtual void deleteChildrenProperty (IlvStIProperty *property, IlvStIProperty *parent)
 Called when a property is deleted. More...
 
virtual IlUInt getChildPosition (const IlvStIProperty *property, const IlvStIProperty *parent) const
 Returns the position of the child property. More...
 
virtual IlvStIProperty ** getInitialChildrenProperties (IlUInt &count, const IlvStIProperty *property=0) const
 Called when the accessor is initialized and returns an array containing the initial children of the property. More...
 
virtual void replaceProperty (IlvStIProperty *origProperty, IlvStIProperty *newProperty, const IlvStIProperty *parent, IlUInt index)
 Called when a property is replaced by another. More...
 
- Protected Member Functions inherited from IlvStIPropertiesAccessor
virtual IlvStIPropertycreateDefaultProperty () const
 Called to create a default property. More...
 
virtual void deleteNewProperty (IlvStIProperty *property)
 Deletes the property. More...
 
virtual IlvStIPropertygetOriginalValue ()
 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 IlvStIPropertycopyProperty (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...
 

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...
 
- Protected Attributes inherited from IlvStIPropertiesAccessor
IlArray _properties
 compilers
 

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

Initializes a new instance of IlvStIPropertyTreeAccessor.

Parameters
accessorThe accessor to the object that contains the tree of properties.
updateModeThe update mode of the accessor.
buildModeThe update mode of the accessor.
nameThe accessor name.

Member Function Documentation

◆ addProperty()

virtual void IlvStIPropertyTreeAccessor::addProperty ( IlvStIProperty property,
const IlvStIProperty parent,
IlUInt  index 
)
protectedvirtual

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
propertyThe new property.
parentThe parent of the new property.
indexThe insertion position of the new property.

◆ createProperty()

virtual IlvStIProperty* IlvStIPropertyTreeAccessor::createProperty ( const IlvStIProperty parent,
IlUInt  index,
IlAny  data = 0 
) const
protectedvirtual

Called to create a new property.

Is called to create a new property that will be added to the list of the parent.

Parameters
parentThe parent of the new property.
indexThe insertion position of the new property.
dataComes 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.

◆ deleteChildrenProperty()

virtual void IlvStIPropertyTreeAccessor::deleteChildrenProperty ( IlvStIProperty property,
IlvStIProperty parent 
)
protectedvirtual

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
propertyThe property.
parentThe parent of the property.

◆ getChildPosition()

virtual IlUInt IlvStIPropertyTreeAccessor::getChildPosition ( const IlvStIProperty property,
const IlvStIProperty parent 
) const
protectedvirtual

Returns the position of the child property.

Returns the position of the child property, relative to its parent property.

Parameters
propertyThe child property.
parentThe parent property.
Returns
The position of the child property.

◆ getInitialChildrenProperties()

virtual IlvStIProperty** IlvStIPropertyTreeAccessor::getInitialChildrenProperties ( IlUInt count,
const IlvStIProperty property = 0 
) const
protectedvirtual

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
countThe property count.
propertyThe property.
Returns
An array containing the initial children of the property.

◆ replaceProperty()

virtual void IlvStIPropertyTreeAccessor::replaceProperty ( IlvStIProperty origProperty,
IlvStIProperty newProperty,
const IlvStIProperty parent,
IlUInt  index 
)
protectedvirtual

Called when a property is replaced 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
origPropertyThe initial property.
newPropertyThe new property.
parentThe parent of the initial property.
indexThe position of the initial property.