]> Pileus Git - ~andy/gtk/blobdiff - docs/reference/gtk/tmpl/gtkcontainer.sgml
Add docs.
[~andy/gtk] / docs / reference / gtk / tmpl / gtkcontainer.sgml
index de1877ace7515c1fb23c16150ebeb06869c4feff..c0ac78af81e3d5d98f1c3dddede421333f0b602a 100644 (file)
@@ -2,13 +2,29 @@
 GtkContainer
 
 <!-- ##### SECTION Short_Description ##### -->
-
+Base class for widgets which contain other widgets
 
 <!-- ##### SECTION Long_Description ##### -->
-<para>
-
+<para id="child-properties">
+<structname>GtkContainer</structname> introduces <firstterm>child 
+properties</firstterm> - these are object properties that are not specific
+to either the container or the contained widget, but rather to their relation.
+Typical examples of child properties are the position or pack-type of a widget
+which is contained in a #GtkBox.</para>
+<para>
+Use gtk_container_class_install_child_property() to install child properties 
+for a container class and gtk_container_class_find_child_property() or
+gtk_container_class_list_child_properties() to get information about existing
+child properties.
+</para>
+<para>
+To set the value of a child property, use gtk_container_child_set_property(), 
+gtk_container_child_set() or gtk_container_child_set_valist(). 
+To obtain the value of a child property, use 
+gtk_container_child_get_property(), gtk_container_child_get() or
+gtk_container_child_get_valist(). To emit notification about child property 
+changes, use gtk_widget_child_notify().
 </para>
-
 <!-- ##### SECTION See_Also ##### -->
 <para>
 
@@ -43,6 +59,7 @@ GtkContainer
 Does the same as gtk_container_get_border_width().
 </para>
 
+@Deprecated: Use gtk_container_get_border_width() instead.
 
 
 <!-- ##### FUNCTION gtk_container_add ##### -->
@@ -120,6 +137,7 @@ Does the same as gtk_container_get_border_width().
 @marshal: 
 @callback_data: 
 @notify: 
+@Deprecated: Use gtk_container_foreach() instead.
 
 
 <!-- ##### MACRO gtk_container_children ##### -->
@@ -128,8 +146,7 @@ Does the same as gtk_container_get_children().
 </para>
 
 @Returns: 
-<!-- # Unused Parameters # -->
-@container: 
+@Deprecated: Use gtk_container_get_children() instead.
 
 
 <!-- ##### FUNCTION gtk_container_get_children ##### -->
@@ -353,6 +370,8 @@ Does the same as gtk_container_get_children().
 @cclass: 
 @property_name: 
 @Returns: 
+<!-- # Unused Parameters # -->
+@class: 
 
 
 <!-- ##### FUNCTION gtk_container_class_install_child_property ##### -->
@@ -363,6 +382,8 @@ Does the same as gtk_container_get_children().
 @cclass: 
 @property_id: 
 @pspec: 
+<!-- # Unused Parameters # -->
+@class: 
 
 
 <!-- ##### FUNCTION gtk_container_class_list_child_properties ##### -->
@@ -373,6 +394,8 @@ Does the same as gtk_container_get_children().
 @cclass: 
 @n_properties: 
 @Returns: 
+<!-- # Unused Parameters # -->
+@class: 
 
 
 <!-- ##### SIGNAL GtkContainer::add ##### -->
@@ -411,12 +434,12 @@ Does the same as gtk_container_get_children().
 
 </para>
 
-<!-- ##### ARG GtkContainer:resize-mode ##### -->
+<!-- ##### ARG GtkContainer:child ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG GtkContainer:child ##### -->
+<!-- ##### ARG GtkContainer:resize-mode ##### -->
 <para>
 
 </para>