diff --git a/docs/reference/gtk/tmpl/gtkalignment.sgml b/docs/reference/gtk/tmpl/gtkalignment.sgml deleted file mode 100644 index 142c728964..0000000000 --- a/docs/reference/gtk/tmpl/gtkalignment.sgml +++ /dev/null @@ -1,141 +0,0 @@ - -GtkAlignment - - -A widget which controls the alignment and size of its child - - - -The #GtkAlignment widget controls the alignment and size of its child widget. -It has four settings: xscale, yscale, xalign, and yalign. - - -The scale settings are used to specify how much the child widget should -expand to fill the space allocated to the #GtkAlignment. -The values can range from 0 (meaning the child doesn't expand at all) to -1 (meaning the child expands to fill all of the available space). - - -The align settings are used to place the child widget within the available -area. The values range from 0 (top or left) to 1 (bottom or right). -Of course, if the scale settings are both set to 1, the alignment settings -have no effect. - - - - - - - - - - - - -The #GtkAlignment-struct struct contains private data only, and should -be accessed using the functions below. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Creates a new #GtkAlignment. - - -@xalign: the horizontal alignment of the child widget, from 0 (left) to 1 -(right). -@yalign: the vertical alignment of the child widget, from 0 (top) to 1 -(bottom). -@xscale: the amount that the child widget expands horizontally to fill up -unused space, from 0 to 1. -A value of 0 indicates that the child widget should never expand. -A value of 1 indicates that the child widget will expand to fill all of the -space allocated for the #GtkAlignment. -@yscale: the amount that the child widget expands vertically to fill up -unused space, from 0 to 1. The values are similar to @xscale. -@Returns: the new #GtkAlignment. - - - - -Sets the #GtkAlignment values. - - -@alignment: a #GtkAlignment. -@xalign: the horizontal alignment of the child widget, from 0 (left) to 1 -(right). -@yalign: the vertical alignment of the child widget, from 0 (top) to 1 -(bottom). -@xscale: the amount that the child widget expands horizontally to fill up -unused space, from 0 to 1. -A value of 0 indicates that the child widget should never expand. -A value of 1 indicates that the child widget will expand to fill all of the -space allocated for the #GtkAlignment. -@yscale: the amount that the child widget expands vertically to fill up -unused space, from 0 to 1. The values are similar to @xscale. - - - - - - - -@alignment: -@padding_top: -@padding_bottom: -@padding_left: -@padding_right: - - - - - - - -@alignment: -@padding_top: -@padding_bottom: -@padding_left: -@padding_right: - - diff --git a/gtk/gtkalignment.c b/gtk/gtkalignment.c index 2552c57567..ad741751e2 100644 --- a/gtk/gtkalignment.c +++ b/gtk/gtkalignment.c @@ -24,6 +24,25 @@ * GTK+ at ftp://ftp.gtk.org/pub/gtk/. */ +/** + * SECTION:gtkalignment + * @Short_description: A widget which controls the alignment and size of its child + * @Title: GtkAlignment + * + * The #GtkAlignment widget controls the alignment and size of its child widget. + * It has four settings: xscale, yscale, xalign, and yalign. + * + * The scale settings are used to specify how much the child widget should + * expand to fill the space allocated to the #GtkAlignment. + * The values can range from 0 (meaning the child doesn't expand at all) to + * 1 (meaning the child expands to fill all of the available space). + * + * The align settings are used to place the child widget within the available + * area. The values range from 0 (top or left) to 1 (bottom or right). + * Of course, if the scale settings are both set to 1, the alignment settings + * have no effect. + */ + #include "config.h" #include "gtkalignment.h" #include "gtkprivate.h" @@ -215,6 +234,24 @@ gtk_alignment_init (GtkAlignment *alignment) priv->padding_right = 0; } +/** + * gtk_alignment_new: + * @xalign: the horizontal alignment of the child widget, from 0 (left) to 1 + * (right). + * @yalign: the vertical alignment of the child widget, from 0 (top) to 1 + * (bottom). + * @xscale: the amount that the child widget expands horizontally to fill up + * unused space, from 0 to 1. + * A value of 0 indicates that the child widget should never expand. + * A value of 1 indicates that the child widget will expand to fill all of the + * space allocated for the #GtkAlignment. + * @yscale: the amount that the child widget expands vertically to fill up + * unused space, from 0 to 1. The values are similar to @xscale. + * + * Creates a new #GtkAlignment. + * + * Returns: the new #GtkAlignment. + */ GtkWidget* gtk_alignment_new (gfloat xalign, gfloat yalign, @@ -359,6 +396,23 @@ gtk_alignment_get_property (GObject *object, } } +/** + * gtk_alignment_set: + * @alignment: a #GtkAlignment. + * @xalign: the horizontal alignment of the child widget, from 0 (left) to 1 + * (right). + * @yalign: the vertical alignment of the child widget, from 0 (top) to 1 + * (bottom). + * @xscale: the amount that the child widget expands horizontally to fill up + * unused space, from 0 to 1. + * A value of 0 indicates that the child widget should never expand. + * A value of 1 indicates that the child widget will expand to fill all of the + * space allocated for the #GtkAlignment. + * @yscale: the amount that the child widget expands vertically to fill up + * unused space, from 0 to 1. The values are similar to @xscale. + * + * Sets the #GtkAlignment values. + */ void gtk_alignment_set (GtkAlignment *alignment, gfloat xalign,