Add docs.

[~andy/gtk] / docs / reference / gtk / tmpl / gtkcontainer.sgml

diff --git a/docs/reference/gtk/tmpl/gtkcontainer.sgml b/docs/reference/gtk/tmpl/gtkcontainer.sgml
index 4fa9b0e086fb1220754875455d76510d9c43b0f9..c0ac78af81e3d5d98f1c3dddede421333f0b602a 100644 (file)
--- a/docs/reference/gtk/tmpl/gtkcontainer.sgml
+++ b/docs/reference/gtk/tmpl/gtkcontainer.sgml
@@ -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>
 
@@ -38,21 +54,24 @@ GtkContainer
 @pspec: 
 
 
-<!-- ##### MACRO GTK_HAVE_CONTAINER_FOCUS_ADJUSTMENTS ##### -->
+<!-- ##### MACRO gtk_container_border_width ##### -->
 <para>
-
+Does the same as gtk_container_get_border_width().
 </para>
 
+@Deprecated: Use gtk_container_get_border_width() instead.
 
 
-<!-- ##### MACRO gtk_container_border_width ##### -->
+<!-- ##### FUNCTION gtk_container_add ##### -->
 <para>
 
 </para>
 
+@container: 
+@widget: 
 
 
-<!-- ##### FUNCTION gtk_container_add ##### -->
+<!-- ##### FUNCTION gtk_container_remove ##### -->
 <para>
 
 </para>
@@ -61,13 +80,24 @@ GtkContainer
 @widget: 
 
 
-<!-- ##### FUNCTION gtk_container_remove ##### -->
+<!-- ##### FUNCTION gtk_container_add_with_properties ##### -->
 <para>
 
 </para>
 
 @container: 
 @widget: 
+@first_prop_name: 
+@Varargs: 
+
+
+<!-- ##### FUNCTION gtk_container_get_resize_mode ##### -->
+<para>
+
+</para>
+
+@container: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gtk_container_set_resize_mode ##### -->
@@ -107,16 +137,25 @@ GtkContainer
 @marshal: 
 @callback_data: 
 @notify: 
+@Deprecated: Use gtk_container_foreach() instead.
 
 
 <!-- ##### MACRO gtk_container_children ##### -->
 <para>
-
+Does the same as gtk_container_get_children().
 </para>
 
 @Returns: 
-<!-- # Unused Parameters # -->
+@Deprecated: Use gtk_container_get_children() instead.
+
+
+<!-- ##### FUNCTION gtk_container_get_children ##### -->
+<para>
+
+</para>
+
 @container: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gtk_container_set_reallocate_redraws ##### -->
@@ -137,6 +176,15 @@ GtkContainer
 @child: 
 
 
+<!-- ##### FUNCTION gtk_container_get_focus_vadjustment ##### -->
+<para>
+
+</para>
+
+@container: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gtk_container_set_focus_vadjustment ##### -->
 <para>
 
@@ -146,6 +194,15 @@ GtkContainer
 @adjustment: 
 
 
+<!-- ##### FUNCTION gtk_container_get_focus_hadjustment ##### -->
+<para>
+
+</para>
+
+@container: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gtk_container_set_focus_hadjustment ##### -->
 <para>
 
@@ -172,6 +229,17 @@ GtkContainer
 @Returns: 
 
 
+<!-- ##### FUNCTION gtk_container_child_get ##### -->
+<para>
+
+</para>
+
+@container: 
+@child: 
+@first_prop_name: 
+@Varargs: 
+
+
 <!-- ##### FUNCTION gtk_container_child_set ##### -->
 <para>
 
@@ -185,20 +253,48 @@ GtkContainer
 @first_arg_name: 
 
 
-<!-- ##### FUNCTION gtk_container_queue_resize ##### -->
+<!-- ##### FUNCTION gtk_container_child_get_property ##### -->
 <para>
 
 </para>
 
 @container: 
+@child: 
+@property_name: 
+@value: 
 
 
-<!-- ##### FUNCTION gtk_container_clear_resize_widgets ##### -->
+<!-- ##### FUNCTION gtk_container_child_set_property ##### -->
 <para>
 
 </para>
 
 @container: 
+@child: 
+@property_name: 
+@value: 
+
+
+<!-- ##### FUNCTION gtk_container_child_get_valist ##### -->
+<para>
+
+</para>
+
+@container: 
+@child: 
+@first_property_name: 
+@var_args: 
+
+
+<!-- ##### FUNCTION gtk_container_child_set_valist ##### -->
+<para>
+
+</para>
+
+@container: 
+@child: 
+@first_property_name: 
+@var_args: 
 
 
 <!-- ##### FUNCTION gtk_container_forall ##### -->
@@ -211,13 +307,12 @@ GtkContainer
 @callback_data: 
 
 
-<!-- ##### FUNCTION gtk_container_child_composite_name ##### -->
+<!-- ##### FUNCTION gtk_container_get_border_width ##### -->
 <para>
 
 </para>
 
 @container: 
-@child: 
 @Returns: 
 
 
@@ -240,6 +335,16 @@ GtkContainer
 @event: 
 
 
+<!-- ##### FUNCTION gtk_container_get_focus_chain ##### -->
+<para>
+
+</para>
+
+@container: 
+@focusable_widgets: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gtk_container_set_focus_chain ##### -->
 <para>
 
@@ -257,6 +362,42 @@ GtkContainer
 @container: 
 
 
+<!-- ##### FUNCTION gtk_container_class_find_child_property ##### -->
+<para>
+
+</para>
+
+@cclass: 
+@property_name: 
+@Returns: 
+<!-- # Unused Parameters # -->
+@class: 
+
+
+<!-- ##### FUNCTION gtk_container_class_install_child_property ##### -->
+<para>
+
+</para>
+
+@cclass: 
+@property_id: 
+@pspec: 
+<!-- # Unused Parameters # -->
+@class: 
+
+
+<!-- ##### FUNCTION gtk_container_class_list_child_properties ##### -->
+<para>
+
+</para>
+
+@cclass: 
+@n_properties: 
+@Returns: 
+<!-- # Unused Parameters # -->
+@class: 
+
+
 <!-- ##### SIGNAL GtkContainer::add ##### -->
 <para>
 
@@ -293,12 +434,12 @@ GtkContainer
 
 </para>
 
-<!-- ##### ARG GtkContainer:resize-mode ##### -->
+<!-- ##### ARG GtkContainer:child ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG GtkContainer:child ##### -->
+<!-- ##### ARG GtkContainer:resize-mode ##### -->
 <para>
 
 </para>