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