Text Struct Reference

Stores a text. More...

Public Member Functions
void	clear ()
	Clears the text. More...
bool	operator== (const std::string &name) const
	The compare operator for std::strings. More...
bool	operator== (const Text &rhs) const
	The compare operator for Texts. More...
void	set (const char *buffer, size_t numChars)
	Set a new text. More...
	Text (const char *buffer, size_t numChars)
	The constructor with a given text buffer. More...
	~Text ()
	The destructor. More...

Public Attributes
char *	m_buffer
	The buffer with the text. More...
size_t	m_capacity
	The capacity of the text. More...
size_t	m_len
	The length of the text. More...

Detailed Description

Stores a text.

A text is stored in a simple character buffer. Texts buffer can be greater than the number of stored characters in them.

Constructor & Destructor Documentation

Text()

BEGIN_ODDLPARSER_NS Text::Text	(	const char *	buffer,
		size_t	numChars
	)

The constructor with a given text buffer.

Parameters

buffer	[in] The buffer.
numChars	[in] The number of characters in the buffer.

~Text()

Text::~Text

(

)

The destructor.

Member Function Documentation

clear()

void Text::clear

(

)

Clears the text.

operator==() [1/2]

bool Text::operator==

(

const std::string &

name

)

const

The compare operator for std::strings.

operator==() [2/2]

bool Text::operator==

(

const Text &

rhs

)

const

The compare operator for Texts.

set()

void Text::set	(	const char *	buffer,
		size_t	numChars
	)

Set a new text.

Parameters

buffer	[in] The buffer.
numChars	[in] The number of characters in the buffer.

Member Data Documentation

m_buffer

char* Text::m_buffer

The buffer with the text.

m_capacity

size_t Text::m_capacity

The capacity of the text.

m_len

size_t Text::m_len

The length of the text.

---

The documentation for this struct was generated from the following files:

• OpenDDLCommon.h
• OpenDDLCommon.cpp