Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkalignment.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkAlignment
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 a widget which controls the alignment and size of its child.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The #GtkAlignment widget controls the alignment and size of its child widget.
  10 It has four settings: xscale, yscale, xalign, and yalign.
  11 </para>
  12 <para>
  13 The scale settings are used to specify how much the child widget should
  14 expand to fill the space allocated to the #GtkAlignment.
  15 The values can range from 0 (meaning the child doesn't expand at all) to
  16 1 (meaning the child expands to fill all of the available space).
  17 </para>
  18 <para>
  19 The align settings are used to place the child widget within the available
  20 area. The values range from 0 (top or left) to 1 (bottom or right).
  21 Of course, if the scale settings are both set to 1, the alignment settings
  22 have no effect.
  23 </para>
  24
  25 <!-- ##### SECTION See_Also ##### -->
  26 <para>
  27
  28 </para>
  29
  30 <!-- ##### STRUCT GtkAlignment ##### -->
  31 <para>
  32 The #GtkAlignment-struct struct contains private data only, and should
  33 be accessed using the functions below.
  34 </para>
  35
  36 @bin:
  37 @xalign:
  38 @yalign:
  39 @xscale:
  40 @yscale:
  41
  42 <!-- ##### FUNCTION gtk_alignment_new ##### -->
  43 <para>
  44 Creates a new #GtkAlignment.
  45 </para>
  46
  47 @xalign: the horizontal alignment of the child widget, from 0 (left) to 1
  48 (right).
  49 @yalign: the vertical alignment of the child widget, from 0 (top) to 1
  50 (bottom).
  51 @xscale: the amount that the child widget expands horizontally to fill up
  52 unused space, from 0 to 1.
  53 A value of 0 indicates that the child widget should never expand.
  54 A value of 1 indicates that the child widget will expand to fill all of the
  55 space allocated for the #GtkAlignment.
  56 @yscale: the amount that the child widget expands vertically to fill up
  57 unused space, from 0 to 1. The values are similar to @xscale.
  58 @Returns: the new #GtkAlignment.
  59
  60
  61 <!-- ##### FUNCTION gtk_alignment_set ##### -->
  62 <para>
  63 Sets the #GtkAlignment values.
  64 </para>
  65
  66 @alignment: a #GtkAlignment.
  67 @xalign: the horizontal alignment of the child widget, from 0 (left) to 1
  68 (right).
  69 @yalign: the vertical alignment of the child widget, from 0 (top) to 1
  70 (bottom).
  71 @xscale: the amount that the child widget expands horizontally to fill up
  72 unused space, from 0 to 1.
  73 A value of 0 indicates that the child widget should never expand.
  74 A value of 1 indicates that the child widget will expand to fill all of the
  75 space allocated for the #GtkAlignment.
  76 @yscale: the amount that the child widget expands vertically to fill up
  77 unused space, from 0 to 1. The values are similar to @xscale.
  78
  79
  80 <!-- ##### ARG GtkAlignment:xalign ##### -->
  81 <para>
  82 the horizontal alignment of the child widget, from 0 (left) to 1 (right).
  83 </para>
  84
  85 <!-- ##### ARG GtkAlignment:yalign ##### -->
  86 <para>
  87 the vertical alignment of the child widget, from 0 (top) to 1 (bottom).
  88 </para>
  89
  90 <!-- ##### ARG GtkAlignment:xscale ##### -->
  91 <para>
  92 the amount that the child widget expands horizontally to fill up
  93 unused space, from 0 to 1.
  94 A value of 0 indicates that the child widget should never expand.
  95 A value of 1 indicates that the child widget will expand to fill all of the
  96 space allocated for the #GtkAlignment.
  97 </para>
  98
  99 <!-- ##### ARG GtkAlignment:yscale ##### -->
 100 <para>
 101 the amount that the child widget expands vertically to fill up
 102 unused space, from 0 to 1. The values are similar to @xscale.
 103 </para>
 104