summaryrefslogtreecommitdiff
path: root/gtk/gtktreemodel.c
diff options
context:
space:
mode:
authorWilliam Jon McCann <william.jon.mccann@gmail.com>2014-01-27 17:04:46 -0500
committerWilliam Jon McCann <william.jon.mccann@gmail.com>2014-01-27 19:59:55 -0500
commit22586ea7c2c87a44ac1cc87f876e9f3ba2e73625 (patch)
tree72f3256948c09d527f3cd7ec409017c92515dde7 /gtk/gtktreemodel.c
parent8418e6422f0ec67c51d472321f4704a3a16e0368 (diff)
downloadgtk+-22586ea7c2c87a44ac1cc87f876e9f3ba2e73625.tar.gz
docs: use #*-struct instead of <structname>
Diffstat (limited to 'gtk/gtktreemodel.c')
-rw-r--r--gtk/gtktreemodel.c162
1 files changed, 81 insertions, 81 deletions
diff --git a/gtk/gtktreemodel.c b/gtk/gtktreemodel.c
index b85b4815cb..822b33b666 100644
--- a/gtk/gtktreemodel.c
+++ b/gtk/gtktreemodel.c
@@ -63,21 +63,21 @@
* Models are accessed on a node/column level of granularity. One can
* query for the value of a model at a certain node and a certain
* column on that node. There are two structures used to reference
- * a particular node in a model. They are the #GtkTreePath and the
- * #GtkTreeIter<footnote><para>Here, <abbrev>iter</abbrev> is short
+ * a particular node in a model. They are the #GtkTreePath-struct and the
+ * #GtkTreeIter-struct<footnote><para>Here, <abbrev>iter</abbrev> is short
* for <quote>iterator</quote></para></footnote>. Most of the interface
- * consists of operations on a #GtkTreeIter.
+ * consists of operations on a #GtkTreeIter-struct.
*
* A path is essentially a potential node. It is a location on a model
* that may or may not actually correspond to a node on a specific
- * model. The #GtkTreePath struct can be converted into either an
+ * model. The #GtkTreePath-struct can be converted into either an
* array of unsigned integers or a string. The string form is a list
* of numbers separated by a colon. Each number refers to the offset
* at that level. Thus, the path <quote>0</quote> refers to the root
* node and the path <quote>2:4</quote> refers to the fifth child of
* the third node.
*
- * By contrast, a #GtkTreeIter is a reference to a specific node on
+ * By contrast, a #GtkTreeIter-struct is a reference to a specific node on
* a specific model. It is a generic struct with an integer and three
* generic pointers. These are filled in by the model in a model-specific
* way. One can convert a path to an iterator by calling
@@ -115,7 +115,7 @@
* callbacks.
*
* <example>
- * <title>Acquiring a <structname>GtkTreeIter</structname></title>
+ * <title>Acquiring a #GtkTreeIter-struct</title>
* <programlisting>
* /&ast; Three ways of getting the iter pointing to the location &ast;/
* GtkTreePath *path;
@@ -146,7 +146,7 @@
* how to write such a function, see the #GtkListStore documentation.
*
* <example>
- * <title>Reading data from a <structname>GtkTreeModel</structname></title>
+ * <title>Reading data from a #GtkTreeModel</title>
* <programlisting>
* enum
* {
@@ -345,8 +345,8 @@ gtk_tree_model_base_init (gpointer g_class)
/**
* GtkTreeModel::row-changed:
* @tree_model: the #GtkTreeModel on which the signal is emitted
- * @path: a #GtkTreePath identifying the changed row
- * @iter: a valid #GtkTreeIter pointing to the changed row
+ * @path: a #GtkTreePath-struct identifying the changed row
+ * @iter: a valid #GtkTreeIter-struct pointing to the changed row
*
* This signal is emitted when a row in the model has changed.
*/
@@ -377,8 +377,8 @@ gtk_tree_model_base_init (gpointer g_class)
/**
* GtkTreeModel::row-inserted:
* @tree_model: the #GtkTreeModel on which the signal is emitted
- * @path: a #GtkTreePath identifying the new row
- * @iter: a valid #GtkTreeIter pointing to the new row
+ * @path: a #GtkTreePath-struct identifying the new row
+ * @iter: a valid #GtkTreeIter-struct pointing to the new row
*
* This signal is emitted when a new row has been inserted in
* the model.
@@ -402,8 +402,8 @@ gtk_tree_model_base_init (gpointer g_class)
/**
* GtkTreeModel::row-has-child-toggled:
* @tree_model: the #GtkTreeModel on which the signal is emitted
- * @path: a #GtkTreePath identifying the row
- * @iter: a valid #GtkTreeIter pointing to the row
+ * @path: a #GtkTreePath-struct identifying the row
+ * @iter: a valid #GtkTreeIter-struct pointing to the row
*
* This signal is emitted when a row has gotten the first child
* row or lost its last child row.
@@ -422,7 +422,7 @@ gtk_tree_model_base_init (gpointer g_class)
/**
* GtkTreeModel::row-deleted:
* @tree_model: the #GtkTreeModel on which the signal is emitted
- * @path: a #GtkTreePath identifying the row
+ * @path: a #GtkTreePath-struct identifying the row
*
* This signal is emitted when a row has been deleted.
*
@@ -448,9 +448,9 @@ gtk_tree_model_base_init (gpointer g_class)
/**
* GtkTreeModel::rows-reordered: (skip)
* @tree_model: the #GtkTreeModel on which the signal is emitted
- * @path: a #GtkTreePath identifying the tree node whose children
+ * @path: a #GtkTreePath-struct identifying the tree node whose children
* have been reordered
- * @iter: a valid #GtkTreeIter pointing to the node whose children
+ * @iter: a valid #GtkTreeIter-struct pointing to the node whose children
* have been reordered, or %NULL if the depth of @path is 0
* @new_order: an array of integers mapping the current position
* of each child to its old position before the re-ordering,
@@ -577,10 +577,10 @@ rows_reordered_marshal (GClosure *closure,
/**
* gtk_tree_path_new:
*
- * Creates a new #GtkTreePath.
- * This structure refers to a row.
+ * Creates a new #GtkTreePath-struct.
+ * This refers to a row.
*
- * Return value: A newly created #GtkTreePath.
+ * Return value: A newly created #GtkTreePath-struct.
*/
GtkTreePath *
gtk_tree_path_new (void)
@@ -598,7 +598,7 @@ gtk_tree_path_new (void)
* gtk_tree_path_new_from_string:
* @path: The string representation of a path
*
- * Creates a new #GtkTreePath initialized to @path.
+ * Creates a new #GtkTreePath-struct initialized to @path.
*
* @path is expected to be a colon separated list of numbers.
* For example, the string "10:4:0" would create a path of depth
@@ -606,7 +606,7 @@ gtk_tree_path_new (void)
* child of that 11th child, and the 1st child of that 5th child.
* If an invalid path string is passed in, %NULL is returned.
*
- * Return value: A newly-created #GtkTreePath, or %NULL
+ * Return value: A newly-created #GtkTreePath-struct, or %NULL
*/
GtkTreePath *
gtk_tree_path_new_from_string (const gchar *path)
@@ -654,7 +654,7 @@ gtk_tree_path_new_from_string (const gchar *path)
*
* Creates a new path with @first_index and @varargs as indices.
*
- * Return value: A newly created #GtkTreePath
+ * Return value: A newly created #GtkTreePath-struct
*
* Since: 2.2
*/
@@ -689,7 +689,7 @@ gtk_tree_path_new_from_indices (gint first_index,
*
* Creates a new path with the given @indices array of @length.
*
- * Return value: A newly created #GtkTreePath
+ * Return value: A newly created #GtkTreePath-struct
*
* Since: 3.12
*/
@@ -712,7 +712,7 @@ gtk_tree_path_new_from_indicesv (gint *indices,
/**
* gtk_tree_path_to_string:
- * @path: A #GtkTreePath
+ * @path: A #GtkTreePath-struct
*
* Generates a string representation of the path.
*
@@ -754,11 +754,11 @@ gtk_tree_path_to_string (GtkTreePath *path)
/**
* gtk_tree_path_new_first:
*
- * Creates a new #GtkTreePath.
+ * Creates a new #GtkTreePath-struct.
*
* The string representation of this path is "0".
*
- * Return value: A new #GtkTreePath
+ * Return value: A new #GtkTreePath-struct
*/
GtkTreePath *
gtk_tree_path_new_first (void)
@@ -773,7 +773,7 @@ gtk_tree_path_new_first (void)
/**
* gtk_tree_path_append_index:
- * @path: a #GtkTreePath
+ * @path: a #GtkTreePath-struct
* @index_: the index
*
* Appends a new index to a path.
@@ -803,7 +803,7 @@ gtk_tree_path_append_index (GtkTreePath *path,
/**
* gtk_tree_path_prepend_index:
- * @path: a #GtkTreePath
+ * @path: a #GtkTreePath-struct
* @index_: the index
*
* Prepends a new index to a path.
@@ -832,7 +832,7 @@ gtk_tree_path_prepend_index (GtkTreePath *path,
/**
* gtk_tree_path_get_depth:
- * @path: a #GtkTreePath
+ * @path: a #GtkTreePath-struct
*
* Returns the current depth of @path.
*
@@ -848,7 +848,7 @@ gtk_tree_path_get_depth (GtkTreePath *path)
/**
* gtk_tree_path_get_indices: (skip)
- * @path: a #GtkTreePath
+ * @path: a #GtkTreePath-struct
*
* Returns the current indices of @path.
*
@@ -869,7 +869,7 @@ gtk_tree_path_get_indices (GtkTreePath *path)
/**
* gtk_tree_path_get_indices_with_depth: (rename-to gtk_tree_path_get_indices)
- * @path: a #GtkTreePath
+ * @path: a #GtkTreePath-struct
* @depth: (out) (allow-none): return location for number of elements
* returned in the integer array, or %NULL
*
@@ -898,7 +898,7 @@ gtk_tree_path_get_indices_with_depth (GtkTreePath *path,
/**
* gtk_tree_path_free:
- * @path: (allow-none): a #GtkTreePath
+ * @path: (allow-none): a #GtkTreePath-struct
*
* Frees @path. If @path is %NULL, it simply returns.
*/
@@ -914,11 +914,11 @@ gtk_tree_path_free (GtkTreePath *path)
/**
* gtk_tree_path_copy:
- * @path: a #GtkTreePath
+ * @path: a #GtkTreePath-struct
*
- * Creates a new #GtkTreePath as a copy of @path.
+ * Creates a new #GtkTreePath-struct as a copy of @path.
*
- * Return value: a new #GtkTreePath
+ * Return value: a new #GtkTreePath-struct
*/
GtkTreePath *
gtk_tree_path_copy (const GtkTreePath *path)
@@ -941,8 +941,8 @@ G_DEFINE_BOXED_TYPE (GtkTreePath, gtk_tree_path,
/**
* gtk_tree_path_compare:
- * @a: a #GtkTreePath
- * @b: a #GtkTreePath to compare with
+ * @a: a #GtkTreePath-struct
+ * @b: a #GtkTreePath-struct to compare with
*
* Compares two paths.
*
@@ -977,8 +977,8 @@ gtk_tree_path_compare (const GtkTreePath *a,
/**
* gtk_tree_path_is_ancestor:
- * @path: a #GtkTreePath
- * @descendant: another #GtkTreePath
+ * @path: a #GtkTreePath-struct
+ * @descendant: another #GtkTreePath-struct
*
* Returns %TRUE if @descendant is a descendant of @path.
*
@@ -1010,8 +1010,8 @@ gtk_tree_path_is_ancestor (GtkTreePath *path,
/**
* gtk_tree_path_is_descendant:
- * @path: a #GtkTreePath
- * @ancestor: another #GtkTreePath
+ * @path: a #GtkTreePath-struct
+ * @ancestor: another #GtkTreePath-struct
*
* Returns %TRUE if @path is a descendant of @ancestor.
*
@@ -1044,7 +1044,7 @@ gtk_tree_path_is_descendant (GtkTreePath *path,
/**
* gtk_tree_path_next:
- * @path: a #GtkTreePath
+ * @path: a #GtkTreePath-struct
*
* Moves the @path to point to the next node at the current depth.
*/
@@ -1059,7 +1059,7 @@ gtk_tree_path_next (GtkTreePath *path)
/**
* gtk_tree_path_prev:
- * @path: a #GtkTreePath
+ * @path: a #GtkTreePath-struct
*
* Moves the @path to point to the previous node at the
* current depth, if it exists.
@@ -1085,7 +1085,7 @@ gtk_tree_path_prev (GtkTreePath *path)
/**
* gtk_tree_path_up:
- * @path: a #GtkTreePath
+ * @path: a #GtkTreePath-struct
*
* Moves the @path to point to its parent node, if it has a parent.
*
@@ -1106,7 +1106,7 @@ gtk_tree_path_up (GtkTreePath *path)
/**
* gtk_tree_path_down:
- * @path: a #GtkTreePath
+ * @path: a #GtkTreePath-struct
*
* Moves @path to point to the first child of the current path.
*/
@@ -1120,7 +1120,7 @@ gtk_tree_path_down (GtkTreePath *path)
/**
* gtk_tree_iter_copy:
- * @iter: a #GtkTreeIter
+ * @iter: a #GtkTreeIter-struct
*
* Creates a dynamically allocated tree iterator as a copy of @iter.
*
@@ -1237,8 +1237,8 @@ gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
/**
* gtk_tree_model_get_iter:
* @tree_model: a #GtkTreeModel
- * @iter: (out): the uninitialized #GtkTreeIter
- * @path: the #GtkTreePath
+ * @iter: (out): the uninitialized #GtkTreeIter-struct
+ * @path: the #GtkTreePath-struct
*
* Sets @iter to a valid iterator pointing to @path. If @path does
* not exist, @iter is set to an invalid iterator and %FALSE is returned.
@@ -1268,8 +1268,8 @@ gtk_tree_model_get_iter (GtkTreeModel *tree_model,
/**
* gtk_tree_model_get_iter_from_string:
* @tree_model: a #GtkTreeModel
- * @iter: (out): an uninitialized #GtkTreeIter
- * @path_string: a string representation of a #GtkTreePath
+ * @iter: (out): an uninitialized #GtkTreeIter-struct
+ * @path_string: a string representation of a #GtkTreePath-struct
*
* Sets @iter to a valid iterator pointing to @path_string, if it
* exists. Otherwise, @iter is left invalid and %FALSE is returned.
@@ -1301,7 +1301,7 @@ gtk_tree_model_get_iter_from_string (GtkTreeModel *tree_model,
/**
* gtk_tree_model_get_string_from_iter:
* @tree_model: a #GtkTreeModel
- * @iter: a #GtkTreeIter
+ * @iter: a #GtkTreeIter-struct
*
* Generates a string representation of the iter.
*
@@ -1337,7 +1337,7 @@ gtk_tree_model_get_string_from_iter (GtkTreeModel *tree_model,
/**
* gtk_tree_model_get_iter_first:
* @tree_model: a #GtkTreeModel
- * @iter: (out): the uninitialized #GtkTreeIter
+ * @iter: (out): the uninitialized #GtkTreeIter-struct
*
* Initializes @iter with the first iterator in the tree
* (the one at the path "0") and returns %TRUE. Returns
@@ -1365,13 +1365,13 @@ gtk_tree_model_get_iter_first (GtkTreeModel *tree_model,
/**
* gtk_tree_model_get_path:
* @tree_model: a #GtkTreeModel
- * @iter: the #GtkTreeIter
+ * @iter: the #GtkTreeIter-struct
*
- * Returns a newly-created #GtkTreePath referenced by @iter.
+ * Returns a newly-created #GtkTreePath-struct referenced by @iter.
*
* This path should be freed with gtk_tree_path_free().
*
- * Return value: a newly-created #GtkTreePath
+ * Return value: a newly-created #GtkTreePath-struct
*/
GtkTreePath *
gtk_tree_model_get_path (GtkTreeModel *tree_model,
@@ -1391,7 +1391,7 @@ gtk_tree_model_get_path (GtkTreeModel *tree_model,
/**
* gtk_tree_model_get_value:
* @tree_model: a #GtkTreeModel
- * @iter: the #GtkTreeIter
+ * @iter: the #GtkTreeIter-struct
* @column: the column to lookup the value at
* @value: (out) (transfer none): an empty #GValue to set
*
@@ -1421,7 +1421,7 @@ gtk_tree_model_get_value (GtkTreeModel *tree_model,
/**
* gtk_tree_model_iter_next:
* @tree_model: a #GtkTreeModel
- * @iter: (in): the #GtkTreeIter
+ * @iter: (in): the #GtkTreeIter-struct
*
* Sets @iter to point to the node following it at the current level.
*
@@ -1469,7 +1469,7 @@ gtk_tree_model_iter_previous_default (GtkTreeModel *tree_model,
/**
* gtk_tree_model_iter_previous:
* @tree_model: a #GtkTreeModel
- * @iter: (in): the #GtkTreeIter
+ * @iter: (in): the #GtkTreeIter-struct
*
* Sets @iter to point to the previous node at the current level.
*
@@ -1503,8 +1503,8 @@ gtk_tree_model_iter_previous (GtkTreeModel *tree_model,
/**
* gtk_tree_model_iter_children:
* @tree_model: a #GtkTreeModel
- * @iter: (out): the new #GtkTreeIter to be set to the child
- * @parent: (allow-none): the #GtkTreeIter, or %NULL
+ * @iter: (out): the new #GtkTreeIter-struct to be set to the child
+ * @parent: (allow-none): the #GtkTreeIter-struct, or %NULL
*
* Sets @iter to point to the first child of @parent.
*
@@ -1538,7 +1538,7 @@ gtk_tree_model_iter_children (GtkTreeModel *tree_model,
/**
* gtk_tree_model_iter_has_child:
* @tree_model: a #GtkTreeModel
- * @iter: the #GtkTreeIter to test for children
+ * @iter: the #GtkTreeIter-struct to test for children
*
* Returns %TRUE if @iter has children, %FALSE otherwise.
*
@@ -1562,7 +1562,7 @@ gtk_tree_model_iter_has_child (GtkTreeModel *tree_model,
/**
* gtk_tree_model_iter_n_children:
* @tree_model: a #GtkTreeModel
- * @iter: (allow-none): the #GtkTreeIter, or %NULL
+ * @iter: (allow-none): the #GtkTreeIter-struct, or %NULL
*
* Returns the number of children that @iter has.
*
@@ -1588,8 +1588,8 @@ gtk_tree_model_iter_n_children (GtkTreeModel *tree_model,
/**
* gtk_tree_model_iter_nth_child:
* @tree_model: a #GtkTreeModel
- * @iter: (out): the #GtkTreeIter to set to the nth child
- * @parent: (allow-none): the #GtkTreeIter to get the child from, or %NULL.
+ * @iter: (out): the #GtkTreeIter-struct to set to the nth child
+ * @parent: (allow-none): the #GtkTreeIter-struct to get the child from, or %NULL.
* @n: the index of the desired child
*
* Sets @iter to be the child of @parent, using the given index.
@@ -1625,8 +1625,8 @@ gtk_tree_model_iter_nth_child (GtkTreeModel *tree_model,
/**
* gtk_tree_model_iter_parent:
* @tree_model: a #GtkTreeModel
- * @iter: (out): the new #GtkTreeIter to set to the parent
- * @child: the #GtkTreeIter
+ * @iter: (out): the new #GtkTreeIter-struct to set to the parent
+ * @child: the #GtkTreeIter-struct
*
* Sets @iter to be the parent of @child.
*
@@ -1659,7 +1659,7 @@ gtk_tree_model_iter_parent (GtkTreeModel *tree_model,
/**
* gtk_tree_model_ref_node:
* @tree_model: a #GtkTreeModel
- * @iter: the #GtkTreeIter
+ * @iter: the #GtkTreeIter-struct
*
* Lets the tree ref the node.
*
@@ -1695,7 +1695,7 @@ gtk_tree_model_ref_node (GtkTreeModel *tree_model,
/**
* gtk_tree_model_unref_node:
* @tree_model: a #GtkTreeModel
- * @iter: the #GtkTreeIter
+ * @iter: the #GtkTreeIter-struct
*
* Lets the tree unref the node.
*
@@ -1810,8 +1810,8 @@ gtk_tree_model_get_valist (GtkTreeModel *tree_model,
/**
* gtk_tree_model_row_changed:
* @tree_model: a #GtkTreeModel
- * @path: a #GtkTreePath pointing to the changed row
- * @iter: a valid #GtkTreeIter pointing to the changed row
+ * @path: a #GtkTreePath-struct pointing to the changed row
+ * @iter: a valid #GtkTreeIter-struct pointing to the changed row
*
* Emits the #GtkTreeModel::row-changed signal on @tree_model.
*/
@@ -1830,8 +1830,8 @@ gtk_tree_model_row_changed (GtkTreeModel *tree_model,
/**
* gtk_tree_model_row_inserted:
* @tree_model: a #GtkTreeModel
- * @path: a #GtkTreePath pointing to the inserted row
- * @iter: a valid #GtkTreeIter pointing to the inserted row
+ * @path: a #GtkTreePath-struct pointing to the inserted row
+ * @iter: a valid #GtkTreeIter-struct pointing to the inserted row
*
* Emits the #GtkTreeModel::row-inserted signal on @tree_model.
*/
@@ -1850,8 +1850,8 @@ gtk_tree_model_row_inserted (GtkTreeModel *tree_model,
/**
* gtk_tree_model_row_has_child_toggled:
* @tree_model: a #GtkTreeModel
- * @path: a #GtkTreePath pointing to the changed row
- * @iter: a valid #GtkTreeIter pointing to the changed row
+ * @path: a #GtkTreePath-struct pointing to the changed row
+ * @iter: a valid #GtkTreeIter-struct pointing to the changed row
*
* Emits the #GtkTreeModel::row-has-child-toggled signal on
* @tree_model. This should be called by models after the child
@@ -1872,7 +1872,7 @@ gtk_tree_model_row_has_child_toggled (GtkTreeModel *tree_model,
/**
* gtk_tree_model_row_deleted:
* @tree_model: a #GtkTreeModel
- * @path: a #GtkTreePath pointing to the previous location of
+ * @path: a #GtkTreePath-struct pointing to the previous location of
* the deleted row
*
* Emits the #GtkTreeModel::row-deleted signal on @tree_model.
@@ -1897,9 +1897,9 @@ gtk_tree_model_row_deleted (GtkTreeModel *tree_model,
/**
* gtk_tree_model_rows_reordered: (skip)
* @tree_model: a #GtkTreeModel
- * @path: a #GtkTreePath pointing to the tree node whose children
+ * @path: a #GtkTreePath-struct pointing to the tree node whose children
* have been reordered
- * @iter: a valid #GtkTreeIter pointing to the node whose children
+ * @iter: a valid #GtkTreeIter-struct pointing to the node whose children
* have been reordered, or %NULL if the depth of @path is 0
* @new_order: an array of integers mapping the current position of
* each child to its old position before the re-ordering,
@@ -1925,9 +1925,9 @@ gtk_tree_model_rows_reordered (GtkTreeModel *tree_model,
/**
* gtk_tree_model_rows_reordered_with_length: (rename-to gtk_tree_model_rows_reordered)
* @tree_model: a #GtkTreeModel
- * @path: a #GtkTreePath pointing to the tree node whose children
+ * @path: a #GtkTreePath-struct pointing to the tree node whose children
* have been reordered
- * @iter: (allow-none): a valid #GtkTreeIter pointing to the node
+ * @iter: (allow-none): a valid #GtkTreeIter-struct pointing to the node
* whose children have been reordered, or %NULL if the depth
* of @path is 0
* @new_order: (array length=length): an array of integers
@@ -2263,7 +2263,7 @@ gtk_tree_row_reference_unref_path (GtkTreePath *path,
/**
* gtk_tree_row_reference_new:
* @model: a #GtkTreeModel
- * @path: a valid #GtkTreePath to monitor
+ * @path: a valid #GtkTreePath-struct to monitor
*
* Creates a row reference based on @path.
*
@@ -2292,7 +2292,7 @@ gtk_tree_row_reference_new (GtkTreeModel *model,
* gtk_tree_row_reference_new_proxy:
* @proxy: a proxy #GObject
* @model: a #GtkTreeModel
- * @path: a valid #GtkTreePath to monitor
+ * @path: a valid #GtkTreePath-struct to monitor
*
* You do not need to use this function.
*