summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtkalignment.sgml
blob: 24c0af826313301e69bc33252b3732df9b74882c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
<!-- ##### 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>

<!-- ##### 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: