]> Pileus Git - ~andy/gtk/commitdiff
container: clarify the docs
authorStefan Kost <ensonic@users.sf.net>
Fri, 20 Aug 2010 10:55:41 +0000 (13:55 +0300)
committerStefan Kost <ensonic@users.sf.net>
Wed, 1 Sep 2010 13:59:00 +0000 (16:59 +0300)
Hightlight more that focus_child is a container internal thing and suggest
what application developers most likely were looking for instead.

gtk/gtkcontainer.c

index 0a1f705cd239bc51a3793ae68a821b6c441cde49..839ae4375552e92257b712e12ae6eab6f1fdfbd4 100644 (file)
@@ -1587,6 +1587,9 @@ gtk_container_foreach (GtkContainer *container,
  * This function emits the GtkContainer::set_focus_child signal of
  * @container. Implementations of #GtkContainer can override the
  * default behaviour by overriding the class closure of this signal.
+ *
+ * This is function is mostly meant to be used by widgets. Applications can use
+ * gtk_widget_grab_focus() to manualy set the focus to a specific widget.
  */
 void
 gtk_container_set_focus_child (GtkContainer *container,
@@ -1603,10 +1606,12 @@ gtk_container_set_focus_child (GtkContainer *container,
  * gtk_container_get_focus_child:
  * @container: a #GtkContainer
  *
- * Returns the current focus child widget inside @container.
+ * Returns the current focus child widget inside @container. This is not the
+ * currently focused widget. That can be obtained by calling
+ * gtk_window_get_focus().
  *
- * Returns: The child widget which has the focus
- *          inside @container, or %NULL if none is set.
+ * Returns: The child widget which will recieve the focus inside @container when
+ *          the @conatiner is focussed, or %NULL if none is set.
  *
  * Since: 2.14
  **/