Represents a folder item that contains layers and / or other folders. More...

#include <FolderItem.h>

Inheritance diagram for te::qt::widgets::FolderItem:

Public Member Functions
void	addChild (TreeItem *item)
	Adds a child to the item. The child is added to the end of the list. 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...

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...

void	setTitle (const std::string &title)
	Updates the title of the folder. More...

Instantiation Methods
Methods related to creation and destruction of the object.
	FolderItem (te::map::AbstractLayerPtr layer)
	Constructor. More...

	~FolderItem ()
	Destructor. More...

Reimplementation of TreeItem
Methods reimplemented of the TreeItem class.
std::string	getAsString () const
	Returns the label of the item to be presented in a Qt view. More...

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

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

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

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

te::map::AbstractLayerPtr	m_layer
	The asbtract layer. More...

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

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

Detailed Description

Represents a folder item that contains layers and / or other folders.

Note: The type of the item is "FOLDER".

Definition at line 48 of file FolderItem.h.

Constructor & Destructor Documentation

te::qt::widgets::FolderItem::FolderItem ( te::map::AbstractLayerPtr layer )

Constructor.

Parameters

layer The layer of the item.

Definition at line 27 of file FolderItem.cpp.

References ~FolderItem().

te::qt::widgets::FolderItem::~FolderItem ( )

default

Destructor.

Referenced by FolderItem().

Member Function Documentation

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

inherited

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

Parameters

item	The child to be inserted.

Definition at line 44 of file qt/widgets/layer/explorer/TreeItem.cpp.

References te::qt::widgets::TreeItem::m_children, and te::qt::widgets::TreeItem::setParent().

Referenced by AddRuleItems(), AddSliceItems(), GetFolder(), GetRootFolder(), te::qt::widgets::LayerItem::LayerItem(), te::qt::widgets::RuleItem::RuleItem(), and te::qt::widgets::LayerItem::updateLegend().

Qt::ItemFlags te::qt::widgets::FolderItem::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 from te::qt::widgets::TreeItem.

Definition at line 65 of file FolderItem.cpp.

References te::qt::widgets::TreeItem::flags().

std::string te::qt::widgets::FolderItem::getAsString ( ) const

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.

Implements te::qt::widgets::TreeItem.

Definition at line 36 of file FolderItem.cpp.

References m_layer.

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

inherited

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.

Definition at line 61 of file qt/widgets/layer/explorer/TreeItem.cpp.

References te::qt::widgets::TreeItem::m_children.

Referenced by GetAllLayers(), GetVisibility(), GetVisibleLayers(), te::qt::widgets::LayerItemModel::index(), and setVisible().

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

inherited

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.

Definition at line 94 of file qt/widgets/layer/explorer/TreeItem.cpp.

References te::qt::widgets::TreeItem::m_children, te::common::NodeT< T >::m_next, and te::common::NodeT< T >::m_value.

Referenced by te::qt::widgets::TreeItem::getChildrenCount(), te::qt::widgets::LayerItem::updateChart(), te::qt::widgets::LayerItemView::updateChart(), te::qt::widgets::LayerItemView::updateLegend(), and te::qt::widgets::LayerItem::~LayerItem().

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

inherited

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.

Definition at line 82 of file qt/widgets/layer/explorer/TreeItem.cpp.

References te::qt::widgets::TreeItem::getChildren(), and te::qt::widgets::TreeItem::m_children.

Referenced by te::qt::widgets::LayerItemModel::addItems(), GetAllLayers(), GetVisibility(), GetVisibleLayers(), te::qt::widgets::TreeItem::hasChildren(), te::qt::widgets::LayerItemModel::index(), te::qt::widgets::LayerItemModel::rowCount(), and setVisible().

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

inherited

Returns the item parent.

Returns: A pointer to the parent.

Definition at line 69 of file qt/widgets/layer/explorer/TreeItem.cpp.

References te::qt::widgets::TreeItem::m_parent.

Referenced by te::qt::widgets::LayerItemModel::addItems(), GetAllLayers(), te::qt::widgets::LayerItemView::mouseDoubleClickEvent(), te::qt::af::BaseApplication::onLayerRemoveTriggered(), te::qt::widgets::LayerItemModel::parent(), and te::qt::widgets::LayerItemModel::setData().

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

inherited

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

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

Definition at line 115 of file qt/widgets/layer/explorer/TreeItem.cpp.

References te::qt::widgets::TreeItem::m_children, and te::qt::widgets::TreeItem::m_parent.

Referenced by te::qt::widgets::LayerItemModel::addItems(), te::qt::widgets::LayerItemModel::parent(), te::qt::widgets::LayerItemView::updateChart(), te::qt::widgets::LayerItem::updateLegend(), and te::qt::widgets::LayerItemView::updateLegend().

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

virtualinherited

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.

Definition at line 134 of file qt/widgets/layer/explorer/TreeItem.cpp.

Referenced by te::qt::widgets::LayerItemModel::data().

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

inherited

Returns the type of the item.

Returns: Type of the item.

Definition at line 129 of file qt/widgets/layer/explorer/TreeItem.cpp.

References te::qt::widgets::TreeItem::m_type.

Referenced by te::qt::widgets::LayerViewMenuManager::eventFilter(), Expand(), FindInsertInformation(), te::qt::widgets::LayerItemView::findLayerIndex(), GetAllLayers(), GetAllSTLayers(), GetAllWFSLayers(), GetAllWMSLayers(), GetAvailableLayers(), te::qt::widgets::GetChangedAndVisibleLayers(), te::qt::widgets::LayerViewDelegate::getIcon(), GetParent(), GetSelectedLayer(), GetSelectedLayers(), te::qt::widgets::GetValidLayers(), GetVisibleLayers(), te::qt::widgets::LayerItemView::mouseDoubleClickEvent(), te::qt::af::LayerExplorer::onApplicationTriggered(), TerraView::onLayerDuplicateLayerTriggered(), te::qt::af::BaseApplication::onLayerRenameTriggered(), te::qt::plugins::wms::WMSItemDelegate::paint(), te::qt::plugins::wfs::WFSItemDelegate::paint(), EditDelegate::paint(), te::qt::plugins::st::STItemDelegate::paint(), te::qt::widgets::RasterLayerDelegate::paint(), te::qt::widgets::ThemeViewDelegate::paint(), te::ws::ogc::wms::qt::WMSItemDelegate::paint(), te::qt::widgets::LayerViewDelegate::paint(), and te::qt::widgets::LayerItemModel::setData().

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

inherited

Tells us if the item has children or not.

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

Definition at line 110 of file qt/widgets/layer/explorer/TreeItem.cpp.

References te::qt::widgets::TreeItem::getChildrenCount().

Referenced by te::qt::widgets::LayerItemModel::addLayers().

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

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 from te::qt::widgets::TreeItem.

Definition at line 75 of file FolderItem.cpp.

References te::qt::widgets::LayerItem::getLayer(), te::qt::widgets::TreeItem::insertChild(), and m_layer.

te::qt::widgets::VISIBLE te::qt::widgets::FolderItem::isVisible ( ) const

virtual

Returns the visibilty state of the item.

Returns: The state of visibilty of the item.

Reimplemented from te::qt::widgets::TreeItem.

Definition at line 41 of file FolderItem.cpp.

References GetVisibility().

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

inherited

Removes all children.

Definition at line 139 of file qt/widgets/layer/explorer/TreeItem.cpp.

References te::qt::widgets::TreeItem::m_children.

Referenced by te::qt::widgets::StyleItem::updateStyle().

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

inherited

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.

Definition at line 74 of file qt/widgets/layer/explorer/TreeItem.cpp.

References te::qt::widgets::TreeItem::m_children.

Referenced by te::qt::widgets::LayerItemModel::addItems(), and te::qt::widgets::LayerItemModel::removeRows().

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

inherited

Updates the item parent.

Parameters

item	The new parent.

Definition at line 39 of file qt/widgets/layer/explorer/TreeItem.cpp.

References te::qt::widgets::TreeItem::m_parent.

Referenced by te::qt::widgets::TreeItem::addChild(), and te::qt::widgets::LayerItem::~LayerItem().

void te::qt::widgets::FolderItem::setTitle ( const std::string & title )

Updates the title of the folder.

Parameters

title The new item title.

Definition at line 70 of file FolderItem.cpp.

References m_layer.

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