gtkctree.sgml

This GTK+ version 2.12.3. GTK+ is a multi-platform toolkit for creating graphical user interfaces.

<para>
Recursively apply a function to nodes up to a certain depth.
The function is called for each node after it has been called
for that node's children.
</para>

@ctree: 
@node: The node where to start.
@depth: The maximum absolute depth for applying the function.  If depth is negative, this function just calls #gtk_ctree_post_recursive.
@func: The function to apply to each node.
@data: A closure argument given to each invocation of the function.


<!-- ##### FUNCTION gtk_ctree_is_viewable ##### -->
<para>
This function checks whether the given node is viewable i.e. so that
all of its parent nodes are expanded.  This is different from being
actually visible: the node can be viewable but outside the scrolling
area of the window.
</para>

@ctree: 
@node: 
@Returns: Whether the node is viewable.


<!-- ##### FUNCTION gtk_ctree_last ##### -->
<para>
Returns the last child of the last child of the last child...
of the given node.
</para>

@ctree: 
@node: 
@Returns: 


<!-- ##### FUNCTION gtk_ctree_find_node_ptr ##### -->
<para>
Finds the node pointer given a #GtkCTreeRow structure.
</para>

@ctree: 
@ctree_row: 
@Returns: The node pointer.


<!-- ##### FUNCTION gtk_ctree_find ##### -->
<para>

</para>

@ctree: 
@node: The node to start searching from. May be %NULL.
@child: 
@Returns: True if @child is on some level a child (grandchild...) of the @node.


<!-- ##### FUNCTION gtk_ctree_is_ancestor ##### -->
<para>

</para>

@ctree: 
@node: 
@child: 
@Returns: True is @node is an ancestor of @child.


<!-- ##### FUNCTION gtk_ctree_find_by_row_data ##### -->
<para>
Finds a node in the tree under @node that has the given user data pointer.
</para>

@ctree: 
@node: 
@data: 
@Returns: The node, or %NULL if not found.


<!-- ##### FUNCTION gtk_ctree_find_all_by_row_data ##### -->
<para>
Finds all nodes in the tree under @node that have the given user data pointer.
</para>

@ctree: 
@node: 
@data: 
@Returns: A list of nodes that have the given data pointer.


<!-- ##### FUNCTION gtk_ctree_find_by_row_data_custom ##### -->
<para>
Find the first node under @node whose row data pointer fulfills 
a custom criterion.
</para>

@ctree: 
@node: The node where to start searching.
@data: User data for the criterion function.
@func: The criterion function.
@Returns: The first node found.


<!-- ##### FUNCTION gtk_ctree_find_all_by_row_data_custom ##### -->
<para>
Find all nodes under @node whose row data pointer fulfills 
a custom criterion.

</para>

@ctree: 
@node: The node where to start searching.
@data: User data for the criterion function.
@func: The criterion function.
@Returns: A list of all nodes found.


<!-- ##### FUNCTION gtk_ctree_is_hot_spot ##### -->
<para>
</para>

@ctree: 
@x: 
@y: 
@Returns: True if the given coordinates lie on an expander button.


<!-- ##### FUNCTION gtk_ctree_move ##### -->
<para>
Move a node in the tree to another location.
</para>

@ctree: 
@node: The node to be moved.
@new_parent: The new parent-to-be of the node.
@new_sibling: The new sibling-to-be of the node.


<!-- ##### FUNCTION gtk_ctree_expand ##### -->
<para>
Expand one node.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_expand_recursive ##### -->
<para>
Expand one node and all nodes underneath.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_expand_to_depth ##### -->
<para>
Expand a node and its children up to the depth given.
</para>

@ctree: 
@node: 
@depth: The (absolute) depth up to which to expand nodes.


<!-- ##### FUNCTION gtk_ctree_collapse ##### -->
<para>
Collapse one node.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_collapse_recursive ##### -->
<para>
Collapse one node and all its subnodes.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_collapse_to_depth ##### -->
<para>
Collapse a node and its children up to the depth given.
</para>

@ctree: 
@node: 
@depth: The (absolute) depth up to which to collapse nodes.


<!-- ##### FUNCTION gtk_ctree_toggle_expansion ##### -->
<para>
Toggle a node, i.e. if it is collapsed, expand it and vice versa.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_toggle_expansion_recursive ##### -->
<para>
Toggle the expansion of a node and all its children.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_select ##### -->
<para>
Cause the given node to be selected and emit the appropriate signal.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_select_recursive ##### -->
<para>
Cause the given node and its subnodes to be selected and emit the appropriate signal(s).
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_unselect ##### -->
<para>
Unselect the given node and emit the appropriate signal.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_unselect_recursive ##### -->
<para>
Unselect the given node and its subnodes and emit the appropriate signal(s).
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_real_select_recursive ##### -->
<para>
The function that implements both #gtk_ctree_select_recursive and
#gtk_ctree_unselect_recursive.
</para>

@ctree: 
@node: 
@state: True for selecting, false for unselecting.


<!-- ##### FUNCTION gtk_ctree_node_set_text ##### -->
<para>
Set the text in a node.
</para>

@ctree: 
@node: 
@column: The column whose text to change.
@text: The new text.


<!-- ##### FUNCTION gtk_ctree_node_set_pixmap ##### -->
<para>
FIXME
</para>

@ctree: 
@node: 
@column: 
@pixmap: 
@mask: 


<!-- ##### FUNCTION gtk_ctree_node_set_pixtext ##### -->
<para>
FIXME
</para>

@ctree: 
@node: 
@column: 
@text: 
@spacing: 
@pixmap: 
@mask: 


<!-- ##### FUNCTION gtk_ctree_set_node_info ##### -->
<para>
Change the information. Most parameters correspond 
to the parameters of #gtk_ctree_insert_node.
</para>

@ctree: 
@node: 
@text: The text to be in the tree column.
@spacing: 
@pixmap_closed: 
@mask_closed: 
@pixmap_opened: 
@mask_opened: 
@is_leaf: 
@expanded: 


<!-- ##### FUNCTION gtk_ctree_node_set_shift ##### -->
<para>
Shift the given cell the given amounts in pixels.
</para>

@ctree: 
@node: 
@column: 
@vertical: 
@horizontal: 


<!-- ##### FUNCTION gtk_ctree_node_set_selectable ##### -->
<para>

</para>

@ctree: 
@node: 
@selectable: Whether this node can be selected by the user.


<!-- ##### FUNCTION gtk_ctree_node_get_selectable ##### -->
<para>

</para>

@ctree: 
@node: 
@Returns: Whether this node can be selected by the user.


<!-- ##### FUNCTION gtk_ctree_node_get_cell_type ##### -->
<para>

</para>

@ctree: 
@node: 
@column: 
@Returns: The type of the given cell.


<!-- ##### FUNCTION gtk_ctree_node_get_text ##### -->
<para>

</para>

@ctree: 
@node: 
@column: 
@text: If nonnull, the pointer to the text string is assigned to *@text.
@Returns: True if the given cell has text in it.


<!-- ##### FUNCTION gtk_ctree_node_get_pixmap ##### -->
<para>

</para>

@ctree: 
@node: 
@column: 
@pixmap: If nonnull, the pointer to the pixmap is returned through this.
@mask: If nonnull, the pointer to the mask is returned through this.
@Returns: True if the given cell contains a pixmap.


<!-- ##### FUNCTION gtk_ctree_node_get_pixtext ##### -->
<para>
Get the parameters of a cell containing both a pixmap and text.
</para>

@ctree: 
@node: 
@column: 
@text: 
@spacing: 
@pixmap: 
@mask: 
@Returns: 


<!-- ##### FUNCTION gtk_ctree_get_node_info ##### -->
<para>
Get information corresponding to a node.
Any of the return parameters can be null. 
</para>

@ctree: 
@node: 
@text: 
@spacing: 
@pixmap_closed: 
@mask_closed: 
@pixmap_opened: 
@mask_opened: 
@is_leaf: 
@expanded: 
@Returns: 


<!-- ##### FUNCTION gtk_ctree_node_set_row_style ##### -->
<para>
Set the style of a row.
</para>

@ctree: 
@node: 
@style: 


<!-- ##### FUNCTION gtk_ctree_node_get_row_style ##### -->
<para>
Get the style of a row.
</para>

@ctree: 
@node: 
@Returns: 


<!-- ##### FUNCTION gtk_ctree_node_set_cell_style ##### -->
<para>
Set the style of an individual cell.
</para>

@ctree: 
@node: 
@column: 
@style: 


<!-- ##### FUNCTION gtk_ctree_node_get_cell_style ##### -->
<para>
Get the style of an individual cell.
</para>

@ctree: 
@node: 
@column: 
@Returns: 


<!-- ##### FUNCTION gtk_ctree_node_set_foreground ##### -->
<para>

</para>

@ctree: 
@node: 
@color: 


<!-- ##### FUNCTION gtk_ctree_node_set_background ##### -->
<para>

</para>

@ctree: 
@node: 
@color: 


<!-- ##### FUNCTION gtk_ctree_node_set_row_data ##### -->
<para>
Set the custom data associated with a node.
</para>

@ctree: 
@node: 
@data: 


<!-- ##### FUNCTION gtk_ctree_node_set_row_data_full ##### -->
<para>
This is the full interface to setting row data, so that a destructor
can be given for the data.
</para>

@ctree: 
@node: 
@data: 
@destroy: The routine to be called when @data is no longer needed.


<!-- ##### FUNCTION gtk_ctree_node_get_row_data ##### -->
<para>

</para>

@ctree: 
@node: 
@Returns: 


<!-- ##### FUNCTION gtk_ctree_node_moveto ##### -->
<para>
This function makes the given column of the given node visible by
scrolling.
</para>

@ctree: 
@node: The node to be made visible.
@column: The column to be made visible.
@row_align: Where in the window the row should appear.
@col_align: Where in the window the column should appear.


<!-- ##### FUNCTION gtk_ctree_node_is_visible ##### -->
<para>

</para>

@ctree: 
@node: 
@Returns: True if the node is currently inside the bounds of the window.
Note that this function can return true even if the node is not
viewable, if the node's ancestor is visible.


<!-- ##### FUNCTION gtk_ctree_set_indent ##### -->
<para>

</para>

@ctree: 
@indent: The number of pixels to shift the levels of the tree.


<!-- ##### FUNCTION gtk_ctree_set_spacing ##### -->
<para>
The spacing between the tree graphic and the actual node content.
</para>

@ctree: 
@spacing: 


<!-- ##### MACRO gtk_ctree_set_reorderable ##### -->
<para>

</para>

@t: 
@r: 


<!-- ##### FUNCTION gtk_ctree_set_line_style ##### -->
<para>

</para>

@ctree: 
@line_style: 


<!-- ##### FUNCTION gtk_ctree_set_expander_style ##### -->
<para>

</para>

@ctree: 
@expander_style: 


<!-- ##### FUNCTION gtk_ctree_set_drag_compare_func ##### -->
<para>
FIXME
</para>

@ctree: 
@cmp_func: 


<!-- ##### FUNCTION gtk_ctree_sort_node ##### -->
<para>
Sort the children of a node. See #GtkCList for how to set the sorting
criteria etc.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_sort_recursive ##### -->
<para>
Sort the descendants of a node. See #GtkCList for how to set the sorting
criteria etc.
</para>

@ctree: 
@node: 


<!-- ##### FUNCTION gtk_ctree_node_nth ##### -->
<para>

</para>

@ctree: 
@row: 
@Returns: The node corresponding to the @row th row.


<!-- ##### FUNCTION gtk_ctree_set_show_stub ##### -->
<para>

</para>

@ctree: 
@show_stub: