VDKCustomTree Class Reference

This class wraps gtkctree widget. More...

#include <vdkctree.h>

Inheritance diagram for VDKCustomTree:

List of all members.

Public Member Functions

• __rwproperty (VDKCustomTree, int) Spacing
• __rwproperty (VDKCustomTree, VDKTreeNode) SelectedNode
• __rproperty (VDKCustomTree, int) SelectedColumn
• __rwproperty (VDKCustomTree, VDKTreeNode) UnselectedNode
• __rproperty (VDKCustomTree, int) UnselectedColumn
• __rwproperty (VDKCustomTree, GtkCTreeLineStyle) LineStyle
• __rwproperty (VDKCustomTree, GtkCTreeExpanderStyle) ExpanderStyle
• VDKCustomTree (VDKForm *owner, int columns=1, char **titles=NULL, GtkSelectionMode mode=GTK_SELECTION_SINGLE, int tree_column=0)
• virtual ~VDKCustomTree ()
• VDKTreeNode AddNode (char *text[], GtkCTreeNode *parent, bool expanded=true, bool isLeaf=false, char **pixmap_closed=NULL, char **pixmap_opened=NULL)
• bool RemoveNode (VDKTreeNode node)
• int RemoveKey (char *key)
• virtual void Clear ()
• VDKTreeNode Selection ()
• VDKTreeNode Unselection ()
• VDKTreeNodeArray & Selections ()
• Tuple operator[] (VDKTreeNode node)
• VDKTreeNodeList * Find (char *key)
• bool IsLeaf (VDKTreeNode node)
• char * Key (VDKTreeNode node)
• bool IsExpanded (VDKTreeNode node)

---

Detailed Description

This class wraps gtkctree widget.

Signals

• select_node_signal, emitted on selecting a tree node (or double clicking on extended selection mode). SelectedNode property contains selected node address. SelectedNode is set to NULL if no node is selected.
• unselect_node_signal, emitted on unselecting a tree node . UnselectedNode property contains uelected node address. UnselectedNode is set to NULL if no node is unselected.

Tip

VDKTreeNode is defined as GtkCTreeNode*

EXAMPLES

On ./testvdk/ctreewin.cc

---

Constructor & Destructor Documentation

VDKCustomTree::VDKCustomTree	(	VDKForm *	owner,
		int	columns = 1,
		char **	titles = NULL,
		GtkSelectionMode	mode = GTK_SELECTION_SINGLE,
		int	tree_column = 0
	)

Constructor

Parameters:

	columns,number	of columns
	titles,an	array of title strings
	mode,selection	mode
	tree_column,key	column

VDKCustomTree::~VDKCustomTree

(

)

[virtual]

Destructor

---

Member Function Documentation

VDKCustomTree::__rwproperty	(	VDKCustomTree	,
		int
	)

Sets/gets spacing distance (default 5)

VDKCustomTree::__rwproperty	(	VDKCustomTree	,
		VDKTreeNode
	)

Sets/gets selected node, setting to NULL will select root node. An aswer NULL means no node selected.

VDKCustomTree::__rproperty	(	VDKCustomTree	,
		int
	)

Sets/gets selected column, an answer == -1 means no column selected.

VDKCustomTree::__rwproperty	(	VDKCustomTree	,
		VDKTreeNode
	)

Sets/gets unselected node, setting to NULL will unselect root node. An aswer NULL means no node unselected.

VDKCustomTree::__rproperty	(	VDKCustomTree	,
		int
	)

Sets/gets unselected column, an answer == -1 means no column unselected.

VDKCustomTree::__rwproperty	(	VDKCustomTree	,
		GtkCTreeLineStyle
	)

Sets/gets line style arg. (default GTK_CTREE_LINES_SOLID)

VDKCustomTree::__rwproperty	(	VDKCustomTree	,
		GtkCTreeExpanderStyle
	)

Sets/gets expander style (default GTK_CTREE_EXPANDER_SQUARE)

VDKTreeNode VDKCustomTree::AddNode	(	char *	text[],
		GtkCTreeNode *	parent,
		bool	expanded = true,
		bool	isLeaf = false,
		char **	pixmap_closed = NULL,
		char **	pixmap_opened = NULL
	)

Add a node to <parent> tree.

Parameters:

	text,an	array of strings
	parent,if	NULL add the node as a new root (same as adding a row to a VDKCustomList)
	isLeaf,if	is a leaf or not
	pixmap_closed,pixmap	showed when node is collapsed
	pixmap_open,pixmap	showed when node is expanded

bool VDKCustomTree::RemoveNode

(

VDKTreeNode

node

)

Removes a node, return true on success

Parameters:

node,node

to be removed

int VDKCustomTree::RemoveKey

(

char *

key

)

Removes all nodes with key==<key>, return number of removed nodes

void VDKCustomTree::Clear

(

)

[virtual]

Clear widget

Reimplemented from VDKCustom.

VDKTreeNode VDKCustomTree::Selection

(

)

[inline]

Returns selected node

VDKTreeNode VDKCustomTree::Unselection

(

)

[inline]

Returns unselected node

VDKTreeNodeArray & VDKCustomTree::Selections

(

)

Returns an array of selected nodes (valid on multiple and extended mode)

Tuple VDKCustomTree::operator[]

(

VDKTreeNode

node

)

Returns a tuple of <node> node, an array containing all columns texts.

Parameters:

node

VDKTreeNodeList * VDKCustomTree::Find

(

char *

key

)

Returns a list of nodes that match <key>. Returned list should be deleted by user or it will leak.

bool VDKCustomTree::IsLeaf

(

VDKTreeNode

node

)

Returns true if <node> is a leaf

Parameters:

node

char * VDKCustomTree::Key

(

VDKTreeNode

node

)

Returns node key

Parameters:

node

bool VDKCustomTree::IsExpanded

(

VDKTreeNode

node

)

Returns true if <node> is expanded

Parameters:

node

---

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

• vdkctree.h
• vdkctree.cc

---