class TcGfxCompList

Class: TcGfxCompList

Public Fields

template <class Item> friend class TcGfxChildIterator
Friend declaration.

Public Methods

TcGfxCompList()
Constructor
~TcGfxCompList()
Destructor
const TcGfxCompList& operator=(const TcGfxCompList &right)
Assignment Operation
int addListItem(TcGfxComponent *item)
Add a TcGfxComponent to the list
int removeListItem(TcGfxComponent *item)
Remove a TcGfxComponent from the list
void printDebug()
Print the items in the list to standard out by CompName.
const TcGfxComponent* getCompByName(const TcUtString &name)
Return a pointer to the item with the string name, name
bool isEmpty()
Returns true if the list is empty, and false otherwise.

Documentation

Class: TcGfxCompList.

Role: This class provides an interface to a list of TcGfxComponents.

Each child can be leaf nodes or other groups containing lists.

Responsibilities: It adds and removes TcGfxComponents. Returns dynamically allocated iterators to its children.

template <class Item> friend class TcGfxChildIterator
Friend declaration.

TcGfxCompList()
Constructor

~TcGfxCompList()
Destructor

const TcGfxCompList& operator=(const TcGfxCompList &right)
Assignment Operation

int addListItem(TcGfxComponent *item)
Add a TcGfxComponent to the list. The compName must be defined in the item, and it must be unqie in the list. A return value of 1 indicates a successful insertion, 0 means that the name already exists.

int removeListItem(TcGfxComponent *item)
Remove a TcGfxComponent from the list. A return value of 1 indicates a successful deletion, 0 means that the name already exists.

void printDebug()
Print the items in the list to standard out by CompName.

const TcGfxComponent* getCompByName(const TcUtString &name)
Return a pointer to the item with the string name, name. Returns NULL if not found.
Parameters:
name - String name of a TcGfxComponent.

bool isEmpty()
Returns true if the list is empty, and false otherwise.

This class has no child classes.

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de