Views
Studio Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvStIValueProperty Class Reference

Inspector class. More...

#include <ivstudio/inspectors/genprop.h>

Inheritance diagram for IlvStIValueProperty:
IlvStIProperty

Public Member Functions

 IlvStIValueProperty (const IlvStIValueProperty &src)
 copy constructor. More...
 
 IlvStIValueProperty (const IlvStValue &value, const char *name=IlString::EmptyCString)
 Initializes a new instance of IlvStIValueProperty. More...
 
virtual const char * getString () const
 Returns a character string that represents the object's value. More...
 
virtual IlvValuegetValue (IlvValue &) const
 Copies the object's value to the value. More...
 
virtual void set (const IlvStIProperty &)
 Copies the property to this property. More...
 
virtual void setString (const char *str)
 Converts the character string to the object's value. More...
 
virtual void setValue (const IlvValue &)
 Sets the value to the object. More...
 
- Public Member Functions inherited from IlvStIProperty
virtual void modified ()
 Is called automatically after the object has been modified. More...
 

Detailed Description

Inspector class.

Library: ivstudio

This class encapsulates an IlvValue object and redefines the base class methods according to that object.

See also
IlvStValue.

Constructor & Destructor Documentation

◆ IlvStIValueProperty() [1/2]

IlvStIValueProperty::IlvStIValueProperty ( const IlvStValue value,
const char *  name = IlString::EmptyCString 
)

Initializes a new instance of IlvStIValueProperty.

Parameters
valueThe object value.
nameThe object name.

◆ IlvStIValueProperty() [2/2]

IlvStIValueProperty::IlvStIValueProperty ( const IlvStIValueProperty src)

copy constructor.

Parameters
srcThe object which will be copied.

Member Function Documentation

◆ getString()

virtual const char* IlvStIValueProperty::getString ( ) const
virtual

Returns a character string that represents the object's value.

Returns
A character string that represents the object's value.

Implements IlvStIProperty.

◆ getValue()

virtual IlvValue& IlvStIValueProperty::getValue ( IlvValue val) const
virtual

Copies the object's value to the value.

Parameters
valContains the value.
Returns
The value.

Implements IlvStIProperty.

◆ set()

virtual void IlvStIValueProperty::set ( const IlvStIProperty prop)
virtual

Copies the property to this property.

Parameters
propThe new property.

Implements IlvStIProperty.

◆ setString()

virtual void IlvStIValueProperty::setString ( const char *  str)
virtual

Converts the character string to the object's value.

Parameters
strThe character string which contains the value.

Implements IlvStIProperty.

◆ setValue()

virtual void IlvStIValueProperty::setValue ( const IlvValue val)
virtual

Sets the value to the object.

Parameters
valThe new value.

Implements IlvStIProperty.