Commit b802be45 authored by Tadej Borovšak's avatar Tadej Borovšak Committed by Javier Jardón

[docs] Move documentation to inline comments: GtkAlignment.

Fixes https://bugzilla.gnome.org/show_bug.cgi?id=611956Signed-off-by: default avatarJavier Jardón <jjardon@gnome.org>
parent b6a61425
<!-- ##### SECTION Title ##### -->
GtkAlignment
<!-- ##### SECTION Short_Description ##### -->
A widget which controls the alignment and size of its child
<!-- ##### SECTION Long_Description ##### -->
<para>
The #GtkAlignment widget controls the alignment and size of its child widget.
It has four settings: xscale, yscale, xalign, and yalign.
</para>
<para>
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).
</para>
<para>
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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GtkAlignment ##### -->
<para>
The #GtkAlignment-struct struct contains private data only, and should
be accessed using the functions below.
</para>
<!-- ##### ARG GtkAlignment:bottom-padding ##### -->
<para>
</para>
<!-- ##### ARG GtkAlignment:left-padding ##### -->
<para>
</para>
<!-- ##### ARG GtkAlignment:right-padding ##### -->
<para>
</para>
<!-- ##### ARG GtkAlignment:top-padding ##### -->
<para>
</para>
<!-- ##### ARG GtkAlignment:xalign ##### -->
<para>
</para>
<!-- ##### ARG GtkAlignment:xscale ##### -->
<para>
</para>
<!-- ##### ARG GtkAlignment:yalign ##### -->
<para>
</para>
<!-- ##### ARG GtkAlignment:yscale ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_alignment_new ##### -->
<para>
Creates a new #GtkAlignment.
</para>
@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.
<!-- ##### FUNCTION gtk_alignment_set ##### -->
<para>
Sets the #GtkAlignment values.
</para>
@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.
<!-- ##### FUNCTION gtk_alignment_get_padding ##### -->
<para>
</para>
@alignment:
@padding_top:
@padding_bottom:
@padding_left:
@padding_right:
<!-- ##### FUNCTION gtk_alignment_set_padding ##### -->
<para>
</para>
@alignment:
@padding_top:
@padding_bottom:
@padding_left:
@padding_right:
......@@ -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,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment