Rogue Wave Views Studio Package API Reference Guide |
Rogue Wave Views Documentation Home |
Inspector class. More...
#include <ivstudio/inspectors/genacces.h>
Public Types | |
Public Types inherited from IlvStIAccessor |
Public Member Functions | |
virtual IlvStIError * | check () const |
Validates the accessor value. More... | |
virtual IlvStIError * | checkValue (const IlvStIProperty *prop) const |
Checks the value for a property. More... | |
virtual IlvStIProperty * | get () |
Returns the object's 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 | initialize () |
Called to initialize the accessor according to the inspected data. 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... | |
virtual void | set (const IlvStIProperty *prop, IlvStIEditor *editor) |
Sets the current property to the property. 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... | |
virtual IlvStIEditor * | findFirstEditor () const |
Returns the first editor owned by the accessor. 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... | |
virtual UpdateMode | getUpdateMode () const |
Returns the update mode for 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 | |
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 IlvStIProperty * | createDefaultProperty () const |
Called to create a default property. More... | |
virtual IlvStIProperty * | getOriginalValue () |
Called to retrieve the property from the inspected object. 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... | |
Friends | |
class | IlvStICombinedAccessor |
Inspector class.
Library: ivstudio
This class accesses an object property. The get()
method of this class fetches the property and stores it in an IlvStIProperty
object. This method is called by the initialize()
method. The stored value is used by the dependent accessors and by the editors. Then, the apply()
method assigns the new property to the inspected object.
When subtyping this class, you should redefine only the methods getOriginalValue()
and applyValue()
, which are used in the get()
and apply()
methods respectively.
A preview accessor can be set to the accessor. When the accessor is initialized, the preview accessor is also initialized with the same value. Likewise, when the accessor is set to a value, the preview accessor is assigned the same value. Using a preview accessor makes it possible to reflect changes to the accessor in another object, such as a graphic object in an inspector panel.
IlvStIEditor
, IlvStIPrecondition
, IlvStIProperty
, IlvStIAccessor
. 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.
Enumerator | |
---|---|
Uninitialized |
The property is uninitialized. |
Inaccessible |
The property is inaccessible. |
ReadWrite |
The property is readable and writable. |
ReadOnly |
The property is read only. |
|
protected |
Initializes an instance of IlvStIPropertyAccessor
.
name | The accessor name. |
updateMode | The update mode. |
buildMode | The build mode. |
|
protectedvirtual |
Called to change the property of the inspected object.
Is called by the apply()
method to change the property of the inspected object. Because the apply()
method performs internal operations, such as handling the building mode, we recommend that you redefine the applyValue()
method instead of the apply()
method.
prop | The new value. |
Reimplemented in IlvStIGraphicContainerAccessor, and IlvStIInspectedObjectAccessor.
|
virtual |
Validates the accessor value.
0
. Reimplemented from IlvStIAccessor.
|
virtual |
Checks the value for a property.
Tests whether the property provided as the parameter is valid. If not, it generates an error. If a validator has been set, it is used by default. Otherwise, the method does nothing.
prop | The property. |
0
if no error occurs, otherwise returns an error.
|
protectedvirtual |
Called to copy the property when the accessor is in copy mode.
Is called by the get()
method to copy the property provided as the parameter when the accessor is in copy mode (see IlvStIAccessor::BuildMode
). By default, this function calls the copy()
function of the property and returns the result.
property | The property. |
|
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.
Reimplemented in IlvStICombinedAccessor, and IlvStIPropertiesAccessor.
|
virtual |
Returns the object's property.
IlvStIProperty
object. Reimplemented in IlvStIPropertiesAccessor.
|
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.
Reimplemented in IlvStIGraphicContainerAccessor, IlvStICombinedAccessor, IlvStIInspectedObjectAccessor, and IlvStIPropertiesAccessor.
IlvStIPrecondition* IlvStIPropertyAccessor::getPrecondition | ( | ) | const |
Returns the precondition.
IlvStIPropertyAccessor* IlvStIPropertyAccessor::getPreviewAccessor | ( | ) | const |
Returns the preview accessor.
PropertyStatus IlvStIPropertyAccessor::getPropertyStatus | ( | ) | const |
Returns the status of the current stored property.
|
protectedvirtual |
Returns IlTrue
if validation is performed.
IlTrue
if validation is performed when apply()
is called. If it returns IlFalse
, validation is performed as soon as the changes are made. IlvStIValidator* IlvStIPropertyAccessor::getValidator | ( | ) | const |
Returns the validator used by the checkValue()
method.
checkValue()
method
|
virtual |
Called to initialize the accessor according to the inspected data.
By default, this method only initializes all dependent accessors.
IlTrue
if successfull, otherwise return IlFalse
. Reimplemented from IlvStIAccessor.
Reimplemented in IlvStICombinedAccessor, and IlvStIPropertiesAccessor.
|
virtual |
Returns IlTrue
if the current property is read-only.
IlTrue
if the current property is read-only.
|
virtual |
Returns IlTrue
if the current property has read and write access.
IlTrue
if the current property has read and write access.
|
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.
prop | The new property. |
editor | The editor which must be not reinitialized. |
Reimplemented in IlvStICombinedAccessor, and IlvStIPropertiesAccessor.
void IlvStIPropertyAccessor::setPrecondition | ( | IlvStIPrecondition * | precond | ) |
Sets the precondition.
Sets the precondition used to test whether the object property can be accessed. If the precondition was already set, it is destroyed and replaced with the new one.
precond | The new precondition. |
void IlvStIPropertyAccessor::setPreviewAccessor | ( | IlvStIPropertyAccessor * | accessor | ) |
Sets the preview accessor.
accessor | The accessor which uses the current accessor like preview accessor. |
void IlvStIPropertyAccessor::setValidator | ( | IlvStIValidator * | validator | ) |
Sets the validator to the accessor.
validator | The validator to the accessor. |
© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.