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