te::qt::widgets::LayerItem Class Reference

An item that contains a te::map::AbstractLayerPtr. More...

#include <LayerItem.h>

Inheritance diagram for te::qt::widgets::LayerItem:
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...
 
TreeItemgetChild (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...
 
te::map::AbstractLayerPtr getLayer () const
 Returns the layer contained in the item. More...
 
TreeItemgetParent () const
 Returns the item parent. More...
 
int getPosition ()
 Returns the position of item in its parent's list of children. More...
 
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...
 
virtual 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...
 
TreeItemremoveChild (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 updateChart ()
 Updates the chart item. More...
 
int updateLegend ()
 updateLegend More...
 
Instantiation Methods

Methods related to creation and destruction of the object.

 LayerItem (te::map::AbstractLayerPtr layer)
 Constructor. More...
 
 ~LayerItem ()
 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< Queuem_children
 Queue of items (children). More...
 
te::map::AbstractLayerPtr m_layer
 The asbtract layer. More...
 
TreeItemm_parent
 Pointer to the parent. More...
 
std::string m_type
 Item type. More...
 

Detailed Description

An item that contains a te::map::AbstractLayerPtr.

Note
The type of the item is "LAYER".

Definition at line 51 of file LayerItem.h.

Constructor & Destructor Documentation

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

Constructor.

Parameters
layerThe layer of the item.

Definition at line 89 of file LayerItem.cpp.

References te::qt::widgets::TreeItem::addChild(), m_layer, and updateChart().

te::qt::widgets::LayerItem::~LayerItem ( )

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
itemThe 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(), LayerItem(), te::qt::widgets::RuleItem::RuleItem(), and updateLegend().

Qt::ItemFlags te::qt::widgets::LayerItem::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 135 of file LayerItem.cpp.

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

std::string te::qt::widgets::LayerItem::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 117 of file LayerItem.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
posThe position of the desired child at the children list.
Returns
The child item located at pos.
Exceptions
Ifpos 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 te::qt::widgets::FolderItem::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]itemsThe set of items founded.
typeThe 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(), updateChart(), te::qt::widgets::LayerItemView::updateChart(), te::qt::widgets::LayerItemView::updateLegend(), and ~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
typeThe 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 te::qt::widgets::FolderItem::setVisible().

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(), updateLegend(), and te::qt::widgets::LayerItemView::updateLegend().

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

Returns the item tooltip (for information purposes).

Returns
The item tooltip.

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

Definition at line 164 of file LayerItem.cpp.

References BuildToolIip().

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::TreeItem::insertChild ( TreeItem item,
const size_t &  pos 
)
throw (te::common::Exception
)
virtualinherited

Inserts a child item at the desired position.

Parameters
itemThe child to be inserted.
posThe position of the child in the children list.
Exceptions
Ifpos is greater than the children list size, a te::common::Exception will be raised.

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

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

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

Referenced by te::qt::widgets::LayerItemModel::addFolder(), te::qt::widgets::LayerItemModel::addItems(), te::qt::widgets::LayerItemModel::addLayer(), te::qt::widgets::LayerItemModel::addLayers(), te::qt::widgets::FolderItem::insertChild(), and updateChart().

te::qt::widgets::VISIBLE te::qt::widgets::LayerItem::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 122 of file LayerItem.cpp.

References m_layer, te::qt::widgets::NONE, te::qt::widgets::TOTALLY, and te::map::VISIBLE.

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
posThe position of the desired child at the children list.
Returns
The removed item.
Exceptions
Ifpos 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
itemThe 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 ~LayerItem().

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

Updates the visibilty state of the item.

Parameters
visibleThe new visibility state.
updateAncestorsUpdates also ancestors states.
updateDescendentsUpdates also descendents states.

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

Definition at line 127 of file LayerItem.cpp.

References m_layer, te::qt::widgets::TreeItem::m_parent, te::map::NOT_VISIBLE, te::qt::widgets::TreeItem::setVisible(), te::qt::widgets::TOTALLY, and te::map::VISIBLE.

void te::qt::widgets::LayerItem::updateChart ( )

Updates the chart item.

Definition at line 145 of file LayerItem.cpp.

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

Referenced by LayerItem().

int te::qt::widgets::LayerItem::updateLegend ( )

Member Data Documentation

te::map::AbstractLayerPtr te::qt::widgets::LayerItem::m_layer
protected

The asbtract layer.

Definition at line 115 of file LayerItem.h.

Referenced by getAsString(), getLayer(), isVisible(), LayerItem(), setVisible(), updateChart(), and updateLegend().

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

Item type.

Definition at line 236 of file qt/widgets/layer/explorer/TreeItem.h.

Referenced by te::qt::widgets::TreeItem::getType().


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