VBentoColor Class Reference

VBentoColor is a VBentoAttribute that holds a VColor value. More...

#include <vbento.h>

Inheritance diagram for VBentoColor:

List of all members.

Public Member Functions
	VBentoColor ()
	Constructs with uninitialized name and the default value.
	VBentoColor (VBinaryIOStream &stream)
	Constructs by reading from stream.
	VBentoColor (const VString &name, const VColor &c)
	Constructs from supplied name and value.
virtual	~VBentoColor ()
	Destructor.
virtual VBentoAttribute *	clone () const
VBentoColor &	operator= (const VBentoColor &rhs)
virtual void	getValueAsXMLText (VString &s) const
	Returns a string suitable for an XML attribute value, including escaping via _escapeXMLValue() if needed.
virtual void	getValueAsString (VString &s) const
	Returns a printable form of the attribute value.
virtual void	getValueAsBentoTextString (VString &s) const
	Returns a Bento Text form of the attribute value.
const VColor &	getValue () const
	Returns the attribute's value.
void	setValue (const VColor &i)
	Sets the attribute's value.
Static Public Member Functions
static const VString &	DATA_TYPE_ID ()
	The data type name / class ID string.
Protected Member Functions
virtual Vs64	getDataLength () const
	Returns the length of this object's raw data only.
virtual void	writeDataToBinaryStream (VBinaryIOStream &stream) const
	Writes the object's raw data only to a binary stream.

---

Detailed Description

VBentoColor is a VBentoAttribute that holds a VColor value.

Definition at line 1824 of file vbento.h.

---

Constructor & Destructor Documentation

VBentoColor::VBentoColor

(

VBinaryIOStream &

stream

)

[inline]

Constructs by reading from stream.

Parameters:

stream

the stream to read

Definition at line 1830 of file vbento.h.

---

Member Function Documentation

const VColor& VBentoColor::getValue

(

)

const [inline]

Returns the attribute's value.

Returns:

a reference to the value object

Definition at line 1841 of file vbento.h.

void VBentoColor::setValue

(

const VColor &

i

)

[inline]

Sets the attribute's value.

Parameters:

i	the attribute value

Definition at line 1842 of file vbento.h.

virtual Vs64 VBentoColor::getDataLength

(

)

const [inline, protected, virtual]

Returns the length of this object's raw data only.

Returns:

the length of the object's raw data

Implements VBentoAttribute.

Definition at line 1846 of file vbento.h.

virtual void VBentoColor::writeDataToBinaryStream

(

VBinaryIOStream &

stream

)

const [inline, protected, virtual]

Writes the object's raw data only to a binary stream.

Parameters:

stream

the stream to write to

Implements VBentoAttribute.

Definition at line 1847 of file vbento.h.

References VColor::writeToStream().

---

The documentation for this class was generated from the following file:

• vbento.h