TerraLib 4.1
TeViewNode Class Reference

A class to deal with nodes of a view. More...

#include <TeViewNode.h>

Inheritance diagram for TeViewNode:
TeAbstractTheme TeViewTree TeFileTheme TeSFSTheme TeTheme TeExternalTheme

List of all members.

Public Member Functions

 TeViewNode (const string &name="", TeViewNode *parent=0, const int &view=0, const int &id=0, const int &nodeType=0)
 Empty constructor.
 TeViewNode (const TeViewNodeParams &viewNodeParams)
 Constructor.
virtual ~TeViewNode ()
 Destructor.
virtual TeViewNodeclone ()
 Makes a copy of the object.
virtual void add (TeViewNode *, const bool &=true)
 Inserts a new child in the tree hierachy. Fails if the object is a leaf.
virtual TeViewNoderemoveID (int)
 Remove an existing child identified by its id from the tree hierarchy.
virtual TeViewNoderemove (const string &)
 Remove an existing child identified by its name from the tree hierarchy.
virtual TeViewNoderetrieve (int)
 Retrieve a node identified by its identifier from the tree structure.
virtual TeViewNodeparent ()
 Returns a pointer to a parent node.
virtual int parentId ()
 Returns the identifier of a node parent.
virtual void parentId (int i)
 Sets the identification of the parent node.
virtual void setParent (TeViewNode *node)
 Sets the parent of node.
virtual int id ()
 Returns the identification of a node.
virtual void id (int i)
 Sets the identification of a node.
virtual string name ()
 Returns the name of a node.
virtual void name (const string &s)
 Sets the name of a node.
virtual int priority () const
 Returns the priority of a node.
virtual void priority (int i)
 Sets the priority of a node.
virtual void view (int viewId)
 Sets the view identification of a node.
virtual int view ()
 Returns the view identification of a node.
virtual int type ()
 Returns the node type.
virtual void type (const int &t)
 Sets the node type.
virtual void moveUp ()
 Moves a node up in the tree structure.
virtual void moveDown ()
 Moves a node down in the tree structure.
virtual void swap (unsigned int, unsigned int)
 Swaps nodes.
virtual void visibility (int)
 Sets the nodes visibility.
virtual int visibility ()
 Returns the nodes visibility.
virtual void draw ()
 Draws a node.
virtual void sort ()
 Sorts the node.
virtual int getProductId () const
virtual TeViewNodeParamsviewNodeParams ()
virtual void viewNodeParams (TeViewNodeParams &p)

Static Public Member Functions

static TeViewNodeDefaultObject ()

Protected Member Functions

virtual void moveUp (TeViewNode *)
virtual void moveDown (TeViewNode *)

Protected Attributes

TeViewNodeParams viewNodeParams_
 Node parameters.

Detailed Description

A class to deal with nodes of a view.

In Terralib, a view is composed of nodes. This is a base class used to specialize view node types.

See also:
TeView TeViewNodeParams

Constructor & Destructor Documentation

TeViewNode::TeViewNode ( const string name = "",
TeViewNode parent = 0,
const int &  view = 0,
const int &  id = 0,
const int &  nodeType = 0 
) [inline]

Empty constructor.

TeViewNode::TeViewNode ( const TeViewNodeParams viewNodeParams) [inline]

Constructor.

virtual TeViewNode::~TeViewNode ( ) [inline, virtual]

Destructor.


Member Function Documentation

virtual void TeViewNode::add ( TeViewNode ,
const bool &  = true 
) [inline, virtual]

Inserts a new child in the tree hierachy. Fails if the object is a leaf.

Reimplemented in TeViewTree.

virtual TeViewNode* TeViewNode::clone ( ) [inline, virtual]

Makes a copy of the object.

Reimplemented in TeExternalTheme, TeFileTheme, and TeTheme.

static TeViewNode* TeViewNode::DefaultObject ( ) [inline, static]
virtual void TeViewNode::draw ( ) [inline, virtual]

Draws a node.

Reimplemented in TeViewTree.

virtual int TeViewNode::getProductId ( ) const [inline, virtual]
virtual int TeViewNode::id ( ) [inline, virtual]

Returns the identification of a node.

virtual void TeViewNode::id ( int  i) [inline, virtual]

Sets the identification of a node.

virtual void TeViewNode::moveDown ( TeViewNode ) [inline, protected, virtual]

Reimplemented in TeViewTree.

virtual void TeViewNode::moveDown ( ) [inline, virtual]

Moves a node down in the tree structure.

virtual void TeViewNode::moveUp ( ) [inline, virtual]

Moves a node up in the tree structure.

virtual void TeViewNode::moveUp ( TeViewNode ) [inline, protected, virtual]

Reimplemented in TeViewTree.

virtual void TeViewNode::name ( const string s) [inline, virtual]

Sets the name of a node.

virtual string TeViewNode::name ( ) [inline, virtual]

Returns the name of a node.

virtual TeViewNode* TeViewNode::parent ( ) [inline, virtual]

Returns a pointer to a parent node.

virtual void TeViewNode::parentId ( int  i) [inline, virtual]

Sets the identification of the parent node.

virtual int TeViewNode::parentId ( ) [inline, virtual]

Returns the identifier of a node parent.

virtual void TeViewNode::priority ( int  i) [inline, virtual]

Sets the priority of a node.

virtual int TeViewNode::priority ( ) const [inline, virtual]

Returns the priority of a node.

virtual TeViewNode* TeViewNode::remove ( const string ) [inline, virtual]

Remove an existing child identified by its name from the tree hierarchy.

Fails if the object is a leaf Should be used in conjunction with a delete

Reimplemented in TeViewTree.

virtual TeViewNode* TeViewNode::removeID ( int  ) [inline, virtual]

Remove an existing child identified by its id from the tree hierarchy.

Fails if the object is a leaf Should be used in conjunction with a delete

Reimplemented in TeViewTree.

virtual TeViewNode* TeViewNode::retrieve ( int  ) [inline, virtual]

Retrieve a node identified by its identifier from the tree structure.

virtual void TeViewNode::setParent ( TeViewNode node) [inline, virtual]

Sets the parent of node.

Reimplemented in TeAbstractTheme.

virtual void TeViewNode::sort ( ) [inline, virtual]

Sorts the node.

Reimplemented in TeViewTree.

virtual void TeViewNode::swap ( unsigned int  ,
unsigned int   
) [inline, virtual]

Swaps nodes.

Reimplemented in TeViewTree.

virtual void TeViewNode::type ( const int &  t) [inline, virtual]

Sets the node type.

virtual int TeViewNode::type ( ) [inline, virtual]

Returns the node type.

virtual int TeViewNode::view ( ) [inline, virtual]

Returns the view identification of a node.

virtual void TeViewNode::view ( int  viewId) [inline, virtual]

Sets the view identification of a node.

virtual TeViewNodeParams& TeViewNode::viewNodeParams ( ) [inline, virtual]
virtual void TeViewNode::viewNodeParams ( TeViewNodeParams p) [inline, virtual]
virtual void TeViewNode::visibility ( int  ) [inline, virtual]

Sets the nodes visibility.

Reimplemented in TeAbstractTheme, and TeViewTree.

virtual int TeViewNode::visibility ( ) [inline, virtual]

Returns the nodes visibility.

Reimplemented in TeAbstractTheme, and TeViewTree.


Member Data Documentation

Node parameters.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines