aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlberto Garcia <agarcia@igalia.com>2010-01-22 18:07:26 +0100
committerAlberto Garcia <agarcia@igalia.com>2010-01-22 18:10:39 +0100
commit1d169046ab6341b39b87b357ff48ddce0573804d (patch)
tree70df0d4f96b0a8e06cf4327f79ecfd3f0fa914fe
parent2382d9885dc56ae15045fcf4ce7c9272e27c6114 (diff)
HildonTouchSelector documentation updates
Fixes: MB#4640
-rw-r--r--hildon/hildon-touch-selector.c13
1 files changed, 9 insertions, 4 deletions
diff --git a/hildon/hildon-touch-selector.c b/hildon/hildon-touch-selector.c
index c2e7b96..8739ed6 100644
--- a/hildon/hildon-touch-selector.c
+++ b/hildon/hildon-touch-selector.c
@@ -2193,7 +2193,7 @@ hildon_touch_selector_get_active (HildonTouchSelector *selector,
/**
* hildon_touch_selector_get_selected:
* @selector: a #HildonTouchSelector
- * @column: the column number we want to get the element
+ * @column: the column to get the item from
* @iter: #GtkTreeIter currently selected
*
* Sets @iter to the currently selected node on the nth-column, if selection is
@@ -2204,7 +2204,10 @@ hildon_touch_selector_get_active (HildonTouchSelector *selector,
* This function will not work if selection is in
* %HILDON_TOUCH_SELECTOR_MULTIPLE mode and the column is the first one.
*
- * See gtk_tree_selection_get_selected() for more information.
+ * To change the currently selected iter, see
+ * hildon_touch_selector_select_iter()
+ *
+ * See also gtk_tree_selection_get_selected() for more information.
*
* Returns: %TRUE if @iter was correctly set, %FALSE otherwise
*
@@ -2250,15 +2253,17 @@ hildon_touch_selector_get_selected (HildonTouchSelector * selector,
}
/**
- * hildon_touch_selector_select_iter
+ * hildon_touch_selector_select_iter:
* @selector: a #HildonTouchSelector
- * @column: the column to selects
+ * @column: the column to select an item from
* @iter: the #GtkTreeIter to be selected
* @scroll_to: whether to smoothly scroll to the item
*
* Sets the currently selected item in the column @column to the one pointed by @iter,
* optionally smoothly scrolling to it.
*
+ * To obtain the currently selected iter, see hildon_touch_selector_get_selected()
+ *
* Since: 2.2
**/
void