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