TdkFCTTreeLegend Class Reference

Defines the TdkFCTTreeLegend class. Defines the tree legend. More...

#include <TdkFCTTreeLegend.h>

List of all members.

Public Member Functions
Constructor and Destructor Methods
Methods related to instantiation and destruction.
	TdkFCTTreeLegend ()
	Constructor.
virtual	~TdkFCTTreeLegend ()
	Virtual destructor.
Behavioral Methods
Methods related to tree behavior.
virtual void	insertItem (TdkTreeLegendItem *item)=0
	Inserts a TdkTreeLegendItem in the tree.
virtual void	removeItem (TdkTreeLegendItem *item)=0
	Removes a TdkTreeLegendItem in the tree.
virtual TdkTreeLegendItem *	getItem (const TdkTreeLegendItem::itemTypes &type, const int &itemId)=0
	Retrieves the correspondent tree legend item.
virtual TdkTreeLegendItem *	getCurrentItem (const TdkTreeLegendItem::itemTypes &type)=0
	Retrieves the selected tree legend item.
virtual TdkTreeLegendParams *	getItemParams ()=0
	Retrieves params for a new TdkTreeLegend could be created.
virtual void	clear ()=0
	Clears tree legend.
virtual void	selectItem (TdkTreeLegendItem *item)=0
	Selects the correspondent tree legend item.
virtual TdkTreeLegendItem *	getPopupItem ()=0
	Retrieves the tree legend item that calls popup menu.
virtual void	showItemOutPopupMnu ()=0
	Shows popup menu. This menu is showed when no tree legend item was clicked.
virtual vector< TdkTreeLegendItem * >	getChildren (const int &typeItem=-1)=0
	Returns a vector of pointers to the tree legend children itens.

---

Detailed Description

Defines the TdkFCTTreeLegend class. Defines the tree legend.

This class defines the themes or layers tree.

TODO: 1) 2) 3)

See also:

TdkTreeLegendItem, TdkPopupMenu, TdkTreeLegendParams

---

Constructor & Destructor Documentation

TdkFCTTreeLegend::TdkFCTTreeLegend

(

)

[inline]

Constructor.

TdkFCTTreeLegend::~TdkFCTTreeLegend

(

)

[inline, virtual]

Virtual destructor.

---

Member Function Documentation

virtual void TdkFCTTreeLegend::insertItem

(

TdkTreeLegendItem *

item

)

[pure virtual]

Inserts a TdkTreeLegendItem in the tree.

Parameters:

item

A tree legend item.

virtual void TdkFCTTreeLegend::removeItem

(

TdkTreeLegendItem *

item

)

[pure virtual]

Removes a TdkTreeLegendItem in the tree.

Parameters:

item

Tree legend item to be removed.

virtual TdkTreeLegendItem* TdkFCTTreeLegend::getItem	(	const TdkTreeLegendItem::itemTypes &	type,
		const int &	itemId
	)			[pure virtual]

Retrieves the correspondent tree legend item.

Parameters:

	type	Item type: Theme, Layer, Database, View.
	itemId	Terralib id of the object.

virtual TdkTreeLegendItem* TdkFCTTreeLegend::getCurrentItem

(

const TdkTreeLegendItem::itemTypes &

type

)

[pure virtual]

Retrieves the selected tree legend item.

Parameters:

type

Item type: Theme, Layer, Database, View.

Returns:

Legend item with correspondent type and id.

virtual TdkTreeLegendParams* TdkFCTTreeLegend::getItemParams

(

)

[pure virtual]

Retrieves params for a new TdkTreeLegend could be created.

Returns:

Params for a new TdkTreeLegend to be created.

virtual void TdkFCTTreeLegend::clear

(

)

[pure virtual]

Clears tree legend.

virtual void TdkFCTTreeLegend::selectItem

(

TdkTreeLegendItem *

item

)

[pure virtual]

Selects the correspondent tree legend item.

Parameters:

item

Item to be selected.

virtual TdkTreeLegendItem* TdkFCTTreeLegend::getPopupItem

(

)

[pure virtual]

Retrieves the tree legend item that calls popup menu.

Returns:

Item that called popup menu.

virtual void TdkFCTTreeLegend::showItemOutPopupMnu

(

)

[pure virtual]

Shows popup menu. This menu is showed when no tree legend item was clicked.

virtual vector<TdkTreeLegendItem*> TdkFCTTreeLegend::getChildren

(

const int &

typeItem = -1

)

[pure virtual]

Returns a vector of pointers to the tree legend children itens.

Parameters:

typeItem

Node type requested. Types allowed: DATABASE, LAYER, VIEW, THEME.

Returns:

Vector with all tree legend children itens.

---

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

• D:/usuarios/rodrigof/svn/tdk/src/peer/components/ui/TdkFCTTreeLegend.h

---