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.
14 Please refer to the <link linkend="TreeWidget">tree widget conceptual overview</link>
15 for an overview of all the objects and data types related to the tree widget and how
19 <!-- ##### SECTION See_Also ##### -->
21 #GtkTreeViewColumn, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable, #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable, #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle
24 <!-- ##### STRUCT GtkTreeView ##### -->
30 <!-- ##### SIGNAL GtkTreeView::columns-changed ##### -->
35 @treeview: the object which received the signal.
37 <!-- ##### SIGNAL GtkTreeView::cursor-changed ##### -->
42 @treeview: the object which received the signal.
44 <!-- ##### SIGNAL GtkTreeView::expand-collapse-cursor-row ##### -->
49 @treeview: the object which received the signal.
55 <!-- ##### SIGNAL GtkTreeView::move-cursor ##### -->
60 @treeview: the object which received the signal.
65 <!-- ##### SIGNAL GtkTreeView::row-activated ##### -->
70 @treeview: the object which received the signal.
74 <!-- ##### SIGNAL GtkTreeView::row-collapsed ##### -->
79 @treeview: the object which received the signal.
83 <!-- ##### SIGNAL GtkTreeView::row-expanded ##### -->
88 @treeview: the object which received the signal.
92 <!-- ##### SIGNAL GtkTreeView::select-all ##### -->
97 @treeview: the object which received the signal.
100 <!-- ##### SIGNAL GtkTreeView::select-cursor-parent ##### -->
105 @treeview: the object which received the signal.
108 <!-- ##### SIGNAL GtkTreeView::select-cursor-row ##### -->
113 @treeview: the object which received the signal.
117 <!-- ##### SIGNAL GtkTreeView::set-scroll-adjustments ##### -->
122 @treeview: the object which received the signal.
126 <!-- ##### SIGNAL GtkTreeView::start-interactive-search ##### -->
131 @treeview: the object which received the signal.
134 <!-- ##### SIGNAL GtkTreeView::test-collapse-row ##### -->
139 @treeview: the object which received the signal.
144 <!-- ##### SIGNAL GtkTreeView::test-expand-row ##### -->
149 @treeview: the object which received the signal.
154 <!-- ##### SIGNAL GtkTreeView::toggle-cursor-row ##### -->
159 @treeview: the object which received the signal.
162 <!-- ##### SIGNAL GtkTreeView::unselect-all ##### -->
167 @treeview: the object which received the signal.
170 <!-- ##### ARG GtkTreeView:enable-search ##### -->
175 <!-- ##### ARG GtkTreeView:expander-column ##### -->
180 <!-- ##### ARG GtkTreeView:fixed-height-mode ##### -->
185 <!-- ##### ARG GtkTreeView:hadjustment ##### -->
190 <!-- ##### ARG GtkTreeView:headers-clickable ##### -->
195 <!-- ##### ARG GtkTreeView:headers-visible ##### -->
200 <!-- ##### ARG GtkTreeView:hover-expand ##### -->
205 <!-- ##### ARG GtkTreeView:hover-selection ##### -->
210 <!-- ##### ARG GtkTreeView:model ##### -->
215 <!-- ##### ARG GtkTreeView:reorderable ##### -->
220 <!-- ##### ARG GtkTreeView:rules-hint ##### -->
225 <!-- ##### ARG GtkTreeView:search-column ##### -->
230 <!-- ##### ARG GtkTreeView:vadjustment ##### -->
235 <!-- ##### ARG GtkTreeView:allow-rules ##### -->
240 <!-- ##### ARG GtkTreeView:even-row-color ##### -->
245 <!-- ##### ARG GtkTreeView:expander-size ##### -->
250 <!-- ##### ARG GtkTreeView:horizontal-separator ##### -->
255 <!-- ##### ARG GtkTreeView:indent-expanders ##### -->
260 <!-- ##### ARG GtkTreeView:odd-row-color ##### -->
265 <!-- ##### ARG GtkTreeView:vertical-separator ##### -->
270 <!-- ##### ENUM GtkTreeViewDropPosition ##### -->
272 An enum for determining where a dropped row goes.
275 @GTK_TREE_VIEW_DROP_BEFORE:
276 @GTK_TREE_VIEW_DROP_AFTER:
277 @GTK_TREE_VIEW_DROP_INTO_OR_BEFORE:
278 @GTK_TREE_VIEW_DROP_INTO_OR_AFTER:
280 <!-- ##### STRUCT GtkTreeViewPrivate ##### -->
282 A private struct for internal use only. The definition of this
283 structure is not publically available.
287 <!-- ##### USER_FUNCTION GtkTreeViewColumnDropFunc ##### -->
289 Function type for determining whether @column can be dropped in a
290 particular spot (as determined by @prev_column and @next_column). In
291 left to right locales, @prev_column is on the left of the potential drop
292 spot, and @next_column is on the right. In right to left mode, this is
293 reversed. This function should return %TRUE if the spot is a valid drop
294 spot. Please note that returning %TRUE does not actually indicate that
295 the column drop was made, but is meant only to indicate a possible drop
299 @tree_view: A #GtkTreeView
300 @column: The #GtkTreeViewColumn being dragged
301 @prev_column: A #GtkTreeViewColumn on one side of @column
302 @next_column: A #GtkTreeViewColumn on the other side of @column
304 @Returns: %TRUE, if #column can be dropped in this spot
307 <!-- ##### USER_FUNCTION GtkTreeViewMappingFunc ##### -->
309 Function used for #gtk_tree_view_map_expanded_rows.
312 @tree_view: A #GtkTreeView
313 @path: The path that's expanded
314 @user_data: user data
317 <!-- ##### USER_FUNCTION GtkTreeViewSearchEqualFunc ##### -->
319 A function used for checking whether a row in @model matches
320 a search key string entered by the user. Note the return value
321 is reversed from what you would normally expect, though it
322 has some similarity to strcmp() returning 0 for equal strings.
325 @model: the #GtkTreeModel being searched
326 @column: the search column set by gtk_tree_view_set_search_column()
327 @key: the key string to compare with
328 @iter: a #GtkTreeIter pointing the row of @model that should be compared
330 @search_data: user data from gtk_tree_view_set_search_equal_func()
331 @Returns: %FALSE if the row matches, %TRUE otherwise.
334 <!-- ##### FUNCTION gtk_tree_view_new ##### -->
342 <!-- ##### FUNCTION gtk_tree_view_new_with_model ##### -->
351 <!-- ##### FUNCTION gtk_tree_view_get_model ##### -->
360 <!-- ##### FUNCTION gtk_tree_view_set_model ##### -->
367 <!-- # Unused Parameters # -->
371 <!-- ##### FUNCTION gtk_tree_view_get_selection ##### -->
380 <!-- ##### FUNCTION gtk_tree_view_get_hadjustment ##### -->
387 <!-- # Unused Parameters # -->
391 <!-- ##### FUNCTION gtk_tree_view_set_hadjustment ##### -->
398 <!-- # Unused Parameters # -->
402 <!-- ##### FUNCTION gtk_tree_view_get_vadjustment ##### -->
409 <!-- # Unused Parameters # -->
413 <!-- ##### FUNCTION gtk_tree_view_set_vadjustment ##### -->
420 <!-- # Unused Parameters # -->
424 <!-- ##### FUNCTION gtk_tree_view_get_headers_visible ##### -->
433 <!-- ##### FUNCTION gtk_tree_view_set_headers_visible ##### -->
442 <!-- ##### FUNCTION gtk_tree_view_columns_autosize ##### -->
450 <!-- ##### FUNCTION gtk_tree_view_set_headers_clickable ##### -->
457 <!-- # Unused Parameters # -->
461 <!-- ##### FUNCTION gtk_tree_view_set_rules_hint ##### -->
470 <!-- ##### FUNCTION gtk_tree_view_get_rules_hint ##### -->
479 <!-- ##### FUNCTION gtk_tree_view_append_column ##### -->
489 <!-- ##### FUNCTION gtk_tree_view_remove_column ##### -->
499 <!-- ##### FUNCTION gtk_tree_view_insert_column ##### -->
510 <!-- ##### FUNCTION gtk_tree_view_insert_column_with_attributes ##### -->
523 <!-- ##### FUNCTION gtk_tree_view_insert_column_with_data_func ##### -->
538 <!-- ##### FUNCTION gtk_tree_view_get_column ##### -->
548 <!-- ##### FUNCTION gtk_tree_view_get_columns ##### -->
557 <!-- ##### FUNCTION gtk_tree_view_move_column_after ##### -->
567 <!-- ##### FUNCTION gtk_tree_view_set_expander_column ##### -->
576 <!-- ##### FUNCTION gtk_tree_view_get_expander_column ##### -->
585 <!-- ##### FUNCTION gtk_tree_view_set_column_drag_function ##### -->
596 <!-- ##### FUNCTION gtk_tree_view_scroll_to_point ##### -->
606 <!-- ##### FUNCTION gtk_tree_view_scroll_to_cell ##### -->
619 <!-- ##### FUNCTION gtk_tree_view_set_cursor ##### -->
630 <!-- ##### FUNCTION gtk_tree_view_set_cursor_on_cell ##### -->
642 <!-- ##### FUNCTION gtk_tree_view_get_cursor ##### -->
652 <!-- ##### FUNCTION gtk_tree_view_row_activated ##### -->
662 <!-- ##### FUNCTION gtk_tree_view_expand_all ##### -->
670 <!-- ##### FUNCTION gtk_tree_view_collapse_all ##### -->
678 <!-- ##### FUNCTION gtk_tree_view_expand_to_path ##### -->
687 <!-- ##### FUNCTION gtk_tree_view_expand_row ##### -->
698 <!-- ##### FUNCTION gtk_tree_view_collapse_row ##### -->
708 <!-- ##### FUNCTION gtk_tree_view_map_expanded_rows ##### -->
718 <!-- ##### FUNCTION gtk_tree_view_row_expanded ##### -->
728 <!-- ##### FUNCTION gtk_tree_view_set_reorderable ##### -->
737 <!-- ##### FUNCTION gtk_tree_view_get_reorderable ##### -->
746 <!-- ##### FUNCTION gtk_tree_view_get_path_at_pos ##### -->
759 <!-- # Unused Parameters # -->
763 <!-- ##### FUNCTION gtk_tree_view_get_cell_area ##### -->
774 <!-- ##### FUNCTION gtk_tree_view_get_background_area ##### -->
785 <!-- ##### FUNCTION gtk_tree_view_get_visible_rect ##### -->
794 <!-- ##### FUNCTION gtk_tree_view_get_bin_window ##### -->
803 <!-- ##### FUNCTION gtk_tree_view_widget_to_tree_coords ##### -->
815 <!-- ##### FUNCTION gtk_tree_view_tree_to_widget_coords ##### -->
827 <!-- ##### FUNCTION gtk_tree_view_enable_model_drag_dest ##### -->
838 <!-- ##### FUNCTION gtk_tree_view_enable_model_drag_source ##### -->
850 <!-- ##### FUNCTION gtk_tree_view_unset_rows_drag_source ##### -->
858 <!-- ##### FUNCTION gtk_tree_view_unset_rows_drag_dest ##### -->
866 <!-- ##### FUNCTION gtk_tree_view_set_drag_dest_row ##### -->
876 <!-- ##### FUNCTION gtk_tree_view_get_drag_dest_row ##### -->
886 <!-- ##### FUNCTION gtk_tree_view_get_dest_row_at_pos ##### -->
899 <!-- ##### FUNCTION gtk_tree_view_create_row_drag_icon ##### -->
909 <!-- ##### FUNCTION gtk_tree_view_set_enable_search ##### -->
916 <!-- # Unused Parameters # -->
920 <!-- ##### FUNCTION gtk_tree_view_get_enable_search ##### -->
929 <!-- ##### FUNCTION gtk_tree_view_get_search_column ##### -->
938 <!-- ##### FUNCTION gtk_tree_view_set_search_column ##### -->
947 <!-- ##### FUNCTION gtk_tree_view_get_search_equal_func ##### -->
956 <!-- ##### FUNCTION gtk_tree_view_set_search_equal_func ##### -->
967 <!-- ##### FUNCTION gtk_tree_view_get_fixed_height_mode ##### -->
976 <!-- ##### FUNCTION gtk_tree_view_set_fixed_height_mode ##### -->
985 <!-- ##### FUNCTION gtk_tree_view_get_hover_selection ##### -->
994 <!-- ##### FUNCTION gtk_tree_view_set_hover_selection ##### -->
1003 <!-- ##### FUNCTION gtk_tree_view_get_hover_expand ##### -->
1012 <!-- ##### FUNCTION gtk_tree_view_set_hover_expand ##### -->
1021 <!-- ##### USER_FUNCTION GtkTreeDestroyCountFunc ##### -->
1032 <!-- ##### FUNCTION gtk_tree_view_set_destroy_count_func ##### -->
1043 <!-- ##### USER_FUNCTION GtkTreeViewRowSeparatorFunc ##### -->
1045 Function type for determining whether the row pointed to by @iter should
1046 be rendered as a separator. A common way to implement this is to have a
1047 boolean column in the model, whose values the #GtkTreeViewRowSeparatorFunc
1051 @model: the #GtkTreeModel
1052 @iter: a #GtkTreeIter pointing at a row in @model
1054 @Returns: %TRUE if the row is a separator
1057 <!-- ##### FUNCTION gtk_tree_view_get_row_separator_func ##### -->
1066 <!-- ##### FUNCTION gtk_tree_view_set_row_separator_func ##### -->