TdkTreeLegendItem Class Reference

Defines the TdkTreeLegendItem class. Defines an interface for a tree legend item. More...

#include <TdkTreeLegendItem.h>

Inheritance diagram for TdkTreeLegendItem:

List of all members.

Constructor and Destructor Methods
Methods related to instantiation and destruction.
	TdkTreeLegendItem (const int &typeNode)
	Constructor.
static TdkTreeLegendItem *	DefaultObject ()
	Method used by Abstract Factory. Returns a default object.
Public Types
This enum specifies the possible item types.
enum	itemTypes { THEME, LAYER, VIEW, DATABASE }
Public Member Functions
Behavioral Methods
Methods related tree legend item behavior.
virtual int	getItemId ()=0
	Retrieves the terralib object id of the node.
int	getItemType ()
	Retrieves the node type: THEME, LAYER, VIEW, DATABASE.
virtual void	setOpen (const bool &open)=0
	Updates the open state of node.
virtual bool	isOpen ()=0
	Retrieves open state of node.
virtual string	getText ()=0
	Retrieves node's visible text.
Private Attributes
int	_itemType
	Node type: THEME, LAYER, VIEW, DATABASE.

---

Detailed Description

Defines the TdkTreeLegendItem class. Defines an interface for a tree legend item.

---

Member Enumeration Documentation

enum TdkTreeLegendItem::itemTypes

Enumerator:

THEME	Type theme
LAYER	Type layer
VIEW	Type view
DATABASE	Type database

---

Constructor & Destructor Documentation

TdkTreeLegendItem::TdkTreeLegendItem

(

const int &

typeNode

)

[inline]

Constructor.

Parameters:

typeNode

Node type: THEME, LAYER, VIEW, DATABASE.

---

Member Function Documentation

static TdkTreeLegendItem* TdkTreeLegendItem::DefaultObject

(

)

[inline, static]

Method used by Abstract Factory. Returns a default object.

virtual int TdkTreeLegendItem::getItemId

(

)

[pure virtual]

Retrieves the terralib object id of the node.

Returns:

Terralib object id.

int TdkTreeLegendItem::getItemType

(

)

[inline]

Retrieves the node type: THEME, LAYER, VIEW, DATABASE.

Returns:

Node type.

virtual void TdkTreeLegendItem::setOpen

(

const bool &

open

)

[pure virtual]

Updates the open state of node.

Parameters:

open

New open state of the node. True - node openend, False - node closed.

virtual bool TdkTreeLegendItem::isOpen

(

)

[pure virtual]

Retrieves open state of node.

Returns:

True if node is open, false otherwise.

virtual string TdkTreeLegendItem::getText

(

)

[pure virtual]

Retrieves node's visible text.

Returns:

Node's visible text.

---

Member Data Documentation

int TdkTreeLegendItem::_itemType [private]

Node type: THEME, LAYER, VIEW, DATABASE.

---

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

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

---