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

   1 /* gtktreeview.h
   2  * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
   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_VIEW_H__
  20 #define __GTK_TREE_VIEW_H__
  21
  22 #include <gtk/gtkcontainer.h>
  23 #include <gtk/gtktreemodel.h>
  24 #include <gtk/gtktreeviewcolumn.h>
  25 #include <gtk/gtkdnd.h>
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif /* __cplusplus */
  30
  31 typedef enum
  32 {
  33   /* drop before/after this row */
  34   GTK_TREE_VIEW_DROP_BEFORE,
  35   GTK_TREE_VIEW_DROP_AFTER,
  36   /* drop as a child of this row (with fallback to before or after
  37    * if into is not possible)
  38    */
  39   GTK_TREE_VIEW_DROP_INTO_OR_BEFORE,
  40   GTK_TREE_VIEW_DROP_INTO_OR_AFTER
  41 } GtkTreeViewDropPosition;
  42
  43 #define GTK_TYPE_TREE_VIEW              (gtk_tree_view_get_type ())
  44 #define GTK_TREE_VIEW(obj)              (GTK_CHECK_CAST ((obj), GTK_TYPE_TREE_VIEW, GtkTreeView))
  45 #define GTK_TREE_VIEW_CLASS(klass)      (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_VIEW, GtkTreeViewClass))
  46 #define GTK_IS_TREE_VIEW(obj)           (GTK_CHECK_TYPE ((obj), GTK_TYPE_TREE_VIEW))
  47 #define GTK_IS_TREE_VIEW_CLASS(klass)   (GTK_CHECK_CLASS_TYPE ((obj), GTK_TYPE_TREE_VIEW))
  48
  49 typedef struct _GtkTreeView        GtkTreeView;
  50 typedef struct _GtkTreeViewClass   GtkTreeViewClass;
  51 typedef struct _GtkTreeViewPrivate GtkTreeViewPrivate;
  52
  53 typedef struct _GtkTreeSelection      GtkTreeSelection;
  54 typedef struct _GtkTreeSelectionClass GtkTreeSelectionClass;
  55
  56
  57 struct _GtkTreeView
  58 {
  59   GtkContainer parent;
  60
  61   GtkTreeViewPrivate *priv;
  62 };
  63
  64 struct _GtkTreeViewClass
  65 {
  66   GtkContainerClass parent_class;
  67
  68   void (* set_scroll_adjustments) (GtkTreeView       *tree_view,
  69                                    GtkAdjustment     *hadjustment,
  70                                    GtkAdjustment     *vadjustment);
  71   void (* row_activated)          (GtkTreeView       *tree_view,
  72                                    GtkTreeViewColumn *column);
  73   gint (* expand_row)             (GtkTreeView       *tree_view,
  74                                    GtkTreeIter       *iter,
  75                                    GtkTreePath       *path);
  76   gint (* collapse_row)           (GtkTreeView       *tree_view,
  77                                    GtkTreeIter       *iter,
  78                                    GtkTreePath       *path);
  79
  80 };
  81
  82 GtkType                gtk_tree_view_get_type                      (void);
  83 GtkWidget             *gtk_tree_view_new                           (void);
  84 GtkWidget             *gtk_tree_view_new_with_model                (GtkTreeModel       *model);
  85 GtkTreeModel          *gtk_tree_view_get_model                     (GtkTreeView        *tree_view);
  86 void                   gtk_tree_view_set_model                     (GtkTreeView        *tree_view,
  87                                                                     GtkTreeModel       *model);
  88 GtkTreeSelection      *gtk_tree_view_get_selection                 (GtkTreeView        *tree_view);
  89 GtkAdjustment         *gtk_tree_view_get_hadjustment               (GtkTreeView        *tree_view);
  90 void                   gtk_tree_view_set_hadjustment               (GtkTreeView        *tree_view,
  91                                                                     GtkAdjustment      *adjustment);
  92 GtkAdjustment         *gtk_tree_view_get_vadjustment               (GtkTreeView        *tree_view);
  93 void                   gtk_tree_view_set_vadjustment               (GtkTreeView        *tree_view,
  94                                                                     GtkAdjustment      *adjustment);
  95 gboolean               gtk_tree_view_get_headers_visible           (GtkTreeView        *tree_view);
  96 void                   gtk_tree_view_set_headers_visible           (GtkTreeView        *tree_view,
  97                                                                     gboolean            headers_visible);
  98 void                   gtk_tree_view_columns_autosize              (GtkTreeView        *tree_view);
  99 void                   gtk_tree_view_set_headers_clickable         (GtkTreeView        *tree_view,
 100                                                                     gboolean            setting);
 101 gint                   gtk_tree_view_append_column                 (GtkTreeView        *tree_view,
 102                                                                     GtkTreeViewColumn  *column);
 103 gint                   gtk_tree_view_remove_column                 (GtkTreeView        *tree_view,
 104                                                                     GtkTreeViewColumn  *column);
 105 gint                   gtk_tree_view_insert_column                 (GtkTreeView        *tree_view,
 106                                                                     GtkTreeViewColumn  *column,
 107                                                                     gint                position);
 108 gint                   gtk_tree_view_insert_column_with_attributes (GtkTreeView        *tree_view,
 109                                                                     gint                position,
 110                                                                     gchar              *title,
 111                                                                     GtkCellRenderer    *cell,
 112                                                                     ...);
 113 GtkTreeViewColumn     *gtk_tree_view_get_column                    (GtkTreeView        *tree_view,
 114                                                                     gint                n);
 115 void                   gtk_tree_view_set_expander_column           (GtkTreeView        *tree_view,
 116                                                                     gint                col);
 117 gint                   gtk_tree_view_get_expander_column           (GtkTreeView        *tree_view);
 118
 119
 120 /* Actions */
 121 void                   gtk_tree_view_scroll_to_point               (GtkTreeView        *tree_view,
 122                                                                     gint                tree_x,
 123                                                                     gint                tree_y);
 124 void                   gtk_tree_view_scroll_to_cell                (GtkTreeView        *tree_view,
 125                                                                     GtkTreePath        *path,
 126                                                                     GtkTreeViewColumn  *column,
 127                                                                     gfloat              row_align,
 128                                                                     gfloat              col_align);
 129 gboolean               gtk_tree_view_get_path_at_pos               (GtkTreeView        *tree_view,
 130                                                                     GdkWindow          *window,
 131                                                                     gint                x,
 132                                                                     gint                y,
 133                                                                     GtkTreePath       **path,
 134                                                                     GtkTreeViewColumn **column,
 135                                                                     gint               *cell_x,
 136                                                                     gint               *cell_y);
 137 void                   gtk_tree_view_get_cell_area                 (GtkTreeView        *tree_view,
 138                                                                     GtkTreePath        *path,
 139                                                                     GtkTreeViewColumn  *column,
 140                                                                     GdkRectangle       *rect);
 141 void                   gtk_tree_view_get_background_area           (GtkTreeView        *tree_view,
 142                                                                     GtkTreePath        *path,
 143                                                                     GtkTreeViewColumn  *column,
 144                                                                     GdkRectangle       *rect);
 145 void                   gtk_tree_view_expand_all                    (GtkTreeView        *tree_view);
 146 void                   gtk_tree_view_collapse_all                  (GtkTreeView        *tree_view);
 147 gboolean               gtk_tree_view_expand_row                    (GtkTreeView        *tree_view,
 148                                                                     GtkTreePath        *path,
 149                                                                     gboolean            open_all);
 150 gboolean               gtk_tree_view_collapse_row                  (GtkTreeView        *tree_view,
 151                                                                     GtkTreePath        *path);
 152 void                   gtk_tree_view_row_activated                 (GtkTreeView        *tree_view,
 153                                                                     GtkTreePath        *path,
 154                                                                     GtkTreeViewColumn  *column);
 155
 156 void gtk_tree_view_get_visible_rect      (GtkTreeView  *tree_view,
 157                                           GdkRectangle *visible_rect);
 158 void gtk_tree_view_widget_to_tree_coords (GtkTreeView  *tree_view,
 159                                           gint          wx,
 160                                           gint          wy,
 161                                           gint         *tx,
 162                                           gint         *ty);
 163 void gtk_tree_view_tree_to_widget_coords (GtkTreeView  *tree_view,
 164                                           gint          tx,
 165                                           gint          ty,
 166                                           gint         *wx,
 167                                           gint         *wy);
 168
 169 void     gtk_tree_view_set_rules_hint     (GtkTreeView  *tree_view,
 170                                            gboolean      setting);
 171 gboolean gtk_tree_view_get_rules_hint     (GtkTreeView  *tree_view);
 172
 173
 174 /* Drag-and-Drop support */
 175
 176 typedef gboolean (* GtkTreeViewDraggableFunc) (GtkTreeView    *tree_view,
 177                                                GdkDragContext *context,
 178                                                GtkTreePath    *path,
 179                                                gpointer        user_data);
 180
 181 /* this func can change "pos" if it likes, in addition to returning
 182  * true/false for whether a drop is possible
 183  */
 184 typedef gboolean (* GtkTreeViewDroppableFunc) (GtkTreeView             *tree_view,
 185                                                GdkDragContext          *context,
 186                                                GtkTreePath             *path,
 187                                                GtkTreeViewDropPosition *pos,
 188                                                gpointer                 user_data);
 189
 190 void     gtk_tree_view_set_rows_drag_source   (GtkTreeView              *tree_view,
 191                                                GdkModifierType           start_button_mask,
 192                                                const GtkTargetEntry     *targets,
 193                                                gint                      n_targets,
 194                                                GdkDragAction             actions,
 195                                                GtkTreeViewDraggableFunc  row_draggable_func,
 196                                                gpointer                  user_data);
 197 void     gtk_tree_view_set_rows_drag_dest     (GtkTreeView              *tree_view,
 198                                                const GtkTargetEntry     *targets,
 199                                                gint                      n_targets,
 200                                                GdkDragAction             actions,
 201                                                GtkTreeViewDroppableFunc  location_droppable_func,
 202                                                gpointer                  user_data);
 203
 204 void     gtk_tree_view_unset_rows_drag_source (GtkTreeView *tree_view);
 205 void     gtk_tree_view_unset_rows_drag_dest   (GtkTreeView *tree_view);
 206
 207 /* These are useful to implement your own custom stuff. */
 208 void       gtk_tree_view_set_drag_dest_row    (GtkTreeView              *tree_view,
 209                                                GtkTreePath              *path,
 210                                                GtkTreeViewDropPosition   pos);
 211 void       gtk_tree_view_get_drag_dest_row    (GtkTreeView              *tree_view,
 212                                                GtkTreePath             **path,
 213                                                GtkTreeViewDropPosition  *pos);
 214 gboolean   gtk_tree_view_get_dest_row_at_pos  (GtkTreeView              *tree_view,
 215                                                gint                      drag_x,
 216                                                gint                      drag_y,
 217                                                GtkTreePath             **path,
 218                                                GtkTreeViewDropPosition  *pos);
 219 GdkPixmap* gtk_tree_view_create_row_drag_icon (GtkTreeView              *tree_view,
 220                                                GtkTreePath              *path);
 221
 222
 223
 224 #ifdef __cplusplus
 225 }
 226 #endif /* __cplusplus */
 227
 228
 229 #endif /* __GTK_TREE_VIEW_H__ */
 230