IlsSwHRefDatatype Class Reference

This class is the Rogue Wave Views data type used to represent a hyper-reference. More...

#include <ilmvsw/svswutil.h>

Inherits IliPointerTypeClass.

Public Member Functions
virtual IlsRpObject *	getHRef (const IliValue &, IlsRpAttributeId &) const
	Retrieves a pointer to the hyper-reference from a Rogue Wave Views value. More...
virtual IlsString	getLabel (const IliValue &) const
	Gets the current label of a hyper-reference as contained in the Rogue Wave Views value. More...
virtual IlvBoolean	setHRef (IliValue &, const IlsRpObject &, IlsRpAttributeId, const IlsString &) const
	Sets a Rogue Wave Views value to a hyper-reference and optional label. More...
virtual IlvBoolean	setLabel (IliValue &, const IlsString &) const
	Sets the current label of a hyper-reference in the Rogue Wave Views value. More...

Detailed Description

This class is the Rogue Wave Views data type used to represent a hyper-reference.

Library: mvsw

See also

IlsSwHRefType, IliDatatype, IliValue.

Member Function Documentation

getHRef()

virtual IlsRpObject* IlsSwHRefDatatype::getHRef ( const IliValue &  , IlsRpAttributeId &    ) const

virtual

Retrieves a pointer to the hyper-reference from a Rogue Wave Views value.

This method returns 0 if the value is void or empty, or if the representation object no longer exists. This method is used as follows:

IlsRpAttributeId attrId;
IlsRpObject* rpObj = IlsSwHRefType->getHRef(v, attrId);

getLabel()

virtual IlsString IlsSwHRefDatatype::getLabel ( const IliValue &  ) const

virtual

Gets the current label of a hyper-reference as contained in the Rogue Wave Views value.

This method is used as follows:

IlsString s = IlsSwHRefType->getLabel(v);

setHRef()

virtual IlvBoolean IlsSwHRefDatatype::setHRef ( IliValue &  , const IlsRpObject &  , IlsRpAttributeId  , const IlsString &    ) const

virtual

Sets a Rogue Wave Views value to a hyper-reference and optional label.

Note

If the Views value is not of type IlsSwHRefType, this method returns IlvFalse.

This method is used as follows:

IlvBoolean b = IlsSwHRefType->setHRef(v,rpObj,attrId,"");

setLabel()

virtual IlvBoolean IlsSwHRefDatatype::setLabel ( IliValue &  , const IlsString &    ) const

virtual

Sets the current label of a hyper-reference in the Rogue Wave Views value.

This method is used as follows:

IlvBoolean b = IlsSwHRefType->setLabel(v, s);