Rogue Wave Views
Studio Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions | Protected Member Functions
IlvStIGraphicContainerAccessor Class Reference

Inspector class. More...

#include <ivstudio/inspectors/genacces.h>

Inherits IlvStIValueInterAccessor.

Public Member Functions

 IlvStIGraphicContainerAccessor (IlvGraphicHolder *holder=0, const char *name=0, UpdateMode updateMode=Inherited, BuildMode buildMode=None)
 Initializes a new instance of the IlvStIGraphicContainerAccessor class. More...
 
virtual IlvGraphicgetGraphic ()
 Returns the graphic object to be accessed. More...
 

Protected Member Functions

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

Detailed Description

Inspector class.

Library: ivstudio

This class is used to return a graphic object held by a container. This class can be used, for example, to access a graphic object that serves as a preview object inside the inspector panel.

See also
IlvStIAccessor, IlvStInspectorPanel.

Constructor & Destructor Documentation

§ IlvStIGraphicContainerAccessor()

IlvStIGraphicContainerAccessor::IlvStIGraphicContainerAccessor ( IlvGraphicHolder holder = 0,
const char *  name = 0,
UpdateMode  updateMode = Inherited,
BuildMode  buildMode = None 
)

Initializes a new instance of the IlvStIGraphicContainerAccessor class.

Parameters
holderThe container that holds the object to be accessed.
nameThe accessor name.
updateModeThe update mode of the accessor.
buildModeThe build mode of the accessor.

Member Function Documentation

§ applyValue()

virtual void IlvStIGraphicContainerAccessor::applyValue ( IlvStIProperty prop)
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.

Parameters
propThe new value.

Reimplemented from IlvStIPropertyAccessor.

§ getGraphic()

virtual IlvGraphic* IlvStIGraphicContainerAccessor::getGraphic ( )
virtual

Returns the graphic object to be accessed.

Returns
The graphic object to be accessed.

§ getOriginalValue()

virtual IlvStIProperty* IlvStIGraphicContainerAccessor::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 IlvStIPropertyAccessor.


© Copyright 2017, 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.