Commit 0b51abbf authored by Philip Withnall's avatar Philip Withnall Committed by Ignacio Casal Quinteiro

Add (out) annotations to GtkTreeIter parameters

parent c4832a9d
......@@ -5046,7 +5046,7 @@ gtk_combo_box_set_active_internal (GtkComboBox *combo_box,
/**
* gtk_combo_box_get_active_iter:
* @combo_box: A #GtkComboBox
* @iter: The uninitialized #GtkTreeIter
* @iter: (out): The uninitialized #GtkTreeIter
*
* Sets @iter to point to the current active item, if it exists.
*
......
......@@ -5001,9 +5001,9 @@ gtk_icon_view_set_tooltip_cell (GtkIconView *icon_view,
* @x: the x coordinate (relative to widget coordinates)
* @y: the y coordinate (relative to widget coordinates)
* @keyboard_tip: whether this is a keyboard tooltip or not
* @model: (allow-none): a pointer to receive a #GtkTreeModel or %NULL
* @path: (allow-none): a pointer to receive a #GtkTreePath or %NULL
* @iter: (allow-none): a pointer to receive a #GtkTreeIter or %NULL
* @model: (out) (allow-none): a pointer to receive a #GtkTreeModel or %NULL
* @path: (out) (allow-none): a pointer to receive a #GtkTreePath or %NULL
* @iter: (out) (allow-none): a pointer to receive a #GtkTreeIter or %NULL
*
* This function is supposed to be used in a #GtkWidget::query-tooltip
* signal handler for #GtkIconView. The @x, @y and @keyboard_tip values
......
......@@ -990,7 +990,7 @@ gtk_list_store_remove (GtkListStore *list_store,
/**
* gtk_list_store_insert:
* @list_store: A #GtkListStore
* @iter: An unset #GtkTreeIter to set to the new row
* @iter: (out): An unset #GtkTreeIter to set to the new row
* @position: position to insert the new row
*
* Creates a new row at @position. @iter will be changed to point to this new
......@@ -1041,7 +1041,7 @@ gtk_list_store_insert (GtkListStore *list_store,
/**
* gtk_list_store_insert_before:
* @list_store: A #GtkListStore
* @iter: An unset #GtkTreeIter to set to the new row
* @iter: (out): An unset #GtkTreeIter to set to the new row
* @sibling: (allow-none): A valid #GtkTreeIter, or %NULL
*
* Inserts a new row before @sibling. If @sibling is %NULL, then the row will
......@@ -1073,7 +1073,7 @@ gtk_list_store_insert_before (GtkListStore *list_store,
/**
* gtk_list_store_insert_after:
* @list_store: A #GtkListStore
* @iter: An unset #GtkTreeIter to set to the new row
* @iter: (out): An unset #GtkTreeIter to set to the new row
* @sibling: (allow-none): A valid #GtkTreeIter, or %NULL
*
* Inserts a new row after @sibling. If @sibling is %NULL, then the row will be
......@@ -1105,7 +1105,7 @@ gtk_list_store_insert_after (GtkListStore *list_store,
/**
* gtk_list_store_prepend:
* @list_store: A #GtkListStore
* @iter: An unset #GtkTreeIter to set to the prepend row
* @iter: (out): An unset #GtkTreeIter to set to the prepend row
*
* Prepends a new row to @list_store. @iter will be changed to point to this new
* row. The row will be empty after this function is called. To fill in
......@@ -1125,7 +1125,7 @@ gtk_list_store_prepend (GtkListStore *list_store,
/**
* gtk_list_store_append:
* @list_store: A #GtkListStore
* @iter: An unset #GtkTreeIter to set to the appended row
* @iter: (out): An unset #GtkTreeIter to set to the appended row
*
* Appends a new row to @list_store. @iter will be changed to point to this new
* row. The row will be empty after this function is called. To fill in
......@@ -1883,7 +1883,7 @@ gtk_list_store_has_default_sort_func (GtkTreeSortable *sortable)
/**
* gtk_list_store_insert_with_values:
* @list_store: A #GtkListStore
* @iter: (allow-none): An unset #GtkTreeIter to set to the new row, or %NULL.
* @iter: (out) (allow-none): An unset #GtkTreeIter to set to the new row, or %NULL.
* @position: position to insert the new row
* @Varargs: pairs of column number and value, terminated with -1
*
......@@ -1969,7 +1969,7 @@ gtk_list_store_insert_with_values (GtkListStore *list_store,
/**
* gtk_list_store_insert_with_valuesv:
* @list_store: A #GtkListStore
* @iter: (allow-none): An unset #GtkTreeIter to set to the new row, or %NULL.
* @iter: (out) (allow-none): An unset #GtkTreeIter to set to the new row, or %NULL.
* @position: position to insert the new row
* @columns: an array of column numbers
* @values: an array of GValues
......
......@@ -998,7 +998,7 @@ gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
/**
* gtk_tree_model_get_iter:
* @tree_model: A #GtkTreeModel.
* @iter: The uninitialized #GtkTreeIter.
* @iter: (out): The uninitialized #GtkTreeIter.
* @path: The #GtkTreePath.
*
* Sets @iter to a valid iterator pointing to @path.
......@@ -1028,7 +1028,7 @@ gtk_tree_model_get_iter (GtkTreeModel *tree_model,
/**
* gtk_tree_model_get_iter_from_string:
* @tree_model: A #GtkTreeModel.
* @iter: An uninitialized #GtkTreeIter.
* @iter: (out): An uninitialized #GtkTreeIter.
* @path_string: A string representation of a #GtkTreePath.
*
* Sets @iter to a valid iterator pointing to @path_string, if it
......@@ -1094,7 +1094,7 @@ gtk_tree_model_get_string_from_iter (GtkTreeModel *tree_model,
/**
* gtk_tree_model_get_iter_first:
* @tree_model: A #GtkTreeModel.
* @iter: The uninitialized #GtkTreeIter.
* @iter: (out): The uninitialized #GtkTreeIter.
*
* Initializes @iter with the first iterator in the tree (the one at the path
* "0") and returns %TRUE. Returns %FALSE if the tree is empty.
......@@ -1175,7 +1175,7 @@ gtk_tree_model_get_value (GtkTreeModel *tree_model,
/**
* gtk_tree_model_iter_next:
* @tree_model: A #GtkTreeModel.
* @iter: The #GtkTreeIter.
* @iter: (inout): The #GtkTreeIter.
*
* Sets @iter to point to the node following it at the current level. If there
* is no next @iter, %FALSE is returned and @iter is set to be invalid.
......@@ -1200,7 +1200,7 @@ gtk_tree_model_iter_next (GtkTreeModel *tree_model,
/**
* gtk_tree_model_iter_children:
* @tree_model: A #GtkTreeModel.
* @iter: The new #GtkTreeIter to be set to the child.
* @iter: (out): The new #GtkTreeIter to be set to the child.
* @parent: (allow-none): The #GtkTreeIter, or %NULL
*
* Sets @iter to point to the first child of @parent. If @parent has no
......@@ -1281,7 +1281,7 @@ gtk_tree_model_iter_n_children (GtkTreeModel *tree_model,
/**
* gtk_tree_model_iter_nth_child:
* @tree_model: A #GtkTreeModel.
* @iter: The #GtkTreeIter to set to the nth child.
* @iter: (out): The #GtkTreeIter to set to the nth child.
* @parent: (allow-none): The #GtkTreeIter to get the child from, or %NULL.
* @n: Then index of the desired child.
*
......@@ -1316,7 +1316,7 @@ gtk_tree_model_iter_nth_child (GtkTreeModel *tree_model,
/**
* gtk_tree_model_iter_parent:
* @tree_model: A #GtkTreeModel
* @iter: The new #GtkTreeIter to set to the parent.
* @iter: (out): The new #GtkTreeIter to set to the parent.
* @child: The #GtkTreeIter.
*
* Sets @iter to be the parent of @child. If @child is at the toplevel, and
......
......@@ -3177,7 +3177,7 @@ gtk_tree_model_filter_set_visible_column (GtkTreeModelFilter *filter,
/**
* gtk_tree_model_filter_convert_child_iter_to_iter:
* @filter: A #GtkTreeModelFilter.
* @filter_iter: An uninitialized #GtkTreeIter.
* @filter_iter: (out): An uninitialized #GtkTreeIter.
* @child_iter: A valid #GtkTreeIter pointing to a row on the child model.
*
* Sets @filter_iter to point to the row in @filter that corresponds to the
......@@ -3224,7 +3224,7 @@ gtk_tree_model_filter_convert_child_iter_to_iter (GtkTreeModelFilter *filter,
/**
* gtk_tree_model_filter_convert_iter_to_child_iter:
* @filter: A #GtkTreeModelFilter.
* @child_iter: An uninitialized #GtkTreeIter.
* @child_iter: (out): An uninitialized #GtkTreeIter.
* @filter_iter: A valid #GtkTreeIter pointing to a row on @filter.
*
* Sets @child_iter to point to the row pointed to by @filter_iter.
......
......@@ -2087,7 +2087,7 @@ gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sor
/**
* gtk_tree_model_sort_convert_child_iter_to_iter:
* @tree_model_sort: A #GtkTreeModelSort
* @sort_iter: An uninitialized #GtkTreeIter.
* @sort_iter: (out): An uninitialized #GtkTreeIter.
* @child_iter: A valid #GtkTreeIter pointing to a row on the child model
*
* Sets @sort_iter to point to the row in @tree_model_sort that corresponds to
......@@ -2194,7 +2194,7 @@ gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sor
/**
* gtk_tree_model_sort_convert_iter_to_child_iter:
* @tree_model_sort: A #GtkTreeModelSort
* @child_iter: An uninitialized #GtkTreeIter
* @child_iter: (out): An uninitialized #GtkTreeIter
* @sorted_iter: A valid #GtkTreeIter pointing to a row on @tree_model_sort.
*
* Sets @child_iter to point to the row pointed to by @sorted_iter.
......
......@@ -328,7 +328,7 @@ gtk_tree_selection_get_tree_view (GtkTreeSelection *selection)
* gtk_tree_selection_get_selected:
* @selection: A #GtkTreeSelection.
* @model: (out) (allow-none) (transfer none): A pointer to set to the #GtkTreeModel, or NULL.
* @iter: (allow-none): The #GtkTreeIter, or NULL.
* @iter: (out) (allow-none): The #GtkTreeIter, or NULL.
*
* Sets @iter to the currently selected node if @selection is set to
* #GTK_SELECTION_SINGLE or #GTK_SELECTION_BROWSE. @iter may be NULL if you
......
......@@ -1157,7 +1157,7 @@ gtk_tree_store_remove (GtkTreeStore *tree_store,
/**
* gtk_tree_store_insert:
* @tree_store: A #GtkTreeStore
* @iter: An unset #GtkTreeIter to set to the new row
* @iter: (out): An unset #GtkTreeIter to set to the new row
* @parent: (allow-none): A valid #GtkTreeIter, or %NULL
* @position: position to insert the new row
*
......@@ -1218,7 +1218,7 @@ gtk_tree_store_insert (GtkTreeStore *tree_store,
/**
* gtk_tree_store_insert_before:
* @tree_store: A #GtkTreeStore
* @iter: An unset #GtkTreeIter to set to the new row
* @iter: (out): An unset #GtkTreeIter to set to the new row
* @parent: (allow-none): A valid #GtkTreeIter, or %NULL
* @sibling: (allow-none): A valid #GtkTreeIter, or %NULL
*
......@@ -1298,7 +1298,7 @@ gtk_tree_store_insert_before (GtkTreeStore *tree_store,
/**
* gtk_tree_store_insert_after:
* @tree_store: A #GtkTreeStore
* @iter: An unset #GtkTreeIter to set to the new row
* @iter: (out): An unset #GtkTreeIter to set to the new row
* @parent: (allow-none): A valid #GtkTreeIter, or %NULL
* @sibling: (allow-none): A valid #GtkTreeIter, or %NULL
*
......@@ -1379,7 +1379,7 @@ gtk_tree_store_insert_after (GtkTreeStore *tree_store,
/**
* gtk_tree_store_insert_with_values:
* @tree_store: A #GtkTreeStore
* @iter: (allow-none): An unset #GtkTreeIter to set the new row, or %NULL.
* @iter: (out) (allow-none): An unset #GtkTreeIter to set the new row, or %NULL.
* @parent: (allow-none): A valid #GtkTreeIter, or %NULL
* @position: position to insert the new row
* @Varargs: pairs of column number and value, terminated with -1
......@@ -1470,7 +1470,7 @@ gtk_tree_store_insert_with_values (GtkTreeStore *tree_store,
/**
* gtk_tree_store_insert_with_valuesv:
* @tree_store: A #GtkTreeStore
* @iter: (allow-none): An unset #GtkTreeIter to set the new row, or %NULL.
* @iter: (out) (allow-none): An unset #GtkTreeIter to set the new row, or %NULL.
* @parent: (allow-none): A valid #GtkTreeIter, or %NULL
* @position: position to insert the new row
* @columns: an array of column numbers
......@@ -1547,7 +1547,7 @@ gtk_tree_store_insert_with_valuesv (GtkTreeStore *tree_store,
/**
* gtk_tree_store_prepend:
* @tree_store: A #GtkTreeStore
* @iter: An unset #GtkTreeIter to set to the prepended row
* @iter: (out): An unset #GtkTreeIter to set to the prepended row
* @parent: (allow-none): A valid #GtkTreeIter, or %NULL
*
* Prepends a new row to @tree_store. If @parent is non-%NULL, then it will prepend
......@@ -1605,7 +1605,7 @@ gtk_tree_store_prepend (GtkTreeStore *tree_store,
/**
* gtk_tree_store_append:
* @tree_store: A #GtkTreeStore
* @iter: An unset #GtkTreeIter to set to the appended row
* @iter: (out): An unset #GtkTreeIter to set to the appended row
* @parent: (allow-none): A valid #GtkTreeIter, or %NULL
*
* Appends a new row to @tree_store. If @parent is non-%NULL, then it will append the
......
......@@ -15483,9 +15483,9 @@ gtk_tree_view_set_tooltip_cell (GtkTreeView *tree_view,
* @x: the x coordinate (relative to widget coordinates)
* @y: the y coordinate (relative to widget coordinates)
* @keyboard_tip: whether this is a keyboard tooltip or not
* @model: (allow-none): a pointer to receive a #GtkTreeModel or %NULL
* @path: (allow-none): a pointer to receive a #GtkTreePath or %NULL
* @iter: (allow-none): a pointer to receive a #GtkTreeIter or %NULL
* @model: (out) (allow-none): a pointer to receive a #GtkTreeModel or %NULL
* @path: (out) (allow-none): a pointer to receive a #GtkTreePath or %NULL
* @iter: (out) (allow-none): a pointer to receive a #GtkTreeIter or %NULL
*
* This function is supposed to be used in a #GtkWidget::query-tooltip
* signal handler for #GtkTreeView. The @x, @y and @keyboard_tip values
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment