Pileus Git - ~andy/gtk/blob - gtk/gtktree.h

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19 #ifndef __GTK_TREE_H__
  20 #define __GTK_TREE_H__
  21
  22 /* set this flag to enable tree debugging output */
  23 /* #define TREE_DEBUG */
  24
  25 #include <gdk/gdk.h>
  26 #include <gtk/gtkcontainer.h>
  27
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif /* __cplusplus */
  32
  33
  34 #define GTK_TYPE_TREE                  (gtk_tree_get_type ())
  35 #define GTK_TREE(obj)                  (GTK_CHECK_CAST ((obj), GTK_TYPE_TREE, GtkTree))
  36 #define GTK_TREE_CLASS(klass)          (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE, GtkTreeClass))
  37 #define GTK_IS_TREE(obj)               (GTK_CHECK_TYPE ((obj), GTK_TYPE_TREE))
  38 #define GTK_IS_TREE_CLASS(klass)       (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE))
  39
  40 #define GTK_IS_ROOT_TREE(obj)   ((GtkObject*) GTK_TREE(obj)->root_tree == (GtkObject*)obj)
  41 #define GTK_TREE_ROOT_TREE(obj) (GTK_TREE(obj)->root_tree ? GTK_TREE(obj)->root_tree : GTK_TREE(obj))
  42 #define GTK_TREE_SELECTION(obj) (GTK_TREE_ROOT_TREE(obj)->selection)
  43
  44 typedef enum
  45 {
  46   GTK_TREE_VIEW_LINE,  /* default view mode */
  47   GTK_TREE_VIEW_ITEM
  48 } GtkTreeViewMode;
  49
  50 typedef struct _GtkTree       GtkTree;
  51 typedef struct _GtkTreeClass  GtkTreeClass;
  52
  53 struct _GtkTree
  54 {
  55   GtkContainer container;
  56
  57   GList *children;
  58
  59   GtkTree* root_tree; /* owner of selection list */
  60   GtkWidget* tree_owner;
  61   GList *selection;
  62   guint level;
  63   guint indent_value;
  64   guint current_indent;
  65   guint selection_mode : 2;
  66   guint view_mode : 1;
  67   guint view_line : 1;
  68 };
  69
  70 struct _GtkTreeClass
  71 {
  72   GtkContainerClass parent_class;
  73
  74   void (* selection_changed) (GtkTree   *tree);
  75   void (* select_child)      (GtkTree   *tree,
  76                               GtkWidget *child);
  77   void (* unselect_child)    (GtkTree   *tree,
  78                               GtkWidget *child);
  79 };
  80
  81
  82 GtkType    gtk_tree_get_type           (void);
  83 GtkWidget* gtk_tree_new                (void);
  84 void       gtk_tree_append             (GtkTree          *tree,
  85                                         GtkWidget        *tree_item);
  86 void       gtk_tree_prepend            (GtkTree          *tree,
  87                                         GtkWidget        *tree_item);
  88 void       gtk_tree_insert             (GtkTree          *tree,
  89                                         GtkWidget        *tree_item,
  90                                         gint              position);
  91 void       gtk_tree_remove_items       (GtkTree          *tree,
  92                                         GList            *items);
  93 void       gtk_tree_clear_items        (GtkTree          *tree,
  94                                         gint              start,
  95                                         gint              end);
  96 void       gtk_tree_select_item        (GtkTree          *tree,
  97                                         gint              item);
  98 void       gtk_tree_unselect_item      (GtkTree          *tree,
  99                                         gint              item);
 100 void       gtk_tree_select_child       (GtkTree          *tree,
 101                                         GtkWidget        *tree_item);
 102 void       gtk_tree_unselect_child     (GtkTree          *tree,
 103                                         GtkWidget        *tree_item);
 104 gint       gtk_tree_child_position     (GtkTree          *tree,
 105                                         GtkWidget        *child);
 106 void       gtk_tree_set_selection_mode (GtkTree          *tree,
 107                                         GtkSelectionMode  mode);
 108 void       gtk_tree_set_view_mode      (GtkTree          *tree,
 109                                         GtkTreeViewMode   mode);
 110 void       gtk_tree_set_view_lines     (GtkTree          *tree,
 111                                         guint            flag);
 112
 113 /* deprecated function, use gtk_container_remove instead.
 114  */
 115 void       gtk_tree_remove_item        (GtkTree          *tree,
 116                                         GtkWidget        *child);
 117
 118
 119 #ifdef __cplusplus
 120 }
 121 #endif /* __cplusplus */
 122
 123
 124 #endif /* __GTK_TREE_H__ */