2 * Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
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.
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.
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.
20 #ifndef __GTK_TREE_PRIVATE_H__
21 #define __GTK_TREE_PRIVATE_H__
27 #include <gtk/gtktreeview.h>
28 #include <gtk/gtktreeselection.h>
29 #include <gtk/gtkrbtree.h>
31 #define TREE_VIEW_DRAG_WIDTH 6
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
47 GTK_TREE_SELECT_MODE_TOGGLE = 1 << 0,
48 GTK_TREE_SELECT_MODE_EXTEND = 1 << 1
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
64 RUBBER_BAND_MAYBE_START = 1,
65 RUBBER_BAND_ACTIVE = 2
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)&>K_TREE_VIEW_FLAG_SET (tree_view, GTK_TREE_VIEW_SHOW_EXPANDERS))
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.
78 #define TREE_VIEW_COLUMN_DRAG_DEAD_MULTIPLIER(tree_view) (10*TREE_VIEW_HEADER_HEIGHT(tree_view))
80 typedef struct _GtkTreeViewColumnReorder GtkTreeViewColumnReorder;
81 struct _GtkTreeViewColumnReorder
85 GtkTreeViewColumn *left_column;
86 GtkTreeViewColumn *right_column;
89 struct _GtkTreeViewPrivate
94 /* tree information */
103 GtkAdjustment *hadjustment;
104 GtkAdjustment *vadjustment;
107 GdkWindow *bin_window;
108 GdkWindow *header_window;
110 /* Scroll position state keeping */
111 GtkTreeRowReference *top_row;
113 /* dy == y pos of top_row + top_row_dy */
114 /* we cache it for simplicity of the code */
117 guint presize_handler_timer;
118 guint validate_rows_timer;
119 guint scroll_sync_timer;
121 /* Indentation and expander layout */
123 GtkTreeViewColumn *expander_column;
125 gint level_indentation;
127 /* Key navigation (focus), selection */
130 GtkTreeRowReference *anchor;
131 GtkTreeRowReference *cursor;
133 GtkTreeViewColumn *focus_column;
135 /* Current pressed node, previously pressed, prelight */
136 GtkRBNode *button_pressed_node;
137 GtkRBTree *button_pressed_tree;
146 guint last_button_time;
150 GtkRBNode *prelight_node;
151 GtkRBTree *prelight_tree;
154 GtkTreeViewColumn *edited_column;
156 /* The node that's currently being collapsed or expanded */
157 GtkRBNode *expanded_collapsed_node;
158 GtkRBTree *expanded_collapsed_tree;
159 guint expand_collapse_timeout;
161 /* Auto expand/collapse timeout in hover mode */
162 guint auto_expand_timeout;
164 /* Selection information */
165 GtkTreeSelection *selection;
167 /* Header information */
172 GtkTreeViewColumnDropFunc column_drop_func;
173 gpointer column_drop_func_data;
174 GDestroyNotify column_drop_func_data_destroy;
175 GList *column_drag_info;
176 GtkTreeViewColumnReorder *cur_reorder;
178 /* Interactive Header reordering */
179 GdkWindow *drag_window;
180 GdkWindow *drag_highlight_window;
181 GtkTreeViewColumn *drag_column;
184 /* Interactive Header Resizing */
188 /* Non-interactive Header Resizing, expand flag support */
191 gint last_extra_space;
192 gint last_extra_space_per_column;
193 gint last_number_of_expand_columns;
196 GtkTreeDestroyCountFunc destroy_count_func;
197 gpointer destroy_count_data;
198 GDestroyNotify destroy_count_destroy;
200 /* Scroll timeout (e.g. during dnd, rubber banding) */
201 guint scroll_timeout;
203 /* Row drag-and-drop */
204 GtkTreeRowReference *drag_dest_row;
205 GtkTreeViewDropPosition drag_dest_pos;
206 guint open_dest_timeout;
209 gint rubber_band_status;
212 gint rubber_band_shift;
213 gint rubber_band_ctrl;
215 GtkRBNode *rubber_band_start_node;
216 GtkRBTree *rubber_band_start_tree;
218 GtkRBNode *rubber_band_end_node;
219 GtkRBTree *rubber_band_end_tree;
224 /* Scroll-to functionality when unrealized */
225 GtkTreeRowReference *scroll_to_path;
226 GtkTreeViewColumn *scroll_to_column;
227 gfloat scroll_to_row_align;
228 gfloat scroll_to_col_align;
230 /* Interactive search */
233 GtkTreeViewSearchPositionFunc search_position_func;
234 GtkTreeViewSearchEqualFunc search_equal_func;
235 gpointer search_user_data;
236 GDestroyNotify search_destroy;
237 gpointer search_position_user_data;
238 GDestroyNotify search_position_destroy;
239 GtkWidget *search_window;
240 GtkWidget *search_entry;
241 guint search_entry_changed_id;
242 guint typeselect_flush_timeout;
244 /* Grid and tree lines */
245 GtkTreeViewGridLines grid_lines;
248 gboolean tree_lines_enabled;
252 GtkTreeViewRowSeparatorFunc row_separator_func;
253 gpointer row_separator_data;
254 GDestroyNotify row_separator_destroy;
256 /* Tooltip support */
259 /* Here comes the bitfield */
260 guint scroll_to_use_align : 1;
262 guint fixed_height_mode : 1;
263 guint fixed_height_check : 1;
265 guint reorderable : 1;
266 guint header_has_focus : 1;
267 guint drag_column_window_state : 3;
268 /* hint to display rows in alternating colors */
270 guint mark_rows_col_dirty : 1;
273 guint empty_view_drop : 1;
275 guint ctrl_pressed : 1;
276 guint shift_pressed : 1;
278 guint init_hadjust_value : 1;
280 guint in_top_row_to_dy : 1;
282 /* interactive search */
283 guint enable_search : 1;
284 guint disable_popdown : 1;
285 guint search_custom_entry_set : 1;
287 guint hover_selection : 1;
288 guint hover_expand : 1;
289 guint imcontext_changed : 1;
291 guint rubber_banding_enable : 1;
295 guint post_validation_flag : 1;
297 /* Whether our key press handler is to avoid sending an unhandled binding to the search entry */
298 guint search_entry_avoid_unhandled_binding : 1;
303 #define TREE_VIEW_INTERNAL_ASSERT(expr, ret) G_STMT_START{ \
306 g_log (G_LOG_DOMAIN, \
307 G_LOG_LEVEL_CRITICAL, \
308 "%s (%s): assertion `%s' failed.\n" \
309 "There is a disparity between the internal view of the GtkTreeView,\n" \
310 "and the GtkTreeModel. This generally means that the model has changed\n"\
311 "without letting the view know. Any display from now on is likely to\n" \
319 #define TREE_VIEW_INTERNAL_ASSERT_VOID(expr) G_STMT_START{ \
322 g_log (G_LOG_DOMAIN, \
323 G_LOG_LEVEL_CRITICAL, \
324 "%s (%s): assertion `%s' failed.\n" \
325 "There is a disparity between the internal view of the GtkTreeView,\n" \
326 "and the GtkTreeModel. This generally means that the model has changed\n"\
327 "without letting the view know. Any display from now on is likely to\n" \
337 #define TREE_VIEW_INTERNAL_ASSERT(expr, ret) G_STMT_START{ \
340 g_log (G_LOG_DOMAIN, \
341 G_LOG_LEVEL_CRITICAL, \
342 "file %s: line %d: assertion `%s' failed.\n" \
343 "There is a disparity between the internal view of the GtkTreeView,\n" \
344 "and the GtkTreeModel. This generally means that the model has changed\n"\
345 "without letting the view know. Any display from now on is likely to\n" \
353 #define TREE_VIEW_INTERNAL_ASSERT_VOID(expr) G_STMT_START{ \
356 g_log (G_LOG_DOMAIN, \
357 G_LOG_LEVEL_CRITICAL, \
358 "file %s: line %d: assertion '%s' failed.\n" \
359 "There is a disparity between the internal view of the GtkTreeView,\n" \
360 "and the GtkTreeModel. This generally means that the model has changed\n"\
361 "without letting the view know. Any display from now on is likely to\n" \
371 /* functions that shouldn't be exported */
372 void _gtk_tree_selection_internal_select_node (GtkTreeSelection *selection,
376 GtkTreeSelectMode mode,
377 gboolean override_browse_mode);
378 void _gtk_tree_selection_emit_changed (GtkTreeSelection *selection);
379 gboolean _gtk_tree_view_find_node (GtkTreeView *tree_view,
383 GtkTreePath *_gtk_tree_view_find_path (GtkTreeView *tree_view,
386 void _gtk_tree_view_child_move_resize (GtkTreeView *tree_view,
392 void _gtk_tree_view_queue_draw_node (GtkTreeView *tree_view,
395 const GdkRectangle *clip_rect);
397 void _gtk_tree_view_column_realize_button (GtkTreeViewColumn *column);
398 void _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column);
399 void _gtk_tree_view_column_set_tree_view (GtkTreeViewColumn *column,
400 GtkTreeView *tree_view);
401 void _gtk_tree_view_column_unset_model (GtkTreeViewColumn *column,
402 GtkTreeModel *old_model);
403 void _gtk_tree_view_column_unset_tree_view (GtkTreeViewColumn *column);
404 void _gtk_tree_view_column_set_width (GtkTreeViewColumn *column,
406 void _gtk_tree_view_column_start_drag (GtkTreeView *tree_view,
407 GtkTreeViewColumn *column);
408 gboolean _gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
409 GtkCellEditable **editable_widget,
412 const GdkRectangle *background_area,
413 const GdkRectangle *cell_area,
415 void _gtk_tree_view_column_start_editing (GtkTreeViewColumn *tree_column,
416 GtkCellEditable *editable_widget);
417 void _gtk_tree_view_column_stop_editing (GtkTreeViewColumn *tree_column);
418 void _gtk_tree_view_install_mark_rows_col_dirty (GtkTreeView *tree_view);
419 void _gtk_tree_view_column_autosize (GtkTreeView *tree_view,
420 GtkTreeViewColumn *column);
422 gboolean _gtk_tree_view_column_has_editable_cell (GtkTreeViewColumn *column);
423 GtkCellRenderer *_gtk_tree_view_column_get_edited_cell (GtkTreeViewColumn *column);
424 gint _gtk_tree_view_column_count_special_cells (GtkTreeViewColumn *column);
425 GtkCellRenderer *_gtk_tree_view_column_get_cell_at_pos (GtkTreeViewColumn *column,
428 GtkTreeSelection* _gtk_tree_selection_new (void);
429 GtkTreeSelection* _gtk_tree_selection_new_with_tree_view (GtkTreeView *tree_view);
430 void _gtk_tree_selection_set_tree_view (GtkTreeSelection *selection,
431 GtkTreeView *tree_view);
432 gboolean _gtk_tree_selection_row_is_selectable (GtkTreeSelection *selection,
436 void _gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
438 const GdkRectangle *background_area,
439 const GdkRectangle *cell_area,
440 const GdkRectangle *expose_area,
442 void _gtk_tree_view_column_get_focus_area (GtkTreeViewColumn *tree_column,
443 const GdkRectangle *background_area,
444 const GdkRectangle *cell_area,
445 GdkRectangle *focus_area);
446 gboolean _gtk_tree_view_column_cell_focus (GtkTreeViewColumn *tree_column,
450 void _gtk_tree_view_column_cell_draw_focus (GtkTreeViewColumn *tree_column,
452 const GdkRectangle *background_area,
453 const GdkRectangle *cell_area,
454 const GdkRectangle *expose_area,
456 void _gtk_tree_view_column_cell_set_dirty (GtkTreeViewColumn *tree_column,
457 gboolean install_handler);
458 void _gtk_tree_view_column_get_neighbor_sizes (GtkTreeViewColumn *column,
459 GtkCellRenderer *cell,
467 #endif /* __GTK_TREE_PRIVATE_H__ */