Defines a hierarchical structure. More...

#include <TreeItem.h>

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

Instantiation Methods
Methods related to creation and destruction of the object.
std::string	m_type
	Item type.

std::unique_ptr< Queue >	m_children
	Queue of items (children).

TreeItem *	m_parent
	Pointer to the parent.

	TreeItem (const std::string &type)
	Constructor.

virtual	~TreeItem ()
	Destructor.

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

virtual void	addChild (TreeItem *item)
	Adds a child to the item. The child is added to the end of the list.

virtual void	insertChild (TreeItem *item, const size_t &pos)
	Inserts a child item at the desired position.

TreeItem *	getChild (const size_t &pos) const
	Returns the child located at pos.

TreeItem *	getParent () const
	Returns the item parent.

TreeItem *	removeChild (const size_t &pos)
	Removes the child located at pos from the children list.

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

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

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

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

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

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

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

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

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

void	removeAllChilds ()
	Removes all children.

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

Detailed Description

Defines a hierarchical structure.

Definition at line 72 of file TreeItem.h.

Constructor & Destructor Documentation

◆ TreeItem()

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

Constructor.

Parameters

type	The type of the item.

Referenced by te::qt::widgets::FolderItem::addChild(), addChild(), getChild(), getParent(), te::qt::widgets::FolderItem::insertChild(), insertChild(), removeChild(), and setParent().

◆ ~TreeItem()

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

virtual

Destructor.

Member Function Documentation

◆ addChild()

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

virtual

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

Parameters

item	The child to be inserted.

Reimplemented in te::qt::widgets::FolderItem.

References TreeItem().

◆ flags()

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::ChartItem, te::qt::widgets::ChartSliceItem, te::qt::widgets::ColorMapItem, te::qt::widgets::ColorMapSliceItem, te::qt::widgets::FolderItem, te::qt::widgets::LayerItem, te::qt::widgets::LegendItem, te::qt::widgets::RuleItem, and te::qt::widgets::StyleItem.

◆ getAsString()

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::ChartItem, te::qt::widgets::ChartSliceItem, te::qt::widgets::ColorMapItem, te::qt::widgets::ColorMapSliceItem, te::qt::widgets::FolderItem, te::qt::widgets::LayerItem, te::qt::widgets::LegendItem, te::qt::widgets::RuleItem, and te::qt::widgets::StyleItem.

◆ getChild()

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

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.

References TreeItem().

◆ getChildren()

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.

◆ getChildrenCount()

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.

◆ getParent()

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

Returns the item parent.

Returns: A pointer to the parent.

References TreeItem().

◆ getPosition()

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.

◆ getToolTip()

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, te::qt::widgets::RuleItem, and te::qt::widgets::StyleItem.

◆ getType()

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

Returns the type of the item.

Returns: Type of the item.

◆ hasChildren()

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.

◆ insertChild()

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

virtual

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.

Reimplemented in te::qt::widgets::FolderItem.

References TreeItem().

◆ isVisible()

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::ChartItem, te::qt::widgets::FolderItem, te::qt::widgets::LayerItem, and te::qt::widgets::RuleItem.

◆ removeAllChilds()

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

Removes all children.

◆ removeChild()

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

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.

References TreeItem().

◆ setParent()

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

Updates the item parent.

Parameters

item	The new parent.

References TreeItem().

◆ setVisible()

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::ChartItem, te::qt::widgets::FolderItem, te::qt::widgets::LayerItem, and te::qt::widgets::RuleItem.

Member Data Documentation

◆ m_children

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

protected

Queue of items (children).

Definition at line 237 of file TreeItem.h.

◆ m_parent

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

protected

Pointer to the parent.

Definition at line 238 of file TreeItem.h.

◆ m_type

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_release/src/terralib/qt/widgets/layer/explorer/TreeItem.h

Instantiation Methods

Detailed Description

Constructor & Destructor Documentation

◆ TreeItem()

◆ ~TreeItem()

Member Function Documentation

◆ addChild()

◆ flags()

◆ getAsString()

◆ getChild()

◆ getChildren()

◆ getChildrenCount()

◆ getParent()

◆ getPosition()

◆ getToolTip()

◆ getType()

◆ hasChildren()

◆ insertChild()

◆ isVisible()

◆ removeAllChilds()

◆ removeChild()

◆ setParent()

◆ setVisible()

Member Data Documentation

◆ m_children

◆ m_parent

◆ m_type