GtkCTree

Name

GtkCTree -- a widget displaying a hierarchical tree.

Synopsis


#include <gtk/gtk.h>


struct      GtkCTree;
#define     GTK_CTREE_ROW                   (_node_)
#define     GTK_CTREE_NODE                  (_node_)
#define     GTK_CTREE_NODE_NEXT             (_nnode_)
#define     GTK_CTREE_NODE_PREV             (_pnode_)
#define     GTK_CTREE_FUNC                  (_func_)
enum        GtkCTreePos;
enum        GtkCTreeLineStyle;
enum        GtkCTreeExpanderStyle;
enum        GtkCTreeExpansionType;
void        (*GtkCTreeFunc)                 (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gpointer data);
gboolean    (*GtkCTreeGNodeFunc)            (GtkCTree *ctree,
                                             guint depth,
                                             GNode *gnode,
                                             GtkCTreeNode *cnode,
                                             gpointer data);
gboolean    (*GtkCTreeCompareDragFunc)      (GtkCTree *ctree,
                                             GtkCTreeNode *source_node,
                                             GtkCTreeNode *new_parent,
                                             GtkCTreeNode *new_sibling);
struct      GtkCTreeRow;
struct      GtkCTreeNode;
#define     GTK_TYPE_CTREE_NODE
GtkWidget*  gtk_ctree_new_with_titles       (gint columns,
                                             gint tree_column,
                                             gchar *titles[]);
GtkWidget*  gtk_ctree_new                   (gint columns,
                                             gint tree_column);
GtkCTreeNode* gtk_ctree_insert_node         (GtkCTree *ctree,
                                             GtkCTreeNode *parent,
                                             GtkCTreeNode *sibling,
                                             gchar *text[],
                                             guint8 spacing,
                                             GdkPixmap *pixmap_closed,
                                             GdkBitmap *mask_closed,
                                             GdkPixmap *pixmap_opened,
                                             GdkBitmap *mask_opened,
                                             gboolean is_leaf,
                                             gboolean expanded);
void        gtk_ctree_remove_node           (GtkCTree *ctree,
                                             GtkCTreeNode *node);
GtkCTreeNode* gtk_ctree_insert_gnode        (GtkCTree *ctree,
                                             GtkCTreeNode *parent,
                                             GtkCTreeNode *sibling,
                                             GNode *gnode,
                                             GtkCTreeGNodeFunc func,
                                             gpointer data);
GNode*      gtk_ctree_export_to_gnode       (GtkCTree *ctree,
                                             GNode *parent,
                                             GNode *sibling,
                                             GtkCTreeNode *node,
                                             GtkCTreeGNodeFunc func,
                                             gpointer data);
void        gtk_ctree_post_recursive        (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             GtkCTreeFunc func,
                                             gpointer data);
void        gtk_ctree_post_recursive_to_depth
                                            (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint depth,
                                             GtkCTreeFunc func,
                                             gpointer data);
void        gtk_ctree_pre_recursive         (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             GtkCTreeFunc func,
                                             gpointer data);
void        gtk_ctree_pre_recursive_to_depth
                                            (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint depth,
                                             GtkCTreeFunc func,
                                             gpointer data);
gboolean    gtk_ctree_is_viewable           (GtkCTree *ctree,
                                             GtkCTreeNode *node);
GtkCTreeNode* gtk_ctree_last                (GtkCTree *ctree,
                                             GtkCTreeNode *node);
GtkCTreeNode* gtk_ctree_find_node_ptr       (GtkCTree *ctree,
                                             GtkCTreeRow *ctree_row);
gboolean    gtk_ctree_find                  (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             GtkCTreeNode *child);
gboolean    gtk_ctree_is_ancestor           (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             GtkCTreeNode *child);
GtkCTreeNode* gtk_ctree_find_by_row_data    (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gpointer data);
GList*      gtk_ctree_find_all_by_row_data  (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gpointer data);
GtkCTreeNode* gtk_ctree_find_by_row_data_custom
                                            (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gpointer data,
                                             GCompareFunc func);
GList*      gtk_ctree_find_all_by_row_data_custom
                                            (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gpointer data,
                                             GCompareFunc func);
gboolean    gtk_ctree_is_hot_spot           (GtkCTree *ctree,
                                             gint x,
                                             gint y);
void        gtk_ctree_move                  (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             GtkCTreeNode *new_parent,
                                             GtkCTreeNode *new_sibling);
void        gtk_ctree_expand                (GtkCTree *ctree,
                                             GtkCTreeNode *node);
void        gtk_ctree_expand_recursive      (GtkCTree *ctree,
                                             GtkCTreeNode *node);
void        gtk_ctree_expand_to_depth       (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint depth);
void        gtk_ctree_collapse              (GtkCTree *ctree,
                                             GtkCTreeNode *node);
void        gtk_ctree_collapse_recursive    (GtkCTree *ctree,
                                             GtkCTreeNode *node);
void        gtk_ctree_collapse_to_depth     (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint depth);
void        gtk_ctree_toggle_expansion      (GtkCTree *ctree,
                                             GtkCTreeNode *node);
void        gtk_ctree_toggle_expansion_recursive
                                            (GtkCTree *ctree,
                                             GtkCTreeNode *node);
void        gtk_ctree_select                (GtkCTree *ctree,
                                             GtkCTreeNode *node);
void        gtk_ctree_select_recursive      (GtkCTree *ctree,
                                             GtkCTreeNode *node);
void        gtk_ctree_unselect              (GtkCTree *ctree,
                                             GtkCTreeNode *node);
void        gtk_ctree_unselect_recursive    (GtkCTree *ctree,
                                             GtkCTreeNode *node);
void        gtk_ctree_real_select_recursive (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint state);
void        gtk_ctree_node_set_text         (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column,
                                             const gchar *text);
void        gtk_ctree_node_set_pixmap       (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column,
                                             GdkPixmap *pixmap,
                                             GdkBitmap *mask);
void        gtk_ctree_node_set_pixtext      (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column,
                                             const gchar *text,
                                             guint8 spacing,
                                             GdkPixmap *pixmap,
                                             GdkBitmap *mask);
void        gtk_ctree_set_node_info         (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             const gchar *text,
                                             guint8 spacing,
                                             GdkPixmap *pixmap_closed,
                                             GdkBitmap *mask_closed,
                                             GdkPixmap *pixmap_opened,
                                             GdkBitmap *mask_opened,
                                             gboolean is_leaf,
                                             gboolean expanded);
void        gtk_ctree_node_set_shift        (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column,
                                             gint vertical,
                                             gint horizontal);
void        gtk_ctree_node_set_selectable   (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gboolean selectable);
gboolean    gtk_ctree_node_get_selectable   (GtkCTree *ctree,
                                             GtkCTreeNode *node);
GtkCellType gtk_ctree_node_get_cell_type    (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column);
gboolean    gtk_ctree_node_get_text         (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column,
                                             gchar **text);
gboolean    gtk_ctree_node_get_pixmap       (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column,
                                             GdkPixmap **pixmap,
                                             GdkBitmap **mask);
gboolean    gtk_ctree_node_get_pixtext      (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column,
                                             gchar **text,
                                             guint8 *spacing,
                                             GdkPixmap **pixmap,
                                             GdkBitmap **mask);
gboolean    gtk_ctree_get_node_info         (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gchar **text,
                                             guint8 *spacing,
                                             GdkPixmap **pixmap_closed,
                                             GdkBitmap **mask_closed,
                                             GdkPixmap **pixmap_opened,
                                             GdkBitmap **mask_opened,
                                             gboolean *is_leaf,
                                             gboolean *expanded);
void        gtk_ctree_node_set_row_style    (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             GtkStyle *style);
GtkStyle*   gtk_ctree_node_get_row_style    (GtkCTree *ctree,
                                             GtkCTreeNode *node);
void        gtk_ctree_node_set_cell_style   (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column,
                                             GtkStyle *style);
GtkStyle*   gtk_ctree_node_get_cell_style   (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column);
void        gtk_ctree_node_set_foreground   (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             GdkColor *color);
void        gtk_ctree_node_set_background   (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             GdkColor *color);
void        gtk_ctree_node_set_row_data     (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gpointer data);
void        gtk_ctree_node_set_row_data_full
                                            (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gpointer data,
                                             GtkDestroyNotify destroy);
gpointer    gtk_ctree_node_get_row_data     (GtkCTree *ctree,
                                             GtkCTreeNode *node);
void        gtk_ctree_node_moveto           (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column,
                                             gfloat row_align,
                                             gfloat col_align);
GtkVisibility gtk_ctree_node_is_visible     (GtkCTree *ctree,
                                             GtkCTreeNode *node);
void        gtk_ctree_set_indent            (GtkCTree *ctree,
                                             gint indent);
void        gtk_ctree_set_spacing           (GtkCTree *ctree,
                                             gint spacing);
#define     gtk_ctree_set_reorderable       (t,r)
void        gtk_ctree_set_line_style        (GtkCTree *ctree,
                                             GtkCTreeLineStyle line_style);
void        gtk_ctree_set_expander_style    (GtkCTree *ctree,
                                             GtkCTreeExpanderStyle expander_style);
void        gtk_ctree_set_drag_compare_func (GtkCTree *ctree,
                                             GtkCTreeCompareDragFunc cmp_func);
void        gtk_ctree_sort_node             (GtkCTree *ctree,
                                             GtkCTreeNode *node);
void        gtk_ctree_sort_recursive        (GtkCTree *ctree,
                                             GtkCTreeNode *node);
GtkCTreeNode* gtk_ctree_node_nth            (GtkCTree *ctree,
                                             guint row);
void        gtk_ctree_set_show_stub         (GtkCTree *ctree,
                                             gboolean show_stub);


Object Hierarchy


  GObject
   +----GtkObject
         +----GtkWidget
               +----GtkContainer
                     +----GtkCList
                           +----GtkCTree

Properties


  "n-columns"            guint                : Read / Write / Construct Only
  "tree-column"          guint                : Read / Write / Construct Only
  "indent"               guint                : Read / Write
  "spacing"              guint                : Read / Write
  "show-stub"            gboolean             : Read / Write
  "line-style"           GtkCTreeLineStyle    : Read / Write
  "expander-style"       GtkCTreeExpanderStyle : Read / Write

Signal Prototypes


"change-focus-row-expansion"
            void        user_function      (GtkCTree *ctree,
                                            GtkCTreeExpansionType expansion,
                                            gpointer user_data);
"tree-collapse"
            void        user_function      (GtkCTree *ctree,
                                            GList *node,
                                            gpointer user_data);
"tree-expand"
            void        user_function      (GtkCTree *ctree,
                                            GList *node,
                                            gpointer user_data);
"tree-move" void        user_function      (GtkCTree *ctree,
                                            GList *node,
                                            GList *new_parent,
                                            GList *new_sibling,
                                            gpointer user_data);
"tree-select-row"
            void        user_function      (GtkCTree *ctree,
                                            GList *node,
                                            gint column,
                                            gpointer user_data);
"tree-unselect-row"
            void        user_function      (GtkCTree *ctree,
                                            GList *node,
                                            gint column,
                                            gpointer user_data);

Description

The GtkCTree widget is used for showing a hierarchical tree to the user, for example a directory tree.

The tree is internally represented as a set of GtkCTreeNode structures.

The interface has much in common with the GtkCList widget: rows (nodes) can be selected by the user etc.

Positions in the tree are often indicated by two arguments, a parent and a sibling, both GtkCTreeNode pointers. If the parent is NULL, the position is at the root of the tree and if the sibling is NULL, it will be the last child of parent, otherwise it will be inserted just before the sibling.

Details

struct GtkCTree

struct GtkCTree;

Warning

GtkCTree is deprecated and should not be used in newly-written code.

The GtkCTree contains the following user-accessible fields. These fields should be considered read-only; to set the values, use the methods below.


GTK_CTREE_ROW()

#define GTK_CTREE_ROW(_node_) ((GtkCTreeRow *)(((GList *)(_node_))->data))

Warning

GTK_CTREE_ROW is deprecated and should not be used in newly-written code.

Used to get the GtkCTreeRow structure corresponding to the given GtkCTreeNode.


GTK_CTREE_NODE()

#define GTK_CTREE_NODE(_node_) ((GtkCTreeNode *)((_node_)))

Warning

GTK_CTREE_NODE is deprecated and should not be used in newly-written code.


GTK_CTREE_NODE_NEXT()

#define GTK_CTREE_NODE_NEXT(_nnode_) ((GtkCTreeNode *)(((GList *)(_nnode_))->next))

Warning

GTK_CTREE_NODE_NEXT is deprecated and should not be used in newly-written code.

FIXME


GTK_CTREE_NODE_PREV()

#define GTK_CTREE_NODE_PREV(_pnode_) ((GtkCTreeNode *)(((GList *)(_pnode_))->prev))

Warning

GTK_CTREE_NODE_PREV is deprecated and should not be used in newly-written code.

FIXME


GTK_CTREE_FUNC()

#define GTK_CTREE_FUNC(_func_) ((GtkCTreeFunc)(_func_))

Warning

GTK_CTREE_FUNC is deprecated and should not be used in newly-written code.


enum GtkCTreePos

typedef enum
{
  GTK_CTREE_POS_BEFORE,
  GTK_CTREE_POS_AS_CHILD,
  GTK_CTREE_POS_AFTER
} GtkCTreePos;

Warning

GtkCTreePos is deprecated and should not be used in newly-written code.

A value specifying the position of a new node relative to an old one.


enum GtkCTreeLineStyle

typedef enum
{
  GTK_CTREE_LINES_NONE,
  GTK_CTREE_LINES_SOLID,
  GTK_CTREE_LINES_DOTTED,
  GTK_CTREE_LINES_TABBED
} GtkCTreeLineStyle;

Warning

GtkCTreeLineStyle is deprecated and should not be used in newly-written code.

The appearance of the lines in the tree graphics.


enum GtkCTreeExpanderStyle

typedef enum
{
  GTK_CTREE_EXPANDER_NONE,
  GTK_CTREE_EXPANDER_SQUARE,
  GTK_CTREE_EXPANDER_TRIANGLE,
  GTK_CTREE_EXPANDER_CIRCULAR
} GtkCTreeExpanderStyle;

Warning

GtkCTreeExpanderStyle is deprecated and should not be used in newly-written code.

The appearance of the expander buttons, i.e. the small buttons which expand or contract parts of the tree when pressed.


enum GtkCTreeExpansionType

typedef enum
{
  GTK_CTREE_EXPANSION_EXPAND,
  GTK_CTREE_EXPANSION_EXPAND_RECURSIVE,
  GTK_CTREE_EXPANSION_COLLAPSE,
  GTK_CTREE_EXPANSION_COLLAPSE_RECURSIVE,
  GTK_CTREE_EXPANSION_TOGGLE,
  GTK_CTREE_EXPANSION_TOGGLE_RECURSIVE
} GtkCTreeExpansionType;

Warning

GtkCTreeExpansionType is deprecated and should not be used in newly-written code.

How to expand or collapse a part of a tree.


GtkCTreeFunc ()

void        (*GtkCTreeFunc)                 (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gpointer data);

Warning

GtkCTreeFunc is deprecated and should not be used in newly-written code.

A generic callback type to do something with a particular node.


GtkCTreeGNodeFunc ()

gboolean    (*GtkCTreeGNodeFunc)            (GtkCTree *ctree,
                                             guint depth,
                                             GNode *gnode,
                                             GtkCTreeNode *cnode,
                                             gpointer data);

Warning

GtkCTreeGNodeFunc is deprecated and should not be used in newly-written code.

FIXME


GtkCTreeCompareDragFunc ()

gboolean    (*GtkCTreeCompareDragFunc)      (GtkCTree *ctree,
                                             GtkCTreeNode *source_node,
                                             GtkCTreeNode *new_parent,
                                             GtkCTreeNode *new_sibling);

Warning

GtkCTreeCompareDragFunc is deprecated and should not be used in newly-written code.

FIXME


struct GtkCTreeRow

struct GtkCTreeRow
{
  GtkCListRow row;
  
  GtkCTreeNode *parent;
  GtkCTreeNode *sibling;
  GtkCTreeNode *children;
  
  GdkPixmap *pixmap_closed;
  GdkBitmap *mask_closed;
  GdkPixmap *pixmap_opened;
  GdkBitmap *mask_opened;
  
  guint16 level;
  
  guint is_leaf  : 1;
  guint expanded : 1;
};

Warning

GtkCTreeRow is deprecated and should not be used in newly-written code.

A structure representing a single row in the tree graph. The values inside the structure should be considered read-only. This structure is derived from the GtkCListRow structure.


struct GtkCTreeNode

struct GtkCTreeNode {
  GList list;
};

Warning

GtkCTreeNode is deprecated and should not be used in newly-written code.

This structure is opaque - you should use the macros GTK_CTREE_ROW, GTK_CTREE_NODE_NEXT etc. as well as the functions below to access it.


GTK_TYPE_CTREE_NODE

#define GTK_TYPE_CTREE_NODE (gtk_ctree_node_get_type ())

Warning

GTK_TYPE_CTREE_NODE is deprecated and should not be used in newly-written code.


gtk_ctree_new_with_titles ()

GtkWidget*  gtk_ctree_new_with_titles       (gint columns,
                                             gint tree_column,
                                             gchar *titles[]);

Warning

gtk_ctree_new_with_titles is deprecated and should not be used in newly-written code.

Create a new GtkCTree widget with the given titles for the columns.


gtk_ctree_new ()

GtkWidget*  gtk_ctree_new                   (gint columns,
                                             gint tree_column);

Warning

gtk_ctree_new is deprecated and should not be used in newly-written code.

Create a new GtkCTree widget.


gtk_ctree_insert_node ()

GtkCTreeNode* gtk_ctree_insert_node         (GtkCTree *ctree,
                                             GtkCTreeNode *parent,
                                             GtkCTreeNode *sibling,
                                             gchar *text[],
                                             guint8 spacing,
                                             GdkPixmap *pixmap_closed,
                                             GdkBitmap *mask_closed,
                                             GdkPixmap *pixmap_opened,
                                             GdkBitmap *mask_opened,
                                             gboolean is_leaf,
                                             gboolean expanded);

Warning

gtk_ctree_insert_node is deprecated and should not be used in newly-written code.

Insert a new node to the tree. The position is specified through the parent-sibling notation, as explained in the introduction above.


gtk_ctree_remove_node ()

void        gtk_ctree_remove_node           (GtkCTree *ctree,
                                             GtkCTreeNode *node);

Warning

gtk_ctree_remove_node is deprecated and should not be used in newly-written code.

Remove the node and all nodes underneath it from the tree.


gtk_ctree_insert_gnode ()

GtkCTreeNode* gtk_ctree_insert_gnode        (GtkCTree *ctree,
                                             GtkCTreeNode *parent,
                                             GtkCTreeNode *sibling,
                                             GNode *gnode,
                                             GtkCTreeGNodeFunc func,
                                             gpointer data);

Warning

gtk_ctree_insert_gnode is deprecated and should not be used in newly-written code.

FIXME


gtk_ctree_export_to_gnode ()

GNode*      gtk_ctree_export_to_gnode       (GtkCTree *ctree,
                                             GNode *parent,
                                             GNode *sibling,
                                             GtkCTreeNode *node,
                                             GtkCTreeGNodeFunc func,
                                             gpointer data);

Warning

gtk_ctree_export_to_gnode is deprecated and should not be used in newly-written code.

FIXME


gtk_ctree_post_recursive ()

void        gtk_ctree_post_recursive        (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             GtkCTreeFunc func,
                                             gpointer data);

Warning

gtk_ctree_post_recursive is deprecated and should not be used in newly-written code.

Recursively apply a function to all nodes of the tree at or below a certain node. The function is called for each node after it has been called for that node's children.


gtk_ctree_post_recursive_to_depth ()

void        gtk_ctree_post_recursive_to_depth
                                            (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint depth,
                                             GtkCTreeFunc func,
                                             gpointer data);

Warning

gtk_ctree_post_recursive_to_depth is deprecated and should not be used in newly-written code.

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.


gtk_ctree_pre_recursive ()

void        gtk_ctree_pre_recursive         (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             GtkCTreeFunc func,
                                             gpointer data);

Warning

gtk_ctree_pre_recursive is deprecated and should not be used in newly-written code.

Recursively apply a function to all nodes of the tree at or below a certain node. The function is called for each node after it has been called for its parent.


gtk_ctree_pre_recursive_to_depth ()

void        gtk_ctree_pre_recursive_to_depth
                                            (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint depth,
                                             GtkCTreeFunc func,
                                             gpointer data);

Warning

gtk_ctree_pre_recursive_to_depth is deprecated and should not be used in newly-written code.

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.


gtk_ctree_is_viewable ()

gboolean    gtk_ctree_is_viewable           (GtkCTree *ctree,
                                             GtkCTreeNode *node);

Warning

gtk_ctree_is_viewable is deprecated and should not be used in newly-written code.

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.


gtk_ctree_last ()

GtkCTreeNode* gtk_ctree_last                (GtkCTree *ctree,
                                             GtkCTreeNode *node);

Warning

gtk_ctree_last is deprecated and should not be used in newly-written code.

Returns the last child of the last child of the last child... of the given node.


gtk_ctree_find_node_ptr ()

GtkCTreeNode* gtk_ctree_find_node_ptr       (GtkCTree *ctree,
                                             GtkCTreeRow *ctree_row);

Warning

gtk_ctree_find_node_ptr is deprecated and should not be used in newly-written code.

Finds the node pointer given a GtkCTreeRow structure.


gtk_ctree_find ()

gboolean    gtk_ctree_find                  (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             GtkCTreeNode *child);

Warning

gtk_ctree_find is deprecated and should not be used in newly-written code.


gtk_ctree_is_ancestor ()

gboolean    gtk_ctree_is_ancestor           (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             GtkCTreeNode *child);

Warning

gtk_ctree_is_ancestor is deprecated and should not be used in newly-written code.


gtk_ctree_find_by_row_data ()

GtkCTreeNode* gtk_ctree_find_by_row_data    (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gpointer data);

Warning

gtk_ctree_find_by_row_data is deprecated and should not be used in newly-written code.

Finds a node in the tree under node that has the given user data pointer.


gtk_ctree_find_all_by_row_data ()

GList*      gtk_ctree_find_all_by_row_data  (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gpointer data);

Warning

gtk_ctree_find_all_by_row_data is deprecated and should not be used in newly-written code.

Finds all nodes in the tree under node that have the given user data pointer.


gtk_ctree_find_by_row_data_custom ()

GtkCTreeNode* gtk_ctree_find_by_row_data_custom
                                            (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gpointer data,
                                             GCompareFunc func);

Warning

gtk_ctree_find_by_row_data_custom is deprecated and should not be used in newly-written code.

Find the first node under node whose row data pointer fulfills a custom criterion.


gtk_ctree_find_all_by_row_data_custom ()

GList*      gtk_ctree_find_all_by_row_data_custom
                                            (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gpointer data,
                                             GCompareFunc func);

Warning

gtk_ctree_find_all_by_row_data_custom is deprecated and should not be used in newly-written code.

Find all nodes under node whose row data pointer fulfills a custom criterion.


gtk_ctree_is_hot_spot ()

gboolean    gtk_ctree_is_hot_spot           (GtkCTree *ctree,
                                             gint x,
                                             gint y);

Warning

gtk_ctree_is_hot_spot is deprecated and should not be used in newly-written code.


gtk_ctree_move ()

void        gtk_ctree_move                  (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             GtkCTreeNode *new_parent,
                                             GtkCTreeNode *new_sibling);

Warning

gtk_ctree_move is deprecated and should not be used in newly-written code.

Move a node in the tree to another location.


gtk_ctree_expand ()

void        gtk_ctree_expand                (GtkCTree *ctree,
                                             GtkCTreeNode *node);

Warning

gtk_ctree_expand is deprecated and should not be used in newly-written code.

Expand one node.


gtk_ctree_expand_recursive ()

void        gtk_ctree_expand_recursive      (GtkCTree *ctree,
                                             GtkCTreeNode *node);

Warning

gtk_ctree_expand_recursive is deprecated and should not be used in newly-written code.

Expand one node and all nodes underneath.


gtk_ctree_expand_to_depth ()

void        gtk_ctree_expand_to_depth       (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint depth);

Warning

gtk_ctree_expand_to_depth is deprecated and should not be used in newly-written code.

Expand a node and its children up to the depth given.


gtk_ctree_collapse ()

void        gtk_ctree_collapse              (GtkCTree *ctree,
                                             GtkCTreeNode *node);

Warning

gtk_ctree_collapse is deprecated and should not be used in newly-written code.

Collapse one node.


gtk_ctree_collapse_recursive ()

void        gtk_ctree_collapse_recursive    (GtkCTree *ctree,
                                             GtkCTreeNode *node);

Warning

gtk_ctree_collapse_recursive is deprecated and should not be used in newly-written code.

Collapse one node and all its subnodes.


gtk_ctree_collapse_to_depth ()

void        gtk_ctree_collapse_to_depth     (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint depth);

Warning

gtk_ctree_collapse_to_depth is deprecated and should not be used in newly-written code.

Collapse a node and its children up to the depth given.


gtk_ctree_toggle_expansion ()

void        gtk_ctree_toggle_expansion      (GtkCTree *ctree,
                                             GtkCTreeNode *node);

Warning

gtk_ctree_toggle_expansion is deprecated and should not be used in newly-written code.

Toggle a node, i.e. if it is collapsed, expand it and vice versa.


gtk_ctree_toggle_expansion_recursive ()

void        gtk_ctree_toggle_expansion_recursive
                                            (GtkCTree *ctree,
                                             GtkCTreeNode *node);

Warning

gtk_ctree_toggle_expansion_recursive is deprecated and should not be used in newly-written code.

Toggle the expansion of a node and all its children.


gtk_ctree_select ()

void        gtk_ctree_select                (GtkCTree *ctree,
                                             GtkCTreeNode *node);

Warning

gtk_ctree_select is deprecated and should not be used in newly-written code.

Cause the given node to be selected and emit the appropriate signal.


gtk_ctree_select_recursive ()

void        gtk_ctree_select_recursive      (GtkCTree *ctree,
                                             GtkCTreeNode *node);

Warning

gtk_ctree_select_recursive is deprecated and should not be used in newly-written code.

Cause the given node and its subnodes to be selected and emit the appropriate signal(s).


gtk_ctree_unselect ()

void        gtk_ctree_unselect              (GtkCTree *ctree,
                                             GtkCTreeNode *node);

Warning

gtk_ctree_unselect is deprecated and should not be used in newly-written code.

Unselect the given node and emit the appropriate signal.


gtk_ctree_unselect_recursive ()

void        gtk_ctree_unselect_recursive    (GtkCTree *ctree,
                                             GtkCTreeNode *node);

Warning

gtk_ctree_unselect_recursive is deprecated and should not be used in newly-written code.

Unselect the given node and its subnodes and emit the appropriate signal(s).


gtk_ctree_real_select_recursive ()

void        gtk_ctree_real_select_recursive (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint state);

Warning

gtk_ctree_real_select_recursive is deprecated and should not be used in newly-written code.

The function that implements both gtk_ctree_select_recursive and gtk_ctree_unselect_recursive.


gtk_ctree_node_set_text ()

void        gtk_ctree_node_set_text         (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column,
                                             const gchar *text);

Warning

gtk_ctree_node_set_text is deprecated and should not be used in newly-written code.

Set the text in a node.


gtk_ctree_node_set_pixmap ()

void        gtk_ctree_node_set_pixmap       (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column,
                                             GdkPixmap *pixmap,
                                             GdkBitmap *mask);

Warning

gtk_ctree_node_set_pixmap is deprecated and should not be used in newly-written code.

FIXME


gtk_ctree_node_set_pixtext ()

void        gtk_ctree_node_set_pixtext      (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column,
                                             const gchar *text,
                                             guint8 spacing,
                                             GdkPixmap *pixmap,
                                             GdkBitmap *mask);

Warning

gtk_ctree_node_set_pixtext is deprecated and should not be used in newly-written code.

FIXME


gtk_ctree_set_node_info ()

void        gtk_ctree_set_node_info         (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             const gchar *text,
                                             guint8 spacing,
                                             GdkPixmap *pixmap_closed,
                                             GdkBitmap *mask_closed,
                                             GdkPixmap *pixmap_opened,
                                             GdkBitmap *mask_opened,
                                             gboolean is_leaf,
                                             gboolean expanded);

Warning

gtk_ctree_set_node_info is deprecated and should not be used in newly-written code.

Change the information. Most parameters correspond to the parameters of gtk_ctree_insert_node.


gtk_ctree_node_set_shift ()

void        gtk_ctree_node_set_shift        (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column,
                                             gint vertical,
                                             gint horizontal);

Warning

gtk_ctree_node_set_shift is deprecated and should not be used in newly-written code.

Shift the given cell the given amounts in pixels.


gtk_ctree_node_set_selectable ()

void        gtk_ctree_node_set_selectable   (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gboolean selectable);

Warning

gtk_ctree_node_set_selectable is deprecated and should not be used in newly-written code.


gtk_ctree_node_get_selectable ()

gboolean    gtk_ctree_node_get_selectable   (GtkCTree *ctree,
                                             GtkCTreeNode *node);

Warning

gtk_ctree_node_get_selectable is deprecated and should not be used in newly-written code.


gtk_ctree_node_get_cell_type ()

GtkCellType gtk_ctree_node_get_cell_type    (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column);

Warning

gtk_ctree_node_get_cell_type is deprecated and should not be used in newly-written code.


gtk_ctree_node_get_text ()

gboolean    gtk_ctree_node_get_text         (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column,
                                             gchar **text);

Warning

gtk_ctree_node_get_text is deprecated and should not be used in newly-written code.


gtk_ctree_node_get_pixmap ()

gboolean    gtk_ctree_node_get_pixmap       (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column,
                                             GdkPixmap **pixmap,
                                             GdkBitmap **mask);

Warning

gtk_ctree_node_get_pixmap is deprecated and should not be used in newly-written code.


gtk_ctree_node_get_pixtext ()

gboolean    gtk_ctree_node_get_pixtext      (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column,
                                             gchar **text,
                                             guint8 *spacing,
                                             GdkPixmap **pixmap,
                                             GdkBitmap **mask);

Warning

gtk_ctree_node_get_pixtext is deprecated and should not be used in newly-written code.

Get the parameters of a cell containing both a pixmap and text.


gtk_ctree_get_node_info ()

gboolean    gtk_ctree_get_node_info         (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gchar **text,
                                             guint8 *spacing,
                                             GdkPixmap **pixmap_closed,
                                             GdkBitmap **mask_closed,
                                             GdkPixmap **pixmap_opened,
                                             GdkBitmap **mask_opened,
                                             gboolean *is_leaf,
                                             gboolean *expanded);

Warning

gtk_ctree_get_node_info is deprecated and should not be used in newly-written code.

Get information corresponding to a node. Any of the return parameters can be null.


gtk_ctree_node_set_row_style ()

void        gtk_ctree_node_set_row_style    (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             GtkStyle *style);

Warning

gtk_ctree_node_set_row_style is deprecated and should not be used in newly-written code.

Set the style of a row.


gtk_ctree_node_get_row_style ()

GtkStyle*   gtk_ctree_node_get_row_style    (GtkCTree *ctree,
                                             GtkCTreeNode *node);

Warning

gtk_ctree_node_get_row_style is deprecated and should not be used in newly-written code.

Get the style of a row.


gtk_ctree_node_set_cell_style ()

void        gtk_ctree_node_set_cell_style   (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column,
                                             GtkStyle *style);

Warning

gtk_ctree_node_set_cell_style is deprecated and should not be used in newly-written code.

Set the style of an individual cell.


gtk_ctree_node_get_cell_style ()

GtkStyle*   gtk_ctree_node_get_cell_style   (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column);

Warning

gtk_ctree_node_get_cell_style is deprecated and should not be used in newly-written code.

Get the style of an individual cell.


gtk_ctree_node_set_foreground ()

void        gtk_ctree_node_set_foreground   (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             GdkColor *color);

Warning

gtk_ctree_node_set_foreground is deprecated and should not be used in newly-written code.


gtk_ctree_node_set_background ()

void        gtk_ctree_node_set_background   (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             GdkColor *color);

Warning

gtk_ctree_node_set_background is deprecated and should not be used in newly-written code.


gtk_ctree_node_set_row_data ()

void        gtk_ctree_node_set_row_data     (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gpointer data);

Warning

gtk_ctree_node_set_row_data is deprecated and should not be used in newly-written code.

Set the custom data associated with a node.


gtk_ctree_node_set_row_data_full ()

void        gtk_ctree_node_set_row_data_full
                                            (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gpointer data,
                                             GtkDestroyNotify destroy);

Warning

gtk_ctree_node_set_row_data_full is deprecated and should not be used in newly-written code.

This is the full interface to setting row data, so that a destructor can be given for the data.


gtk_ctree_node_get_row_data ()

gpointer    gtk_ctree_node_get_row_data     (GtkCTree *ctree,
                                             GtkCTreeNode *node);

Warning

gtk_ctree_node_get_row_data is deprecated and should not be used in newly-written code.


gtk_ctree_node_moveto ()

void        gtk_ctree_node_moveto           (GtkCTree *ctree,
                                             GtkCTreeNode *node,
                                             gint column,
                                             gfloat row_align,
                                             gfloat col_align);

Warning

gtk_ctree_node_moveto is deprecated and should not be used in newly-written code.

This function makes the given column of the given node visible by scrolling.


gtk_ctree_node_is_visible ()

GtkVisibility gtk_ctree_node_is_visible     (GtkCTree *ctree,
                                             GtkCTreeNode *node);

Warning

gtk_ctree_node_is_visible is deprecated and should not be used in newly-written code.


gtk_ctree_set_indent ()

void        gtk_ctree_set_indent            (GtkCTree *ctree,
                                             gint indent);

Warning

gtk_ctree_set_indent is deprecated and should not be used in newly-written code.


gtk_ctree_set_spacing ()

void        gtk_ctree_set_spacing           (GtkCTree *ctree,
                                             gint spacing);

Warning

gtk_ctree_set_spacing is deprecated and should not be used in newly-written code.

The spacing between the tree graphic and the actual node content.


gtk_ctree_set_reorderable()

#define gtk_ctree_set_reorderable(t,r)                    gtk_clist_set_reorderable((GtkCList*) (t),(r))

Warning

gtk_ctree_set_reorderable is deprecated and should not be used in newly-written code.


gtk_ctree_set_line_style ()

void        gtk_ctree_set_line_style        (GtkCTree *ctree,
                                             GtkCTreeLineStyle line_style);

Warning

gtk_ctree_set_line_style is deprecated and should not be used in newly-written code.


gtk_ctree_set_expander_style ()

void        gtk_ctree_set_expander_style    (GtkCTree *ctree,
                                             GtkCTreeExpanderStyle expander_style);

Warning

gtk_ctree_set_expander_style is deprecated and should not be used in newly-written code.


gtk_ctree_set_drag_compare_func ()

void        gtk_ctree_set_drag_compare_func (GtkCTree *ctree,
                                             GtkCTreeCompareDragFunc cmp_func);

Warning

gtk_ctree_set_drag_compare_func is deprecated and should not be used in newly-written code.

FIXME


gtk_ctree_sort_node ()

void        gtk_ctree_sort_node             (GtkCTree *ctree,
                                             GtkCTreeNode *node);

Warning

gtk_ctree_sort_node is deprecated and should not be used in newly-written code.

Sort the children of a node. See GtkCList for how to set the sorting criteria etc.


gtk_ctree_sort_recursive ()

void        gtk_ctree_sort_recursive        (GtkCTree *ctree,
                                             GtkCTreeNode *node);

Warning

gtk_ctree_sort_recursive is deprecated and should not be used in newly-written code.

Sort the descendants of a node. See GtkCList for how to set the sorting criteria etc.


gtk_ctree_node_nth ()

GtkCTreeNode* gtk_ctree_node_nth            (GtkCTree *ctree,
                                             guint row);

Warning

gtk_ctree_node_nth is deprecated and should not be used in newly-written code.


gtk_ctree_set_show_stub ()

void        gtk_ctree_set_show_stub         (GtkCTree *ctree,
                                             gboolean show_stub);

Warning

gtk_ctree_set_show_stub is deprecated and should not be used in newly-written code.

Properties

"n-columns" (guint : Read / Write / Construct Only)

The number of columns in the tree.

"tree-column" (guint : Read / Write / Construct Only)

The column in which the actual tree graphic appears.

"indent" (guint : Read / Write)

The number of pixels to indent the tree levels.

"spacing" (guint : Read / Write)

The number of pixels between the tree and the columns.

"show-stub" (gboolean : Read / Write)

FIXME

"line-style" (GtkCTreeLineStyle : Read / Write)

The style of the lines in the tree graphic.

"expander-style" (GtkCTreeExpanderStyle : Read / Write)

The style of the expander buttons.

Signals

The "change-focus-row-expansion" signal

void        user_function                  (GtkCTree *ctree,
                                            GtkCTreeExpansionType expansion,
                                            gpointer user_data);

The row which has the focus is either collapsed or expanded or toggled.


The "tree-collapse" signal

void        user_function                  (GtkCTree *ctree,
                                            GList *node,
                                            gpointer user_data);

Emitted when a node is collapsed.


The "tree-expand" signal

void        user_function                  (GtkCTree *ctree,
                                            GList *node,
                                            gpointer user_data);

Emitted when a node is expanded.


The "tree-move" signal

void        user_function                  (GtkCTree *ctree,
                                            GList *node,
                                            GList *new_parent,
                                            GList *new_sibling,
                                            gpointer user_data);

Emitted when a node is moved.


The "tree-select-row" signal

void        user_function                  (GtkCTree *ctree,
                                            GList *node,
                                            gint column,
                                            gpointer user_data);

Emitted when a row is selected.


The "tree-unselect-row" signal

void        user_function                  (GtkCTree *ctree,
                                            GList *node,
                                            gint column,
                                            gpointer user_data);

Emitted when a node is unselected.