te::qt::widgets::ColorMapSliceItem Class Reference

A class that represents a slice of a ColorMapItem. More...

#include <ColorMapSliceItem.h>

Inheritance diagram for te::qt::widgets::ColorMapSliceItem:
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...
 
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...
 
QIcon getIcon () const
 Returns the icon to be presented in the tree. More...
 
TreeItemgetParent () 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...
 
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...
 
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.

 ColorMapSliceItem (const std::string &label, const QColor &beg, const QColor &end=QColor())
 Constructor. More...
 
 ~ColorMapSliceItem ()
 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...
 

Protected Attributes

std::auto_ptr< Queuem_children
 Queue of items (children). More...
 
QIcon m_icon
 Icon to be presented. More...
 
std::string m_label
 Label to be presented on the Qt view. More...
 
TreeItemm_parent
 Pointer to the parent. More...
 
std::string m_type
 Item type. More...
 

Detailed Description

A class that represents a slice of a ColorMapItem.

Note
The type of the item is "COLORMAPSLICE".

Definition at line 50 of file ColorMapSliceItem.h.

Constructor & Destructor Documentation

te::qt::widgets::ColorMapSliceItem::ColorMapSliceItem ( const std::string &  label,
const QColor &  beg,
const QColor &  end = QColor() 
)

Constructor.

Parameters
labelLabel to be presented in the Qt view.
begBegin color.
endEnd color.
Note
Use end for slices with mixed colors.
te::qt::widgets::ColorMapSliceItem::~ColorMapSliceItem ( )

Destructor.

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.
virtual Qt::ItemFlags te::qt::widgets::TreeItem::flags ( )
virtualinherited

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.

std::string te::qt::widgets::ColorMapSliceItem::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.

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.
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.
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.
QIcon te::qt::widgets::ColorMapSliceItem::getIcon ( ) const

Returns the icon to be presented in the tree.

Returns
Icon to be presented.
TreeItem* te::qt::widgets::TreeItem::getParent ( ) const
inherited

Returns the item parent.

Returns
A pointer to the parent.
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.
virtual 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.

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

Returns the type of the item.

Returns
Type of the item.
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.
void te::qt::widgets::TreeItem::insertChild ( TreeItem item,
const size_t &  pos 
)
throw (te::common::Exception
)
inherited

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.
virtual VISIBLE te::qt::widgets::TreeItem::isVisible ( ) const
virtualinherited

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 ( )
inherited

Removes all children.

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.
void te::qt::widgets::TreeItem::setParent ( TreeItem item)
inherited

Updates the item parent.

Parameters
itemThe new parent.
virtual void te::qt::widgets::TreeItem::setVisible ( const VISIBLE visible,
const bool &  updateAncestors = false,
const bool &  updateDescendents = false 
)
virtualinherited

Updates the visibilty state of the item.

Parameters
visibleThe new visibility state.
updateAncestorsUpdates also ancestors states.
updateDescendentsUpdates 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
protectedinherited

Queue of items (children).

Definition at line 237 of file TreeItem.h.

QIcon te::qt::widgets::ColorMapSliceItem::m_icon
protected

Icon to be presented.

Definition at line 96 of file ColorMapSliceItem.h.

std::string te::qt::widgets::ColorMapSliceItem::m_label
protected

Label to be presented on the Qt view.

Definition at line 95 of file ColorMapSliceItem.h.

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

Pointer to the parent.

Definition at line 238 of file TreeItem.h.

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

Item type.

Definition at line 236 of file TreeItem.h.


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