From 36c3eaea8142b4ee8c6c7d1ff3a4e1a9eb836719 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sun, 25 Apr 2010 17:32:44 -0400 Subject: [PATCH] Refer to GtkExtendedLayout from the container docs --- docs/reference/gtk/tmpl/gtkcontainer.sgml | 295 +++++++++++----------- 1 file changed, 151 insertions(+), 144 deletions(-) diff --git a/docs/reference/gtk/tmpl/gtkcontainer.sgml b/docs/reference/gtk/tmpl/gtkcontainer.sgml index 7d28b5bc35..2e5691161d 100644 --- a/docs/reference/gtk/tmpl/gtkcontainer.sgml +++ b/docs/reference/gtk/tmpl/gtkcontainer.sgml @@ -6,100 +6,107 @@ Base class for widgets which contain other widgets -A GTK+ user interface is constructed by nesting widgets inside widgets. -Container widgets are the inner nodes in the resulting tree of widgets: -they contain other widgets. So, for example, you might have a #GtkWindow -containing a #GtkFrame containing a GtkLabel. If you wanted an image instead -of a textual label inside the frame, you might replace the #GtkLabel widget +A GTK+ user interface is constructed by nesting widgets inside widgets. +Container widgets are the inner nodes in the resulting tree of widgets: +they contain other widgets. So, for example, you might have a #GtkWindow +containing a #GtkFrame containing a GtkLabel. If you wanted an image instead +of a textual label inside the frame, you might replace the #GtkLabel widget with a #GtkImage widget. -There are two major kinds of container widgets in GTK+. Both are subclasses +There are two major kinds of container widgets in GTK+. Both are subclasses of the abstract #GtkContainer base class. -The first type of container widget has a single child widget and derives -from #GtkBin. These containers are decorators, which -add some kind of functionality to the child. For example, a #GtkButton makes -its child into a clickable button; a #GtkFrame draws a frame around its child +The first type of container widget has a single child widget and derives +from #GtkBin. These containers are decorators, which +add some kind of functionality to the child. For example, a #GtkButton makes +its child into a clickable button; a #GtkFrame draws a frame around its child and a #GtkWindow places its child widget inside a top-level window. -The second type of container can have more than one child; its purpose is to -manage layout. This means that these containers assign -sizes and positions to their children. For example, a #GtkHBox arranges its -children in a horizontal row, and a #GtkTable arranges the widgets it contains -in a two-dimensional grid. +The second type of container can have more than one child; its purpose is to +manage layout. This means that these containers assign +sizes and positions to their children. For example, a #GtkHBox arranges its +children in a horizontal row, and a #GtkTable arranges the widgets it contains +in a two-dimensional grid. -To fulfill its task, a layout container must negotiate the size requirements -with its parent and its children. This negotiation is carried out in two -phases, size requisition and size -allocation. +To fulfill its task, a layout container must negotiate the size requirements +with its parent and its children. The basic form of this negotiation is +carried out in two phases, size requisition and +size allocation, which are implemented by the +size_request() and size_allocate() virtual functions in #GtkWidget. + + +GTK+ also supports a more complicated form of size negotiation called +width-for-height (and its dual +height-for-width). See #GtkExtendedLayout +to learn more about width-for-height geometry management. Size Requisition -The size requisition of a widget is it's desired width and height. +The size requisition of a widget is it's desired width and height. This is represented by a #GtkRequisition. -How a widget determines its desired size depends on the widget. -A #GtkLabel, for example, requests enough space to display all its text. -Container widgets generally base their size request on the requisitions -of their children. +How a widget determines its desired size depends on the widget. +A #GtkLabel, for example, requests enough space to display all its text. +Container widgets generally base their size request on the requisitions +of their children. -The size requisition phase of the widget layout process operates top-down. -It starts at a top-level widget, typically a #GtkWindow. The top-level widget -asks its child for its size requisition by calling gtk_widget_size_request(). -To determine its requisition, the child asks its own children for their -requisitions and so on. Finally, the top-level widget will get a requisition -back from its child. +The size requisition phase of the widget layout process operates top-down. +It starts at a top-level widget, typically a #GtkWindow. The top-level widget +asks its child for its size requisition by calling gtk_widget_size_request(). +To determine its requisition, the child asks its own children for their +requisitions and so on. Finally, the top-level widget will get a requisition +back from its child. Size Allocation -When the top-level widget has determined how much space its child would like -to have, the second phase of the size negotiation, size allocation, begins. -Depending on its configuration (see gtk_window_set_resizable()), the top-level -widget may be able to expand in order to satisfy the size request or it may -have to ignore the size request and keep its fixed size. It then tells its -child widget how much space it gets by calling gtk_widget_size_allocate(). -The child widget divides the space among its children and tells each child -how much space it got, and so on. Under normal circumstances, a #GtkWindow +When the top-level widget has determined how much space its child would like +to have, the second phase of the size negotiation, size allocation, begins. +Depending on its configuration (see gtk_window_set_resizable()), the top-level +widget may be able to expand in order to satisfy the size request or it may +have to ignore the size request and keep its fixed size. It then tells its +child widget how much space it gets by calling gtk_widget_size_allocate(). +The child widget divides the space among its children and tells each child +how much space it got, and so on. Under normal circumstances, a #GtkWindow will always give its child the amount of space the child requested. -A child's size allocation is represented by a #GtkAllocation. This struct -contains not only a width and height, but also a position (i.e. X and Y +A child's size allocation is represented by a #GtkAllocation. This struct +contains not only a width and height, but also a position (i.e. X and Y coordinates), so that containers can tell their children not only how much -space they have gotten, but also where they are positioned inside the space -available to the container. +space they have gotten, but also where they are positioned inside the space +available to the container. -Widgets are required to honor the size allocation they receive; a size +Widgets are required to honor the size allocation they receive; a size request is only a request, and widgets must be able to cope with any size. Child properties -GtkContainer introduces child +GtkContainer introduces child properties - 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. -Use gtk_container_class_install_child_property() to install child properties +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. -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 +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 +gtk_container_child_get_valist(). To emit notification about child property changes, use gtk_widget_child_notify(). @@ -107,7 +114,7 @@ changes, use gtk_widget_child_notify(). GtkContainer as GtkBuildable -The GtkContainer implementation of the GtkBuildable interface +The GtkContainer implementation of the GtkBuildable interface supports a <packing> element for children, which can contain multiple <property> elements that specify child properties for the child. @@ -152,7 +159,7 @@ for regular properties. @container: the object which received the signal. -@widget: +@widget: @@ -167,7 +174,7 @@ for regular properties. @container: the object which received the signal. -@widget: +@widget: @@ -175,7 +182,7 @@ for regular properties. @container: the object which received the signal. -@widget: +@widget: @@ -197,7 +204,7 @@ for regular properties. -@widget: +@widget: @@ -206,7 +213,7 @@ This macro should be used to emit a standard warning about unexpected properties in set_child_property() and get_child_property() implementations. -@object: the #GObject on which set_child_property() or get_child_property() +@object: the #GObject on which set_child_property() or get_child_property() was called @property_id: the numeric id of the property @pspec: the #GParamSpec of the property @@ -225,8 +232,8 @@ Does the same as gtk_container_set_border_width(). -@container: -@widget: +@container: +@widget: @@ -234,8 +241,8 @@ Does the same as gtk_container_set_border_width(). -@container: -@widget: +@container: +@widget: @@ -243,10 +250,10 @@ Does the same as gtk_container_set_border_width(). -@container: -@widget: -@first_prop_name: -@Varargs: +@container: +@widget: +@first_prop_name: +@Varargs: @@ -254,8 +261,8 @@ Does the same as gtk_container_set_border_width(). -@container: -@Returns: +@container: +@Returns: @@ -263,8 +270,8 @@ Does the same as gtk_container_set_border_width(). -@container: -@resize_mode: +@container: +@resize_mode: @@ -272,7 +279,7 @@ Does the same as gtk_container_set_border_width(). -@container: +@container: @@ -280,9 +287,9 @@ Does the same as gtk_container_set_border_width(). -@container: -@callback: -@callback_data: +@container: +@callback: +@callback_data: @@ -290,11 +297,11 @@ Does the same as gtk_container_set_border_width(). -@container: -@callback: -@marshal: -@callback_data: -@notify: +@container: +@callback: +@marshal: +@callback_data: +@notify: @Deprecated: Use gtk_container_foreach() instead. @@ -311,8 +318,8 @@ Does the same as gtk_container_get_children(). -@container: -@Returns: +@container: +@Returns: @@ -320,8 +327,8 @@ Does the same as gtk_container_get_children(). -@container: -@needs_redraws: +@container: +@needs_redraws: @@ -329,8 +336,8 @@ Does the same as gtk_container_get_children(). -@container: -@Returns: +@container: +@Returns: @@ -338,8 +345,8 @@ Does the same as gtk_container_get_children(). -@container: -@child: +@container: +@child: @@ -347,8 +354,8 @@ Does the same as gtk_container_get_children(). -@container: -@Returns: +@container: +@Returns: @@ -356,8 +363,8 @@ Does the same as gtk_container_get_children(). -@container: -@adjustment: +@container: +@adjustment: @@ -365,8 +372,8 @@ Does the same as gtk_container_get_children(). -@container: -@Returns: +@container: +@Returns: @@ -374,8 +381,8 @@ Does the same as gtk_container_get_children(). -@container: -@adjustment: +@container: +@adjustment: @@ -383,7 +390,7 @@ Does the same as gtk_container_get_children(). -@container: +@container: @@ -391,8 +398,8 @@ Does the same as gtk_container_get_children(). -@container: -@Returns: +@container: +@Returns: @@ -400,10 +407,10 @@ Does the same as gtk_container_get_children(). -@container: -@child: -@first_prop_name: -@Varargs: +@container: +@child: +@first_prop_name: +@Varargs: @@ -411,10 +418,10 @@ Does the same as gtk_container_get_children(). -@container: -@child: -@first_prop_name: -@Varargs: +@container: +@child: +@first_prop_name: +@Varargs: @@ -422,10 +429,10 @@ Does the same as gtk_container_get_children(). -@container: -@child: -@property_name: -@value: +@container: +@child: +@property_name: +@value: @@ -433,10 +440,10 @@ Does the same as gtk_container_get_children(). -@container: -@child: -@property_name: -@value: +@container: +@child: +@property_name: +@value: @@ -444,10 +451,10 @@ Does the same as gtk_container_get_children(). -@container: -@child: -@first_property_name: -@var_args: +@container: +@child: +@first_property_name: +@var_args: @@ -455,10 +462,10 @@ Does the same as gtk_container_get_children(). -@container: -@child: -@first_property_name: -@var_args: +@container: +@child: +@first_property_name: +@var_args: @@ -466,9 +473,9 @@ Does the same as gtk_container_get_children(). -@container: -@callback: -@callback_data: +@container: +@callback: +@callback_data: @@ -476,8 +483,8 @@ Does the same as gtk_container_get_children(). -@container: -@Returns: +@container: +@Returns: @@ -485,8 +492,8 @@ Does the same as gtk_container_get_children(). -@container: -@border_width: +@container: +@border_width: @@ -494,9 +501,9 @@ Does the same as gtk_container_get_children(). -@container: -@child: -@event: +@container: +@child: +@event: @@ -504,9 +511,9 @@ Does the same as gtk_container_get_children(). -@container: -@focusable_widgets: -@Returns: +@container: +@focusable_widgets: +@Returns: @@ -514,8 +521,8 @@ Does the same as gtk_container_get_children(). -@container: -@focusable_widgets: +@container: +@focusable_widgets: @@ -523,7 +530,7 @@ Does the same as gtk_container_get_children(). -@container: +@container: @@ -531,9 +538,9 @@ Does the same as gtk_container_get_children(). -@cclass: -@property_name: -@Returns: +@cclass: +@property_name: +@Returns: @@ -541,9 +548,9 @@ Does the same as gtk_container_get_children(). -@cclass: -@property_id: -@pspec: +@cclass: +@property_id: +@pspec: @@ -551,8 +558,8 @@ Does the same as gtk_container_get_children(). -@cclass: -@n_properties: -@Returns: +@cclass: +@n_properties: +@Returns: