Rogue Wave Views
Studio Package API Reference Guide
Product Documentation:

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

Property class. More...

#include <ivstudio/stprop.h>

Inheritance diagram for IlvStPropertySet:
IlvStProperty IlvStDescriptiveObject IlvStOptions IlvStPanelHandler IlvStClassDescriptor IlvStDialog IlvStPanelClass

Public Member Functions

 IlvStPropertySet (const IlSymbol *name)
 Initializes an instance of IlvStPropertySet. More...
 
 IlvStPropertySet (const char *name)
 Initializes an instance of IlvStPropertySet. More...
 
virtual const char * getName () const
 Returns the property name. More...
 
virtual IlBoolean getPropertyValue (const IlSymbol *name, IlvValue &value)
 Returns the value from a property. More...
 
virtual void setName (const char *str)
 Sets the property name. More...
 
virtual IlBoolean setPropertyValue (const IlSymbol *name, const IlvValue &value)
 Sets the value of one property. More...
 
- Public Member Functions inherited from IlvStProperty
virtual const IlSymbolgetNameSymbol () const
 Returns the property name. More...
 
virtual IlvValuegetValue (IlvValue &value) const
 Returns the property value. More...
 
virtual void setNameSymbol (const IlSymbol *str)
 Sets the property name. More...
 
virtual void setValue (const IlvValue &value)
 Sets the property value. More...
 

Detailed Description

Property class.

Library: ivstudio

This property is a set of properties.

Constructor & Destructor Documentation

§ IlvStPropertySet() [1/2]

IlvStPropertySet::IlvStPropertySet ( const IlSymbol name)

Initializes an instance of IlvStPropertySet.

Parameters
nameThe property name.

§ IlvStPropertySet() [2/2]

IlvStPropertySet::IlvStPropertySet ( const char *  name)

Initializes an instance of IlvStPropertySet.

Parameters
nameThe property name.

Member Function Documentation

§ getName()

virtual const char* IlvStPropertySet::getName ( ) const
virtual

Returns the property name.

Returns
The property name.

Reimplemented from IlvStProperty.

Reimplemented in IlvStPanelHandler.

§ getPropertyValue()

virtual IlBoolean IlvStPropertySet::getPropertyValue ( const IlSymbol name,
IlvValue value 
)
virtual

Returns the value from a property.

Parameters
nameThe property name
valueIs set on return to the property value.
Returns
IlFalse if the property can not be found, and IlTrue on success.

§ setName()

virtual void IlvStPropertySet::setName ( const char *  str)
virtual

Sets the property name.

Parameters
strThe property name.

Reimplemented from IlvStProperty.

§ setPropertyValue()

virtual IlBoolean IlvStPropertySet::setPropertyValue ( const IlSymbol name,
const IlvValue value 
)
virtual

Sets the value of one property.

Parameters
nameThe property name
valueThe property value.
Returns
IlTrue if the change has been done.

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