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