Trivial doc fixes.
2005-07-25 Matthias Clasen <mclasen@redhat.com> * gtk/gtktreemodelsort.c: Trivial doc fixes. * gtk/gtktreesortable.c: Talk about comparison functions, not sort functions in some places. (#311398, Fabrice Bauzac) 2005-07-25 Matthias Clasen <mclasen@redhat.com> * gtk/tmpl/gtktreemodelsort.sgml: Note that the sorting function is not guaranteed to be stable. (#311398, Fabrice Bauzac)
This commit is contained in:
Matthias Clasen
committed by
Matthias Clasen
Matthias Clasen
parent
258f25700d
commit
e0f77a1f76
@ -1,5 +1,10 @@
|
||||
2005-07-25 Matthias Clasen <mclasen@redhat.com>
|
||||
|
||||
* gtk/gtktreemodelsort.c: Trivial doc fixes.
|
||||
|
||||
* gtk/gtktreesortable.c: Talk about comparison functions, not
|
||||
sort functions in some places. (#311398, Fabrice Bauzac)
|
||||
|
||||
* gtk/gtk.symbols:
|
||||
* gtk/gtkobject.[hc]:
|
||||
* gtk/gtkfilechooserdialog.[hc]
|
||||
|
||||
@ -1,5 +1,10 @@
|
||||
2005-07-25 Matthias Clasen <mclasen@redhat.com>
|
||||
|
||||
* gtk/gtktreemodelsort.c: Trivial doc fixes.
|
||||
|
||||
* gtk/gtktreesortable.c: Talk about comparison functions, not
|
||||
sort functions in some places. (#311398, Fabrice Bauzac)
|
||||
|
||||
* gtk/gtk.symbols:
|
||||
* gtk/gtkobject.[hc]:
|
||||
* gtk/gtkfilechooserdialog.[hc]
|
||||
|
||||
@ -1,5 +1,10 @@
|
||||
2005-07-25 Matthias Clasen <mclasen@redhat.com>
|
||||
|
||||
* gtk/gtktreemodelsort.c: Trivial doc fixes.
|
||||
|
||||
* gtk/gtktreesortable.c: Talk about comparison functions, not
|
||||
sort functions in some places. (#311398, Fabrice Bauzac)
|
||||
|
||||
* gtk/gtk.symbols:
|
||||
* gtk/gtkobject.[hc]:
|
||||
* gtk/gtkfilechooserdialog.[hc]
|
||||
|
||||
@ -1,3 +1,9 @@
|
||||
2005-07-25 Matthias Clasen <mclasen@redhat.com>
|
||||
|
||||
* gtk/tmpl/gtktreemodelsort.sgml: Note that the sorting
|
||||
function is not guaranteed to be stable. (#311398,
|
||||
Fabrice Bauzac)
|
||||
|
||||
2005-07-22 Matthias Clasen <mclasen@redhat.com>
|
||||
|
||||
* === Released 2.7.4 ===
|
||||
|
||||
@ -11,7 +11,8 @@ interface. It does not hold any data itself, but rather is created with
|
||||
a child model and proxies its data. It has identical column types to
|
||||
this child model, and the changes in the child are propagated. The
|
||||
primary purpose of this model is to provide a way to sort a different
|
||||
model without modifying it.
|
||||
model without modifying it. Note that the sort function used by
|
||||
#GtkTreeModelSort is not guaranteed to be stable.
|
||||
</para>
|
||||
<para>
|
||||
The use of this is best demonstrated through an example. In the
|
||||
|
||||
@ -375,7 +375,7 @@ gtk_tree_model_sort_drag_source_init (GtkTreeDragSourceIface *iface)
|
||||
* gtk_tree_model_sort_new_with_model:
|
||||
* @child_model: A #GtkTreeModel
|
||||
*
|
||||
* Creates a new #GtkTreeModel, with @child_model as the child_model.
|
||||
* Creates a new #GtkTreeModel, with @child_model as the child model.
|
||||
*
|
||||
* Return value: A new #GtkTreeModel.
|
||||
*/
|
||||
@ -1941,11 +1941,12 @@ gtk_tree_model_sort_elt_get_path (SortLevel *level,
|
||||
/**
|
||||
* gtk_tree_model_sort_set_model:
|
||||
* @tree_model_sort: The #GtkTreeModelSort.
|
||||
* @child_model: A #GtkTreeModel, or NULL.
|
||||
* @child_model: A #GtkTreeModel, or %NULL.
|
||||
*
|
||||
* Sets the model of @tree_model_sort to be @model. If @model is NULL, then the
|
||||
* old model is unset. The sort function is unset as a result of this call.
|
||||
* The model will be in an unsorted state until a sort function is set.
|
||||
* Sets the model of @tree_model_sort to be @model. If @model is %NULL,
|
||||
* then the old model is unset. The sort function is unset as a result
|
||||
* of this call. The model will be in an unsorted state until a sort
|
||||
* function is set.
|
||||
**/
|
||||
static void
|
||||
gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
|
||||
@ -2107,8 +2108,8 @@ gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_mode
|
||||
*
|
||||
* Converts @child_path to a path relative to @tree_model_sort. That is,
|
||||
* @child_path points to a path in the child model. The returned path will
|
||||
* point to the same row in the sorted model. If @child_path isn't a valid path
|
||||
* on the child model, then %NULL is returned.
|
||||
* point to the same row in the sorted model. If @child_path isn't a valid
|
||||
* path on the child model, then %NULL is returned.
|
||||
*
|
||||
* Return value: A newly allocated #GtkTreePath, or %NULL
|
||||
**/
|
||||
@ -2162,10 +2163,11 @@ gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sor
|
||||
* @tree_model_sort: A #GtkTreeModelSort
|
||||
* @sorted_path: A #GtkTreePath to convert
|
||||
*
|
||||
* Converts @sorted_path to a path on the child model of @tree_model_sort. That
|
||||
* is, @sorted_path points to a location in @tree_model_sort. The returned path
|
||||
* will point to the same location in the model not being sorted. If @sorted_path
|
||||
* does not point to a location in the child model, %NULL is returned.
|
||||
* Converts @sorted_path to a path on the child model of @tree_model_sort.
|
||||
* That is, @sorted_path points to a location in @tree_model_sort. The
|
||||
* returned path will point to the same location in the model not being
|
||||
* sorted. If @sorted_path does not point to a location in the child model,
|
||||
* %NULL is returned.
|
||||
*
|
||||
* Return value: A newly allocated #GtkTreePath, or %NULL
|
||||
**/
|
||||
@ -2497,8 +2499,9 @@ gtk_tree_model_sort_iter_is_valid_helper (GtkTreeIter *iter,
|
||||
* @tree_model_sort: A #GtkTreeModelSort.
|
||||
* @iter: A #GtkTreeIter.
|
||||
*
|
||||
* WARNING: This function is slow. Only use it for debugging and/or testing
|
||||
* purposes.
|
||||
* <warning><para>
|
||||
* This function is slow. Only use it for debugging and/or testing purposes.
|
||||
* </para></warning>
|
||||
*
|
||||
* Checks if the given iter is a valid iter for this #GtkTreeModelSort.
|
||||
*
|
||||
|
||||
@ -151,8 +151,8 @@ gtk_tree_sortable_set_sort_column_id (GtkTreeSortable *sortable,
|
||||
* gtk_tree_sortable_set_sort_func:
|
||||
* @sortable: A #GtkTreeSortable
|
||||
* @sort_column_id: the sort column id to set the function for
|
||||
* @sort_func: The sorting function
|
||||
* @user_data: User data to pass to the sort func, or %NULL
|
||||
* @sort_func: The comparison function
|
||||
* @user_data: User data to pass to @sort_func, or %NULL
|
||||
* @destroy: Destroy notifier of @user_data, or %NULL
|
||||
*
|
||||
* Sets the comparison function used when sorting to be @sort_func. If the
|
||||
@ -182,13 +182,14 @@ gtk_tree_sortable_set_sort_func (GtkTreeSortable *sortable,
|
||||
/**
|
||||
* gtk_tree_sortable_set_default_sort_func:
|
||||
* @sortable: A #GtkTreeSortable
|
||||
* @sort_func: The sorting function
|
||||
* @user_data: User data to pass to the sort func, or %NULL
|
||||
* @sort_func: The comparison function
|
||||
* @user_data: User data to pass to @sort_func, or %NULL
|
||||
* @destroy: Destroy notifier of @user_data, or %NULL
|
||||
*
|
||||
* Sets the default comparison function used when sorting to be @sort_func. If
|
||||
* the current sort column id of @sortable is
|
||||
* %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using this function.
|
||||
* Sets the default comparison function used when sorting to be @sort_func.
|
||||
* If the current sort column id of @sortable is
|
||||
* %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using
|
||||
* this function.
|
||||
*
|
||||
* If @sort_func is %NULL, then there will be no default comparison function.
|
||||
* This means that once the model has been sorted, it can't go back to the
|
||||
|
||||
Reference in New Issue
Block a user