 |
Rogue Wave Views Studio Package API Reference Guide |
Rogue Wave Views Documentation Home |
|
Rogue Wave Views Studio Package API Reference Guide |
Rogue Wave Views Documentation Home |
Inspector class. More...
#include <ivstudio/inspectors/genacces.h>
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. 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... | |
| 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 IlvStIPropertyAccessor | |
| 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 | 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... | |
| 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... | |
| 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 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... | |
Additional Inherited Members | |
| Public Types inherited from IlvStIPropertyAccessor | |
| Public Types inherited from IlvStIAccessor |
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.
IlvStIPropertyAccessor, IlvStIAccessor | 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().
| accessor | The accessor which is linked to this accessor. |
| updateMode | The update mode. |
| buildMode | The build mode. |
| name | The accessor name. |
|
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 from IlvStIPropertyAccessor.
Reimplemented in IlvStIPropertiesAccessor.
| IlvStIPropertyAccessor* IlvStICombinedAccessor::getObjectAccessor | ( | ) | const |
Returns the accessor to the object to which this accessor applies.
|
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 from IlvStIPropertyAccessor.
Reimplemented in IlvStIInspectedObjectAccessor, and IlvStIPropertiesAccessor.
|
virtual |
Returns the update mode for the accessor.
Reimplemented from IlvStIAccessor.
|
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 IlvStIPropertyAccessor.
Reimplemented in IlvStIPropertiesAccessor.
|
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 from IlvStIPropertyAccessor.
Reimplemented in IlvStIPropertiesAccessor.
© 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.