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 #ifdef __cplusplus
  25 extern "C" {
  26 #endif /* __cplusplus */
  27
  28 #include <gtk/gtktreeview.h>
  29 #include <gtk/gtktreeselection.h>
  30 #include <gtk/gtkrbtree.h>
  31
  32 #define TREE_VIEW_DRAG_WIDTH 6
  33
  34 typedef enum
  35 {
  36   GTK_TREE_VIEW_IS_LIST = 1 << 0,
  37   GTK_TREE_VIEW_SHOW_EXPANDERS = 1 << 1,
  38   GTK_TREE_VIEW_IN_COLUMN_RESIZE = 1 << 2,
  39   GTK_TREE_VIEW_ARROW_PRELIT = 1 << 3,
  40   GTK_TREE_VIEW_HEADERS_VISIBLE = 1 << 4,
  41   GTK_TREE_VIEW_DRAW_KEYFOCUS = 1 << 5,
  42   GTK_TREE_VIEW_MODEL_SETUP = 1 << 6,
  43   GTK_TREE_VIEW_IN_COLUMN_DRAG = 1 << 7
  44 } GtkTreeViewFlags;
  45
  46 enum
  47 {
  48   DRAG_COLUMN_WINDOW_STATE_UNSET = 0,
  49   DRAG_COLUMN_WINDOW_STATE_ORIGINAL = 1,
  50   DRAG_COLUMN_WINDOW_STATE_ARROW = 2,
  51   DRAG_COLUMN_WINDOW_STATE_ARROW_LEFT = 3,
  52   DRAG_COLUMN_WINDOW_STATE_ARROW_RIGHT = 4
  53 };
  54
  55 #define GTK_TREE_VIEW_SET_FLAG(tree_view, flag)   G_STMT_START{ (tree_view->priv->flags|=flag); }G_STMT_END
  56 #define GTK_TREE_VIEW_UNSET_FLAG(tree_view, flag) G_STMT_START{ (tree_view->priv->flags&=~(flag)); }G_STMT_END
  57 #define GTK_TREE_VIEW_FLAG_SET(tree_view, flag)   ((tree_view->priv->flags&flag)==flag)
  58 #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)
  59 #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))
  60 #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))
  61
  62  /* This lovely little value is used to determine how far away from the title bar
  63   * you can move the mouse and still have a column drag work.
  64   */
  65 #define TREE_VIEW_COLUMN_DRAG_DEAD_MULTIPLIER(tree_view) (10*TREE_VIEW_HEADER_HEIGHT(tree_view))
  66
  67 typedef void (*GtkTreeViewSearchDialogPositionFunc) (GtkTreeView *tree_view,
  68                                                      GtkWidget   *search_dialog);
  69
  70 typedef struct _GtkTreeViewColumnReorder GtkTreeViewColumnReorder;
  71 struct _GtkTreeViewColumnReorder
  72 {
  73   gint left_align;
  74   gint right_align;
  75   GtkTreeViewColumn *left_column;
  76   GtkTreeViewColumn *right_column;
  77 };
  78
  79 struct _GtkTreeViewPrivate
  80 {
  81   GtkTreeModel *model;
  82
  83   guint flags;
  84   /* tree information */
  85   GtkRBTree *tree;
  86
  87   GtkRBNode *button_pressed_node;
  88   GtkRBTree *button_pressed_tree;
  89
  90   GList *children;
  91   gint width;
  92   gint height;
  93   gint expander_size;
  94
  95   GtkAdjustment *hadjustment;
  96   GtkAdjustment *vadjustment;
  97
  98   GdkWindow *bin_window;
  99   GdkWindow *header_window;
 100   GdkWindow *drag_window;
 101   GdkWindow *drag_highlight_window;
 102   GtkTreeViewColumn *drag_column;
 103
 104   GtkTreeRowReference *last_button_press;
 105   GtkTreeRowReference *last_button_press_2;
 106
 107   /* bin_window offset */
 108   GtkTreeRowReference *top_row;
 109   gint top_row_dy;
 110   /* dy == y pos of top_row + top_row_dy */
 111   /* we cache it for simplicity of the code */
 112   gint dy;
 113   gint drag_column_x;
 114
 115   GtkTreeViewColumn *expander_column;
 116   GtkTreeViewColumn *edited_column;
 117   guint presize_handler_timer;
 118   guint validate_rows_timer;
 119   guint scroll_sync_timer;
 120
 121   /* Focus code */
 122   GtkTreeViewColumn *focus_column;
 123
 124   /* Selection stuff */
 125   GtkTreeRowReference *anchor;
 126   GtkTreeRowReference *cursor;
 127
 128   /* Column Resizing */
 129   gint drag_pos;
 130   gint x_drag;
 131
 132   /* Prelight information */
 133   GtkRBNode *prelight_node;
 134   GtkRBTree *prelight_tree;
 135
 136   /* The node that's currently being collapsed or expanded */
 137   GtkRBNode *expanded_collapsed_node;
 138   GtkRBTree *expanded_collapsed_tree;
 139   guint expand_collapse_timeout;
 140
 141   /* Selection information */
 142   GtkTreeSelection *selection;
 143
 144   /* Header information */
 145   gint n_columns;
 146   GList *columns;
 147   gint header_height;
 148
 149   GtkTreeViewColumnDropFunc column_drop_func;
 150   gpointer column_drop_func_data;
 151   GtkDestroyNotify column_drop_func_data_destroy;
 152   GList *column_drag_info;
 153   GtkTreeViewColumnReorder *cur_reorder;
 154
 155   /* ATK Hack */
 156   GtkTreeDestroyCountFunc destroy_count_func;
 157   gpointer destroy_count_data;
 158   GtkDestroyNotify destroy_count_destroy;
 159
 160   /* Scroll timeout (e.g. during dnd) */
 161   guint scroll_timeout;
 162
 163   /* Row drag-and-drop */
 164   GtkTreeRowReference *drag_dest_row;
 165   GtkTreeViewDropPosition drag_dest_pos;
 166   guint open_dest_timeout;
 167
 168   gint pressed_button;
 169   gint press_start_x;
 170   gint press_start_y;
 171
 172   /* Scroll-to functionality when unrealized */
 173   GtkTreeRowReference *scroll_to_path;
 174   GtkTreeViewColumn *scroll_to_column;
 175   gfloat scroll_to_row_align;
 176   gfloat scroll_to_col_align;
 177   guint scroll_to_use_align : 1;
 178
 179   guint fixed_height_check : 1;
 180
 181   guint reorderable : 1;
 182   guint header_has_focus : 1;
 183   guint drag_column_window_state : 3;
 184   /* hint to display rows in alternating colors */
 185   guint has_rules : 1;
 186   guint mark_rows_col_dirty : 1;
 187
 188   /* interactive search */
 189   guint enable_search : 1;
 190   guint disable_popdown : 1;
 191   gint search_column;
 192   GtkTreeViewSearchDialogPositionFunc search_dialog_position_func;
 193   GtkTreeViewSearchEqualFunc search_equal_func;
 194   gpointer search_user_data;
 195   GtkDestroyNotify search_destroy;
 196 };
 197
 198 /* cool ABI compat hack */
 199 #define GTK_CELL_RENDERER_INFO_KEY "gtk-cell-renderer-info"
 200
 201 typedef struct _GtkCellRendererInfo GtkCellRendererInfo;
 202 struct _GtkCellRendererInfo
 203 {
 204   GdkColor cell_background;
 205
 206   /* text renderer */
 207   gulong focus_out_id;
 208
 209   /* toggle renderer */
 210   gboolean inconsistent :1;
 211 };
 212
 213 #ifdef __GNUC__
 214
 215 #define TREE_VIEW_INTERNAL_ASSERT(expr, ret)     G_STMT_START{          \
 216      if (!(expr))                                                       \
 217        {                                                                \
 218          g_log (G_LOG_DOMAIN,                                           \
 219                 G_LOG_LEVEL_CRITICAL,                                   \
 220                 "file %s: line %d (%s): assertion `%s' failed.\n"       \
 221                 "There is a disparity between the internal view of the GtkTreeView,\n"    \
 222                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
 223                 "without letting the view know.  Any display from now on is likely to\n"  \
 224                 "be incorrect.\n",                                                        \
 225                 __FILE__,                                               \
 226                 __LINE__,                                               \
 227                 __PRETTY_FUNCTION__,                                    \
 228                 #expr);                                                 \
 229          return ret;                                                    \
 230        };                               }G_STMT_END
 231
 232 #define TREE_VIEW_INTERNAL_ASSERT_VOID(expr)     G_STMT_START{          \
 233      if (!(expr))                                                       \
 234        {                                                                \
 235          g_log (G_LOG_DOMAIN,                                           \
 236                 G_LOG_LEVEL_CRITICAL,                                   \
 237                 "file %s: line %d (%s): assertion `%s' failed.\n"       \
 238                 "There is a disparity between the internal view of the GtkTreeView,\n"    \
 239                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
 240                 "without letting the view know.  Any display from now on is likely to\n"  \
 241                 "be incorrect.\n",                                                        \
 242                 __FILE__,                                               \
 243                 __LINE__,                                               \
 244                 __PRETTY_FUNCTION__,                                    \
 245                 #expr);                                                 \
 246          return;                                                        \
 247        };                               }G_STMT_END
 248
 249 #else
 250
 251 #define TREE_VIEW_INTERNAL_ASSERT(expr, ret)     G_STMT_START{          \
 252      if (!(expr))                                                       \
 253        {                                                                \
 254          g_log (G_LOG_DOMAIN,                                           \
 255                 G_LOG_LEVEL_CRITICAL,                                   \
 256                 "file %s: line %d: assertion `%s' failed.\n"       \
 257                 "There is a disparity between the internal view of the GtkTreeView,\n"    \
 258                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
 259                 "without letting the view know.  Any display from now on is likely to\n"  \
 260                 "be incorrect.\n",                                                        \
 261                 __FILE__,                                               \
 262                 __LINE__,                                               \
 263                 #expr);                                                 \
 264          return ret;                                                    \
 265        };                               }G_STMT_END
 266
 267 #define TREE_VIEW_INTERNAL_ASSERT_VOID(expr)     G_STMT_START{          \
 268      if (!(expr))                                                       \
 269        {                                                                \
 270          g_log (G_LOG_DOMAIN,                                           \
 271                 G_LOG_LEVEL_CRITICAL,                                   \
 272                 "file %s: line %d: assertion '%s' failed.\n"            \
 273                 "There is a disparity between the internal view of the GtkTreeView,\n"    \
 274                 "and the GtkTreeModel.  This generally means that the model has changed\n"\
 275                 "without letting the view know.  Any display from now on is likely to\n"  \
 276                 "be incorrect.\n",                                                        \
 277                 __FILE__,                                               \
 278                 __LINE__,                                               \
 279                 #expr);                                                 \
 280          return;                                                        \
 281        };                               }G_STMT_END
 282 #endif
 283
 284
 285 /* functions that shouldn't be exported */
 286 void         _gtk_tree_selection_internal_select_node (GtkTreeSelection  *selection,
 287                                                        GtkRBNode         *node,
 288                                                        GtkRBTree         *tree,
 289                                                        GtkTreePath       *path,
 290                                                        GdkModifierType    state,
 291                                                        gboolean           override_browse_mode);
 292 gboolean     _gtk_tree_view_find_node                 (GtkTreeView       *tree_view,
 293                                                        GtkTreePath       *path,
 294                                                        GtkRBTree        **tree,
 295                                                        GtkRBNode        **node);
 296 GtkTreePath *_gtk_tree_view_find_path                 (GtkTreeView       *tree_view,
 297                                                        GtkRBTree         *tree,
 298                                                        GtkRBNode         *node);
 299 void         _gtk_tree_view_child_move_resize         (GtkTreeView       *tree_view,
 300                                                        GtkWidget         *widget,
 301                                                        gint               x,
 302                                                        gint               y,
 303                                                        gint               width,
 304                                                        gint               height);
 305 void         _gtk_tree_view_queue_draw_node           (GtkTreeView       *tree_view,
 306                                                        GtkRBTree         *tree,
 307                                                        GtkRBNode         *node,
 308                                                        GdkRectangle      *clip_rect);
 309
 310 void _gtk_tree_view_column_realize_button   (GtkTreeViewColumn *column);
 311 void _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column);
 312 void _gtk_tree_view_column_set_tree_view    (GtkTreeViewColumn *column,
 313                                              GtkTreeView       *tree_view);
 314 void _gtk_tree_view_column_unset_model      (GtkTreeViewColumn *column,
 315                                              GtkTreeModel      *old_model);
 316 void _gtk_tree_view_column_unset_tree_view  (GtkTreeViewColumn *column);
 317 void _gtk_tree_view_column_set_width        (GtkTreeViewColumn *column,
 318                                              gint               width);
 319 void _gtk_tree_view_column_start_drag       (GtkTreeView       *tree_view,
 320                                              GtkTreeViewColumn *column);
 321 gboolean _gtk_tree_view_column_cell_event   (GtkTreeViewColumn  *tree_column,
 322                                              GtkCellEditable   **editable_widget,
 323                                              GdkEvent           *event,
 324                                              gchar              *path_string,
 325                                              GdkRectangle       *background_area,
 326                                              GdkRectangle       *cell_area,
 327                                              guint               flags);
 328 void _gtk_tree_view_column_start_editing (GtkTreeViewColumn *tree_column,
 329                                           GtkCellEditable   *editable_widget);
 330 void _gtk_tree_view_column_stop_editing  (GtkTreeViewColumn *tree_column);
 331 void _gtk_tree_view_install_mark_rows_col_dirty (GtkTreeView *tree_view);
 332 void             _gtk_tree_view_column_autosize          (GtkTreeView       *tree_view,
 333                                                           GtkTreeViewColumn *column);
 334
 335 gboolean         _gtk_tree_view_column_has_editable_cell (GtkTreeViewColumn *column);
 336 GtkCellRenderer *_gtk_tree_view_column_get_edited_cell   (GtkTreeViewColumn *column);
 337 gint             _gtk_tree_view_column_count_special_cells (GtkTreeViewColumn *column);
 338 GtkCellRenderer *_gtk_tree_view_column_get_cell_at_pos   (GtkTreeViewColumn *column,
 339                                                           gint               x);
 340
 341 GtkTreeSelection* _gtk_tree_selection_new                (void);
 342 GtkTreeSelection* _gtk_tree_selection_new_with_tree_view (GtkTreeView      *tree_view);
 343 void              _gtk_tree_selection_set_tree_view      (GtkTreeSelection *selection,
 344                                                           GtkTreeView      *tree_view);
 345
 346 void              _gtk_tree_view_column_cell_render      (GtkTreeViewColumn *tree_column,
 347                                                           GdkWindow         *window,
 348                                                           GdkRectangle      *background_area,
 349                                                           GdkRectangle      *cell_area,
 350                                                           GdkRectangle      *expose_area,
 351                                                           guint              flags);
 352 gboolean          _gtk_tree_view_column_cell_focus       (GtkTreeViewColumn *tree_column,
 353                                                           gint               direction,
 354                                                           gboolean           left,
 355                                                           gboolean           right);
 356 void              _gtk_tree_view_column_cell_draw_focus  (GtkTreeViewColumn *tree_column,
 357                                                           GdkWindow         *window,
 358                                                           GdkRectangle      *background_area,
 359                                                           GdkRectangle      *cell_area,
 360                                                           GdkRectangle      *expose_area,
 361                                                           guint              flags);
 362 void              _gtk_tree_view_column_cell_set_dirty   (GtkTreeViewColumn *tree_column,
 363                                                           gboolean           install_handler);
 364 void              _gtk_tree_view_column_get_neighbor_sizes (GtkTreeViewColumn *column,
 365                                                             GtkCellRenderer   *cell,
 366                                                             gint              *left,
 367                                                             gint              *right);
 368
 369
 370 #ifdef __cplusplus
 371 }
 372 #endif /* __cplusplus */
 373
 374
 375 #endif /* __GTK_TREE_PRIVATE_H__ */
 376