PHP Editor Review - Gtk Manual Gtk gtkctree

GtkCTree

Widget that displays a hierarchical tree.

Object Hierarchy

GtkObject
`-- GtkWidget
       `-- GtkContainer
              `-- GtkCList
                     `-- GtkCTree

Direct subclasses

None.

Description

GtkCTree has been deprecated since GTK+ 2.0 and should not be used in newly written code.

Constructor

GtkCTree (int nColumns, int nTreeGraphicCol, array arColTitles]);
-- Creates a new CtkCTree object.

Methods

insert_node()
Inserts a new node in the tree.
remove_node()
Removes the given node from the tree
post_recursive()
Recursively apply a function to all nodes of the tree at or below a certain node.
post_recursive_to_depth()
Recursively apply a function to nodes up to a certain depth
pre_recursive()
Recursively apply a function to all nodes of the tree at or below a certain node.
pre_recursive_to_depth()
Recursively apply a function to nodes up to a certain depth.
is_viewable()
This function checks whether the given node is viewable i.e. so that all of its parent nodes are expanded.
last()
Returns the last child of the last child of the last child... of the given node.
node_nth()
Returns the node in row X
find()
Checks if child is on some level a child (grandchild...) of the node.
find_by_row_data()
FIXME
find_by_row_data()
FIXME
is_ancestor()
Checks if node is an ancestor of child.
is_hot_spot()
Checks if the given coordinates lie on an expander button.
move()
Move a node in the tree to another location.
expand()
Expand one node.
expand_recursive()
Expand one node and all nodes underneath.
expand_to_depth()
Expand a node and its children up to the depth given.
collapse()
Collapse one node.
collapse_recursive()
Collapse one node and all its subnodes.
collapse_to_depth()
Collapse a node and its children up to the depth given.
toggle_expansion()
Toggle a node, i.e. if it is collapsed, expand it and vice versa.
toggle_expansion_recursive()
Toggle the expansion of a node and all its children.
select()
Cause the given node to be selected and emit the appropriate signal.
select_recursive()
Cause the given node and its subnodes to be selected and emit the appropriate signal(s).
unselect()
Unselect the given node and emit the appropriate signal.
unselect_recursive()
Unselect the given node and its subnodes and emit the appropriate signal(s).
node_set_text()
Set the column text of the specific row.
node_set_pixmap()
Sets an icon into a column of the node.
node_set_pixtext()
Sets the pixmap and the corresponding text of a column of a row.
set_node_info()
Changes all the values set by the insert_node function.
node_set_shift()
Shift the column of the given cell the given amounts in pixels.
node_set_selectable()
Sets whether this node can be selected by the user.
node_get_selectable()
Whether this node can be selected by the user.
node_get_cell_type()
Returns the type of the given cell.
node_get_text()
Returns the column text of a given row.
node_get_pixtext()
Returns the column pixtext of a given row.
get_node_info()
GGet information corresponding to a node.
node_set_row_style()
Set the style of a row.
node_get_row_style()
Get the style of a row.
node_set_cell_style()
Set the style of an individual cell.
node_get_cell_style()
Get the style of an individual cell.
node_set_foreground()
Set the foreground color of a row.
node_set_background()
Set the background color of a row.
node_set_row_data()
Associate a custom object with the row.
node_get_row_data()
Returns the custom object associated with the node.
node_moveto()
This function makes the given column of the given node visible by scrolling.
node_is_visible()
True if the node is currently inside the bounds of the window.
set_indent()
Sets the number of pixels to shift the levels of the tree.
set_spacing()
Sets the spacing between the tree graphic and the actual node content.
set_show_stub()
FIXME
set_line_style()
Set the line style of the tree.
set_expander_style()
Set the expander style of the tree.
sort_node()
Sort the children of a node.
sort_recursive()
Sort the descendants of a node.

Signals

"tree-select-row"
Emitted when a row is selected.
"tree-unselect-row"
Emitted when a node is unselected.
"tree-expand"
Emitted when a node is expanded.
"tree-collapse"
Emitted when a node is collapsed.
"tree-move"
Emitted when a node is moved.

Properties

clist:
FIXME
row_list:
Array of viewable nodes.
selection:
Array of selected rows (nodes).