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 #define GTK_TREE_VIEW_COLUMN_GET_PRIVATE(column) (G_TYPE_INSTANCE_GET_PRIVATE ((column), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumnPrivate))
  81
  82 typedef struct _GtkTreeViewColumnReorder GtkTreeViewColumnReorder;
  83 struct _GtkTreeViewColumnReorder
  84 {
  85   gint left_align;
  86   gint right_align;
  87   GtkTreeViewColumn *left_column;
  88   GtkTreeViewColumn *right_column;
  89 };
  90
  91 struct _GtkTreeViewPrivate
  92 {
  93   GtkTreeModel *model;
  94
  95   guint flags;
  96   /* tree information */
  97   GtkRBTree *tree;
  98
  99   /* Container info */
 100   GList *children;
 101   gint width;
 102   gint height;
 103
 104   /* Adjustments */
 105   GtkAdjustment *hadjustment;
 106   GtkAdjustment *vadjustment;
 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   guint last_button_time;
 146   gint last_button_x;
 147   gint last_button_y;
 148
 149   GtkRBNode *prelight_node;
 150   GtkRBTree *prelight_tree;
 151
 152   /* Cell Editing */
 153   GtkTreeViewColumn *edited_column;
 154
 155   /* The node that's currently being collapsed or expanded */
 156   GtkRBNode *expanded_collapsed_node;
 157   GtkRBTree *expanded_collapsed_tree;
 158   guint expand_collapse_timeout;
 159
 160   /* Auto expand/collapse timeout in hover mode */
 161   guint auto_expand_timeout;
 162
 163   /* Selection information */
 164   GtkTreeSelection *selection;
 165
 166   /* Header information */
 167   gint n_columns;
 168   GList *columns;
 169   gint header_height;
 170
 171   GtkTreeViewColumnDropFunc column_drop_func;
 172   gpointer column_drop_func_data;
 173   GDestroyNotify column_drop_func_data_destroy;
 174   GList *column_drag_info;
 175   GtkTreeViewColumnReorder *cur_reorder;
 176
 177   /* Interactive Header reordering */
 178   GdkWindow *drag_window;
 179   GdkWindow *drag_highlight_window;
 180   GtkTreeViewColumn *drag_column;
 181   gint drag_column_x;
 182
 183   /* Interactive Header Resizing */
 184   gint drag_pos;
 185   gint x_drag;
 186
 187   /* Non-interactive Header Resizing, expand flag support */
 188   gint prev_width;
 189
 190   gint last_extra_space;
 191   gint last_extra_space_per_column;
 192   gint last_number_of_expand_columns;
 193
 194   /* ATK Hack */
 195   GtkTreeDestroyCountFunc destroy_count_func;
 196   gpointer destroy_count_data;
 197   GDestroyNotify destroy_count_destroy;
 198
 199   /* Scroll timeout (e.g. during dnd, rubber banding) */
 200   guint scroll_timeout;
 201
 202   /* Row drag-and-drop */
 203   GtkTreeRowReference *drag_dest_row;
 204   GtkTreeViewDropPosition drag_dest_pos;
 205   guint open_dest_timeout;
 206
 207   /* Rubber banding */
 208   gint rubber_band_status;
 209   gint rubber_band_x;
 210   gint rubber_band_y;
 211   gint rubber_band_shift;
 212   gint rubber_band_ctrl;
 213
 214   GtkRBNode *rubber_band_start_node;
 215   GtkRBTree *rubber_band_start_tree;
 216
 217   GtkRBNode *rubber_band_end_node;
 218   GtkRBTree *rubber_band_end_tree;
 219
 220   /* fixed height */
 221   gint fixed_height;
 222
 223   /* Scroll-to functionality when unrealized */
 224   GtkTreeRowReference *scroll_to_path;
 225   GtkTreeViewColumn *scroll_to_column;
 226   gfloat scroll_to_row_align;
 227   gfloat scroll_to_col_align;
 228
 229   /* Interactive search */
 230   gint selected_iter;
 231   gint search_column;
 232   GtkTreeViewSearchPositionFunc search_position_func;
 233   GtkTreeViewSearchEqualFunc search_equal_func;
 234   gpointer search_user_data;
 235   GDestroyNotify search_destroy;
 236   gpointer search_position_user_data;
 237   GDestroyNotify search_position_destroy;
 238   GtkWidget *search_window;
 239   GtkWidget *search_entry;
 240   guint search_entry_changed_id;
 241   guint typeselect_flush_timeout;
 242
 243   /* Grid and tree lines */
 244   GtkTreeViewGridLines grid_lines;
 245   GdkGC *grid_line_gc;
 246
 247   gboolean tree_lines_enabled;
 248   GdkGC *tree_line_gc;
 249
 250   /* Row separators */
 251   GtkTreeViewRowSeparatorFunc row_separator_func;
 252   gpointer row_separator_data;
 253   GDestroyNotify row_separator_destroy;
 254
 255   /* Tooltip support */
 256   gint tooltip_column;
 257
 258   /* Here comes the bitfield */
 259   guint scroll_to_use_align : 1;
 260
 261   guint fixed_height_mode : 1;
 262   guint fixed_height_check : 1;
 263
 264   guint reorderable : 1;
 265   guint header_has_focus : 1;
 266   guint drag_column_window_state : 3;
 267   /* hint to display rows in alternating colors */
 268   guint has_rules : 1;
 269   guint mark_rows_col_dirty : 1;
 270
 271   /* for DnD */
 272   guint empty_view_drop : 1;
 273
 274   guint ctrl_pressed : 1;
 275   guint shift_pressed : 1;
 276
 277   guint init_hadjust_value : 1;
 278
 279   guint in_top_row_to_dy : 1;
 280
 281   /* interactive search */
 282   guint enable_search : 1;
 283   guint disable_popdown : 1;
 284   guint search_custom_entry_set : 1;
 285
 286   guint hover_selection : 1;
 287   guint hover_expand : 1;
 288   guint imcontext_changed : 1;
 289
 290   guint rubber_banding_enable : 1;
 291
 292   guint in_grab : 1;
 293
 294   guint post_validation_flag : 1;
 295
 296   /* Whether our key press handler is to avoid sending an unhandled binding to the search entry */
 297   guint search_entry_avoid_unhandled_binding : 1;
 298 };
 299
 300 struct _GtkTreeViewColumnPrivate
 301 {
 302   gint natural_width;
 303 };
 304
 305 #ifdef __GNUC__
 306
 307 #define TREE_VIEW_INTERNAL_ASSERT(expr, ret)     G_STMT_START{          \
 308      if (!(expr))                                                       \
 309        {                                                                \
 310          g_log (G_LOG_DOMAIN,                                           \
 311                 G_LOG_LEVEL_CRITICAL,                                   \
 312                 "%s (%s): assertion `%s' failed.\n"                     \
 313                 "There is a disparity between the internal view of the GtkTreeView,\n"    \
 314                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
 315                 "without letting the view know.  Any display from now on is likely to\n"  \
 316                 "be incorrect.\n",                                                        \
 317                 G_STRLOC,                                               \
 318                 G_STRFUNC,                                              \
 319                 #expr);                                                 \
 320          return ret;                                                    \
 321        };                               }G_STMT_END
 322
 323 #define TREE_VIEW_INTERNAL_ASSERT_VOID(expr)     G_STMT_START{          \
 324      if (!(expr))                                                       \
 325        {                                                                \
 326          g_log (G_LOG_DOMAIN,                                           \
 327                 G_LOG_LEVEL_CRITICAL,                                   \
 328                 "%s (%s): assertion `%s' failed.\n"                     \
 329                 "There is a disparity between the internal view of the GtkTreeView,\n"    \
 330                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
 331                 "without letting the view know.  Any display from now on is likely to\n"  \
 332                 "be incorrect.\n",                                                        \
 333                 G_STRLOC,                                               \
 334                 G_STRFUNC,                                              \
 335                 #expr);                                                 \
 336          return;                                                        \
 337        };                               }G_STMT_END
 338
 339 #else
 340
 341 #define TREE_VIEW_INTERNAL_ASSERT(expr, ret)     G_STMT_START{          \
 342      if (!(expr))                                                       \
 343        {                                                                \
 344          g_log (G_LOG_DOMAIN,                                           \
 345                 G_LOG_LEVEL_CRITICAL,                                   \
 346                 "file %s: line %d: assertion `%s' failed.\n"       \
 347                 "There is a disparity between the internal view of the GtkTreeView,\n"    \
 348                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
 349                 "without letting the view know.  Any display from now on is likely to\n"  \
 350                 "be incorrect.\n",                                                        \
 351                 __FILE__,                                               \
 352                 __LINE__,                                               \
 353                 #expr);                                                 \
 354          return ret;                                                    \
 355        };                               }G_STMT_END
 356
 357 #define TREE_VIEW_INTERNAL_ASSERT_VOID(expr)     G_STMT_START{          \
 358      if (!(expr))                                                       \
 359        {                                                                \
 360          g_log (G_LOG_DOMAIN,                                           \
 361                 G_LOG_LEVEL_CRITICAL,                                   \
 362                 "file %s: line %d: assertion '%s' failed.\n"            \
 363                 "There is a disparity between the internal view of the GtkTreeView,\n"    \
 364                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
 365                 "without letting the view know.  Any display from now on is likely to\n"  \
 366                 "be incorrect.\n",                                                        \
 367                 __FILE__,                                               \
 368                 __LINE__,                                               \
 369                 #expr);                                                 \
 370          return;                                                        \
 371        };                               }G_STMT_END
 372 #endif
 373
 374
 375 /* functions that shouldn't be exported */
 376 void         _gtk_tree_selection_internal_select_node (GtkTreeSelection  *selection,
 377                                                        GtkRBNode         *node,
 378                                                        GtkRBTree         *tree,
 379                                                        GtkTreePath       *path,
 380                                                        GtkTreeSelectMode  mode,
 381                                                        gboolean           override_browse_mode);
 382 void         _gtk_tree_selection_emit_changed         (GtkTreeSelection  *selection);
 383 gboolean     _gtk_tree_view_find_node                 (GtkTreeView       *tree_view,
 384                                                        GtkTreePath       *path,
 385                                                        GtkRBTree        **tree,
 386                                                        GtkRBNode        **node);
 387 GtkTreePath *_gtk_tree_view_find_path                 (GtkTreeView       *tree_view,
 388                                                        GtkRBTree         *tree,
 389                                                        GtkRBNode         *node);
 390 void         _gtk_tree_view_child_move_resize         (GtkTreeView       *tree_view,
 391                                                        GtkWidget         *widget,
 392                                                        gint               x,
 393                                                        gint               y,
 394                                                        gint               width,
 395                                                        gint               height);
 396 void         _gtk_tree_view_queue_draw_node           (GtkTreeView       *tree_view,
 397                                                        GtkRBTree         *tree,
 398                                                        GtkRBNode         *node,
 399                                                        const GdkRectangle *clip_rect);
 400
 401 void _gtk_tree_view_column_realize_button   (GtkTreeViewColumn *column);
 402 void _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column);
 403 void _gtk_tree_view_column_set_tree_view    (GtkTreeViewColumn *column,
 404                                              GtkTreeView       *tree_view);
 405 void _gtk_tree_view_column_unset_model      (GtkTreeViewColumn *column,
 406                                              GtkTreeModel      *old_model);
 407 void _gtk_tree_view_column_unset_tree_view  (GtkTreeViewColumn *column);
 408 void _gtk_tree_view_column_set_width        (GtkTreeViewColumn *column,
 409                                              gint               width);
 410 void _gtk_tree_view_column_start_drag       (GtkTreeView       *tree_view,
 411                                              GtkTreeViewColumn *column);
 412 gboolean _gtk_tree_view_column_cell_event   (GtkTreeViewColumn  *tree_column,
 413                                              GtkCellEditable   **editable_widget,
 414                                              GdkEvent           *event,
 415                                              gchar              *path_string,
 416                                              const GdkRectangle *background_area,
 417                                              const GdkRectangle *cell_area,
 418                                              guint               flags);
 419 void _gtk_tree_view_column_start_editing (GtkTreeViewColumn *tree_column,
 420                                           GtkCellEditable   *editable_widget);
 421 void _gtk_tree_view_column_stop_editing  (GtkTreeViewColumn *tree_column);
 422 void _gtk_tree_view_install_mark_rows_col_dirty (GtkTreeView *tree_view);
 423 void             _gtk_tree_view_column_autosize          (GtkTreeView       *tree_view,
 424                                                           GtkTreeViewColumn *column);
 425
 426 gboolean         _gtk_tree_view_column_has_editable_cell (GtkTreeViewColumn *column);
 427 GtkCellRenderer *_gtk_tree_view_column_get_edited_cell   (GtkTreeViewColumn *column);
 428 gint             _gtk_tree_view_column_count_special_cells (GtkTreeViewColumn *column);
 429 GtkCellRenderer *_gtk_tree_view_column_get_cell_at_pos   (GtkTreeViewColumn *column,
 430                                                           gint               x);
 431
 432 GtkTreeSelection* _gtk_tree_selection_new                (void);
 433 GtkTreeSelection* _gtk_tree_selection_new_with_tree_view (GtkTreeView      *tree_view);
 434 void              _gtk_tree_selection_set_tree_view      (GtkTreeSelection *selection,
 435                                                           GtkTreeView      *tree_view);
 436 gboolean          _gtk_tree_selection_row_is_selectable  (GtkTreeSelection *selection,
 437                                                           GtkRBNode        *node,
 438                                                           GtkTreePath      *path);
 439
 440 void              _gtk_tree_view_column_cell_render      (GtkTreeViewColumn  *tree_column,
 441                                                           GdkWindow          *window,
 442                                                           const GdkRectangle *background_area,
 443                                                           const GdkRectangle *cell_area,
 444                                                           const GdkRectangle *expose_area,
 445                                                           guint               flags);
 446 void              _gtk_tree_view_column_get_focus_area   (GtkTreeViewColumn  *tree_column,
 447                                                           const GdkRectangle *background_area,
 448                                                           const GdkRectangle *cell_area,
 449                                                           GdkRectangle       *focus_area);
 450 gboolean          _gtk_tree_view_column_cell_focus       (GtkTreeViewColumn  *tree_column,
 451                                                           gint                direction,
 452                                                           gboolean            left,
 453                                                           gboolean            right);
 454 void              _gtk_tree_view_column_cell_draw_focus  (GtkTreeViewColumn  *tree_column,
 455                                                           GdkWindow          *window,
 456                                                           const GdkRectangle *background_area,
 457                                                           const GdkRectangle *cell_area,
 458                                                           const GdkRectangle *expose_area,
 459                                                           guint               flags);
 460 void              _gtk_tree_view_column_cell_set_dirty   (GtkTreeViewColumn  *tree_column,
 461                                                           gboolean            install_handler);
 462 void              _gtk_tree_view_column_get_neighbor_sizes (GtkTreeViewColumn *column,
 463                                                             GtkCellRenderer   *cell,
 464                                                             gint              *left,
 465                                                             gint              *right);
 466
 467
 468 G_END_DECLS
 469
 470
 471 #endif /* __GTK_TREE_PRIVATE_H__ */
 472