TextNode Class Reference

#include <Ample.h>

Inheritance diagram for TextNode:

Collaboration diagram for TextNode:

Public Types
typedef Observer< NodeObserver >	ObserverType
typedef std::vector < NodeObserver * >	ObserverList
Public Member Functions
void	createBuffer (const std::string &name)
TextBuffer *	getBufferByID (VBufferID ID)
const TextBuffer *	getBufferByID (VBufferID ID) const
TextBuffer *	getBufferByIndex (unsigned int index)
const TextBuffer *	getBufferByIndex (unsigned int index) const
TextBuffer *	getBufferByName (const std::string &name)
const TextBuffer *	getBufferByName (const std::string &name) const
unsigned int	getBufferCount (void) const
const std::string &	getLanguage (void) const
void	setLanguage (const std::string &language)
void	destroy (void)
void	createTagGroup (const std::string &name)
TagGroup *	getTagGroupByID (uint16 ID)
const TagGroup *	getTagGroupByID (uint16 ID) const
TagGroup *	getTagGroupByIndex (unsigned int index)
const TagGroup *	getTagGroupByIndex (unsigned int index) const
TagGroup *	getTagGroupByName (const std::string &name)
const TagGroup *	getTagGroupByName (const std::string &name) const
unsigned int	getTagGroupCount (void) const
Tag *	getTagByNames (const std::string &groupName, const std::string &tagName)
const Tag *	getTagByNames (const std::string &groupName, const std::string &tagName) const
bool	isMine (void) const
VNodeID	getID (void) const
VNodeType	getType (void) const
const std::string &	getName (void) const
void	setName (const std::string &name)
Session &	getSession (void) const
unsigned int	getDataVersion (void) const
unsigned int	getStructureVersion (void) const
void	addObserver (NodeObserver &observer)
void	removeObserver (NodeObserver &observer)
void	removeObserver (Observer< NodeObserver > &observer)
const ObserverList &	getObservers (void) const
Friends
class	Session

Detailed Description

Text node class. Represents a single text node.

Member Typedef Documentation

typedef std::vector<NodeObserver *> ObserverList [inherited]

typedef Observer<NodeObserver > ObserverType [inherited]

Member Function Documentation

void addObserver ( NodeObserver & observer ) [inline, inherited]

Adds the specified observer to this object.

Parameters:

observer

The observer to add.

Remarks:: An observer can only be added once. Additional additions are ignored.

void createBuffer ( const std::string & name )

Creates a new text buffer in this node.

Parameters:

name

The desired name of the text buffer.

Remarks:: This call is asynchronous. It will not take effect until, at the earliest, after the first subsequent call to Session::update.

void createTagGroup ( const std::string & name ) [inherited]

Creates a new tag group in this node.

Parameters:

name

The desired name of the tag group.

Remarks:: This call is asynchronous. It will not take effect until, at the earliest, after the first subsequent call to Session::update.

void destroy ( void ) [inherited]

Destroys this node.

Remarks:: This call is asynchronous. It will not take effect until, at the earliest, after the first subsequent call to Session::update.

const TextBuffer* getBufferByID ( VBufferID ID ) const

Parameters:

ID

The ID of the desired text buffer.

Returns:: The text buffer with the specified ID, or NULL if no such text buffer exists.

TextBuffer* getBufferByID ( VBufferID ID )

Parameters:

ID

The ID of the desired text buffer.

Returns:: The text buffer with the specified ID, or NULL if no such text buffer exists.

const TextBuffer* getBufferByIndex ( unsigned int index ) const

Parameters:

index

The index of the desired text buffer.

Returns:: The text buffer at the specified index, or NULL if no such text buffer exists.

TextBuffer* getBufferByIndex ( unsigned int index )

Parameters:

index

The index of the desired text buffer.

Returns:: The text buffer at the specified index, or NULL if no such text buffer exists.

const TextBuffer* getBufferByName ( const std::string & name ) const

Parameters:

name

The name of the desired text buffer

Returns:: The text buffer with the specified name, or NULL if no such text buffer exists.

TextBuffer* getBufferByName ( const std::string & name )

Parameters:

name

The name of the desired text buffer

Returns:: The text buffer with the specified name, or NULL if no such text buffer exists.

unsigned int getBufferCount ( void ) const

Returns:: The number of text buffers in this node.

unsigned int getDataVersion ( void ) const [inherited]

Returns:: The current version of the internal state.

Remarks:: This value is updated for any kind of change.

VNodeID getID ( void ) const [inherited]

Returns:: The ID of this node.

const std::string& getLanguage ( void ) const

Returns:: The language of this node.

const std::string& getName ( void ) const [inherited]

Returns:: The name of this node.

const ObserverList& getObservers ( void ) const [inline, inherited]

Returns:: The list of observers attached to this object.

Session& getSession ( void ) const [inherited]

Returns:: The session containing this node.

unsigned int getStructureVersion ( void ) const [inherited]

Returns:: The current version of the internal structure.

Remarks:: This value is only updated when the internal structure changes.

const Tag* getTagByNames	(	const std::string &	groupName,
		const std::string &	tagName
	)			const `[inherited]`

Parameters:

	groupName	The name of the group of the desired tag.
	tagName	The name of the desired tag.

Returns:: The tag with the specified name, in the specified group.

Tag* getTagByNames	(	const std::string &	groupName,
		const std::string &	tagName
	)			`[inherited]`

Parameters:

	groupName	The name of the group of the desired tag.
	tagName	The name of the desired tag.

Returns:: The tag with the specified name, in the specified group.

const TagGroup* getTagGroupByID ( uint16 ID ) const [inherited]

Parameters:

ID

The ID of the desired tag group.

Returns:: The tag group with the specified ID, or NULL if no such tag group exists.

TagGroup* getTagGroupByID ( uint16 ID ) [inherited]

Parameters:

ID

The ID of the desired tag group.

Returns:: The tag group with the specified ID, or NULL if no such tag group exists.

const TagGroup* getTagGroupByIndex ( unsigned int index ) const [inherited]

Parameters:

index

The index of the desired tag group.

Returns:: The tag group at the specified index, or NULL if no such tag group exists.

TagGroup* getTagGroupByIndex ( unsigned int index ) [inherited]

Parameters:

index

The index of the desired tag group.

Returns:: The tag group at the specified index, or NULL if no such tag group exists.

const TagGroup* getTagGroupByName ( const std::string & name ) const [inherited]

Parameters:

name

The name of the desired tag group.

Returns:: The tag group with the specified name, or NULL if no such tag group exists.

TagGroup* getTagGroupByName ( const std::string & name ) [inherited]

Parameters:

name

The name of the desired tag group.

Returns:: The tag group with the specified name, or NULL if no such tag group exists.

unsigned int getTagGroupCount ( void ) const [inherited]

Returns:: The number of tag groups in this node.

VNodeType getType ( void ) const [inherited]

Returns:: The type of this node.

bool isMine ( void ) const [inherited]

Returns:: true if this node was created from this client, otherwise false.

void removeObserver ( Observer< NodeObserver > & observer ) [inline, inherited]

Removes the specified observer from this object.

Parameters:

observer

The observer to remove.

void removeObserver ( NodeObserver & observer ) [inline, inherited]

Removes the specified observer from this object.

Parameters:

observer

The observer to remove.

void setLanguage ( const std::string & language )

Changes the language of this node.

Parameters:

language

The desired language.

Remarks:: This call is asynchronous. It will not take effect until, at the earliest, after the first subsequent call to Session::update.

void setName ( const std::string & name ) [inherited]

Changes the name of this node.

Parameters:

name

The desired name.

Remarks:: This call is asynchronous. It will not take effect until, at the earliest, after the first subsequent call to Session::update.

Friends And Related Function Documentation

friend class Session [friend]

Reimplemented from Node.

TextNode Class Reference

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

Member Function Documentation

Friends And Related Function Documentation