IlsSwHRefDatatype
Category
An Rogue Wave Views data type to represent a hyper-reference.
Inheritance Path
IliDatatype
➥ IliPointerTypeClass
➥ IlsSwHRefDatatype
Description
This class is the Rogue Wave Views data type used to represent a hyper-reference.
Library
Synopsis
class IlsSwHRefDatatype : public IliPointerTypeClass
{
public:
virtual IlvBoolean
setHRef(IliValue& value,
const IlsRpObject&,
IlsRpAttributeId,
const IlsString& label) const;
virtual IlsRpObject*
getHRef(const IliValue&,
IlsRpAttributeId&) const;
virtual IlsString
getLabel(const IliValue&) const;
const IlsString&) const;
};
Member Functions
[virtual] IlvBoolean setHRef(IliValue& value,
const IlsRpObject&,
IlsRpAttributeId,
const IlsString& label) const;
This virtual member function can be used to set an 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,"");
[virtual] IlsRpObject* getHRef(const IliValue&,IlsRpAttributeId&) const;
This virtual method can be used to retrieve a pointer to the hyper-reference from an 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);
[virtual] IlsString getLabel(const IliValue&) const;
This virtual member function can be used to get 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);
[virtual] IlvBoolean setLabel(IliValue&, const IlsString&) const;
This virtual member function can be used to set 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);
See Also
IlsSwHRefType, IliDatatype, IliValue ( Rogue Wave Views
/Data Access documentation)
Version 5.8
Copyright © 2014, Rogue Wave Software, Inc. All Rights Reserved.