gtktree

typedef struct _gtktree 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_old()

#define gtk_tree_selection_old(obj) (gtk_tree_root_tree(obj)->selection)

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 g_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 g_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

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:

the default mode is gtk_tree_view_line.

gtk_tree_set_view_lines ()

void        gtk_tree_set_view_lines         (gtktree *tree,
                                             gboolean 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 "select-child" signal

void        user_function                  (gtktree   *tree,
                                            gtkwidget *widget,
                                            gpointer   user_data)      : run first

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

the "selection-changed" signal

void        user_function                  (gtktree *tree,
                                            gpointer user_data)      : run first

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

the "unselect-child" signal

void        user_function                  (gtktree   *tree,
                                            gtkwidget *widget,
                                            gpointer   user_data)      : run first

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