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

   1 /* gtktreeprivate.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 #ifndef __GTK_TREE_PRIVATE_H__
  21 #define __GTK_TREE_PRIVATE_H__
  22
  23
  24 G_BEGIN_DECLS
  25
  26
  27 #include <gtk/gtktreeview.h>
  28 #include <gtk/gtktreeselection.h>
  29 #include <gtk/gtkrbtree.h>
  30
  31 #define TREE_VIEW_DRAG_WIDTH 6
  32
  33 typedef enum
  34 {
  35   GTK_TREE_VIEW_IS_LIST = 1 << 0,
  36   GTK_TREE_VIEW_SHOW_EXPANDERS = 1 << 1,
  37   GTK_TREE_VIEW_IN_COLUMN_RESIZE = 1 << 2,
  38   GTK_TREE_VIEW_ARROW_PRELIT = 1 << 3,
  39   GTK_TREE_VIEW_HEADERS_VISIBLE = 1 << 4,
  40   GTK_TREE_VIEW_DRAW_KEYFOCUS = 1 << 5,
  41   GTK_TREE_VIEW_MODEL_SETUP = 1 << 6,
  42   GTK_TREE_VIEW_IN_COLUMN_DRAG = 1 << 7
  43 } GtkTreeViewFlags;
  44
  45 typedef enum
  46 {
  47   GTK_TREE_SELECT_MODE_TOGGLE = 1 << 0,
  48   GTK_TREE_SELECT_MODE_EXTEND = 1 << 1
  49 }
  50 GtkTreeSelectMode;
  51
  52 enum
  53 {
  54   DRAG_COLUMN_WINDOW_STATE_UNSET = 0,
  55   DRAG_COLUMN_WINDOW_STATE_ORIGINAL = 1,
  56   DRAG_COLUMN_WINDOW_STATE_ARROW = 2,
  57   DRAG_COLUMN_WINDOW_STATE_ARROW_LEFT = 3,
  58   DRAG_COLUMN_WINDOW_STATE_ARROW_RIGHT = 4
  59 };
  60
  61 enum
  62 {
  63   RUBBER_BAND_OFF = 0,
  64   RUBBER_BAND_MAYBE_START = 1,
  65   RUBBER_BAND_ACTIVE = 2
  66 };
  67
  68 #define GTK_TREE_VIEW_SET_FLAG(tree_view, flag)   G_STMT_START{ (tree_view->priv->flags|=flag); }G_STMT_END
  69 #define GTK_TREE_VIEW_UNSET_FLAG(tree_view, flag) G_STMT_START{ (tree_view->priv->flags&=~(flag)); }G_STMT_END
  70 #define GTK_TREE_VIEW_FLAG_SET(tree_view, flag)   ((tree_view->priv->flags&flag)==flag)
  71 #define TREE_VIEW_HEADER_HEIGHT(tree_view)        (GTK_TREE_VIEW_FLAG_SET (tree_view, GTK_TREE_VIEW_HEADERS_VISIBLE)?tree_view->priv->header_height:0)
  72 #define TREE_VIEW_COLUMN_REQUESTED_WIDTH(column)  (CLAMP (column->requested_width, (column->min_width!=-1)?column->min_width:column->requested_width, (column->max_width!=-1)?column->max_width:column->requested_width))
  73 #define TREE_VIEW_DRAW_EXPANDERS(tree_view)       (!GTK_TREE_VIEW_FLAG_SET (tree_view, GTK_TREE_VIEW_IS_LIST)&&GTK_TREE_VIEW_FLAG_SET (tree_view, GTK_TREE_VIEW_SHOW_EXPANDERS))
  74
  75  /* This lovely little value is used to determine how far away from the title bar
  76   * you can move the mouse and still have a column drag work.
  77   */
  78 #define TREE_VIEW_COLUMN_DRAG_DEAD_MULTIPLIER(tree_view) (10*TREE_VIEW_HEADER_HEIGHT(tree_view))
  79
  80 typedef struct _GtkTreeViewColumnReorder GtkTreeViewColumnReorder;
  81 struct _GtkTreeViewColumnReorder
  82 {
  83   gint left_align;
  84   gint right_align;
  85   GtkTreeViewColumn *left_column;
  86   GtkTreeViewColumn *right_column;
  87 };
  88
  89 struct _GtkTreeViewPrivate
  90 {
  91   GtkTreeModel *model;
  92
  93   guint flags;
  94   /* tree information */
  95   GtkRBTree *tree;
  96
  97   /* Container info */
  98   GList *children;
  99   gint width;
 100   gint height;
 101
 102   /* Adjustments */
 103   GtkAdjustment *hadjustment;
 104   GtkAdjustment *vadjustment;
 105   gint           min_display_width;
 106   gint           min_display_height;
 107
 108   /* Sub windows */
 109   GdkWindow *bin_window;
 110   GdkWindow *header_window;
 111
 112   /* Scroll position state keeping */
 113   GtkTreeRowReference *top_row;
 114   gint top_row_dy;
 115   /* dy == y pos of top_row + top_row_dy */
 116   /* we cache it for simplicity of the code */
 117   gint dy;
 118
 119   guint presize_handler_timer;
 120   guint validate_rows_timer;
 121   guint scroll_sync_timer;
 122
 123   /* Indentation and expander layout */
 124   gint expander_size;
 125   GtkTreeViewColumn *expander_column;
 126
 127   gint level_indentation;
 128
 129   /* Key navigation (focus), selection */
 130   gint cursor_offset;
 131
 132   GtkTreeRowReference *anchor;
 133   GtkTreeRowReference *cursor;
 134
 135   GtkTreeViewColumn *focus_column;
 136
 137   /* Current pressed node, previously pressed, prelight */
 138   GtkRBNode *button_pressed_node;
 139   GtkRBTree *button_pressed_tree;
 140
 141   gint pressed_button;
 142   gint press_start_x;
 143   gint press_start_y;
 144
 145   gint event_last_x;
 146   gint event_last_y;
 147
 148   guint last_button_time;
 149   gint last_button_x;
 150   gint last_button_y;
 151
 152   GtkRBNode *prelight_node;
 153   GtkRBTree *prelight_tree;
 154
 155   /* Cell Editing */
 156   GtkTreeViewColumn *edited_column;
 157
 158   /* The node that's currently being collapsed or expanded */
 159   GtkRBNode *expanded_collapsed_node;
 160   GtkRBTree *expanded_collapsed_tree;
 161   guint expand_collapse_timeout;
 162
 163   /* Auto expand/collapse timeout in hover mode */
 164   guint auto_expand_timeout;
 165
 166   /* Selection information */
 167   GtkTreeSelection *selection;
 168
 169   /* Header information */
 170   gint n_columns;
 171   GList *columns;
 172   gint header_height;
 173
 174   GtkTreeViewColumnDropFunc column_drop_func;
 175   gpointer column_drop_func_data;
 176   GDestroyNotify column_drop_func_data_destroy;
 177   GList *column_drag_info;
 178   GtkTreeViewColumnReorder *cur_reorder;
 179
 180   gint prev_width_before_expander;
 181
 182   /* Interactive Header reordering */
 183   GdkWindow *drag_window;
 184   GdkWindow *drag_highlight_window;
 185   GtkTreeViewColumn *drag_column;
 186   gint drag_column_x;
 187
 188   /* Interactive Header Resizing */
 189   gint drag_pos;
 190   gint x_drag;
 191
 192   /* Non-interactive Header Resizing, expand flag support */
 193   gint prev_width;
 194
 195   gint last_extra_space;
 196   gint last_extra_space_per_column;
 197   gint last_number_of_expand_columns;
 198
 199   /* ATK Hack */
 200   GtkTreeDestroyCountFunc destroy_count_func;
 201   gpointer destroy_count_data;
 202   GDestroyNotify destroy_count_destroy;
 203
 204   /* Scroll timeout (e.g. during dnd, rubber banding) */
 205   guint scroll_timeout;
 206
 207   /* Row drag-and-drop */
 208   GtkTreeRowReference *drag_dest_row;
 209   GtkTreeViewDropPosition drag_dest_pos;
 210   guint open_dest_timeout;
 211
 212   /* Rubber banding */
 213   gint rubber_band_status;
 214   gint rubber_band_x;
 215   gint rubber_band_y;
 216   gint rubber_band_shift;
 217   gint rubber_band_ctrl;
 218
 219   GtkRBNode *rubber_band_start_node;
 220   GtkRBTree *rubber_band_start_tree;
 221
 222   GtkRBNode *rubber_band_end_node;
 223   GtkRBTree *rubber_band_end_tree;
 224
 225   /* fixed height */
 226   gint fixed_height;
 227
 228   /* Scroll-to functionality when unrealized */
 229   GtkTreeRowReference *scroll_to_path;
 230   GtkTreeViewColumn *scroll_to_column;
 231   gfloat scroll_to_row_align;
 232   gfloat scroll_to_col_align;
 233
 234   /* Interactive search */
 235   gint selected_iter;
 236   gint search_column;
 237   GtkTreeViewSearchPositionFunc search_position_func;
 238   GtkTreeViewSearchEqualFunc search_equal_func;
 239   gpointer search_user_data;
 240   GDestroyNotify search_destroy;
 241   gpointer search_position_user_data;
 242   GDestroyNotify search_position_destroy;
 243   GtkWidget *search_window;
 244   GtkWidget *search_entry;
 245   gulong search_entry_changed_id;
 246   guint typeselect_flush_timeout;
 247
 248   /* Grid and tree lines */
 249   GtkTreeViewGridLines grid_lines;
 250   double grid_line_dashes[2];
 251   int grid_line_width;
 252
 253   gboolean tree_lines_enabled;
 254   double tree_line_dashes[2];
 255   int tree_line_width;
 256
 257   /* Row separators */
 258   GtkTreeViewRowSeparatorFunc row_separator_func;
 259   gpointer row_separator_data;
 260   GDestroyNotify row_separator_destroy;
 261
 262   /* Tooltip support */
 263   gint tooltip_column;
 264
 265   /* Here comes the bitfield */
 266   guint scroll_to_use_align : 1;
 267
 268   guint fixed_height_mode : 1;
 269   guint fixed_height_check : 1;
 270
 271   guint reorderable : 1;
 272   guint header_has_focus : 1;
 273   guint drag_column_window_state : 3;
 274   /* hint to display rows in alternating colors */
 275   guint has_rules : 1;
 276   guint mark_rows_col_dirty : 1;
 277
 278   /* for DnD */
 279   guint empty_view_drop : 1;
 280
 281   guint ctrl_pressed : 1;
 282   guint shift_pressed : 1;
 283
 284   guint init_hadjust_value : 1;
 285
 286   guint in_top_row_to_dy : 1;
 287
 288   /* interactive search */
 289   guint enable_search : 1;
 290   guint disable_popdown : 1;
 291   guint search_custom_entry_set : 1;
 292
 293   guint hover_selection : 1;
 294   guint hover_expand : 1;
 295   guint imcontext_changed : 1;
 296
 297   guint rubber_banding_enable : 1;
 298
 299   guint in_grab : 1;
 300
 301   guint post_validation_flag : 1;
 302
 303   /* Whether our key press handler is to avoid sending an unhandled binding to the search entry */
 304   guint search_entry_avoid_unhandled_binding : 1;
 305
 306   /* GtkScrollablePolicy needs to be checked when
 307    * driving the scrollable adjustment values */
 308   guint hscroll_policy : 1;
 309   guint vscroll_policy : 1;
 310 };
 311
 312 #ifdef __GNUC__
 313
 314 #define TREE_VIEW_INTERNAL_ASSERT(expr, ret)     G_STMT_START{          \
 315      if (!(expr))                                                       \
 316        {                                                                \
 317          g_log (G_LOG_DOMAIN,                                           \
 318                 G_LOG_LEVEL_CRITICAL,                                   \
 319                 "%s (%s): assertion `%s' failed.\n"                     \
 320                 "There is a disparity between the internal view of the GtkTreeView,\n"    \
 321                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
 322                 "without letting the view know.  Any display from now on is likely to\n"  \
 323                 "be incorrect.\n",                                                        \
 324                 G_STRLOC,                                               \
 325                 G_STRFUNC,                                              \
 326                 #expr);                                                 \
 327          return ret;                                                    \
 328        };                               }G_STMT_END
 329
 330 #define TREE_VIEW_INTERNAL_ASSERT_VOID(expr)     G_STMT_START{          \
 331      if (!(expr))                                                       \
 332        {                                                                \
 333          g_log (G_LOG_DOMAIN,                                           \
 334                 G_LOG_LEVEL_CRITICAL,                                   \
 335                 "%s (%s): assertion `%s' failed.\n"                     \
 336                 "There is a disparity between the internal view of the GtkTreeView,\n"    \
 337                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
 338                 "without letting the view know.  Any display from now on is likely to\n"  \
 339                 "be incorrect.\n",                                                        \
 340                 G_STRLOC,                                               \
 341                 G_STRFUNC,                                              \
 342                 #expr);                                                 \
 343          return;                                                        \
 344        };                               }G_STMT_END
 345
 346 #else
 347
 348 #define TREE_VIEW_INTERNAL_ASSERT(expr, ret)     G_STMT_START{          \
 349      if (!(expr))                                                       \
 350        {                                                                \
 351          g_log (G_LOG_DOMAIN,                                           \
 352                 G_LOG_LEVEL_CRITICAL,                                   \
 353                 "file %s: line %d: assertion `%s' failed.\n"       \
 354                 "There is a disparity between the internal view of the GtkTreeView,\n"    \
 355                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
 356                 "without letting the view know.  Any display from now on is likely to\n"  \
 357                 "be incorrect.\n",                                                        \
 358                 __FILE__,                                               \
 359                 __LINE__,                                               \
 360                 #expr);                                                 \
 361          return ret;                                                    \
 362        };                               }G_STMT_END
 363
 364 #define TREE_VIEW_INTERNAL_ASSERT_VOID(expr)     G_STMT_START{          \
 365      if (!(expr))                                                       \
 366        {                                                                \
 367          g_log (G_LOG_DOMAIN,                                           \
 368                 G_LOG_LEVEL_CRITICAL,                                   \
 369                 "file %s: line %d: assertion '%s' failed.\n"            \
 370                 "There is a disparity between the internal view of the GtkTreeView,\n"    \
 371                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
 372                 "without letting the view know.  Any display from now on is likely to\n"  \
 373                 "be incorrect.\n",                                                        \
 374                 __FILE__,                                               \
 375                 __LINE__,                                               \
 376                 #expr);                                                 \
 377          return;                                                        \
 378        };                               }G_STMT_END
 379 #endif
 380
 381
 382 /* functions that shouldn't be exported */
 383 void         _gtk_tree_selection_internal_select_node (GtkTreeSelection  *selection,
 384                                                        GtkRBNode         *node,
 385                                                        GtkRBTree         *tree,
 386                                                        GtkTreePath       *path,
 387                                                        GtkTreeSelectMode  mode,
 388                                                        gboolean           override_browse_mode);
 389 void         _gtk_tree_selection_emit_changed         (GtkTreeSelection  *selection);
 390 gboolean     _gtk_tree_view_find_node                 (GtkTreeView       *tree_view,
 391                                                        GtkTreePath       *path,
 392                                                        GtkRBTree        **tree,
 393                                                        GtkRBNode        **node);
 394 GtkTreePath *_gtk_tree_view_find_path                 (GtkTreeView       *tree_view,
 395                                                        GtkRBTree         *tree,
 396                                                        GtkRBNode         *node);
 397 void         _gtk_tree_view_child_move_resize         (GtkTreeView       *tree_view,
 398                                                        GtkWidget         *widget,
 399                                                        gint               x,
 400                                                        gint               y,
 401                                                        gint               width,
 402                                                        gint               height);
 403 void         _gtk_tree_view_queue_draw_node           (GtkTreeView       *tree_view,
 404                                                        GtkRBTree         *tree,
 405                                                        GtkRBNode         *node,
 406                                                        const GdkRectangle *clip_rect);
 407
 408 void _gtk_tree_view_column_realize_button   (GtkTreeViewColumn *column);
 409 void _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column);
 410 void _gtk_tree_view_column_set_tree_view    (GtkTreeViewColumn *column,
 411                                              GtkTreeView       *tree_view);
 412 void _gtk_tree_view_column_unset_model      (GtkTreeViewColumn *column,
 413                                              GtkTreeModel      *old_model);
 414 void _gtk_tree_view_column_unset_tree_view  (GtkTreeViewColumn *column);
 415 void _gtk_tree_view_column_set_width        (GtkTreeViewColumn *column,
 416                                              gint               width);
 417 void _gtk_tree_view_column_start_drag       (GtkTreeView       *tree_view,
 418                                              GtkTreeViewColumn *column,
 419                                              GdkDevice         *device);
 420 gboolean _gtk_tree_view_column_cell_event   (GtkTreeViewColumn  *tree_column,
 421                                              GtkCellEditable   **editable_widget,
 422                                              GdkEvent           *event,
 423                                              gchar              *path_string,
 424                                              const GdkRectangle *background_area,
 425                                              const GdkRectangle *cell_area,
 426                                              guint               flags);
 427 void _gtk_tree_view_column_start_editing (GtkTreeViewColumn *tree_column,
 428                                           GtkCellEditable   *editable_widget);
 429 void _gtk_tree_view_column_stop_editing  (GtkTreeViewColumn *tree_column);
 430 void _gtk_tree_view_install_mark_rows_col_dirty (GtkTreeView *tree_view);
 431 void             _gtk_tree_view_column_autosize          (GtkTreeView       *tree_view,
 432                                                           GtkTreeViewColumn *column);
 433
 434 gboolean         _gtk_tree_view_column_has_editable_cell (GtkTreeViewColumn *column);
 435 GtkCellRenderer *_gtk_tree_view_column_get_edited_cell   (GtkTreeViewColumn *column);
 436 gint             _gtk_tree_view_column_count_special_cells (GtkTreeViewColumn *column);
 437 GtkCellRenderer *_gtk_tree_view_column_get_cell_at_pos   (GtkTreeViewColumn *column,
 438                                                           gint               x);
 439
 440 GtkTreeSelection* _gtk_tree_selection_new                (void);
 441 GtkTreeSelection* _gtk_tree_selection_new_with_tree_view (GtkTreeView      *tree_view);
 442 void              _gtk_tree_selection_set_tree_view      (GtkTreeSelection *selection,
 443                                                           GtkTreeView      *tree_view);
 444 gboolean          _gtk_tree_selection_row_is_selectable  (GtkTreeSelection *selection,
 445                                                           GtkRBNode        *node,
 446                                                           GtkTreePath      *path);
 447
 448 void              _gtk_tree_view_column_cell_render      (GtkTreeViewColumn  *tree_column,
 449                                                           cairo_t            *cr,
 450                                                           const GdkRectangle *background_area,
 451                                                           const GdkRectangle *cell_area,
 452                                                           guint               flags);
 453 void              _gtk_tree_view_column_get_focus_area   (GtkTreeViewColumn  *tree_column,
 454                                                           const GdkRectangle *background_area,
 455                                                           const GdkRectangle *cell_area,
 456                                                           GdkRectangle       *focus_area);
 457 gboolean          _gtk_tree_view_column_cell_focus       (GtkTreeViewColumn  *tree_column,
 458                                                           gint                direction,
 459                                                           gboolean            left,
 460                                                           gboolean            right);
 461 void              _gtk_tree_view_column_cell_draw_focus  (GtkTreeViewColumn  *tree_column,
 462                                                           cairo_t            *cr,
 463                                                           const GdkRectangle *background_area,
 464                                                           const GdkRectangle *cell_area,
 465                                                           guint               flags);
 466 void              _gtk_tree_view_column_cell_set_dirty   (GtkTreeViewColumn  *tree_column,
 467                                                           gboolean            install_handler);
 468 void              _gtk_tree_view_column_get_neighbor_sizes (GtkTreeViewColumn *column,
 469                                                             GtkCellRenderer   *cell,
 470                                                             gint              *left,
 471                                                             gint              *right);
 472
 473
 474 G_END_DECLS
 475
 476
 477 #endif /* __GTK_TREE_PRIVATE_H__ */
 478