1 <!-- ##### SECTION Title ##### -->
4 <!-- ##### SECTION Short_Description ##### -->
5 A widget for displaying both trees and lists
7 <!-- ##### SECTION Long_Description ##### -->
9 Widget that displays any object that implements the <link
10 linkend="GtkTreeModel">GtkTreeModel</link> interface.
13 <!-- ##### SECTION See_Also ##### -->
15 #GtkTreeViewColumn, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable, #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable, #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle
18 <!-- ##### STRUCT GtkTreeView ##### -->
24 <!-- ##### SIGNAL GtkTreeView::columns-changed ##### -->
29 @treeview: the object which received the signal.
31 <!-- ##### SIGNAL GtkTreeView::cursor-changed ##### -->
36 @treeview: the object which received the signal.
38 <!-- ##### SIGNAL GtkTreeView::expand-collapse-cursor-row ##### -->
43 @treeview: the object which received the signal.
49 <!-- ##### SIGNAL GtkTreeView::move-cursor ##### -->
54 @treeview: the object which received the signal.
59 <!-- ##### SIGNAL GtkTreeView::row-activated ##### -->
64 @treeview: the object which received the signal.
68 <!-- ##### SIGNAL GtkTreeView::row-collapsed ##### -->
73 @treeview: the object which received the signal.
77 <!-- ##### SIGNAL GtkTreeView::row-expanded ##### -->
82 @treeview: the object which received the signal.
86 <!-- ##### SIGNAL GtkTreeView::select-all ##### -->
91 @treeview: the object which received the signal.
94 <!-- ##### SIGNAL GtkTreeView::select-cursor-parent ##### -->
99 @treeview: the object which received the signal.
102 <!-- ##### SIGNAL GtkTreeView::select-cursor-row ##### -->
107 @treeview: the object which received the signal.
111 <!-- ##### SIGNAL GtkTreeView::set-scroll-adjustments ##### -->
116 @treeview: the object which received the signal.
120 <!-- ##### SIGNAL GtkTreeView::start-interactive-search ##### -->
125 @treeview: the object which received the signal.
128 <!-- ##### SIGNAL GtkTreeView::test-collapse-row ##### -->
133 @treeview: the object which received the signal.
138 <!-- ##### SIGNAL GtkTreeView::test-expand-row ##### -->
143 @treeview: the object which received the signal.
148 <!-- ##### SIGNAL GtkTreeView::toggle-cursor-row ##### -->
153 @treeview: the object which received the signal.
156 <!-- ##### SIGNAL GtkTreeView::unselect-all ##### -->
161 @treeview: the object which received the signal.
164 <!-- ##### ARG GtkTreeView:enable-search ##### -->
169 <!-- ##### ARG GtkTreeView:expander-column ##### -->
174 <!-- ##### ARG GtkTreeView:fixed-height-mode ##### -->
179 <!-- ##### ARG GtkTreeView:hadjustment ##### -->
184 <!-- ##### ARG GtkTreeView:headers-clickable ##### -->
189 <!-- ##### ARG GtkTreeView:headers-visible ##### -->
194 <!-- ##### ARG GtkTreeView:hover-expand ##### -->
199 <!-- ##### ARG GtkTreeView:hover-selection ##### -->
204 <!-- ##### ARG GtkTreeView:model ##### -->
209 <!-- ##### ARG GtkTreeView:reorderable ##### -->
214 <!-- ##### ARG GtkTreeView:rules-hint ##### -->
219 <!-- ##### ARG GtkTreeView:search-column ##### -->
224 <!-- ##### ARG GtkTreeView:vadjustment ##### -->
229 <!-- ##### ARG GtkTreeView:allow-rules ##### -->
234 <!-- ##### ARG GtkTreeView:even-row-color ##### -->
239 <!-- ##### ARG GtkTreeView:expander-size ##### -->
244 <!-- ##### ARG GtkTreeView:horizontal-separator ##### -->
249 <!-- ##### ARG GtkTreeView:indent-expanders ##### -->
254 <!-- ##### ARG GtkTreeView:odd-row-color ##### -->
259 <!-- ##### ARG GtkTreeView:vertical-separator ##### -->
264 <!-- ##### ENUM GtkTreeViewDropPosition ##### -->
266 An enum for determining where a dropped row goes.
269 @GTK_TREE_VIEW_DROP_BEFORE:
270 @GTK_TREE_VIEW_DROP_AFTER:
271 @GTK_TREE_VIEW_DROP_INTO_OR_BEFORE:
272 @GTK_TREE_VIEW_DROP_INTO_OR_AFTER:
274 <!-- ##### STRUCT GtkTreeViewPrivate ##### -->
276 A private struct for internal use only. The definition of this
277 structure is not publically available.
281 <!-- ##### USER_FUNCTION GtkTreeViewColumnDropFunc ##### -->
283 Function type for determining whether @column can be dropped in a
284 particular spot (as determined by @prev_column and @next_column). In
285 left to right locales, @prev_column is on the left of the potential drop
286 spot, and @next_column is on the right. In right to left mode, this is
287 reversed. This function should return %TRUE if the spot is a valid drop
288 spot. Please note that returning %TRUE does not actually indicate that
289 the column drop was made, but is meant only to indicate a possible drop
293 @tree_view: A #GtkTreeView
294 @column: The #GtkTreeViewColumn being dragged
295 @prev_column: A #GtkTreeViewColumn on one side of @column
296 @next_column: A #GtkTreeViewColumn on the other side of @column
298 @Returns: %TRUE, if #column can be dropped in this spot
301 <!-- ##### USER_FUNCTION GtkTreeViewMappingFunc ##### -->
303 Function used for #gtk_tree_view_map_expanded_rows.
306 @tree_view: A #GtkTreeView
307 @path: The path that's expanded
308 @user_data: user data
311 <!-- ##### USER_FUNCTION GtkTreeViewSearchEqualFunc ##### -->
313 A function used for checking whether a row in @model matches
314 a search key string entered by the user. Note the return value
315 is reversed from what you would normally expect, though it
316 has some similarity to strcmp() returning 0 for equal strings.
319 @model: the #GtkTreeModel being searched
320 @column: the search column set by gtk_tree_view_set_search_column()
321 @key: the key string to compare with
322 @iter: a #GtkTreeIter pointing the row of @model that should be compared
324 @search_data: user data from gtk_tree_view_set_search_equal_func()
325 @Returns: %FALSE if the row matches, %TRUE otherwise.
328 <!-- ##### FUNCTION gtk_tree_view_new ##### -->
336 <!-- ##### FUNCTION gtk_tree_view_new_with_model ##### -->
345 <!-- ##### FUNCTION gtk_tree_view_get_model ##### -->
354 <!-- ##### FUNCTION gtk_tree_view_set_model ##### -->
361 <!-- # Unused Parameters # -->
365 <!-- ##### FUNCTION gtk_tree_view_get_selection ##### -->
374 <!-- ##### FUNCTION gtk_tree_view_get_hadjustment ##### -->
381 <!-- # Unused Parameters # -->
385 <!-- ##### FUNCTION gtk_tree_view_set_hadjustment ##### -->
392 <!-- # Unused Parameters # -->
396 <!-- ##### FUNCTION gtk_tree_view_get_vadjustment ##### -->
403 <!-- # Unused Parameters # -->
407 <!-- ##### FUNCTION gtk_tree_view_set_vadjustment ##### -->
414 <!-- # Unused Parameters # -->
418 <!-- ##### FUNCTION gtk_tree_view_get_headers_visible ##### -->
427 <!-- ##### FUNCTION gtk_tree_view_set_headers_visible ##### -->
436 <!-- ##### FUNCTION gtk_tree_view_columns_autosize ##### -->
444 <!-- ##### FUNCTION gtk_tree_view_set_headers_clickable ##### -->
451 <!-- # Unused Parameters # -->
455 <!-- ##### FUNCTION gtk_tree_view_set_rules_hint ##### -->
464 <!-- ##### FUNCTION gtk_tree_view_get_rules_hint ##### -->
473 <!-- ##### FUNCTION gtk_tree_view_append_column ##### -->
483 <!-- ##### FUNCTION gtk_tree_view_remove_column ##### -->
493 <!-- ##### FUNCTION gtk_tree_view_insert_column ##### -->
504 <!-- ##### FUNCTION gtk_tree_view_insert_column_with_attributes ##### -->
517 <!-- ##### FUNCTION gtk_tree_view_insert_column_with_data_func ##### -->
532 <!-- ##### FUNCTION gtk_tree_view_get_column ##### -->
542 <!-- ##### FUNCTION gtk_tree_view_get_columns ##### -->
551 <!-- ##### FUNCTION gtk_tree_view_move_column_after ##### -->
561 <!-- ##### FUNCTION gtk_tree_view_set_expander_column ##### -->
570 <!-- ##### FUNCTION gtk_tree_view_get_expander_column ##### -->
579 <!-- ##### FUNCTION gtk_tree_view_set_column_drag_function ##### -->
590 <!-- ##### FUNCTION gtk_tree_view_scroll_to_point ##### -->
600 <!-- ##### FUNCTION gtk_tree_view_scroll_to_cell ##### -->
613 <!-- ##### FUNCTION gtk_tree_view_set_cursor ##### -->
624 <!-- ##### FUNCTION gtk_tree_view_set_cursor_on_cell ##### -->
636 <!-- ##### FUNCTION gtk_tree_view_get_cursor ##### -->
646 <!-- ##### FUNCTION gtk_tree_view_row_activated ##### -->
656 <!-- ##### FUNCTION gtk_tree_view_expand_all ##### -->
664 <!-- ##### FUNCTION gtk_tree_view_collapse_all ##### -->
672 <!-- ##### FUNCTION gtk_tree_view_expand_to_path ##### -->
681 <!-- ##### FUNCTION gtk_tree_view_expand_row ##### -->
692 <!-- ##### FUNCTION gtk_tree_view_collapse_row ##### -->
702 <!-- ##### FUNCTION gtk_tree_view_map_expanded_rows ##### -->
712 <!-- ##### FUNCTION gtk_tree_view_row_expanded ##### -->
722 <!-- ##### FUNCTION gtk_tree_view_set_reorderable ##### -->
731 <!-- ##### FUNCTION gtk_tree_view_get_reorderable ##### -->
740 <!-- ##### FUNCTION gtk_tree_view_get_path_at_pos ##### -->
753 <!-- # Unused Parameters # -->
757 <!-- ##### FUNCTION gtk_tree_view_get_cell_area ##### -->
768 <!-- ##### FUNCTION gtk_tree_view_get_background_area ##### -->
779 <!-- ##### FUNCTION gtk_tree_view_get_visible_rect ##### -->
788 <!-- ##### FUNCTION gtk_tree_view_get_bin_window ##### -->
797 <!-- ##### FUNCTION gtk_tree_view_widget_to_tree_coords ##### -->
809 <!-- ##### FUNCTION gtk_tree_view_tree_to_widget_coords ##### -->
821 <!-- ##### FUNCTION gtk_tree_view_enable_model_drag_dest ##### -->
832 <!-- ##### FUNCTION gtk_tree_view_enable_model_drag_source ##### -->
844 <!-- ##### FUNCTION gtk_tree_view_unset_rows_drag_source ##### -->
852 <!-- ##### FUNCTION gtk_tree_view_unset_rows_drag_dest ##### -->
860 <!-- ##### FUNCTION gtk_tree_view_set_drag_dest_row ##### -->
870 <!-- ##### FUNCTION gtk_tree_view_get_drag_dest_row ##### -->
880 <!-- ##### FUNCTION gtk_tree_view_get_dest_row_at_pos ##### -->
893 <!-- ##### FUNCTION gtk_tree_view_create_row_drag_icon ##### -->
903 <!-- ##### FUNCTION gtk_tree_view_set_enable_search ##### -->
910 <!-- # Unused Parameters # -->
914 <!-- ##### FUNCTION gtk_tree_view_get_enable_search ##### -->
923 <!-- ##### FUNCTION gtk_tree_view_get_search_column ##### -->
932 <!-- ##### FUNCTION gtk_tree_view_set_search_column ##### -->
941 <!-- ##### FUNCTION gtk_tree_view_get_search_equal_func ##### -->
950 <!-- ##### FUNCTION gtk_tree_view_set_search_equal_func ##### -->
961 <!-- ##### FUNCTION gtk_tree_view_get_fixed_height_mode ##### -->
970 <!-- ##### FUNCTION gtk_tree_view_set_fixed_height_mode ##### -->
979 <!-- ##### FUNCTION gtk_tree_view_get_hover_selection ##### -->
988 <!-- ##### FUNCTION gtk_tree_view_set_hover_selection ##### -->
997 <!-- ##### FUNCTION gtk_tree_view_get_hover_expand ##### -->
1006 <!-- ##### FUNCTION gtk_tree_view_set_hover_expand ##### -->
1015 <!-- ##### USER_FUNCTION GtkTreeDestroyCountFunc ##### -->
1026 <!-- ##### FUNCTION gtk_tree_view_set_destroy_count_func ##### -->
1037 <!-- ##### USER_FUNCTION GtkTreeViewRowSeparatorFunc ##### -->
1039 Function type for determining whether the row pointed to by @iter should
1040 be rendered as a separator. A common way to implement this is to have a
1041 boolean column in the model, whose values the #GtkTreeViewRowSeparatorFunc
1045 @model: the #GtkTreeModel
1046 @iter: a #GtkTreeIter pointing at a row in @model
1048 @Returns: %TRUE if the row is a separator
1051 <!-- ##### FUNCTION gtk_tree_view_get_row_separator_func ##### -->
1060 <!-- ##### FUNCTION gtk_tree_view_set_row_separator_func ##### -->