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 3786dce30c8ba5bc01f35320a27c4d89b65655d4..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>
 
@@ -19,12 +35,6 @@ GtkContainer
 
 </para>
 
-@widget: 
-@focus_child: 
-@border_width: 
-@need_resize: 
-@resize_mode: 
-@resize_widgets: 
 
 <!-- ##### MACRO GTK_IS_RESIZE_CONTAINER ##### -->
 <para>
@@ -34,11 +44,22 @@ GtkContainer
 @widget: 
 
 
-<!-- ##### MACRO gtk_container_border_width ##### -->
+<!-- ##### MACRO GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID ##### -->
 <para>
 
 </para>
 
+@object: 
+@property_id: 
+@pspec: 
+
+
+<!-- ##### MACRO gtk_container_border_width ##### -->
+<para>
+Does the same as gtk_container_get_border_width().
+</para>
+
+@Deprecated: Use gtk_container_get_border_width() instead.
 
 
 <!-- ##### FUNCTION gtk_container_add ##### -->
@@ -59,6 +80,26 @@ GtkContainer
 @widget: 
 
 
+<!-- ##### 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 ##### -->
 <para>
 
@@ -96,9 +137,19 @@ GtkContainer
 @marshal: 
 @callback_data: 
 @notify: 
+@Deprecated: Use gtk_container_foreach() instead.
 
 
-<!-- ##### FUNCTION gtk_container_children ##### -->
+<!-- ##### MACRO gtk_container_children ##### -->
+<para>
+Does the same as gtk_container_get_children().
+</para>
+
+@Returns: 
+@Deprecated: Use gtk_container_get_children() instead.
+
+
+<!-- ##### FUNCTION gtk_container_get_children ##### -->
 <para>
 
 </para>
@@ -107,14 +158,13 @@ GtkContainer
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_container_focus ##### -->
+<!-- ##### FUNCTION gtk_container_set_reallocate_redraws ##### -->
 <para>
 
 </para>
 
 @container: 
-@direction: 
-@Returns: 
+@needs_redraws: 
 
 
 <!-- ##### FUNCTION gtk_container_set_focus_child ##### -->
@@ -126,16 +176,16 @@ GtkContainer
 @child: 
 
 
-<!-- ##### FUNCTION gtk_container_set_focus_vadjustment ##### -->
+<!-- ##### FUNCTION gtk_container_get_focus_vadjustment ##### -->
 <para>
 
 </para>
 
 @container: 
-@adjustment: 
+@Returns: 
 
 
-<!-- ##### FUNCTION gtk_container_set_focus_hadjustment ##### -->
+<!-- ##### FUNCTION gtk_container_set_focus_vadjustment ##### -->
 <para>
 
 </para>
@@ -144,20 +194,22 @@ GtkContainer
 @adjustment: 
 
 
-<!-- ##### FUNCTION gtk_container_register_toplevel ##### -->
+<!-- ##### FUNCTION gtk_container_get_focus_hadjustment ##### -->
 <para>
 
 </para>
 
 @container: 
+@Returns: 
 
 
-<!-- ##### FUNCTION gtk_container_unregister_toplevel ##### -->
+<!-- ##### FUNCTION gtk_container_set_focus_hadjustment ##### -->
 <para>
 
 </para>
 
 @container: 
+@adjustment: 
 
 
 <!-- ##### FUNCTION gtk_container_resize_children ##### -->
@@ -177,180 +229,173 @@ GtkContainer
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_container_add_child_arg_type ##### -->
-<para>
-
-</para>
-
-@arg_name: 
-@arg_type: 
-@arg_flags: 
-@arg_id: 
-
-
-<!-- ##### FUNCTION gtk_container_query_child_args ##### -->
+<!-- ##### FUNCTION gtk_container_child_get ##### -->
 <para>
 
 </para>
 
-@class_type: 
-@arg_flags: 
-@nargs: 
-@Returns: 
+@container: 
+@child: 
+@first_prop_name: 
+@Varargs: 
 
 
-<!-- ##### FUNCTION gtk_container_child_getv ##### -->
+<!-- ##### FUNCTION gtk_container_child_set ##### -->
 <para>
 
 </para>
 
 @container: 
 @child: 
-@n_args: 
-@args: 
+@first_prop_name: 
+@Varargs: 
+<!-- # Unused Parameters # -->
+@first_arg_name: 
 
 
-<!-- ##### FUNCTION gtk_container_child_setv ##### -->
+<!-- ##### FUNCTION gtk_container_child_get_property ##### -->
 <para>
 
 </para>
 
 @container: 
 @child: 
-@n_args: 
-@args: 
+@property_name: 
+@value: 
 
 
-<!-- ##### FUNCTION gtk_container_add_with_args ##### -->
+<!-- ##### FUNCTION gtk_container_child_set_property ##### -->
 <para>
 
 </para>
 
 @container: 
-@widget: 
-@first_arg_name: 
-@Varargs: 
+@child: 
+@property_name: 
+@value: 
 
 
-<!-- ##### FUNCTION gtk_container_addv ##### -->
+<!-- ##### FUNCTION gtk_container_child_get_valist ##### -->
 <para>
 
 </para>
 
 @container: 
-@widget: 
-@n_args: 
-@args: 
+@child: 
+@first_property_name: 
+@var_args: 
 
 
-<!-- ##### FUNCTION gtk_container_child_set ##### -->
+<!-- ##### FUNCTION gtk_container_child_set_valist ##### -->
 <para>
 
 </para>
 
 @container: 
 @child: 
-@first_arg_name: 
-@Varargs: 
+@first_property_name: 
+@var_args: 
 
 
-<!-- ##### FUNCTION gtk_container_queue_resize ##### -->
+<!-- ##### FUNCTION gtk_container_forall ##### -->
 <para>
 
 </para>
 
 @container: 
+@callback: 
+@callback_data: 
 
 
-<!-- ##### FUNCTION gtk_container_clear_resize_widgets ##### -->
+<!-- ##### FUNCTION gtk_container_get_border_width ##### -->
 <para>
 
 </para>
 
 @container: 
+@Returns: 
 
 
-<!-- ##### FUNCTION gtk_container_arg_set ##### -->
+<!-- ##### FUNCTION gtk_container_set_border_width ##### -->
 <para>
 
 </para>
 
 @container: 
-@child: 
-@arg: 
-@info: 
+@border_width: 
 
 
-<!-- ##### FUNCTION gtk_container_arg_get ##### -->
+<!-- ##### FUNCTION gtk_container_propagate_expose ##### -->
 <para>
 
 </para>
 
 @container: 
 @child: 
-@arg: 
-@info: 
+@event: 
 
 
-<!-- ##### FUNCTION gtk_container_child_args_collect ##### -->
+<!-- ##### FUNCTION gtk_container_get_focus_chain ##### -->
 <para>
 
 </para>
 
-@object_type: 
-@arg_list_p: 
-@info_list_p: 
-@first_arg_name: 
-@args: 
+@container: 
+@focusable_widgets: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_container_child_arg_get_info ##### -->
+<!-- ##### FUNCTION gtk_container_set_focus_chain ##### -->
 <para>
 
 </para>
 
-@object_type: 
-@arg_name: 
-@info_p: 
-@Returns: 
+@container: 
+@focusable_widgets: 
 
 
-<!-- ##### FUNCTION gtk_container_forall ##### -->
+<!-- ##### FUNCTION gtk_container_unset_focus_chain ##### -->
 <para>
 
 </para>
 
 @container: 
-@callback: 
-@callback_data: 
 
 
-<!-- ##### FUNCTION gtk_container_child_composite_name ##### -->
+<!-- ##### FUNCTION gtk_container_class_find_child_property ##### -->
 <para>
 
 </para>
 
-@container: 
-@child: 
+@cclass: 
+@property_name: 
 @Returns: 
+<!-- # Unused Parameters # -->
+@class: 
 
 
-<!-- ##### FUNCTION gtk_container_get_toplevels ##### -->
+<!-- ##### FUNCTION gtk_container_class_install_child_property ##### -->
 <para>
 
 </para>
 
-@Returns: 
+@cclass: 
+@property_id: 
+@pspec: 
+<!-- # Unused Parameters # -->
+@class: 
 
 
-<!-- ##### FUNCTION gtk_container_set_border_width ##### -->
+<!-- ##### FUNCTION gtk_container_class_list_child_properties ##### -->
 <para>
 
 </para>
 
-@container: 
-@border_width: 
+@cclass: 
+@n_properties: 
+@Returns: 
+<!-- # Unused Parameters # -->
+@class: 
 
 
 <!-- ##### SIGNAL GtkContainer::add ##### -->
@@ -361,14 +406,6 @@ GtkContainer
 @container: the object which received the signal.
 @widget: 
 
-<!-- ##### SIGNAL GtkContainer::remove ##### -->
-<para>
-
-</para>
-
-@container: the object which received the signal.
-@widget: 
-
 <!-- ##### SIGNAL GtkContainer::check-resize ##### -->
 <para>
 
@@ -376,14 +413,13 @@ GtkContainer
 
 @container: the object which received the signal.
 
-<!-- ##### SIGNAL GtkContainer::focus ##### -->
+<!-- ##### SIGNAL GtkContainer::remove ##### -->
 <para>
 
 </para>
 
 @container: the object which received the signal.
-@direction: 
-@Returns: 
+@widget: 
 
 <!-- ##### SIGNAL GtkContainer::set-focus-child ##### -->
 <para>
@@ -393,17 +429,17 @@ GtkContainer
 @container: the object which received the signal.
 @widget: 
 
-<!-- ##### ARG GtkContainer:border_width ##### -->
+<!-- ##### ARG GtkContainer:border-width ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG GtkContainer:resize_mode ##### -->
+<!-- ##### ARG GtkContainer:child ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG GtkContainer:child ##### -->
+<!-- ##### ARG GtkContainer:resize-mode ##### -->
 <para>
 
 </para>