callisto-debian/gtk2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docs] Move documentation to inline comments: GtkAlignment.

Browse Source 
Fixes https://bugzilla.gnome.org/show_bug.cgi?id=611956

Signed-off-by: Javier Jardón <jjardon@gnome.org>
This commit is contained in:
Tadej Borovšak
2010-03-05 23:38:44 +01:00
committed by Javier Jardón
parent b6a6142556
commit b802be45b3
2 changed files with 54 additions and 141 deletions
Download Patch File Download Diff File Expand all files Collapse all files

141
docs/reference/gtk/tmpl/gtkalignment.sgml
View File

@ -1,141 +0,0 @@
<!-- ##### 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:

54
gtk/gtkalignment.c
View File

@ -24,6 +24,25 @@
* GTK+ at ftp://ftp.gtk.org/pub/gtk/. * 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 "config.h"
#include "gtkalignment.h" #include "gtkalignment.h"
#include "gtkprivate.h" #include "gtkprivate.h"
@ -215,6 +234,24 @@ gtk_alignment_init (GtkAlignment *alignment)
priv->padding_right = 0; 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* GtkWidget*
gtk_alignment_new (gfloat xalign, gtk_alignment_new (gfloat xalign,
gfloat yalign, 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 void
gtk_alignment_set (GtkAlignment *alignment, gtk_alignment_set (GtkAlignment *alignment,
gfloat xalign, gfloat xalign,