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-selection ##### -->
199 <!-- ##### ARG GtkTreeView:model ##### -->
204 <!-- ##### ARG GtkTreeView:reorderable ##### -->
209 <!-- ##### ARG GtkTreeView:rules-hint ##### -->
214 <!-- ##### ARG GtkTreeView:search-column ##### -->
219 <!-- ##### ARG GtkTreeView:vadjustment ##### -->
224 <!-- ##### ARG GtkTreeView:allow-rules ##### -->
229 <!-- ##### ARG GtkTreeView:even-row-color ##### -->
234 <!-- ##### ARG GtkTreeView:expander-size ##### -->
239 <!-- ##### ARG GtkTreeView:horizontal-separator ##### -->
244 <!-- ##### ARG GtkTreeView:indent-expanders ##### -->
249 <!-- ##### ARG GtkTreeView:odd-row-color ##### -->
254 <!-- ##### ARG GtkTreeView:vertical-separator ##### -->
259 <!-- ##### ENUM GtkTreeViewDropPosition ##### -->
261 An enum for determining where a dropped row goes.
264 @GTK_TREE_VIEW_DROP_BEFORE:
265 @GTK_TREE_VIEW_DROP_AFTER:
266 @GTK_TREE_VIEW_DROP_INTO_OR_BEFORE:
267 @GTK_TREE_VIEW_DROP_INTO_OR_AFTER:
269 <!-- ##### STRUCT GtkTreeViewPrivate ##### -->
271 A private struct for internal use only. The definition of this
272 structure is not publically available.
276 <!-- ##### USER_FUNCTION GtkTreeViewColumnDropFunc ##### -->
278 Function type for determining whether @column can be dropped in a
279 particular spot (as determined by @prev_column and @next_column). In
280 left to right locales, @prev_column is on the left of the potential drop
281 spot, and @next_column is on the right. In right to left mode, this is
282 reversed. This function should return %TRUE if the spot is a valid drop
283 spot. Please note that returning %TRUE does not actually indicate that
284 the column drop was made, but is meant only to indicate a possible drop
288 @tree_view: A #GtkTreeView
289 @column: The #GtkTreeViewColumn being dragged
290 @prev_column: A #GtkTreeViewColumn on one side of @column
291 @next_column: A #GtkTreeViewColumn on the other side of @column
293 @Returns: %TRUE, if #column can be dropped in this spot
296 <!-- ##### USER_FUNCTION GtkTreeViewMappingFunc ##### -->
298 Function used for #gtk_tree_view_map_expanded_rows.
301 @tree_view: A #GtkTreeView
302 @path: The path that's expanded
303 @user_data: user data
306 <!-- ##### USER_FUNCTION GtkTreeViewSearchEqualFunc ##### -->
308 A function used for checking whether a row in @model matches
309 a search key string entered by the user. Note the return value
310 is reversed from what you would normally expect, though it
311 has some similarity to strcmp() returning 0 for equal strings.
314 @model: the #GtkTreeModel being searched
315 @column: the search column set by gtk_tree_view_set_search_column()
316 @key: the key string to compare with
317 @iter: a #GtkTreeIter pointing the row of @model that should be compared
319 @search_data: user data from gtk_tree_view_set_search_equal_func()
320 @Returns: %FALSE if the row matches, %TRUE otherwise.
323 <!-- ##### FUNCTION gtk_tree_view_new ##### -->
331 <!-- ##### FUNCTION gtk_tree_view_new_with_model ##### -->
340 <!-- ##### FUNCTION gtk_tree_view_get_model ##### -->
349 <!-- ##### FUNCTION gtk_tree_view_set_model ##### -->
356 <!-- # Unused Parameters # -->
360 <!-- ##### FUNCTION gtk_tree_view_get_selection ##### -->
369 <!-- ##### FUNCTION gtk_tree_view_get_hadjustment ##### -->
376 <!-- # Unused Parameters # -->
380 <!-- ##### FUNCTION gtk_tree_view_set_hadjustment ##### -->
387 <!-- # Unused Parameters # -->
391 <!-- ##### FUNCTION gtk_tree_view_get_vadjustment ##### -->
398 <!-- # Unused Parameters # -->
402 <!-- ##### FUNCTION gtk_tree_view_set_vadjustment ##### -->
409 <!-- # Unused Parameters # -->
413 <!-- ##### FUNCTION gtk_tree_view_get_headers_visible ##### -->
422 <!-- ##### FUNCTION gtk_tree_view_set_headers_visible ##### -->
431 <!-- ##### FUNCTION gtk_tree_view_columns_autosize ##### -->
439 <!-- ##### FUNCTION gtk_tree_view_set_headers_clickable ##### -->
446 <!-- # Unused Parameters # -->
450 <!-- ##### FUNCTION gtk_tree_view_set_rules_hint ##### -->
459 <!-- ##### FUNCTION gtk_tree_view_get_rules_hint ##### -->
468 <!-- ##### FUNCTION gtk_tree_view_append_column ##### -->
478 <!-- ##### FUNCTION gtk_tree_view_remove_column ##### -->
488 <!-- ##### FUNCTION gtk_tree_view_insert_column ##### -->
499 <!-- ##### FUNCTION gtk_tree_view_insert_column_with_attributes ##### -->
512 <!-- ##### FUNCTION gtk_tree_view_insert_column_with_data_func ##### -->
527 <!-- ##### FUNCTION gtk_tree_view_get_column ##### -->
537 <!-- ##### FUNCTION gtk_tree_view_get_columns ##### -->
546 <!-- ##### FUNCTION gtk_tree_view_move_column_after ##### -->
556 <!-- ##### FUNCTION gtk_tree_view_set_expander_column ##### -->
565 <!-- ##### FUNCTION gtk_tree_view_get_expander_column ##### -->
574 <!-- ##### FUNCTION gtk_tree_view_set_column_drag_function ##### -->
585 <!-- ##### FUNCTION gtk_tree_view_scroll_to_point ##### -->
595 <!-- ##### FUNCTION gtk_tree_view_scroll_to_cell ##### -->
608 <!-- ##### FUNCTION gtk_tree_view_set_cursor ##### -->
619 <!-- ##### FUNCTION gtk_tree_view_set_cursor_on_cell ##### -->
631 <!-- ##### FUNCTION gtk_tree_view_get_cursor ##### -->
641 <!-- ##### FUNCTION gtk_tree_view_row_activated ##### -->
651 <!-- ##### FUNCTION gtk_tree_view_expand_all ##### -->
659 <!-- ##### FUNCTION gtk_tree_view_collapse_all ##### -->
667 <!-- ##### FUNCTION gtk_tree_view_expand_to_path ##### -->
676 <!-- ##### FUNCTION gtk_tree_view_expand_row ##### -->
687 <!-- ##### FUNCTION gtk_tree_view_collapse_row ##### -->
697 <!-- ##### FUNCTION gtk_tree_view_map_expanded_rows ##### -->
707 <!-- ##### FUNCTION gtk_tree_view_row_expanded ##### -->
717 <!-- ##### FUNCTION gtk_tree_view_set_reorderable ##### -->
726 <!-- ##### FUNCTION gtk_tree_view_get_reorderable ##### -->
735 <!-- ##### FUNCTION gtk_tree_view_get_path_at_pos ##### -->
748 <!-- # Unused Parameters # -->
752 <!-- ##### FUNCTION gtk_tree_view_get_cell_area ##### -->
763 <!-- ##### FUNCTION gtk_tree_view_get_background_area ##### -->
774 <!-- ##### FUNCTION gtk_tree_view_get_visible_rect ##### -->
783 <!-- ##### FUNCTION gtk_tree_view_get_bin_window ##### -->
792 <!-- ##### FUNCTION gtk_tree_view_widget_to_tree_coords ##### -->
804 <!-- ##### FUNCTION gtk_tree_view_tree_to_widget_coords ##### -->
816 <!-- ##### FUNCTION gtk_tree_view_enable_model_drag_dest ##### -->
827 <!-- ##### FUNCTION gtk_tree_view_enable_model_drag_source ##### -->
839 <!-- ##### FUNCTION gtk_tree_view_unset_rows_drag_source ##### -->
847 <!-- ##### FUNCTION gtk_tree_view_unset_rows_drag_dest ##### -->
855 <!-- ##### FUNCTION gtk_tree_view_set_drag_dest_row ##### -->
865 <!-- ##### FUNCTION gtk_tree_view_get_drag_dest_row ##### -->
875 <!-- ##### FUNCTION gtk_tree_view_get_dest_row_at_pos ##### -->
888 <!-- ##### FUNCTION gtk_tree_view_create_row_drag_icon ##### -->
898 <!-- ##### FUNCTION gtk_tree_view_set_enable_search ##### -->
905 <!-- # Unused Parameters # -->
909 <!-- ##### FUNCTION gtk_tree_view_get_enable_search ##### -->
918 <!-- ##### FUNCTION gtk_tree_view_get_search_column ##### -->
927 <!-- ##### FUNCTION gtk_tree_view_set_search_column ##### -->
936 <!-- ##### FUNCTION gtk_tree_view_get_search_equal_func ##### -->
945 <!-- ##### FUNCTION gtk_tree_view_set_search_equal_func ##### -->
956 <!-- ##### FUNCTION gtk_tree_view_get_fixed_height_mode ##### -->
965 <!-- ##### FUNCTION gtk_tree_view_set_fixed_height_mode ##### -->
974 <!-- ##### FUNCTION gtk_tree_view_get_hover_selection ##### -->
983 <!-- ##### FUNCTION gtk_tree_view_set_hover_selection ##### -->
992 <!-- ##### USER_FUNCTION GtkTreeDestroyCountFunc ##### -->
1003 <!-- ##### FUNCTION gtk_tree_view_set_destroy_count_func ##### -->
1014 <!-- ##### USER_FUNCTION GtkTreeViewRowSeparatorFunc ##### -->
1016 Function type for determining whether the row pointed to by @iter should
1017 be rendered as a separator. A common way to implement this is to have a
1018 boolean column in the model, whose values the #GtkTreeViewRowSeparatorFunc
1022 @model: the #GtkTreeModel
1023 @iter: a #GtkTreeIter pointing at a row in @model
1025 @Returns: %TRUE if the row is a separator
1028 <!-- ##### FUNCTION gtk_tree_view_get_row_separator_func ##### -->
1037 <!-- ##### FUNCTION gtk_tree_view_set_row_separator_func ##### -->