gtk2/docs/reference/gtk/tmpl/gtktreeview.sgml
Owen Taylor 11aed263b7 Set the width of the layout to the actual wrap width (our requisition) not
Tue May 14 16:44:09 2002  Owen Taylor  <otaylor@redhat.com>

        * gtk/gtklabel.c (gtk_label_ensure_layout): Set
        the width of the layout to the actual wrap width
        (our requisition) not the width we set when calculating
        the width. This results in the lines being justified
        within the correct area. (#79157, Anders Carlsson)

        * gtk/gtkaccelgroup.c gtk/gtkmarshelers.list: Corrected
        registered parameter types of "accel_activate" and
        "accel_changed" signals. (Patch from Murray Cumming, #78798)

        * gtk/gtkrc.c (gtk_rc_make_default_dir): Switch
        binary-version and type to correspond to the
        current ordering in _gtk_get_module_path.
        (#78746, Sergey Kuzminov)

        * gtk/gtkrc.c (gtk_rc_get_module_dir): Add docs
        pointing to the GTK_PATH documentation.

        * gtk/Makefile.am (uninstall-local): Delete
        key themes as well. (#81286, Kristian Rietveld.)
2002-05-14 20:55:22 +00:00

929 lines
13 KiB
Plaintext

<!-- ##### 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>
<!-- ##### SECTION See_Also ##### -->
<para>
#GtkTreeViewColumn, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable, #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable, #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle
</para>
<!-- ##### STRUCT GtkTreeView ##### -->
<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>
</para>
@model:
@column:
@key:
@iter:
@search_data:
@Returns:
<!-- ##### 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_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_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:
<!-- # Unused Parameters # -->
@search_compare_func:
@search_data:
<!-- ##### 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:
<!-- ##### 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:
<!-- ##### 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.
<!-- ##### SIGNAL GtkTreeView::select-cursor-parent ##### -->
<para>
</para>
@treeview: the object which received the signal.
<!-- ##### SIGNAL GtkTreeView::select-cursor-row ##### -->
<para>
</para>
@treeview: the object which received the signal.
@arg1:
<!-- ##### 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.
<!-- ##### 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.
<!-- ##### SIGNAL GtkTreeView::unselect-all ##### -->
<para>
</para>
@treeview: the object which received the signal.
<!-- ##### ARG GtkTreeView:model ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:hadjustment ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:vadjustment ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:headers-visible ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:headers-clickable ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:expander-column ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:reorderable ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:rules-hint ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:enable-search ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:search-column ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:expander-size ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:vertical-separator ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:allow-rules ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:horizontal-separator ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:indent-expanders ##### -->
<para>
</para>