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 #define GTK_TREE_VIEW_GET_CLASS(obj)    (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_TREE_VIEW, GtkTreeViewClass))
  49
  50 typedef struct _GtkTreeView           GtkTreeView;
  51 typedef struct _GtkTreeViewClass      GtkTreeViewClass;
  52 typedef struct _GtkTreeViewPrivate    GtkTreeViewPrivate;
  53 typedef struct _GtkTreeSelection      GtkTreeSelection;
  54 typedef struct _GtkTreeSelectionClass GtkTreeSelectionClass;
  55
  56 struct _GtkTreeView
  57 {
  58   GtkContainer parent;
  59
  60   GtkTreeViewPrivate *priv;
  61 };
  62
  63 struct _GtkTreeViewClass
  64 {
  65   GtkContainerClass parent_class;
  66
  67   void     (* set_scroll_adjustments)     (GtkTreeView       *tree_view,
  68                                            GtkAdjustment     *hadjustment,
  69                                            GtkAdjustment     *vadjustment);
  70   void     (* row_activated)              (GtkTreeView       *tree_view,
  71                                            GtkTreePath       *path,
  72                                            GtkTreeViewColumn *column);
  73   gboolean (* test_expand_row)            (GtkTreeView       *tree_view,
  74                                            GtkTreeIter       *iter,
  75                                            GtkTreePath       *path);
  76   gboolean (* test_collapse_row)          (GtkTreeView       *tree_view,
  77                                            GtkTreeIter       *iter,
  78                                            GtkTreePath       *path);
  79   void     (* row_expanded)               (GtkTreeView       *tree_view,
  80                                            GtkTreeIter       *iter,
  81                                            GtkTreePath       *path);
  82   void     (* row_collapsed)              (GtkTreeView       *tree_view,
  83                                            GtkTreeIter       *iter,
  84                                            GtkTreePath       *path);
  85   void     (* columns_changed)            (GtkTreeView       *tree_view);
  86
  87   /* Key Binding signals */
  88   void     (* begin_extended_selection)   (GtkTreeView       *tree_view);
  89   void     (* end_extended_selection)     (GtkTreeView       *tree_view);
  90   void     (* begin_free_motion)          (GtkTreeView       *tree_view);
  91   void     (* end_free_motion)            (GtkTreeView       *tree_view);
  92   void     (* move_cursor)                (GtkTreeView       *tree_view,
  93                                            GtkMovementStep    step,
  94                                            gint               count);
  95   void     (* select_cursor_row)          (GtkTreeView       *tree_view);
  96   void     (* toggle_cursor_row)          (GtkTreeView       *tree_view);
  97   void     (* expand_collapse_cursor_row) (GtkTreeView       *tree_view,
  98                                            gboolean           logical,
  99                                            gboolean           expand,
 100                                            gboolean           open_all);
 101   void     (* select_cursor_parent)       (GtkTreeView       *tree_view);
 102 };
 103
 104
 105 typedef gboolean (* GtkTreeViewColumnDropFunc) (GtkTreeView             *tree_view,
 106                                                 GtkTreeViewColumn       *column,
 107                                                 GtkTreeViewColumn       *prev_column,
 108                                                 GtkTreeViewColumn       *next_column,
 109                                                 gpointer                 data);
 110 typedef gboolean (* GtkTreeViewDraggableFunc)  (GtkTreeView             *tree_view,
 111                                                 GdkDragContext          *context,
 112                                                 GtkTreePath             *path,
 113                                                 gpointer                user_data);
 114 typedef void     (* GtkTreeViewMappingFunc)    (GtkTreeView             *tree_view,
 115                                                 GtkTreePath             *path,
 116                                                 gpointer                 user_data);
 117 typedef gboolean (* GtkTreeViewDroppableFunc)  (GtkTreeView             *tree_view,
 118                                                 GdkDragContext          *context,
 119                                                 GtkTreePath             *path,
 120                                                 GtkTreeViewDropPosition *pos,
 121                                                 gpointer                 user_data);
 122
 123
 124 /* Creators */
 125 GtkType                gtk_tree_view_get_type                      (void);
 126 GtkWidget             *gtk_tree_view_new                           (void);
 127 GtkWidget             *gtk_tree_view_new_with_model                (GtkTreeModel              *model);
 128
 129 /* Accessors */
 130 GtkTreeModel          *gtk_tree_view_get_model                     (GtkTreeView               *tree_view);
 131 void                   gtk_tree_view_set_model                     (GtkTreeView               *tree_view,
 132                                                                     GtkTreeModel              *model);
 133 GtkTreeSelection      *gtk_tree_view_get_selection                 (GtkTreeView               *tree_view);
 134 GtkAdjustment         *gtk_tree_view_get_hadjustment               (GtkTreeView               *tree_view);
 135 void                   gtk_tree_view_set_hadjustment               (GtkTreeView               *tree_view,
 136                                                                     GtkAdjustment             *adjustment);
 137 GtkAdjustment         *gtk_tree_view_get_vadjustment               (GtkTreeView               *tree_view);
 138 void                   gtk_tree_view_set_vadjustment               (GtkTreeView               *tree_view,
 139                                                                     GtkAdjustment             *adjustment);
 140 gboolean               gtk_tree_view_get_headers_visible           (GtkTreeView               *tree_view);
 141 void                   gtk_tree_view_set_headers_visible           (GtkTreeView               *tree_view,
 142                                                                     gboolean                   headers_visible);
 143 void                   gtk_tree_view_columns_autosize              (GtkTreeView               *tree_view);
 144 void                   gtk_tree_view_set_headers_clickable         (GtkTreeView               *tree_view,
 145                                                                     gboolean                   setting);
 146 void                   gtk_tree_view_set_rules_hint                (GtkTreeView               *tree_view,
 147                                                                     gboolean                   setting);
 148 gboolean               gtk_tree_view_get_rules_hint                (GtkTreeView               *tree_view);
 149
 150 /* Column funtions */
 151 gint                   gtk_tree_view_append_column                 (GtkTreeView               *tree_view,
 152                                                                     GtkTreeViewColumn         *column);
 153 gint                   gtk_tree_view_remove_column                 (GtkTreeView               *tree_view,
 154                                                                     GtkTreeViewColumn         *column);
 155 gint                   gtk_tree_view_insert_column                 (GtkTreeView               *tree_view,
 156                                                                     GtkTreeViewColumn         *column,
 157                                                                     gint                       position);
 158 gint                   gtk_tree_view_insert_column_with_attributes (GtkTreeView               *tree_view,
 159                                                                     gint                       position,
 160                                                                     gchar                     *title,
 161                                                                     GtkCellRenderer           *cell,
 162                                                                     ...);
 163 gint                   gtk_tree_view_insert_column_with_data_func  (GtkTreeView               *tree_view,
 164                                                                     gint                       position,
 165                                                                     gchar                     *title,
 166                                                                     GtkCellRenderer           *cell,
 167                                                                     GtkTreeCellDataFunc        func,
 168                                                                     gpointer                   data,
 169                                                                     GDestroyNotify             dnotify);
 170 GtkTreeViewColumn     *gtk_tree_view_get_column                    (GtkTreeView               *tree_view,
 171                                                                     gint                       n);
 172 GList                 *gtk_tree_view_get_columns                   (GtkTreeView               *tree_view);
 173 void                   gtk_tree_view_move_column_after             (GtkTreeView               *tree_view,
 174                                                                     GtkTreeViewColumn         *column,
 175                                                                     GtkTreeViewColumn         *base_column);
 176 void                   gtk_tree_view_set_expander_column           (GtkTreeView               *tree_view,
 177                                                                     gint                       col);
 178 gint                   gtk_tree_view_get_expander_column           (GtkTreeView               *tree_view);
 179 void                   gtk_tree_view_set_column_drag_function      (GtkTreeView               *tree_view,
 180                                                                     GtkTreeViewColumnDropFunc  func,
 181                                                                     gpointer                   user_data,
 182                                                                     GtkDestroyNotify           destroy);
 183
 184 /* Actions */
 185 void                   gtk_tree_view_scroll_to_point               (GtkTreeView               *tree_view,
 186                                                                     gint                       tree_x,
 187                                                                     gint                       tree_y);
 188 void                   gtk_tree_view_scroll_to_cell                (GtkTreeView               *tree_view,
 189                                                                     GtkTreePath               *path,
 190                                                                     GtkTreeViewColumn         *column,
 191                                                                     gfloat                     row_align,
 192                                                                     gfloat                     col_align);
 193 void                   gtk_tree_view_row_activated                 (GtkTreeView               *tree_view,
 194                                                                     GtkTreePath               *path,
 195                                                                     GtkTreeViewColumn         *column);
 196 void                   gtk_tree_view_expand_all                    (GtkTreeView               *tree_view);
 197 void                   gtk_tree_view_collapse_all                  (GtkTreeView               *tree_view);
 198 gboolean               gtk_tree_view_expand_row                    (GtkTreeView               *tree_view,
 199                                                                     GtkTreePath               *path,
 200                                                                     gboolean                   open_all);
 201 gboolean               gtk_tree_view_collapse_row                  (GtkTreeView               *tree_view,
 202                                                                     GtkTreePath               *path);
 203 void                   gtk_tree_view_map_expanded_rows             (GtkTreeView               *tree_view,
 204                                                                     GtkTreeViewMappingFunc     func,
 205                                                                     gpointer                   data);
 206 gboolean               gtk_tree_view_row_expanded                  (GtkTreeView               *tree_view,
 207                                                                     GtkTreePath               *path);
 208 void                   gtk_tree_view_set_reorderable               (GtkTreeView               *tree_view,
 209                                                                     gboolean                   reorderable);
 210 gboolean               gtk_tree_view_get_reorderable               (GtkTreeView               *tree_view);
 211 void                   gtk_tree_view_set_cursor                    (GtkTreeView               *tree_view,
 212                                                                     GtkTreePath               *path);
 213
 214
 215 /* Layout information */
 216 gboolean               gtk_tree_view_get_path_at_pos               (GtkTreeView               *tree_view,
 217                                                                     GdkWindow                 *window,
 218                                                                     gint                       x,
 219                                                                     gint                       y,
 220                                                                     GtkTreePath              **path,
 221                                                                     GtkTreeViewColumn        **column,
 222                                                                     gint                      *cell_x,
 223                                                                     gint                      *cell_y);
 224 void                   gtk_tree_view_get_cell_area                 (GtkTreeView               *tree_view,
 225                                                                     GtkTreePath               *path,
 226                                                                     GtkTreeViewColumn         *column,
 227                                                                     GdkRectangle              *rect);
 228 void                   gtk_tree_view_get_background_area           (GtkTreeView               *tree_view,
 229                                                                     GtkTreePath               *path,
 230                                                                     GtkTreeViewColumn         *column,
 231                                                                     GdkRectangle              *rect);
 232 void                   gtk_tree_view_get_visible_rect              (GtkTreeView               *tree_view,
 233                                                                     GdkRectangle              *visible_rect);
 234 void                   gtk_tree_view_widget_to_tree_coords         (GtkTreeView               *tree_view,
 235                                                                     gint                       wx,
 236                                                                     gint                       wy,
 237                                                                     gint                      *tx,
 238                                                                     gint                      *ty);
 239 void                   gtk_tree_view_tree_to_widget_coords         (GtkTreeView               *tree_view,
 240                                                                     gint                       tx,
 241                                                                     gint                       ty,
 242                                                                     gint                      *wx,
 243                                                                     gint                      *wy);
 244
 245 /* Drag-and-Drop support */
 246 void                   gtk_tree_view_set_rows_drag_source          (GtkTreeView               *tree_view,
 247                                                                     GdkModifierType            start_button_mask,
 248                                                                     const GtkTargetEntry      *targets,
 249                                                                     gint                       n_targets,
 250                                                                     GdkDragAction              actions,
 251                                                                     GtkTreeViewDraggableFunc   row_draggable_func,
 252                                                                     gpointer                   user_data);
 253 void                   gtk_tree_view_set_rows_drag_dest            (GtkTreeView               *tree_view,
 254                                                                     const GtkTargetEntry      *targets,
 255                                                                     gint                       n_targets,
 256                                                                     GdkDragAction              actions,
 257                                                                     GtkTreeViewDroppableFunc   location_droppable_func,
 258                                                                     gpointer                   user_data);
 259 void                   gtk_tree_view_unset_rows_drag_source        (GtkTreeView               *tree_view);
 260 void                   gtk_tree_view_unset_rows_drag_dest          (GtkTreeView               *tree_view);
 261
 262
 263 /* These are useful to implement your own custom stuff. */
 264 void                   gtk_tree_view_set_drag_dest_row             (GtkTreeView               *tree_view,
 265                                                                     GtkTreePath               *path,
 266                                                                     GtkTreeViewDropPosition    pos);
 267 void                   gtk_tree_view_get_drag_dest_row             (GtkTreeView               *tree_view,
 268                                                                     GtkTreePath              **path,
 269                                                                     GtkTreeViewDropPosition   *pos);
 270 gboolean               gtk_tree_view_get_dest_row_at_pos           (GtkTreeView               *tree_view,
 271                                                                     gint                       drag_x,
 272                                                                     gint                       drag_y,
 273                                                                     GtkTreePath              **path,
 274                                                                     GtkTreeViewDropPosition   *pos);
 275 GdkPixmap             *gtk_tree_view_create_row_drag_icon          (GtkTreeView               *tree_view,
 276                                                                     GtkTreePath               *path);
 277
 278
 279 /* This function should really never be used.  It is just for use by ATK.
 280  */
 281 typedef void (* GtkTreeDestroyCountFunc) (GtkTreeView *tree_view,
 282                                           GtkTreePath *path,
 283                                           gint         children,
 284                                           gpointer     user_data);
 285 void gtk_tree_view_set_destroy_count_func (GtkTreeView             *tree_view,
 286                                            GtkTreeDestroyCountFunc  func,
 287                                            gpointer                 data,
 288                                            GtkDestroyNotify         destroy);
 289
 290
 291
 292
 293 #ifdef __cplusplus
 294 }
 295 #endif /* __cplusplus */
 296
 297
 298 #endif /* __GTK_TREE_VIEW_H__ */
 299