]> Pileus Git - ~andy/gtk/commitdiff
Add docs.
authorMatthias Clasen <matthiasc@src.gnome.org>
Sun, 15 Dec 2002 01:15:52 +0000 (01:15 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Sun, 15 Dec 2002 01:15:52 +0000 (01:15 +0000)
* gtk/gtkcontainer.c (gtk_container_class_install_child_property):
(gtk_container_child_get_valist):
(gtk_container_child_get_property):
(gtk_container_child_set_valist):
(gtk_container_child_set_property):
(gtk_container_add_with_properties):
(gtk_container_child_set):
(gtk_container_child_get): Add docs.

* gtk/gtkwindow.c (gtk_window_activate_default):
(gtk_window_activate_focus): Add docs.

ChangeLog
ChangeLog.pre-2-10
ChangeLog.pre-2-2
ChangeLog.pre-2-4
ChangeLog.pre-2-6
ChangeLog.pre-2-8
gtk/gtkcontainer.c
gtk/gtkwindow.c

index f6a8aa5a2c65ecd46c7909e18c2b59f5d44a3445..8341e6a6570633878fe9aa4cd6f27d6259d8d6c9 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,17 @@
+2002-12-15  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkcontainer.c (gtk_container_class_install_child_property): 
+       (gtk_container_child_get_valist): 
+       (gtk_container_child_get_property): 
+       (gtk_container_child_set_valist): 
+       (gtk_container_child_set_property): 
+       (gtk_container_add_with_properties): 
+       (gtk_container_child_set): 
+       (gtk_container_child_get): Add docs.
+
+       * gtk/gtkwindow.c (gtk_window_activate_default): 
+       (gtk_window_activate_focus): Add docs.
+
 2002-12-14  Matthias Clasen  <maclas@gmx.de>
 
        * gtk/gtkmenuitem.c (gtk_menu_item_position_menu): Made
index f6a8aa5a2c65ecd46c7909e18c2b59f5d44a3445..8341e6a6570633878fe9aa4cd6f27d6259d8d6c9 100644 (file)
@@ -1,3 +1,17 @@
+2002-12-15  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkcontainer.c (gtk_container_class_install_child_property): 
+       (gtk_container_child_get_valist): 
+       (gtk_container_child_get_property): 
+       (gtk_container_child_set_valist): 
+       (gtk_container_child_set_property): 
+       (gtk_container_add_with_properties): 
+       (gtk_container_child_set): 
+       (gtk_container_child_get): Add docs.
+
+       * gtk/gtkwindow.c (gtk_window_activate_default): 
+       (gtk_window_activate_focus): Add docs.
+
 2002-12-14  Matthias Clasen  <maclas@gmx.de>
 
        * gtk/gtkmenuitem.c (gtk_menu_item_position_menu): Made
index f6a8aa5a2c65ecd46c7909e18c2b59f5d44a3445..8341e6a6570633878fe9aa4cd6f27d6259d8d6c9 100644 (file)
@@ -1,3 +1,17 @@
+2002-12-15  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkcontainer.c (gtk_container_class_install_child_property): 
+       (gtk_container_child_get_valist): 
+       (gtk_container_child_get_property): 
+       (gtk_container_child_set_valist): 
+       (gtk_container_child_set_property): 
+       (gtk_container_add_with_properties): 
+       (gtk_container_child_set): 
+       (gtk_container_child_get): Add docs.
+
+       * gtk/gtkwindow.c (gtk_window_activate_default): 
+       (gtk_window_activate_focus): Add docs.
+
 2002-12-14  Matthias Clasen  <maclas@gmx.de>
 
        * gtk/gtkmenuitem.c (gtk_menu_item_position_menu): Made
index f6a8aa5a2c65ecd46c7909e18c2b59f5d44a3445..8341e6a6570633878fe9aa4cd6f27d6259d8d6c9 100644 (file)
@@ -1,3 +1,17 @@
+2002-12-15  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkcontainer.c (gtk_container_class_install_child_property): 
+       (gtk_container_child_get_valist): 
+       (gtk_container_child_get_property): 
+       (gtk_container_child_set_valist): 
+       (gtk_container_child_set_property): 
+       (gtk_container_add_with_properties): 
+       (gtk_container_child_set): 
+       (gtk_container_child_get): Add docs.
+
+       * gtk/gtkwindow.c (gtk_window_activate_default): 
+       (gtk_window_activate_focus): Add docs.
+
 2002-12-14  Matthias Clasen  <maclas@gmx.de>
 
        * gtk/gtkmenuitem.c (gtk_menu_item_position_menu): Made
index f6a8aa5a2c65ecd46c7909e18c2b59f5d44a3445..8341e6a6570633878fe9aa4cd6f27d6259d8d6c9 100644 (file)
@@ -1,3 +1,17 @@
+2002-12-15  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkcontainer.c (gtk_container_class_install_child_property): 
+       (gtk_container_child_get_valist): 
+       (gtk_container_child_get_property): 
+       (gtk_container_child_set_valist): 
+       (gtk_container_child_set_property): 
+       (gtk_container_add_with_properties): 
+       (gtk_container_child_set): 
+       (gtk_container_child_get): Add docs.
+
+       * gtk/gtkwindow.c (gtk_window_activate_default): 
+       (gtk_window_activate_focus): Add docs.
+
 2002-12-14  Matthias Clasen  <maclas@gmx.de>
 
        * gtk/gtkmenuitem.c (gtk_menu_item_position_menu): Made
index f6a8aa5a2c65ecd46c7909e18c2b59f5d44a3445..8341e6a6570633878fe9aa4cd6f27d6259d8d6c9 100644 (file)
@@ -1,3 +1,17 @@
+2002-12-15  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkcontainer.c (gtk_container_class_install_child_property): 
+       (gtk_container_child_get_valist): 
+       (gtk_container_child_get_property): 
+       (gtk_container_child_set_valist): 
+       (gtk_container_child_set_property): 
+       (gtk_container_add_with_properties): 
+       (gtk_container_child_set): 
+       (gtk_container_child_get): Add docs.
+
+       * gtk/gtkwindow.c (gtk_window_activate_default): 
+       (gtk_window_activate_focus): Add docs.
+
 2002-12-14  Matthias Clasen  <maclas@gmx.de>
 
        * gtk/gtkmenuitem.c (gtk_menu_item_position_menu): Made
index 4d8911427e65f82bef6488a8be933627dde8bc0a..60b1f2683f13332a45ba29808f68df641c02d8ca 100644 (file)
@@ -334,6 +334,16 @@ container_set_child_property (GtkContainer       *container,
   g_value_unset (&tmp_value);
 }
 
+/**
+ * gtk_container_child_get_valist:
+ * @container: a #GtkContainer
+ * @child: a widget which is a child of @container
+ * @first_prop_name: the name of the first property to get
+ * @va_list: a %NULL-terminated list of property names and #GValue*, 
+ *           starting with @first_prop_name.
+ * 
+ * Gets the values of one or more child properties for @child and @container.
+ **/
 void
 gtk_container_child_get_valist (GtkContainer *container,
                                GtkWidget    *child,
@@ -394,6 +404,15 @@ gtk_container_child_get_valist (GtkContainer *container,
   g_object_unref (container);
 }
 
+/**
+ * gtk_container_child_get_property:
+ * @container: a #GtkContainer
+ * @child: a widget which is a child of @container
+ * @property_name: the name of the property to get
+ * @value: a location to return the value
+ * 
+ * Gets the value of a child property for @child and @container.
+ **/
 void
 gtk_container_child_get_property (GtkContainer *container,
                                  GtkWidget    *child,
@@ -459,6 +478,16 @@ gtk_container_child_get_property (GtkContainer *container,
   g_object_unref (container);
 }
 
+/**
+ * gtk_container_child_set_valist:
+ * @container: a #GtkContainer
+ * @child: a widget which is a child of @container
+ * @first_prop_name: the name of the first property to set
+ * @va_list: a %NULL-terminated list of property names and values, starting
+ *           with @first_prop_name.
+ * 
+ * Sets one or more child properties for @child and @container.
+ **/
 void
 gtk_container_child_set_valist (GtkContainer *container,
                                GtkWidget    *child,
@@ -525,6 +554,15 @@ gtk_container_child_set_valist (GtkContainer *container,
   g_object_unref (child);
 }
 
+/**
+ * gtk_container_child_set_property:
+ * @container: a #GtkContainer
+ * @child: a widget which is a child of @container
+ * @property_name: the name of the property to set
+ * @value: the value to set the property to
+ * 
+ * Sets a child property for @child and @container.
+ **/
 void
 gtk_container_child_set_property (GtkContainer *container,
                                  GtkWidget    *child,
@@ -567,6 +605,17 @@ gtk_container_child_set_property (GtkContainer *container,
   g_object_unref (child);
 }
 
+/**
+ * gtk_container_add_with_properties:
+ * @container: a #GtkContainer 
+ * @widget: a widget to be placed inside @container 
+ * @first_prop_name: the name of the first child property to set 
+ * @Varargs: a %NULL-terminated list of property names and values, starting
+ *           with @first_prop_name.
+ * 
+ * Adds @widget to @container, setting child properties at the same time.
+ * See gtk_container_add() and gtk_container_child_set() for more details.
+ **/
 void
 gtk_container_add_with_properties (GtkContainer *container,
                                   GtkWidget    *widget,
@@ -596,6 +645,16 @@ gtk_container_add_with_properties (GtkContainer *container,
   g_object_unref (container);
 }
 
+/**
+ * gtk_container_child_set:
+ * @container: a #GtkContainer
+ * @child: a widget which is a child of @container
+ * @first_prop_name: the name of the first property to set
+ * @Varargs: a %NULL-terminated list of property names and values, starting
+ *           with @first_prop_name.
+ * 
+ * Sets one or more child properties for @child and @container.
+ **/
 void
 gtk_container_child_set (GtkContainer      *container,
                         GtkWidget         *child,
@@ -613,6 +672,16 @@ gtk_container_child_set (GtkContainer      *container,
   va_end (var_args);
 }
 
+/**
+ * gtk_container_child_get:
+ * @container: a #GtkContainer
+ * @child: a widget which is a child of @container
+ * @first_prop_name: the name of the first property to get
+ * @Varargs: a %NULL-terminated list of property names and #GValue*, 
+ *           starting with @first_prop_name.
+ * 
+ * Gets the values of one or more child properties for @child and @container.
+ **/
 void
 gtk_container_child_get (GtkContainer      *container,
                         GtkWidget         *child,
@@ -630,6 +699,14 @@ gtk_container_child_get (GtkContainer      *container,
   va_end (var_args);
 }
 
+/**
+ * gtk_container_class_install_child_property:
+ * @cclass: a #GtkContainerClass
+ * @property_id: the id for the property
+ * @pspec: the #GParamSpec for the property
+ * 
+ * Installs a child property on a container class. 
+ **/
 void
 gtk_container_class_install_child_property (GtkContainerClass *cclass,
                                            guint              property_id,
@@ -685,7 +762,8 @@ gtk_container_class_find_child_property (GObjectClass *cclass,
  * gtk_container_class_list_child_properties:
  * @cclass: a #GtkContainerClass
  * @n_properties: location to return the number of child properties found
- * @returns: an newly allocated array of #GParamSpec*. The array must be freed with g_free().
+ * @returns: a newly allocated array of #GParamSpec*. The array must be 
+ *           freed with g_free().
  *
  * Returns all child properties of a container class.
  */
index f5d13a314d137838a1bd747f2ccfefac38477c5b..fc9f9b154078fbffeddd8a11ee7a2b7dc46478e1 100644 (file)
@@ -1487,6 +1487,14 @@ gtk_window_set_position (GtkWindow         *window,
   g_object_notify (G_OBJECT (window), "window_position");
 }
 
+/**
+ * gtk_window_activate_focus:
+ * @window: a #GtkWindow
+ * 
+ * Activates the current focused widget within the window.
+ * 
+ * Return value: %TRUE if a widget got activated.
+ **/
 gboolean 
 gtk_window_activate_focus (GtkWindow *window)
 {
@@ -1522,6 +1530,17 @@ gtk_window_get_focus (GtkWindow *window)
   return window->focus_widget;
 }
 
+/**
+ * gtk_window_activate_default:
+ * @window: a #GtkWindow
+ * 
+ * Activates the default widget for the window, unless the current 
+ * focused widget has been configured to receive the default action 
+ * (see #GTK_RECEIVES_DEFAULT in #GtkWidgetFlags), in which case the
+ * focused widget is activated. 
+ * 
+ * Return value: %TRUE if a widget got activated.
+ **/
 gboolean
 gtk_window_activate_default (GtkWindow *window)
 {