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
  20 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  21 #error "Only <gtk/gtk.h> can be included directly."
  22 #endif
  23
  24 #ifndef __GTK_TREE_VIEW_H__
  25 #define __GTK_TREE_VIEW_H__
  26
  27 #include <gtk/gtkcontainer.h>
  28 #include <gtk/gtktreemodel.h>
  29 #include <gtk/gtktreeviewcolumn.h>
  30 #include <gtk/gtkdnd.h>
  31 #include <gtk/gtkentry.h>
  32
  33 G_BEGIN_DECLS
  34
  35
  36 typedef enum
  37 {
  38   /* drop before/after this row */
  39   GTK_TREE_VIEW_DROP_BEFORE,
  40   GTK_TREE_VIEW_DROP_AFTER,
  41   /* drop as a child of this row (with fallback to before or after
  42    * if into is not possible)
  43    */
  44   GTK_TREE_VIEW_DROP_INTO_OR_BEFORE,
  45   GTK_TREE_VIEW_DROP_INTO_OR_AFTER
  46 } GtkTreeViewDropPosition;
  47
  48 #define GTK_TYPE_TREE_VIEW              (gtk_tree_view_get_type ())
  49 #define GTK_TREE_VIEW(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_VIEW, GtkTreeView))
  50 #define GTK_TREE_VIEW_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_VIEW, GtkTreeViewClass))
  51 #define GTK_IS_TREE_VIEW(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_VIEW))
  52 #define GTK_IS_TREE_VIEW_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_VIEW))
  53 #define GTK_TREE_VIEW_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_VIEW, GtkTreeViewClass))
  54
  55 typedef struct _GtkTreeView           GtkTreeView;
  56 typedef struct _GtkTreeViewClass      GtkTreeViewClass;
  57 typedef struct _GtkTreeViewPrivate    GtkTreeViewPrivate;
  58 typedef struct _GtkTreeSelection      GtkTreeSelection;
  59 typedef struct _GtkTreeSelectionClass GtkTreeSelectionClass;
  60
  61 struct _GtkTreeView
  62 {
  63   GtkContainer parent;
  64
  65   /* <private> */
  66   GtkTreeViewPrivate *priv;
  67 };
  68
  69 struct _GtkTreeViewClass
  70 {
  71   GtkContainerClass parent_class;
  72
  73   void     (* set_scroll_adjustments)     (GtkTreeView       *tree_view,
  74                                            GtkAdjustment     *hadjustment,
  75                                            GtkAdjustment     *vadjustment);
  76   void     (* row_activated)              (GtkTreeView       *tree_view,
  77                                            GtkTreePath       *path,
  78                                            GtkTreeViewColumn *column);
  79   gboolean (* test_expand_row)            (GtkTreeView       *tree_view,
  80                                            GtkTreeIter       *iter,
  81                                            GtkTreePath       *path);
  82   gboolean (* test_collapse_row)          (GtkTreeView       *tree_view,
  83                                            GtkTreeIter       *iter,
  84                                            GtkTreePath       *path);
  85   void     (* row_expanded)               (GtkTreeView       *tree_view,
  86                                            GtkTreeIter       *iter,
  87                                            GtkTreePath       *path);
  88   void     (* row_collapsed)              (GtkTreeView       *tree_view,
  89                                            GtkTreeIter       *iter,
  90                                            GtkTreePath       *path);
  91   void     (* columns_changed)            (GtkTreeView       *tree_view);
  92   void     (* cursor_changed)             (GtkTreeView       *tree_view);
  93
  94   /* Key Binding signals */
  95   gboolean (* move_cursor)                (GtkTreeView       *tree_view,
  96                                            GtkMovementStep    step,
  97                                            gint               count);
  98   gboolean (* select_all)                 (GtkTreeView       *tree_view);
  99   gboolean (* unselect_all)               (GtkTreeView       *tree_view);
 100   gboolean (* select_cursor_row)          (GtkTreeView       *tree_view,
 101                                            gboolean           start_editing);
 102   gboolean (* toggle_cursor_row)          (GtkTreeView       *tree_view);
 103   gboolean (* expand_collapse_cursor_row) (GtkTreeView       *tree_view,
 104                                            gboolean           logical,
 105                                            gboolean           expand,
 106                                            gboolean           open_all);
 107   gboolean (* select_cursor_parent)       (GtkTreeView       *tree_view);
 108   gboolean (* start_interactive_search)   (GtkTreeView       *tree_view);
 109
 110   /* Padding for future expansion */
 111   void (*_gtk_reserved0) (void);
 112   void (*_gtk_reserved1) (void);
 113   void (*_gtk_reserved2) (void);
 114   void (*_gtk_reserved3) (void);
 115   void (*_gtk_reserved4) (void);
 116 };
 117
 118
 119 typedef gboolean (* GtkTreeViewColumnDropFunc) (GtkTreeView             *tree_view,
 120                                                 GtkTreeViewColumn       *column,
 121                                                 GtkTreeViewColumn       *prev_column,
 122                                                 GtkTreeViewColumn       *next_column,
 123                                                 gpointer                 data);
 124 typedef void     (* GtkTreeViewMappingFunc)    (GtkTreeView             *tree_view,
 125                                                 GtkTreePath             *path,
 126                                                 gpointer                 user_data);
 127 typedef gboolean (*GtkTreeViewSearchEqualFunc) (GtkTreeModel            *model,
 128                                                 gint                     column,
 129                                                 const gchar             *key,
 130                                                 GtkTreeIter             *iter,
 131                                                 gpointer                 search_data);
 132 typedef gboolean (*GtkTreeViewRowSeparatorFunc) (GtkTreeModel      *model,
 133                                                  GtkTreeIter       *iter,
 134                                                  gpointer           data);
 135 typedef void     (*GtkTreeViewSearchPositionFunc) (GtkTreeView  *tree_view,
 136                                                    GtkWidget    *search_dialog,
 137                                                    gpointer      user_data);
 138
 139
 140 /* Creators */
 141 GType                  gtk_tree_view_get_type                      (void) G_GNUC_CONST;
 142 GtkWidget             *gtk_tree_view_new                           (void);
 143 GtkWidget             *gtk_tree_view_new_with_model                (GtkTreeModel              *model);
 144
 145 /* Accessors */
 146 GtkTreeModel          *gtk_tree_view_get_model                     (GtkTreeView               *tree_view);
 147 void                   gtk_tree_view_set_model                     (GtkTreeView               *tree_view,
 148                                                                     GtkTreeModel              *model);
 149 GtkTreeSelection      *gtk_tree_view_get_selection                 (GtkTreeView               *tree_view);
 150 GtkAdjustment         *gtk_tree_view_get_hadjustment               (GtkTreeView               *tree_view);
 151 void                   gtk_tree_view_set_hadjustment               (GtkTreeView               *tree_view,
 152                                                                     GtkAdjustment             *adjustment);
 153 GtkAdjustment         *gtk_tree_view_get_vadjustment               (GtkTreeView               *tree_view);
 154 void                   gtk_tree_view_set_vadjustment               (GtkTreeView               *tree_view,
 155                                                                     GtkAdjustment             *adjustment);
 156 gboolean               gtk_tree_view_get_headers_visible           (GtkTreeView               *tree_view);
 157 void                   gtk_tree_view_set_headers_visible           (GtkTreeView               *tree_view,
 158                                                                     gboolean                   headers_visible);
 159 void                   gtk_tree_view_columns_autosize              (GtkTreeView               *tree_view);
 160 gboolean               gtk_tree_view_get_headers_clickable         (GtkTreeView *tree_view);
 161 void                   gtk_tree_view_set_headers_clickable         (GtkTreeView               *tree_view,
 162                                                                     gboolean                   setting);
 163 void                   gtk_tree_view_set_rules_hint                (GtkTreeView               *tree_view,
 164                                                                     gboolean                   setting);
 165 gboolean               gtk_tree_view_get_rules_hint                (GtkTreeView               *tree_view);
 166
 167 /* Column funtions */
 168 gint                   gtk_tree_view_append_column                 (GtkTreeView               *tree_view,
 169                                                                     GtkTreeViewColumn         *column);
 170 gint                   gtk_tree_view_remove_column                 (GtkTreeView               *tree_view,
 171                                                                     GtkTreeViewColumn         *column);
 172 gint                   gtk_tree_view_insert_column                 (GtkTreeView               *tree_view,
 173                                                                     GtkTreeViewColumn         *column,
 174                                                                     gint                       position);
 175 gint                   gtk_tree_view_insert_column_with_attributes (GtkTreeView               *tree_view,
 176                                                                     gint                       position,
 177                                                                     const gchar               *title,
 178                                                                     GtkCellRenderer           *cell,
 179                                                                     ...) G_GNUC_NULL_TERMINATED;
 180 gint                   gtk_tree_view_insert_column_with_data_func  (GtkTreeView               *tree_view,
 181                                                                     gint                       position,
 182                                                                     const gchar               *title,
 183                                                                     GtkCellRenderer           *cell,
 184                                                                     GtkTreeCellDataFunc        func,
 185                                                                     gpointer                   data,
 186                                                                     GDestroyNotify             dnotify);
 187 GtkTreeViewColumn     *gtk_tree_view_get_column                    (GtkTreeView               *tree_view,
 188                                                                     gint                       n);
 189 GList                 *gtk_tree_view_get_columns                   (GtkTreeView               *tree_view);
 190 void                   gtk_tree_view_move_column_after             (GtkTreeView               *tree_view,
 191                                                                     GtkTreeViewColumn         *column,
 192                                                                     GtkTreeViewColumn         *base_column);
 193 void                   gtk_tree_view_set_expander_column           (GtkTreeView               *tree_view,
 194                                                                     GtkTreeViewColumn         *column);
 195 GtkTreeViewColumn     *gtk_tree_view_get_expander_column           (GtkTreeView               *tree_view);
 196 void                   gtk_tree_view_set_column_drag_function      (GtkTreeView               *tree_view,
 197                                                                     GtkTreeViewColumnDropFunc  func,
 198                                                                     gpointer                   user_data,
 199                                                                     GDestroyNotify             destroy);
 200
 201 /* Actions */
 202 void                   gtk_tree_view_scroll_to_point               (GtkTreeView               *tree_view,
 203                                                                     gint                       tree_x,
 204                                                                     gint                       tree_y);
 205 void                   gtk_tree_view_scroll_to_cell                (GtkTreeView               *tree_view,
 206                                                                     GtkTreePath               *path,
 207                                                                     GtkTreeViewColumn         *column,
 208                                                                     gboolean                   use_align,
 209                                                                     gfloat                     row_align,
 210                                                                     gfloat                     col_align);
 211 void                   gtk_tree_view_row_activated                 (GtkTreeView               *tree_view,
 212                                                                     GtkTreePath               *path,
 213                                                                     GtkTreeViewColumn         *column);
 214 void                   gtk_tree_view_expand_all                    (GtkTreeView               *tree_view);
 215 void                   gtk_tree_view_collapse_all                  (GtkTreeView               *tree_view);
 216 void                   gtk_tree_view_expand_to_path                (GtkTreeView               *tree_view,
 217                                                                     GtkTreePath               *path);
 218 gboolean               gtk_tree_view_expand_row                    (GtkTreeView               *tree_view,
 219                                                                     GtkTreePath               *path,
 220                                                                     gboolean                   open_all);
 221 gboolean               gtk_tree_view_collapse_row                  (GtkTreeView               *tree_view,
 222                                                                     GtkTreePath               *path);
 223 void                   gtk_tree_view_map_expanded_rows             (GtkTreeView               *tree_view,
 224                                                                     GtkTreeViewMappingFunc     func,
 225                                                                     gpointer                   data);
 226 gboolean               gtk_tree_view_row_expanded                  (GtkTreeView               *tree_view,
 227                                                                     GtkTreePath               *path);
 228 void                   gtk_tree_view_set_reorderable               (GtkTreeView               *tree_view,
 229                                                                     gboolean                   reorderable);
 230 gboolean               gtk_tree_view_get_reorderable               (GtkTreeView               *tree_view);
 231 void                   gtk_tree_view_set_cursor                    (GtkTreeView               *tree_view,
 232                                                                     GtkTreePath               *path,
 233                                                                     GtkTreeViewColumn         *focus_column,
 234                                                                     gboolean                   start_editing);
 235 void                   gtk_tree_view_set_cursor_on_cell            (GtkTreeView               *tree_view,
 236                                                                     GtkTreePath               *path,
 237                                                                     GtkTreeViewColumn         *focus_column,
 238                                                                     GtkCellRenderer           *focus_cell,
 239                                                                     gboolean                   start_editing);
 240 void                   gtk_tree_view_get_cursor                    (GtkTreeView               *tree_view,
 241                                                                     GtkTreePath              **path,
 242                                                                     GtkTreeViewColumn        **focus_column);
 243
 244
 245 /* Layout information */
 246 GdkWindow             *gtk_tree_view_get_bin_window                (GtkTreeView               *tree_view);
 247 gboolean               gtk_tree_view_get_path_at_pos               (GtkTreeView               *tree_view,
 248                                                                     gint                       x,
 249                                                                     gint                       y,
 250                                                                     GtkTreePath              **path,
 251                                                                     GtkTreeViewColumn        **column,
 252                                                                     gint                      *cell_x,
 253                                                                     gint                      *cell_y);
 254 void                   gtk_tree_view_get_cell_area                 (GtkTreeView               *tree_view,
 255                                                                     GtkTreePath               *path,
 256                                                                     GtkTreeViewColumn         *column,
 257                                                                     GdkRectangle              *rect);
 258 void                   gtk_tree_view_get_background_area           (GtkTreeView               *tree_view,
 259                                                                     GtkTreePath               *path,
 260                                                                     GtkTreeViewColumn         *column,
 261                                                                     GdkRectangle              *rect);
 262 void                   gtk_tree_view_get_visible_rect              (GtkTreeView               *tree_view,
 263                                                                     GdkRectangle              *visible_rect);
 264 gboolean               gtk_tree_view_get_visible_range             (GtkTreeView               *tree_view,
 265                                                                     GtkTreePath              **start_path,
 266                                                                     GtkTreePath              **end_path);
 267
 268 /* Drag-and-Drop support */
 269 void                   gtk_tree_view_enable_model_drag_source      (GtkTreeView               *tree_view,
 270                                                                     GdkModifierType            start_button_mask,
 271                                                                     const GtkTargetEntry      *targets,
 272                                                                     gint                       n_targets,
 273                                                                     GdkDragAction              actions);
 274 void                   gtk_tree_view_enable_model_drag_dest        (GtkTreeView               *tree_view,
 275                                                                     const GtkTargetEntry      *targets,
 276                                                                     gint                       n_targets,
 277                                                                     GdkDragAction              actions);
 278 void                   gtk_tree_view_unset_rows_drag_source        (GtkTreeView               *tree_view);
 279 void                   gtk_tree_view_unset_rows_drag_dest          (GtkTreeView               *tree_view);
 280
 281
 282 /* These are useful to implement your own custom stuff. */
 283 void                   gtk_tree_view_set_drag_dest_row             (GtkTreeView               *tree_view,
 284                                                                     GtkTreePath               *path,
 285                                                                     GtkTreeViewDropPosition    pos);
 286 void                   gtk_tree_view_get_drag_dest_row             (GtkTreeView               *tree_view,
 287                                                                     GtkTreePath              **path,
 288                                                                     GtkTreeViewDropPosition   *pos);
 289 gboolean               gtk_tree_view_get_dest_row_at_pos           (GtkTreeView               *tree_view,
 290                                                                     gint                       drag_x,
 291                                                                     gint                       drag_y,
 292                                                                     GtkTreePath              **path,
 293                                                                     GtkTreeViewDropPosition   *pos);
 294 GdkPixmap             *gtk_tree_view_create_row_drag_icon          (GtkTreeView               *tree_view,
 295                                                                     GtkTreePath               *path);
 296
 297 /* Interactive search */
 298 void                       gtk_tree_view_set_enable_search     (GtkTreeView                *tree_view,
 299                                                                 gboolean                    enable_search);
 300 gboolean                   gtk_tree_view_get_enable_search     (GtkTreeView                *tree_view);
 301 gint                       gtk_tree_view_get_search_column     (GtkTreeView                *tree_view);
 302 void                       gtk_tree_view_set_search_column     (GtkTreeView                *tree_view,
 303                                                                 gint                        column);
 304 GtkTreeViewSearchEqualFunc gtk_tree_view_get_search_equal_func (GtkTreeView                *tree_view);
 305 void                       gtk_tree_view_set_search_equal_func (GtkTreeView                *tree_view,
 306                                                                 GtkTreeViewSearchEqualFunc  search_equal_func,
 307                                                                 gpointer                    search_user_data,
 308                                                                 GDestroyNotify              search_destroy);
 309
 310 GtkEntry                     *gtk_tree_view_get_search_entry         (GtkTreeView                   *tree_view);
 311 void                          gtk_tree_view_set_search_entry         (GtkTreeView                   *tree_view,
 312                                                                       GtkEntry                      *entry);
 313 GtkTreeViewSearchPositionFunc gtk_tree_view_get_search_position_func (GtkTreeView                   *tree_view);
 314 void                          gtk_tree_view_set_search_position_func (GtkTreeView                   *tree_view,
 315                                                                       GtkTreeViewSearchPositionFunc  func,
 316                                                                       gpointer                       data,
 317                                                                       GDestroyNotify                 destroy);
 318
 319 /* Convert between the different coordinate systems */
 320 void gtk_tree_view_convert_widget_to_tree_coords       (GtkTreeView *tree_view,
 321                                                         gint         wx,
 322                                                         gint         wy,
 323                                                         gint        *tx,
 324                                                         gint        *ty);
 325 void gtk_tree_view_convert_tree_to_widget_coords       (GtkTreeView *tree_view,
 326                                                         gint         tx,
 327                                                         gint         ty,
 328                                                         gint        *wx,
 329                                                         gint        *wy);
 330 void gtk_tree_view_convert_widget_to_bin_window_coords (GtkTreeView *tree_view,
 331                                                         gint         wx,
 332                                                         gint         wy,
 333                                                         gint        *bx,
 334                                                         gint        *by);
 335 void gtk_tree_view_convert_bin_window_to_widget_coords (GtkTreeView *tree_view,
 336                                                         gint         bx,
 337                                                         gint         by,
 338                                                         gint        *wx,
 339                                                         gint        *wy);
 340 void gtk_tree_view_convert_tree_to_bin_window_coords   (GtkTreeView *tree_view,
 341                                                         gint         tx,
 342                                                         gint         ty,
 343                                                         gint        *bx,
 344                                                         gint        *by);
 345 void gtk_tree_view_convert_bin_window_to_tree_coords   (GtkTreeView *tree_view,
 346                                                         gint         bx,
 347                                                         gint         by,
 348                                                         gint        *tx,
 349                                                         gint        *ty);
 350
 351 /* This function should really never be used.  It is just for use by ATK.
 352  */
 353 typedef void (* GtkTreeDestroyCountFunc)  (GtkTreeView             *tree_view,
 354                                            GtkTreePath             *path,
 355                                            gint                     children,
 356                                            gpointer                 user_data);
 357 void gtk_tree_view_set_destroy_count_func (GtkTreeView             *tree_view,
 358                                            GtkTreeDestroyCountFunc  func,
 359                                            gpointer                 data,
 360                                            GDestroyNotify           destroy);
 361
 362 void     gtk_tree_view_set_fixed_height_mode (GtkTreeView          *tree_view,
 363                                               gboolean              enable);
 364 gboolean gtk_tree_view_get_fixed_height_mode (GtkTreeView          *tree_view);
 365 void     gtk_tree_view_set_hover_selection   (GtkTreeView          *tree_view,
 366                                               gboolean              hover);
 367 gboolean gtk_tree_view_get_hover_selection   (GtkTreeView          *tree_view);
 368 void     gtk_tree_view_set_hover_expand      (GtkTreeView          *tree_view,
 369                                               gboolean              expand);
 370 gboolean gtk_tree_view_get_hover_expand      (GtkTreeView          *tree_view);
 371 void     gtk_tree_view_set_rubber_banding    (GtkTreeView          *tree_view,
 372                                               gboolean              enable);
 373 gboolean gtk_tree_view_get_rubber_banding    (GtkTreeView          *tree_view);
 374
 375 gboolean gtk_tree_view_is_rubber_banding_active (GtkTreeView       *tree_view);
 376
 377 GtkTreeViewRowSeparatorFunc gtk_tree_view_get_row_separator_func (GtkTreeView               *tree_view);
 378 void                        gtk_tree_view_set_row_separator_func (GtkTreeView                *tree_view,
 379                                                                   GtkTreeViewRowSeparatorFunc func,
 380                                                                   gpointer                    data,
 381                                                                   GDestroyNotify              destroy);
 382
 383 GtkTreeViewGridLines        gtk_tree_view_get_grid_lines         (GtkTreeView                *tree_view);
 384 void                        gtk_tree_view_set_grid_lines         (GtkTreeView                *tree_view,
 385                                                                   GtkTreeViewGridLines        grid_lines);
 386 gboolean                    gtk_tree_view_get_enable_tree_lines  (GtkTreeView                *tree_view);
 387 void                        gtk_tree_view_set_enable_tree_lines  (GtkTreeView                *tree_view,
 388                                                                   gboolean                    enabled);
 389 void                        gtk_tree_view_set_show_expanders     (GtkTreeView                *tree_view,
 390                                                                   gboolean                    enabled);
 391 gboolean                    gtk_tree_view_get_show_expanders     (GtkTreeView                *tree_view);
 392 void                        gtk_tree_view_set_level_indentation  (GtkTreeView                *tree_view,
 393                                                                   gint                        indentation);
 394 gint                        gtk_tree_view_get_level_indentation  (GtkTreeView                *tree_view);
 395
 396 /* Convenience functions for setting tooltips */
 397 void          gtk_tree_view_set_tooltip_row    (GtkTreeView       *tree_view,
 398                                                 GtkTooltip        *tooltip,
 399                                                 GtkTreePath       *path);
 400 void          gtk_tree_view_set_tooltip_cell   (GtkTreeView       *tree_view,
 401                                                 GtkTooltip        *tooltip,
 402                                                 GtkTreePath       *path,
 403                                                 GtkTreeViewColumn *column,
 404                                                 GtkCellRenderer   *cell);
 405 gboolean      gtk_tree_view_get_tooltip_context(GtkTreeView       *tree_view,
 406                                                 gint              *x,
 407                                                 gint              *y,
 408                                                 gboolean           keyboard_tip,
 409                                                 GtkTreeModel     **model,
 410                                                 GtkTreePath      **path,
 411                                                 GtkTreeIter       *iter);
 412 void          gtk_tree_view_set_tooltip_column (GtkTreeView       *tree_view,
 413                                                 gint               column);
 414 gint          gtk_tree_view_get_tooltip_column (GtkTreeView       *tree_view);
 415
 416 G_END_DECLS
 417
 418
 419 #endif /* __GTK_TREE_VIEW_H__ */