2000-10-30 23:21:38 +00:00
|
|
|
<!-- ##### SECTION Title ##### -->
|
2001-09-08 18:23:47 +00:00
|
|
|
GtkTreeModel
|
2000-10-30 23:21:38 +00:00
|
|
|
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
2001-09-08 18:23:47 +00:00
|
|
|
The tree interface used by #GtkTreeView
|
2000-10-30 23:21:38 +00:00
|
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
|
|
<para>
|
2001-09-08 18:23:47 +00:00
|
|
|
#GtkTreeView, #GtkTreeStore, #GtkListStore
|
2000-10-30 23:21:38 +00:00
|
|
|
</para>
|
|
|
|
|
2001-11-15 22:20:18 +00:00
|
|
|
<!-- ##### STRUCT GtkTreeModel ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
2000-10-30 23:21:38 +00:00
|
|
|
<!-- ##### STRUCT GtkTreeIter ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@stamp:
|
2001-01-09 16:41:17 +00:00
|
|
|
@user_data:
|
|
|
|
@user_data2:
|
|
|
|
@user_data3:
|
2000-10-30 23:21:38 +00:00
|
|
|
|
|
|
|
<!-- ##### STRUCT GtkTreePath ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
2001-10-03 04:44:13 +00:00
|
|
|
<!-- ##### STRUCT GtkTreeRowReference ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
2000-10-30 23:21:38 +00:00
|
|
|
<!-- ##### STRUCT GtkTreeModelIface ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@g_iface:
|
2001-09-12 23:16:18 +00:00
|
|
|
@row_changed:
|
|
|
|
@row_inserted:
|
|
|
|
@row_has_child_toggled:
|
|
|
|
@row_deleted:
|
|
|
|
@rows_reordered:
|
2000-11-14 16:36:20 +00:00
|
|
|
@get_flags:
|
2000-10-30 23:21:38 +00:00
|
|
|
@get_n_columns:
|
|
|
|
@get_column_type:
|
|
|
|
@get_iter:
|
|
|
|
@get_path:
|
|
|
|
@get_value:
|
|
|
|
@iter_next:
|
|
|
|
@iter_children:
|
|
|
|
@iter_has_child:
|
|
|
|
@iter_n_children:
|
|
|
|
@iter_nth_child:
|
|
|
|
@iter_parent:
|
2001-03-09 14:49:00 +00:00
|
|
|
@ref_node:
|
|
|
|
@unref_node:
|
2000-11-14 16:36:20 +00:00
|
|
|
|
2001-10-03 04:44:13 +00:00
|
|
|
<!-- ##### USER_FUNCTION GtkTreeModelForeachFunc ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@model:
|
|
|
|
@path:
|
|
|
|
@iter:
|
|
|
|
@data:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2000-11-14 16:36:20 +00:00
|
|
|
<!-- ##### ENUM GtkTreeModelFlags ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@GTK_TREE_MODEL_ITERS_PERSIST:
|
2001-06-13 21:24:09 +00:00
|
|
|
@GTK_TREE_MODEL_LIST_ONLY:
|
2000-10-30 23:21:38 +00:00
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_path_new ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_path_new_from_string ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@path:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_path_to_string ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@path:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2002-02-24 04:45:31 +00:00
|
|
|
<!-- ##### FUNCTION gtk_tree_path_new_first ##### -->
|
2000-10-30 23:21:38 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2002-02-24 04:45:31 +00:00
|
|
|
<!-- ##### MACRO gtk_tree_path_new_root ##### -->
|
|
|
|
<para>
|
|
|
|
A alternate name for gtk_tree_path_new_root() provided for
|
|
|
|
compatibility reasons; this macro will be deprecated in future
|
|
|
|
versions of GTK+.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@Returns: A new #GtkTreePath.
|
|
|
|
|
|
|
|
|
2000-10-30 23:21:38 +00:00
|
|
|
<!-- ##### FUNCTION gtk_tree_path_append_index ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@path:
|
|
|
|
@index:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_path_prepend_index ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@path:
|
|
|
|
@index:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_path_get_depth ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@path:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_path_get_indices ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@path:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_path_free ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@path:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_path_copy ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@path:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_path_compare ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@a:
|
|
|
|
@b:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_path_next ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@path:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_path_prev ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@path:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_path_up ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@path:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_path_down ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@path:
|
|
|
|
|
|
|
|
|
2001-10-03 04:44:13 +00:00
|
|
|
<!-- ##### FUNCTION gtk_tree_path_is_ancestor ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@path:
|
|
|
|
@descendant:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_path_is_descendant ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@path:
|
|
|
|
@ancestor:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_row_reference_new ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@model:
|
|
|
|
@path:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_row_reference_new_proxy ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@proxy:
|
|
|
|
@model:
|
|
|
|
@path:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_row_reference_get_path ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@reference:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_row_reference_valid ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@reference:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_row_reference_free ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@reference:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_row_reference_inserted ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@proxy:
|
|
|
|
@path:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_row_reference_deleted ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@proxy:
|
|
|
|
@path:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_row_reference_reordered ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@proxy:
|
|
|
|
@path:
|
|
|
|
@iter:
|
|
|
|
@new_order:
|
|
|
|
|
|
|
|
|
2000-11-14 16:36:20 +00:00
|
|
|
<!-- ##### FUNCTION gtk_tree_iter_copy ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@iter:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_iter_free ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@iter:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_model_get_flags ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2000-10-30 23:21:38 +00:00
|
|
|
<!-- ##### FUNCTION gtk_tree_model_get_n_columns ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_model_get_column_type ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@index:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_model_get_iter ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@iter:
|
|
|
|
@path:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2001-11-21 21:43:47 +00:00
|
|
|
<!-- ##### FUNCTION gtk_tree_model_get_iter_from_string ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@iter:
|
|
|
|
@path_string:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2002-02-24 04:45:31 +00:00
|
|
|
<!-- ##### FUNCTION gtk_tree_model_get_iter_first ##### -->
|
2001-10-03 04:44:13 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@iter:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2002-02-24 04:45:31 +00:00
|
|
|
<!-- ##### MACRO gtk_tree_model_get_iter_root ##### -->
|
|
|
|
<para>
|
|
|
|
A alternate name for gtk_tree_model_get_iter_root() provided for
|
|
|
|
compatibility reasons; this macro will be deprecated in future
|
|
|
|
versions of GTK+.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model: A #GtkTreeModel.
|
|
|
|
@iter: uninitialized #GtkTreeIter.
|
|
|
|
@Returns: %TRUE, if @iter was set.
|
|
|
|
|
|
|
|
|
2000-10-30 23:21:38 +00:00
|
|
|
<!-- ##### FUNCTION gtk_tree_model_get_path ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@iter:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_model_get_value ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@iter:
|
|
|
|
@column:
|
|
|
|
@value:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_model_iter_next ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@iter:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_model_iter_children ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@iter:
|
|
|
|
@parent:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_model_iter_has_child ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@iter:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_model_iter_n_children ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@iter:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_model_iter_nth_child ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@iter:
|
|
|
|
@parent:
|
|
|
|
@n:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_model_iter_parent ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@iter:
|
|
|
|
@child:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2001-03-23 22:21:06 +00:00
|
|
|
<!-- ##### FUNCTION gtk_tree_model_ref_node ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@iter:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_model_unref_node ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@iter:
|
|
|
|
|
|
|
|
|
2001-10-03 04:44:13 +00:00
|
|
|
<!-- ##### FUNCTION gtk_tree_model_get ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@iter:
|
|
|
|
@Varargs:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_model_get_valist ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@iter:
|
|
|
|
@var_args:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_model_foreach ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@model:
|
|
|
|
@func:
|
|
|
|
@user_data:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_model_row_changed ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@path:
|
|
|
|
@iter:
|
|
|
|
<!-- # Unused Parameters # -->
|
|
|
|
@start_path:
|
|
|
|
@start_iter:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_model_row_inserted ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@path:
|
|
|
|
@iter:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_model_row_has_child_toggled ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@path:
|
|
|
|
@iter:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_model_row_deleted ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@path:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_tree_model_rows_reordered ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@tree_model:
|
|
|
|
@path:
|
|
|
|
@iter:
|
|
|
|
@new_order:
|
|
|
|
|
|
|
|
|