BTextLine Class Reference

#include <BTextLine.h>

Inheritance diagram for BTextLine:

[legend]

List of all members.

---

Detailed Description

Encapsulates a line of text and its insertion point.

Public Member Functions
	BTextLine (const BTextLine &line)
	Copy constructor.
	BTextLine (const BPoint &pt, const BString &text)
	Constructor.
	BTextLine ()
	Default constructor.
virtual size_t	ComputeSize (void) const
	Computes the size of the BByteArray required to store this object.
virtual void	FromByteArray (const BByteArray &bytes, size_t &startPos)
	Initializes an instance of this object from a BByteArray.
const BString &	GetText (void) const
	Gets the text for this BTextLine.
const BPoint &	GetVertex (void) const
	Gets the insertion point for this line of text.
bool	operator!= (const BTextLine &rhs)
	Inequality operator.
bool	operator== (const BTextLine &rhs)
	Equality operator.
void	SetText (const BString &text)
	Sets the text for this BTextLine.
void	SetVertex (const BPoint &pt)
	Sets the insertion point for this line of text.
virtual BByteArray	ToByteArray (void) const
	Stores this object in a BByteArray.
virtual void	Transform (const BTransform &cst)
	Transforms the insertion point of this BTextLine to a different coordinate system.
virtual void	TransformReverse (const BTransform &cst)
	Transforms the insertion point of this BTextLine to a different coordinate system using the "reverse" of the BTransform.
virtual	~BTextLine ()
	Destructor.

---

Constructor & Destructor Documentation

BTextLine

(

)

[inline]

Default constructor.

BTextLine	(	const BPoint &	pt,
		const BString &	text
	)			[inline]

Constructor.

Parameters:

	pt	The insertion point for the text.
	text	The text.

BTextLine

(

const BTextLine &

line

)

[inline]

Copy constructor.

Parameters:

line

The BTextLine to copy.

virtual ~BTextLine

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

virtual size_t ComputeSize

(

void

)

const [inline, virtual]

Computes the size of the BByteArray required to store this object.

Returns:

The size of the BByteArray.

Implements BByteStreamable.

virtual void FromByteArray	(	const BByteArray &	bytes,
		size_t &	startPos
	)			[virtual]

Initializes an instance of this object from a BByteArray.

Parameters:

	bytes	The BByteArray containing the byte representation of the object.
	startPos	The position in the BByteArray where the byte representation begins. This value will be updated to point to the byte past the end of this object in the byte array.

Implements BByteStreamable.

const BString& GetText

(

void

)

const [inline]

Gets the text for this BTextLine.

Returns:

The text.

const BPoint& GetVertex

(

void

)

const [inline]

Gets the insertion point for this line of text.

Returns:

The insertion point.

bool operator!=

(

const BTextLine &

rhs

)

[inline]

Inequality operator.

Parameters:

rhs

The BTextLine to compare to this one.

Returns:

true if the specified BTextFeature does not have the same value as this one.

bool operator==

(

const BTextLine &

rhs

)

Equality operator.

Parameters:

rhs

The BTextLine to compare to this one.

Returns:

true if the specified BTextFeature has the same value as this one.

void SetText

(

const BString &

text

)

[inline]

Sets the text for this BTextLine.

Parameters:

text

The text.

void SetVertex

(

const BPoint &

pt

)

[inline]

Sets the insertion point for this line of text.

Parameters:

pt

The insertion point.

virtual BByteArray ToByteArray

(

void

)

const [virtual]

Stores this object in a BByteArray.

Returns:

A BByteArray that stores the contents of this object.

Implements BByteStreamable.

virtual void Transform

(

const BTransform &

cst

)

[virtual]

Transforms the insertion point of this BTextLine to a different coordinate system.

Parameters:

cst

The BTransform that defines the transformation.

virtual void TransformReverse

(

const BTransform &

cst

)

[virtual]

Transforms the insertion point of this BTextLine to a different coordinate system using the "reverse" of the BTransform.

Parameters:

cst

The BTransform that defines the transformation.

---

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

• BTextLine.h

---

GeoTranslate 5.0 From Blue Marble Geographics