gtktreeprivate.h 16.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/* gtktreeprivate.h
 * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifndef __GTK_TREE_PRIVATE_H__
#define __GTK_TREE_PRIVATE_H__


24 25
G_BEGIN_DECLS

26 27 28 29

#include <gtk/gtktreeview.h>
#include <gtk/gtktreeselection.h>
#include <gtk/gtkrbtree.h>
30

31 32
#define TREE_VIEW_DRAG_WIDTH 6

33 34
typedef enum
{
35 36 37 38 39 40
  GTK_TREE_VIEW_IS_LIST = 1 << 0,
  GTK_TREE_VIEW_SHOW_EXPANDERS = 1 << 1,
  GTK_TREE_VIEW_IN_COLUMN_RESIZE = 1 << 2,
  GTK_TREE_VIEW_ARROW_PRELIT = 1 << 3,
  GTK_TREE_VIEW_HEADERS_VISIBLE = 1 << 4,
  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 44
} GtkTreeViewFlags;

Kristian Rietveld's avatar
Kristian Rietveld committed
45 46 47 48 49 50 51
typedef enum
{
  GTK_TREE_SELECT_MODE_TOGGLE = 1 << 0,
  GTK_TREE_SELECT_MODE_EXTEND = 1 << 1
}
GtkTreeSelectMode;

52 53 54 55 56 57
enum
{
  DRAG_COLUMN_WINDOW_STATE_UNSET = 0,
  DRAG_COLUMN_WINDOW_STATE_ORIGINAL = 1,
  DRAG_COLUMN_WINDOW_STATE_ARROW = 2,
  DRAG_COLUMN_WINDOW_STATE_ARROW_LEFT = 3,
58
  DRAG_COLUMN_WINDOW_STATE_ARROW_RIGHT = 4
59
};
60

61 62 63 64 65 66 67
enum
{
  RUBBER_BAND_OFF = 0,
  RUBBER_BAND_MAYBE_START = 1,
  RUBBER_BAND_ACTIVE = 2
};

68 69 70 71
#define GTK_TREE_VIEW_SET_FLAG(tree_view, flag)   G_STMT_START{ (tree_view->priv->flags|=flag); }G_STMT_END
#define GTK_TREE_VIEW_UNSET_FLAG(tree_view, flag) G_STMT_START{ (tree_view->priv->flags&=~(flag)); }G_STMT_END
#define GTK_TREE_VIEW_FLAG_SET(tree_view, flag)   ((tree_view->priv->flags&flag)==flag)
#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)
Jonathan Blandford's avatar
Jonathan Blandford committed
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 74
#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))

75 76 77 78 79 80 81 82 83 84 85 86 87 88
 /* This lovely little value is used to determine how far away from the title bar
  * you can move the mouse and still have a column drag work.
  */
#define TREE_VIEW_COLUMN_DRAG_DEAD_MULTIPLIER(tree_view) (10*TREE_VIEW_HEADER_HEIGHT(tree_view))

typedef struct _GtkTreeViewColumnReorder GtkTreeViewColumnReorder;
struct _GtkTreeViewColumnReorder
{
  gint left_align;
  gint right_align;
  GtkTreeViewColumn *left_column;
  GtkTreeViewColumn *right_column;
};

89 90 91 92 93 94 95 96 97 98 99 100 101 102
struct _GtkTreeViewPrivate
{
  GtkTreeModel *model;

  guint flags;
  /* tree information */
  GtkRBTree *tree;

  GtkRBNode *button_pressed_node;
  GtkRBTree *button_pressed_tree;

  GList *children;
  gint width;
  gint height;
Kristian Rietveld's avatar
Kristian Rietveld committed
103
  gint expander_size;
104 105 106 107 108 109

  GtkAdjustment *hadjustment;
  GtkAdjustment *vadjustment;

  GdkWindow *bin_window;
  GdkWindow *header_window;
Jonathan Blandford's avatar
Jonathan Blandford committed
110
  GdkWindow *drag_window;
111
  GdkWindow *drag_highlight_window;
Jonathan Blandford's avatar
Jonathan Blandford committed
112
  GtkTreeViewColumn *drag_column;
113

114 115
  GtkTreeRowReference *last_button_press;
  GtkTreeRowReference *last_button_press_2;
116

117
  /* bin_window offset */
118 119
  GtkTreeRowReference *top_row;
  gint top_row_dy;
120 121
  /* dy == y pos of top_row + top_row_dy */
  /* 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;
Jonathan Blandford's avatar
Jonathan Blandford committed
128 129
  guint presize_handler_timer;
  guint validate_rows_timer;
130
  guint scroll_sync_timer;
131 132

  /* Focus code */
133
  GtkTreeViewColumn *focus_column;
134

135
  /* Selection stuff */
136 137
  GtkTreeRowReference *anchor;
  GtkTreeRowReference *cursor;
138 139 140 141 142 143 144 145 146

  /* Column Resizing */
  gint drag_pos;
  gint x_drag;

  /* Prelight information */
  GtkRBNode *prelight_node;
  GtkRBTree *prelight_tree;

147 148 149 150 151
  /* The node that's currently being collapsed or expanded */
  GtkRBNode *expanded_collapsed_node;
  GtkRBTree *expanded_collapsed_tree;
  guint expand_collapse_timeout;

152 153 154 155
  /* Selection information */
  GtkTreeSelection *selection;

  /* Header information */
156 157
  gint n_columns;
  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;
Jonathan Blandford's avatar
Jonathan Blandford committed
163
  GList *column_drag_info;
164
  GtkTreeViewColumnReorder *cur_reorder;
Havoc Pennington's avatar
Havoc Pennington committed
165

166 167 168
  /* ATK Hack */
  GtkTreeDestroyCountFunc destroy_count_func;
  gpointer destroy_count_data;
169
  GDestroyNotify destroy_count_destroy;
170

Havoc Pennington's avatar
Havoc Pennington committed
171 172
  /* Scroll timeout (e.g. during dnd) */
  guint scroll_timeout;
173

Havoc Pennington's avatar
Havoc Pennington committed
174
  /* Row drag-and-drop */
175
  GtkTreeRowReference *drag_dest_row;
Havoc Pennington's avatar
Havoc Pennington committed
176 177
  GtkTreeViewDropPosition drag_dest_pos;
  guint open_dest_timeout;
178

Havoc Pennington's avatar
Havoc Pennington committed
179 180 181
  gint pressed_button;
  gint press_start_x;
  gint press_start_y;
182

183 184 185 186 187 188 189 190 191 192 193 194
  gint rubber_band_status;
  gint rubber_band_x;
  gint rubber_band_y;
  gint rubber_band_shift;
  gint rubber_band_ctrl;

  GtkRBNode *rubber_band_start_node;
  GtkRBTree *rubber_band_start_tree;

  GtkRBNode *rubber_band_end_node;
  GtkRBTree *rubber_band_end_tree;

195 196 197
  /* fixed height */
  gint fixed_height;

198
  /* Scroll-to functionality when unrealized */
199
  GtkTreeRowReference *scroll_to_path;
200 201 202
  GtkTreeViewColumn *scroll_to_column;
  gfloat scroll_to_row_align;
  gfloat scroll_to_col_align;
203
  guint scroll_to_use_align : 1;
204

205
  guint fixed_height_mode : 1;
206 207
  guint fixed_height_check : 1;

208
  guint reorderable : 1;
209 210
  guint header_has_focus : 1;
  guint drag_column_window_state : 3;
211 212
  /* hint to display rows in alternating colors */
  guint has_rules : 1;
Jonathan Blandford's avatar
Jonathan Blandford committed
213
  guint mark_rows_col_dirty : 1;
Kristian Rietveld's avatar
Kristian Rietveld committed
214

215 216 217
  /* for DnD */
  guint empty_view_drop : 1;

Kristian Rietveld's avatar
Kristian Rietveld committed
218 219
  guint ctrl_pressed : 1;
  guint shift_pressed : 1;
220 221 222 223


  guint init_hadjust_value : 1;

224 225
  guint in_top_row_to_dy : 1;

226 227
  /* interactive search */
  guint enable_search : 1;
228
  guint disable_popdown : 1;
229
  guint search_custom_entry_set : 1;
Matthias Clasen's avatar
Matthias Clasen committed
230 231
  
  guint hover_selection : 1;
232
  guint hover_expand : 1;
Jonathan Blandford's avatar
Jonathan Blandford committed
233
  guint imcontext_changed : 1;
234

235 236
  guint rubber_banding_enable : 1;

237 238
  guint in_grab : 1;

Kristian Rietveld's avatar
Kristian Rietveld committed
239

240 241 242
  /* Auto expand/collapse timeout in hover mode */
  guint auto_expand_timeout;

243
  gint selected_iter;
244
  gint search_column;
245
  GtkTreeViewSearchPositionFunc search_position_func;
246 247
  GtkTreeViewSearchEqualFunc search_equal_func;
  gpointer search_user_data;
248
  GDestroyNotify search_destroy;
249 250
  gpointer search_position_user_data;
  GDestroyNotify search_position_destroy;
251 252
  GtkWidget *search_window;
  GtkWidget *search_entry;
Jonathan Blandford's avatar
Jonathan Blandford committed
253 254
  guint search_entry_changed_id;
  guint typeselect_flush_timeout;
255 256

  gint prev_width;
Matthias Clasen's avatar
Matthias Clasen committed
257 258 259

  GtkTreeViewRowSeparatorFunc row_separator_func;
  gpointer row_separator_data;
260
  GDestroyNotify row_separator_destroy;
Kristian Rietveld's avatar
Kristian Rietveld committed
261 262

  gint level_indentation;
263 264 265 266 267 268

  GtkTreeViewGridLines grid_lines;
  GdkGC *grid_line_gc;

  gboolean tree_lines_enabled;
  GdkGC *tree_line_gc;
269 270

  gint tooltip_column;
271 272
};

273 274
#ifdef __GNUC__

275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
#define TREE_VIEW_INTERNAL_ASSERT(expr, ret)     G_STMT_START{          \
     if (!(expr))                                                       \
       {                                                                \
         g_log (G_LOG_DOMAIN,                                           \
                G_LOG_LEVEL_CRITICAL,                                   \
		"file %s: line %d (%s): assertion `%s' failed.\n"       \
	        "There is a disparity between the internal view of the GtkTreeView,\n"    \
		"and the GtkTreeModel.  This generally means that the model has changed\n"\
		"without letting the view know.  Any display from now on is likely to\n"  \
		"be incorrect.\n",                                                        \
                __FILE__,                                               \
                __LINE__,                                               \
                __PRETTY_FUNCTION__,                                    \
                #expr);                                                 \
         return ret;                                                    \
       };                               }G_STMT_END

Jonathan Blandford's avatar
Jonathan Blandford committed
292
#define TREE_VIEW_INTERNAL_ASSERT_VOID(expr)     G_STMT_START{          \
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
     if (!(expr))                                                       \
       {                                                                \
         g_log (G_LOG_DOMAIN,                                           \
                G_LOG_LEVEL_CRITICAL,                                   \
		"file %s: line %d (%s): assertion `%s' failed.\n"       \
	        "There is a disparity between the internal view of the GtkTreeView,\n"    \
		"and the GtkTreeModel.  This generally means that the model has changed\n"\
		"without letting the view know.  Any display from now on is likely to\n"  \
		"be incorrect.\n",                                                        \
                __FILE__,                                               \
                __LINE__,                                               \
                __PRETTY_FUNCTION__,                                    \
                #expr);                                                 \
         return;                                                        \
       };                               }G_STMT_END

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
#else

#define TREE_VIEW_INTERNAL_ASSERT(expr, ret)     G_STMT_START{          \
     if (!(expr))                                                       \
       {                                                                \
         g_log (G_LOG_DOMAIN,                                           \
                G_LOG_LEVEL_CRITICAL,                                   \
		"file %s: line %d: assertion `%s' failed.\n"       \
	        "There is a disparity between the internal view of the GtkTreeView,\n"    \
		"and the GtkTreeModel.  This generally means that the model has changed\n"\
		"without letting the view know.  Any display from now on is likely to\n"  \
		"be incorrect.\n",                                                        \
                __FILE__,                                               \
                __LINE__,                                               \
                #expr);                                                 \
         return ret;                                                    \
       };                               }G_STMT_END

#define TREE_VIEW_INTERNAL_ASSERT_VOID(expr)     G_STMT_START{          \
     if (!(expr))                                                       \
       {                                                                \
         g_log (G_LOG_DOMAIN,                                           \
                G_LOG_LEVEL_CRITICAL,                                   \
		"file %s: line %d: assertion '%s' failed.\n"            \
	        "There is a disparity between the internal view of the GtkTreeView,\n"    \
		"and the GtkTreeModel.  This generally means that the model has changed\n"\
		"without letting the view know.  Any display from now on is likely to\n"  \
		"be incorrect.\n",                                                        \
                __FILE__,                                               \
                __LINE__,                                               \
                #expr);                                                 \
         return;                                                        \
       };                               }G_STMT_END
#endif

344

345 346 347 348 349
/* functions that shouldn't be exported */
void         _gtk_tree_selection_internal_select_node (GtkTreeSelection  *selection,
						       GtkRBNode         *node,
						       GtkRBTree         *tree,
						       GtkTreePath       *path,
Kristian Rietveld's avatar
Kristian Rietveld committed
350
                                                       GtkTreeSelectMode  mode,
Kristian Rietveld's avatar
Kristian Rietveld committed
351
						       gboolean           override_browse_mode);
352
void         _gtk_tree_selection_emit_changed         (GtkTreeSelection  *selection);
353 354 355 356 357 358 359
gboolean     _gtk_tree_view_find_node                 (GtkTreeView       *tree_view,
						       GtkTreePath       *path,
						       GtkRBTree        **tree,
						       GtkRBNode        **node);
GtkTreePath *_gtk_tree_view_find_path                 (GtkTreeView       *tree_view,
						       GtkRBTree         *tree,
						       GtkRBNode         *node);
360 361 362 363 364 365
void         _gtk_tree_view_child_move_resize         (GtkTreeView       *tree_view,
						       GtkWidget         *widget,
						       gint               x,
						       gint               y,
						       gint               width,
						       gint               height);
366 367 368
void         _gtk_tree_view_queue_draw_node           (GtkTreeView       *tree_view,
						       GtkRBTree         *tree,
						       GtkRBNode         *node,
369
						       const GdkRectangle *clip_rect);
370

371 372 373 374
void _gtk_tree_view_column_realize_button   (GtkTreeViewColumn *column);
void _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column);
void _gtk_tree_view_column_set_tree_view    (GtkTreeViewColumn *column,
					     GtkTreeView       *tree_view);
375 376
void _gtk_tree_view_column_unset_model      (GtkTreeViewColumn *column,
					     GtkTreeModel      *old_model);
377
void _gtk_tree_view_column_unset_tree_view  (GtkTreeViewColumn *column);
378 379
void _gtk_tree_view_column_set_width        (GtkTreeViewColumn *column,
					     gint               width);
Jonathan Blandford's avatar
Jonathan Blandford committed
380 381
void _gtk_tree_view_column_start_drag       (GtkTreeView       *tree_view,
					     GtkTreeViewColumn *column);
382 383 384 385
gboolean _gtk_tree_view_column_cell_event   (GtkTreeViewColumn  *tree_column,
					     GtkCellEditable   **editable_widget,
					     GdkEvent           *event,
					     gchar              *path_string,
386 387
					     const GdkRectangle *background_area,
					     const GdkRectangle *cell_area,
388
					     guint               flags);
389 390 391
void _gtk_tree_view_column_start_editing (GtkTreeViewColumn *tree_column,
					  GtkCellEditable   *editable_widget);
void _gtk_tree_view_column_stop_editing  (GtkTreeViewColumn *tree_column);
392 393 394 395
void _gtk_tree_view_install_mark_rows_col_dirty (GtkTreeView *tree_view);
void             _gtk_tree_view_column_autosize          (GtkTreeView       *tree_view,
							  GtkTreeViewColumn *column);

396
gboolean         _gtk_tree_view_column_has_editable_cell (GtkTreeViewColumn *column);
397
GtkCellRenderer *_gtk_tree_view_column_get_edited_cell   (GtkTreeViewColumn *column);
Kristian Rietveld's avatar
Kristian Rietveld committed
398
gint             _gtk_tree_view_column_count_special_cells (GtkTreeViewColumn *column);
399 400
GtkCellRenderer *_gtk_tree_view_column_get_cell_at_pos   (GtkTreeViewColumn *column,
							  gint               x);
401

402 403 404 405
GtkTreeSelection* _gtk_tree_selection_new                (void);
GtkTreeSelection* _gtk_tree_selection_new_with_tree_view (GtkTreeView      *tree_view);
void              _gtk_tree_selection_set_tree_view      (GtkTreeSelection *selection,
                                                          GtkTreeView      *tree_view);
406 407 408
gboolean          _gtk_tree_selection_row_is_selectable  (GtkTreeSelection *selection,
							  GtkRBNode        *node,
							  GtkTreePath      *path);
409

410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
void		  _gtk_tree_view_column_cell_render      (GtkTreeViewColumn  *tree_column,
							  GdkWindow          *window,
							  const GdkRectangle *background_area,
							  const GdkRectangle *cell_area,
							  const GdkRectangle *expose_area,
							  guint               flags);
void		  _gtk_tree_view_column_get_focus_area   (GtkTreeViewColumn  *tree_column,
							  const GdkRectangle *background_area,
							  const GdkRectangle *cell_area,
							  GdkRectangle       *focus_area);
gboolean	  _gtk_tree_view_column_cell_focus       (GtkTreeViewColumn  *tree_column,
							  gint                direction,
							  gboolean            left,
							  gboolean            right);
void		  _gtk_tree_view_column_cell_draw_focus  (GtkTreeViewColumn  *tree_column,
							  GdkWindow          *window,
							  const GdkRectangle *background_area,
							  const GdkRectangle *cell_area,
							  const GdkRectangle *expose_area,
							  guint               flags);
void		  _gtk_tree_view_column_cell_set_dirty	 (GtkTreeViewColumn  *tree_column,
							  gboolean            install_handler);
432 433 434 435
void              _gtk_tree_view_column_get_neighbor_sizes (GtkTreeViewColumn *column,
							    GtkCellRenderer   *cell,
							    gint              *left,
							    gint              *right);
436 437


438
G_END_DECLS
439 440 441 442


#endif /* __GTK_TREE_PRIVATE_H__ */