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

Inheritance diagram for IlvStIPropertyListAccessor:
IlvStIPropertiesAccessor IlvStICombinedAccessor IlvStIPropertyAccessor IlvStIAccessor IlvStNamedObject

Public Member Functions

 IlvStIPropertyListAccessor (IlvStIPropertyAccessor *accessor=0, IlvStIAccessor::UpdateMode updateMode=IlvStIAccessor::Inherited, IlvStIAccessor::BuildMode buildMode=IlvStIAccessor::None, const char *name=0)
 Initializes a new instance of IlvStIPropertiesListAccessor. 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, IlUInt index)
 Adds the property to the list. More...
 
virtual IlvStIPropertycreateProperty (IlUInt index, IlAny data=0) const
 Called to create a new property that will be added to the list. More...
 
virtual void deleteProperty (IlvStIProperty *property, IlUInt index)
 Called when a property is deleted. More...
 
virtual IlvStIProperty ** getInitialProperties (IlUInt &count)
 Called when the accessor is initialized and returns an array containing the initial list of properties. More...
 
virtual void moveProperty (IlvStIProperty *property, IlUInt previousIndex, IlUInt newIndex)
 Called when a property changes of position. More...
 
virtual void replaceProperty (IlvStIProperty *origProperty, IlvStIProperty *newProperty, IlUInt index)
 Replaces a property by another property. 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 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::IlvStIPropertyListAccessor ( IlvStIPropertyAccessor accessor = 0,
IlvStIAccessor::UpdateMode  updateMode = IlvStIAccessor::Inherited,
IlvStIAccessor::BuildMode  buildMode = IlvStIAccessor::None,
const char *  name = 0 
)

Initializes a new instance of IlvStIPropertiesListAccessor.

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

Member Function Documentation

◆ addProperty()

virtual void IlvStIPropertyListAccessor::addProperty ( IlvStIProperty property,
IlUInt  index 
)
protectedvirtual

Adds the property to the list.

Called when the apply() method of the accessor is invoked.

Parameters
propertyThe property.
indexThe insertion position.

◆ createProperty()

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

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

Parameters
indexThe insertion position of the property in the list.
dataComes 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.

◆ deleteProperty()

virtual void IlvStIPropertyListAccessor::deleteProperty ( IlvStIProperty property,
IlUInt  index 
)
protectedvirtual

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
propertyThe property which contains the item.
indexThe item position.

◆ getInitialProperties()

virtual IlvStIProperty** IlvStIPropertyListAccessor::getInitialProperties ( IlUInt count)
protectedvirtual

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
countSet to the number of properties in the returned array.
Returns
An array containing the initial list of properties.

◆ moveProperty()

virtual void IlvStIPropertyListAccessor::moveProperty ( IlvStIProperty property,
IlUInt  previousIndex,
IlUInt  newIndex 
)
protectedvirtual

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
propertyThe property.
previousIndexThe initial position of the property.
newIndexThe new position of the property.

◆ replaceProperty()

virtual void IlvStIPropertyListAccessor::replaceProperty ( IlvStIProperty origProperty,
IlvStIProperty newProperty,
IlUInt  index 
)
protectedvirtual

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
origPropertyThe initial property.
newPropertyThe new property.
indexThe position of the initial property.