GtkTree

struct GtkTree

struct GtkTree;

struct _GtkTree { GtkContainer container; GList *children; GtkTree* root_tree; /* owner of selection list */ GtkWidget* tree_owner; GList *selection; guint level; guint indent_value; guint current_indent; guint selection_mode : 2; guint view_mode : 1; guint view_line : 1; };

GTK_IS_ROOT_TREE()

#define GTK_IS_ROOT_TREE(obj)   ((GtkObject*) GTK_TREE(obj)->root_tree == (GtkObject*)obj)

A macro that returns a boolean value which indicates if obj is a root tree or not.

GTK_TREE_ROOT_TREE()

#define GTK_TREE_ROOT_TREE(obj) (GTK_TREE(obj)->root_tree ? GTK_TREE(obj)->root_tree : GTK_TREE(obj))

A macro that returns the root tree of obj.

If obj is already a root tree, obj is cast to GtkTree and returned.

GTK_TREE_SELECTION()

#define GTK_TREE_SELECTION(obj) (GTK_TREE_ROOT_TREE(obj)->selection)

A macro that returns a GList that contains the selection of the root tree of obj.

enum GtkTreeViewMode

typedef enum 
{
  GTK_TREE_VIEW_LINE,  /* default view mode */
  GTK_TREE_VIEW_ITEM
} GtkTreeViewMode;

gtk_tree_new ()

GtkWidget*  gtk_tree_new                    (void);

Creates a new GtkTree.

gtk_tree_append ()

void        gtk_tree_append                 (GtkTree *tree,
                                             GtkWidget *tree_item);

Adds the GtkTreeItem in tree_item to the end of the items in tree.

gtk_tree_prepend ()

void        gtk_tree_prepend                (GtkTree *tree,
                                             GtkWidget *tree_item);

Adds the GtkTreeItem in tree_item to the start of the items in tree.

gtk_tree_insert ()

void        gtk_tree_insert                 (GtkTree *tree,
                                             GtkWidget *tree_item,
                                             gint position);

Adds the GtkTreeItem in tree_item to the list of items in tree at the position indicated by position.

gtk_tree_remove_items ()

void        gtk_tree_remove_items           (GtkTree *tree,
                                             GList *items);

Removes a list of items from the GtkTree in tree.

If only one item is to be removed from the GtkTree, gtk_container_remove() can be used instead.

Removing an item from a GtkTree dereferences the item, and thus usually destroys the item and any subtrees it may contain. If the item is not to be destroyed, use gtk_object_ref() before removing it.

gtk_tree_clear_items ()

void        gtk_tree_clear_items            (GtkTree *tree,
                                             gint start,
                                             gint end);

Removes the items at positions between start and end from the GtkTree tree.

Removing an item from a GtkTree dereferences the item, and thus usually destroys the item and any subtrees it may contain. If the item is not to be destroyed, use gtk_object_ref() before removing it.

gtk_tree_select_item ()

void        gtk_tree_select_item            (GtkTree *tree,
                                             gint item);

Emits the select_item signal for the child at position item, and thus selects it (unless it is unselected in a signal handler).

gtk_tree_unselect_item ()

void        gtk_tree_unselect_item          (GtkTree *tree,
                                             gint item);

Emits the unselect_item for the child at position item, and thus unselects it.

gtk_tree_select_child ()

void        gtk_tree_select_child           (GtkTree *tree,
                                             GtkWidget *tree_item);

Emits the select_item signal for the child tree_item, and thus selects it (unless it is unselected in a signal handler).

gtk_tree_unselect_child ()

void        gtk_tree_unselect_child         (GtkTree *tree,
                                             GtkWidget *tree_item);

Emits the unselect_item signal for the child tree_item, and thus unselects it.

gtk_tree_child_position ()

gint        gtk_tree_child_position         (GtkTree *tree,
                                             GtkWidget *child);

Returns the position of child in the GtkTree tree.

If child is not a child of tree, then -1 is returned.

gtk_tree_set_selection_mode ()

void        gtk_tree_set_selection_mode     (GtkTree *tree,
                                             GtkSelectionMode mode);

Sets the selection mode for the GtkTree tree.

mode can be one of

• GTK_SELECTION_SINGLE for when only one item can be selected at a time.

• GTK_SELECTION_BROWSE for when one item must be selected.

• GTK_SELECTION_MULTIPLE for when many items can be selected at once.

• GTK_SELECTION_EXTENDED Reserved for later use.

The selection mode is only defined for a root tree, as the root tree "owns" the selection.

The default mode is GTK_SELECTION_SINGLE.

gtk_tree_set_view_mode ()

void        gtk_tree_set_view_mode          (GtkTree *tree,
                                             GtkTreeViewMode mode);

Sets the 'viewmode' for the GtkTree in tree. The 'viewmode' defines how the tree looks when an item is selected.

mode can be one of:

• GTK_TREE_VIEW_LINE : When an item is selected the entire GtkTreeItem is highlighted.

• GTK_TREE_VIEW_ITEM : When an item is selected only the selected item's child widget is highlighted.

The default mode is GTK_TREE_VIEW_LINE.

gtk_tree_set_view_lines ()

void        gtk_tree_set_view_lines         (GtkTree *tree,
                                             guint flag);

Sets whether or not the connecting lines between branches and children are drawn.

gtk_tree_remove_item ()

void        gtk_tree_remove_item            (GtkTree *tree,
                                             GtkWidget *child);

Removes the item child from the GtkTree tree.

The "selection-changed" signal

void        user_function                  (GtkTree *tree,
                                            gpointer user_data);

This signal is emitted by the root tree whenever the selection changes.

The "select-child" signal

void        user_function                  (GtkTree *tree,
                                            GtkWidget *widget,
                                            gpointer user_data);

This signal is emitted by tree whenever widget is about to be selected.

The "unselect-child" signal

void        user_function                  (GtkTree *tree,
                                            GtkWidget *widget,
                                            gpointer user_data);

This signal is emitted by tree whenever widget is about to be unselected.