Defines a hierarchical structure. More...

#include <TreeItem.h>

Inheritance diagram for te::qt::widgets::TreeItem:

Public Member Functions
void	addChild (TreeItem *item)
	Adds a child to the item. The child is added to the end of the list. More...

virtual Qt::ItemFlags	flags ()
	Returns the flags to be used by the model. More...

virtual std::string	getAsString () const =0
	Returns the label of the item to be presented in a Qt view. More...

TreeItem *	getChild (const size_t &pos) const throw (te::common::Exception)
	Returns the child located at pos. More...

void	getChildren (std::vector< TreeItem * > &items, const std::string &type) const
	Returns all children of a certain type. More...

size_t	getChildrenCount (const std::string &type) const
	Returns the number of children. More...

TreeItem *	getParent () const
	Returns the item parent. More...

int	getPosition ()
	Returns the position of item in its parent's list of children. More...

virtual std::string	getToolTip () const
	Returns the item tooltip (for information purposes). More...

std::string	getType () const
	Returns the type of the item. More...

bool	hasChildren () const
	Tells us if the item has children or not. More...

void	insertChild (TreeItem *item, const size_t &pos) throw (te::common::Exception)
	Inserts a child item at the desired position. More...

virtual VISIBLE	isVisible () const
	Returns the visibilty state of the item. More...

void	removeAllChilds ()
	Removes all children. More...

TreeItem *	removeChild (const size_t &pos) throw (te::common::Exception)
	Removes the child located at pos from the children list. More...

void	setParent (TreeItem *item)
	Updates the item parent. More...

virtual void	setVisible (const VISIBLE &visible, const bool &updateAncestors=false, const bool &updateDescendents=false)
	Updates the visibilty state of the item. More...

Instantiation Methods
Methods related to creation and destruction of the object.
	TreeItem (const std::string &type)
	Constructor. More...

virtual	~TreeItem ()
	Destructor. More...

Protected Attributes
std::auto_ptr< Queue >	m_children
	Queue of items (children). More...

TreeItem *	m_parent
	Pointer to the parent. More...

std::string	m_type
	Item type. More...

Detailed Description

Defines a hierarchical structure.

Definition at line 72 of file TreeItem.h.

Constructor & Destructor Documentation

te::qt::widgets::TreeItem::TreeItem ( const std::string & type )

Constructor.

Parameters

type	The type of the item.

virtual te::qt::widgets::TreeItem::~TreeItem ( )

virtual

Destructor.

Member Function Documentation

void te::qt::widgets::TreeItem::addChild ( TreeItem * item )

Adds a child to the item. The child is added to the end of the list.

Parameters

item	The child to be inserted.

virtual Qt::ItemFlags te::qt::widgets::TreeItem::flags ( )

virtual

Returns the flags to be used by the model.

Returns: Qt flags. By default itens are enabled, editable and selectable. If you want to change the flags reimplement this method in a subclass.

Reimplemented in te::qt::widgets::LegendItem, te::qt::widgets::LayerItem, te::qt::widgets::ChartItem, te::qt::widgets::GroupingItem, te::qt::widgets::ChartSliceItem, and te::qt::widgets::FolderItem.

virtual std::string te::qt::widgets::TreeItem::getAsString ( ) const

pure virtual

Returns the label of the item to be presented in a Qt view.

Returns: The item label, to be presented in a Qt view.

Implemented in te::qt::widgets::LegendItem, te::qt::widgets::ColorMapSliceItem, te::qt::widgets::ChartSliceItem, te::qt::widgets::ColorMapItem, te::qt::widgets::LayerItem, te::qt::widgets::ChartItem, te::qt::widgets::GroupingItem, and te::qt::widgets::FolderItem.

TreeItem* te::qt::widgets::TreeItem::getChild	(	const size_t &	pos	)	const
throw	(	te::common::Exception
	)

Returns the child located at pos.

Parameters

pos	The position of the desired child at the children list.

Returns: The child item located at pos.

Exceptions

If	pos is greater or equal than the children list size, a te::common::Exception will be raised.

void te::qt::widgets::TreeItem::getChildren	(	std::vector< TreeItem * > &	items,
		const std::string &	type
	)		const

Returns all children of a certain type.

Parameters

[out]	items	The set of items founded.
	type	The type of items that we are searching for.

size_t te::qt::widgets::TreeItem::getChildrenCount ( const std::string & type ) const

Returns the number of children.

The type, defines the type of children we want to considere in the operation. If an empty string is given as argument, all kinds of children will be considered.

Parameters

type	The type of children we want to calculate the number.

Returns: Number of children of type type.

TreeItem* te::qt::widgets::TreeItem::getParent ( ) const

Returns the item parent.

Returns: A pointer to the parent.

int te::qt::widgets::TreeItem::getPosition ( )

Returns the position of item in its parent's list of children.

Returns: The position of item in its parent's list of children.

virtual std::string te::qt::widgets::TreeItem::getToolTip ( ) const

virtual

Returns the item tooltip (for information purposes).

Returns: The item tooltip.

Reimplemented in te::qt::widgets::LayerItem.

std::string te::qt::widgets::TreeItem::getType ( ) const

Returns the type of the item.

Returns: Type of the item.

bool te::qt::widgets::TreeItem::hasChildren ( ) const

Tells us if the item has children or not.

Returns: True if children list is not empty and false otherwise.

void te::qt::widgets::TreeItem::insertChild	(	TreeItem *	item,
		const size_t &	pos
	)
throw	(	te::common::Exception
	)

Inserts a child item at the desired position.

Parameters

item	The child to be inserted.
pos	The position of the child in the children list.

Exceptions

If	pos is greater than the children list size, a te::common::Exception will be raised.

virtual VISIBLE te::qt::widgets::TreeItem::isVisible ( ) const

virtual

Returns the visibilty state of the item.

Returns: The state of visibilty of the item.

Reimplemented in te::qt::widgets::LayerItem, te::qt::widgets::ChartItem, te::qt::widgets::GroupingItem, and te::qt::widgets::FolderItem.

void te::qt::widgets::TreeItem::removeAllChilds ( )

Removes all children.

TreeItem* te::qt::widgets::TreeItem::removeChild	(	const size_t &	pos	)
throw	(	te::common::Exception
	)

Removes the child located at pos from the children list.

Parameters

pos	The position of the desired child at the children list.

Returns: The removed item.

Exceptions

If	pos is greater or equal than the children list size, a te::common::Exception will be raised.

void te::qt::widgets::TreeItem::setParent ( TreeItem * item )

Updates the item parent.

Parameters

item	The new parent.

virtual void te::qt::widgets::TreeItem::setVisible	(	const VISIBLE &	visible,
		const bool &	updateAncestors = `false`,
		const bool &	updateDescendents = `false`
	)

virtual

Updates the visibilty state of the item.

Parameters

visible	The new visibility state.
updateAncestors	Updates also ancestors states.
updateDescendents	Updates also descendents states.

Reimplemented in te::qt::widgets::LayerItem, te::qt::widgets::ChartItem, te::qt::widgets::GroupingItem, and te::qt::widgets::FolderItem.

Member Data Documentation

std::auto_ptr<Queue> te::qt::widgets::TreeItem::m_children

protected

Queue of items (children).

Definition at line 237 of file TreeItem.h.

TreeItem* te::qt::widgets::TreeItem::m_parent

protected

Pointer to the parent.

Definition at line 238 of file TreeItem.h.

std::string te::qt::widgets::TreeItem::m_type

protected

Item type.

Definition at line 236 of file TreeItem.h.

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

/home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/qt/widgets/layer/explorer/TreeItem.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation