AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity
546e045ccf
gtk2/docs/reference/gtk/tmpl/gtktreeview.sgml
Matthias Clasen 58a1af804c 2.7.0
2005-06-20 22:06:27 +00:00

1080 lines
15 KiB
Plaintext
Raw Blame History

<!-- ##### SECTION Title ##### -->
GtkTreeView
<!-- ##### SECTION Short_Description ##### -->
A widget for displaying both trees and lists
<!-- ##### SECTION Long_Description ##### -->
<para>
Widget that displays any object that implements the <link
linkend="GtkTreeModel">GtkTreeModel</link> interface.
</para>
<para>
Please refer to the <link linkend="TreeWidget">tree widget conceptual overview</link>
for an overview of all the objects and data types related to the tree widget and how
they work together.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GtkTreeViewColumn, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable, #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable, #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GtkTreeView ##### -->
<para>
</para>
<!-- ##### SIGNAL GtkTreeView::columns-changed ##### -->
<para>
</para>
@treeview: the object which received the signal.
<!-- ##### SIGNAL GtkTreeView::cursor-changed ##### -->
<para>
</para>
@treeview: the object which received the signal.
<!-- ##### SIGNAL GtkTreeView::expand-collapse-cursor-row ##### -->
<para>
</para>
@treeview: the object which received the signal.
@arg1:
@arg2:
@arg3:
@Returns:
<!-- ##### SIGNAL GtkTreeView::move-cursor ##### -->
<para>
</para>
@treeview: the object which received the signal.
@arg1:
@arg2:
@Returns:
<!-- ##### SIGNAL GtkTreeView::row-activated ##### -->
<para>
</para>
@treeview: the object which received the signal.
@arg1:
@arg2:
<!-- ##### SIGNAL GtkTreeView::row-collapsed ##### -->
<para>
</para>
@treeview: the object which received the signal.
@arg1:
@arg2:
<!-- ##### SIGNAL GtkTreeView::row-expanded ##### -->
<para>
</para>
@treeview: the object which received the signal.
@arg1:
@arg2:
<!-- ##### SIGNAL GtkTreeView::select-all ##### -->
<para>
</para>
@treeview: the object which received the signal.
@Returns:
<!-- ##### SIGNAL GtkTreeView::select-cursor-parent ##### -->
<para>
</para>
@treeview: the object which received the signal.
@Returns:
<!-- ##### SIGNAL GtkTreeView::select-cursor-row ##### -->
<para>
</para>
@treeview: the object which received the signal.
@arg1:
@Returns:
<!-- ##### SIGNAL GtkTreeView::set-scroll-adjustments ##### -->
<para>
</para>
@treeview: the object which received the signal.
@arg1:
@arg2:
<!-- ##### SIGNAL GtkTreeView::start-interactive-search ##### -->
<para>
</para>
@treeview: the object which received the signal.
@Returns:
<!-- ##### SIGNAL GtkTreeView::test-collapse-row ##### -->
<para>
</para>
@treeview: the object which received the signal.
@arg1:
@arg2:
@Returns:
<!-- ##### SIGNAL GtkTreeView::test-expand-row ##### -->
<para>
</para>
@treeview: the object which received the signal.
@arg1:
@arg2:
@Returns:
<!-- ##### SIGNAL GtkTreeView::toggle-cursor-row ##### -->
<para>
</para>
@treeview: the object which received the signal.
@Returns:
<!-- ##### SIGNAL GtkTreeView::unselect-all ##### -->
<para>
</para>
@treeview: the object which received the signal.
@Returns:
<!-- ##### ARG GtkTreeView:enable-search ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:expander-column ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:fixed-height-mode ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:hadjustment ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:headers-clickable ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:headers-visible ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:hover-expand ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:hover-selection ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:model ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:reorderable ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:rules-hint ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:search-column ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:vadjustment ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:allow-rules ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:even-row-color ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:expander-size ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:horizontal-separator ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:indent-expanders ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:odd-row-color ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:vertical-separator ##### -->
<para>
</para>
<!-- ##### ENUM GtkTreeViewDropPosition ##### -->
<para>
An enum for determining where a dropped row goes.
</para>
@GTK_TREE_VIEW_DROP_BEFORE:
@GTK_TREE_VIEW_DROP_AFTER:
@GTK_TREE_VIEW_DROP_INTO_OR_BEFORE:
@GTK_TREE_VIEW_DROP_INTO_OR_AFTER:
<!-- ##### STRUCT GtkTreeViewPrivate ##### -->
<para>
A private struct for internal use only. The definition of this
structure is not publically available.
</para>
<!-- ##### USER_FUNCTION GtkTreeViewColumnDropFunc ##### -->
<para>
Function type for determining whether @column can be dropped in a
particular spot (as determined by @prev_column and @next_column). In
left to right locales, @prev_column is on the left of the potential drop
spot, and @next_column is on the right. In right to left mode, this is
reversed. This function should return %TRUE if the spot is a valid drop
spot. Please note that returning %TRUE does not actually indicate that
the column drop was made, but is meant only to indicate a possible drop
spot to the user.
</para>
@tree_view: A #GtkTreeView
@column: The #GtkTreeViewColumn being dragged
@prev_column: A #GtkTreeViewColumn on one side of @column
@next_column: A #GtkTreeViewColumn on the other side of @column
@data: user data
@Returns: %TRUE, if #column can be dropped in this spot
<!-- ##### USER_FUNCTION GtkTreeViewMappingFunc ##### -->
<para>
Function used for #gtk_tree_view_map_expanded_rows.
</para>
@tree_view: A #GtkTreeView
@path: The path that's expanded
@user_data: user data
<!-- ##### USER_FUNCTION GtkTreeViewSearchEqualFunc ##### -->
<para>
A function used for checking whether a row in @model matches
a search key string entered by the user. Note the return value
is reversed from what you would normally expect, though it
has some similarity to strcmp() returning 0 for equal strings.
</para>
@model: the #GtkTreeModel being searched
@column: the search column set by gtk_tree_view_set_search_column()
@key: the key string to compare with
@iter: a #GtkTreeIter pointing the row of @model that should be compared
with @key.
@search_data: user data from gtk_tree_view_set_search_equal_func()
@Returns: %FALSE if the row matches, %TRUE otherwise.
<!-- ##### FUNCTION gtk_tree_view_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gtk_tree_view_new_with_model ##### -->
<para>
</para>
@model:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_get_model ##### -->
<para>
</para>
@tree_view:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_set_model ##### -->
<para>
</para>
@tree_view:
@model:
<!-- # Unused Parameters # -->
@tree_model:
<!-- ##### FUNCTION gtk_tree_view_get_selection ##### -->
<para>
</para>
@tree_view:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_get_hadjustment ##### -->
<para>
</para>
@tree_view:
@Returns:
<!-- # Unused Parameters # -->
@layout:
<!-- ##### FUNCTION gtk_tree_view_set_hadjustment ##### -->
<para>
</para>
@tree_view:
@adjustment:
<!-- # Unused Parameters # -->
@layout:
<!-- ##### FUNCTION gtk_tree_view_get_vadjustment ##### -->
<para>
</para>
@tree_view:
@Returns:
<!-- # Unused Parameters # -->
@layout:
<!-- ##### FUNCTION gtk_tree_view_set_vadjustment ##### -->
<para>
</para>
@tree_view:
@adjustment:
<!-- # Unused Parameters # -->
@layout:
<!-- ##### FUNCTION gtk_tree_view_get_headers_visible ##### -->
<para>
</para>
@tree_view:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_set_headers_visible ##### -->
<para>
</para>
@tree_view:
@headers_visible:
<!-- ##### FUNCTION gtk_tree_view_columns_autosize ##### -->
<para>
</para>
@tree_view:
<!-- ##### FUNCTION gtk_tree_view_set_headers_clickable ##### -->
<para>
</para>
@tree_view:
@setting:
<!-- # Unused Parameters # -->
@active:
<!-- ##### FUNCTION gtk_tree_view_set_rules_hint ##### -->
<para>
</para>
@tree_view:
@setting:
<!-- ##### FUNCTION gtk_tree_view_get_rules_hint ##### -->
<para>
</para>
@tree_view:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_append_column ##### -->
<para>
</para>
@tree_view:
@column:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_remove_column ##### -->
<para>
</para>
@tree_view:
@column:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_insert_column ##### -->
<para>
</para>
@tree_view:
@column:
@position:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_insert_column_with_attributes ##### -->
<para>
</para>
@tree_view:
@position:
@title:
@cell:
@Varargs:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_insert_column_with_data_func ##### -->
<para>
</para>
@tree_view:
@position:
@title:
@cell:
@func:
@data:
@dnotify:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_get_column ##### -->
<para>
</para>
@tree_view:
@n:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_get_columns ##### -->
<para>
</para>
@tree_view:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_move_column_after ##### -->
<para>
</para>
@tree_view:
@column:
@base_column:
<!-- ##### FUNCTION gtk_tree_view_set_expander_column ##### -->
<para>
</para>
@tree_view:
@column:
<!-- ##### FUNCTION gtk_tree_view_get_expander_column ##### -->
<para>
</para>
@tree_view:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_set_column_drag_function ##### -->
<para>
</para>
@tree_view:
@func:
@user_data:
@destroy:
<!-- ##### FUNCTION gtk_tree_view_scroll_to_point ##### -->
<para>
</para>
@tree_view:
@tree_x:
@tree_y:
<!-- ##### FUNCTION gtk_tree_view_scroll_to_cell ##### -->
<para>
</para>
@tree_view:
@path:
@column:
@use_align:
@row_align:
@col_align:
<!-- ##### FUNCTION gtk_tree_view_set_cursor ##### -->
<para>
</para>
@tree_view:
@path:
@focus_column:
@start_editing:
<!-- ##### FUNCTION gtk_tree_view_set_cursor_on_cell ##### -->
<para>
</para>
@tree_view:
@path:
@focus_column:
@focus_cell:
@start_editing:
<!-- ##### FUNCTION gtk_tree_view_get_cursor ##### -->
<para>
</para>
@tree_view:
@path:
@focus_column:
<!-- ##### FUNCTION gtk_tree_view_row_activated ##### -->
<para>
</para>
@tree_view:
@path:
@column:
<!-- ##### FUNCTION gtk_tree_view_expand_all ##### -->
<para>
</para>
@tree_view:
<!-- ##### FUNCTION gtk_tree_view_collapse_all ##### -->
<para>
</para>
@tree_view:
<!-- ##### FUNCTION gtk_tree_view_expand_to_path ##### -->
<para>
</para>
@tree_view:
@path:
<!-- ##### FUNCTION gtk_tree_view_expand_row ##### -->
<para>
</para>
@tree_view:
@path:
@open_all:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_collapse_row ##### -->
<para>
</para>
@tree_view:
@path:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_map_expanded_rows ##### -->
<para>
</para>
@tree_view:
@func:
@data:
<!-- ##### FUNCTION gtk_tree_view_row_expanded ##### -->
<para>
</para>
@tree_view:
@path:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_set_reorderable ##### -->
<para>
</para>
@tree_view:
@reorderable:
<!-- ##### FUNCTION gtk_tree_view_get_reorderable ##### -->
<para>
</para>
@tree_view:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_get_path_at_pos ##### -->
<para>
</para>
@tree_view:
@x:
@y:
@path:
@column:
@cell_x:
@cell_y:
@Returns:
<!-- # Unused Parameters # -->
@window:
<!-- ##### FUNCTION gtk_tree_view_get_cell_area ##### -->
<para>
</para>
@tree_view:
@path:
@column:
@rect:
<!-- ##### FUNCTION gtk_tree_view_get_background_area ##### -->
<para>
</para>
@tree_view:
@path:
@column:
@rect:
<!-- ##### FUNCTION gtk_tree_view_get_visible_rect ##### -->
<para>
</para>
@tree_view:
@visible_rect:
<!-- ##### FUNCTION gtk_tree_view_get_bin_window ##### -->
<para>
</para>
@tree_view:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_widget_to_tree_coords ##### -->
<para>
</para>
@tree_view:
@wx:
@wy:
@tx:
@ty:
<!-- ##### FUNCTION gtk_tree_view_tree_to_widget_coords ##### -->
<para>
</para>
@tree_view:
@tx:
@ty:
@wx:
@wy:
<!-- ##### FUNCTION gtk_tree_view_enable_model_drag_dest ##### -->
<para>
</para>
@tree_view:
@targets:
@n_targets:
@actions:
<!-- ##### FUNCTION gtk_tree_view_enable_model_drag_source ##### -->
<para>
</para>
@tree_view:
@start_button_mask:
@targets:
@n_targets:
@actions:
<!-- ##### FUNCTION gtk_tree_view_unset_rows_drag_source ##### -->
<para>
</para>
@tree_view:
<!-- ##### FUNCTION gtk_tree_view_unset_rows_drag_dest ##### -->
<para>
</para>
@tree_view:
<!-- ##### FUNCTION gtk_tree_view_set_drag_dest_row ##### -->
<para>
</para>
@tree_view:
@path:
@pos:
<!-- ##### FUNCTION gtk_tree_view_get_drag_dest_row ##### -->
<para>
</para>
@tree_view:
@path:
@pos:
<!-- ##### FUNCTION gtk_tree_view_get_dest_row_at_pos ##### -->
<para>
</para>
@tree_view:
@drag_x:
@drag_y:
@path:
@pos:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_create_row_drag_icon ##### -->
<para>
</para>
@tree_view:
@path:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_set_enable_search ##### -->
<para>
</para>
@tree_view:
@enable_search:
<!-- # Unused Parameters # -->
@use_search:
<!-- ##### FUNCTION gtk_tree_view_get_enable_search ##### -->
<para>
</para>
@tree_view:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_get_search_column ##### -->
<para>
</para>
@tree_view:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_set_search_column ##### -->
<para>
</para>
@tree_view:
@column:
<!-- ##### FUNCTION gtk_tree_view_get_search_equal_func ##### -->
<para>
</para>
@tree_view:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_set_search_equal_func ##### -->
<para>
</para>
@tree_view:
@search_equal_func:
@search_user_data:
@search_destroy:
<!-- ##### FUNCTION gtk_tree_view_get_fixed_height_mode ##### -->
<para>
</para>
@tree_view:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_set_fixed_height_mode ##### -->
<para>
</para>
@tree_view:
@enable:
<!-- ##### FUNCTION gtk_tree_view_get_hover_selection ##### -->
<para>
</para>
@tree_view:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_set_hover_selection ##### -->
<para>
</para>
@tree_view:
@hover:
<!-- ##### FUNCTION gtk_tree_view_get_hover_expand ##### -->
<para>
</para>
@tree_view:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_set_hover_expand ##### -->
<para>
</para>
@tree_view:
@expand:
<!-- ##### USER_FUNCTION GtkTreeDestroyCountFunc ##### -->
<para>
</para>
@tree_view:
@path:
@children:
@user_data:
<!-- ##### FUNCTION gtk_tree_view_set_destroy_count_func ##### -->
<para>
</para>
@tree_view:
@func:
@data:
@destroy:
<!-- ##### USER_FUNCTION GtkTreeViewRowSeparatorFunc ##### -->
<para>
Function type for determining whether the row pointed to by @iter should
be rendered as a separator. A common way to implement this is to have a
boolean column in the model, whose values the #GtkTreeViewRowSeparatorFunc
returns.
</para>
@model: the #GtkTreeModel
@iter: a #GtkTreeIter pointing at a row in @model
@data: user data
@Returns: %TRUE if the row is a separator
<!-- ##### FUNCTION gtk_tree_view_get_row_separator_func ##### -->
<para>
</para>
@tree_view:
@Returns:
<!-- ##### FUNCTION gtk_tree_view_set_row_separator_func ##### -->
<para>
</para>
@tree_view:
@func:
@data:
@destroy:
Reference in New Issue View Git Blame Copy Permalink