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

   1 <!-- ##### SECTION Title ##### -->
   2 GtkMisc
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 a base class for widgets with alignments and padding.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The #GtkMisc widget is an abstract widget which is not useful itself, but
  10 is used to derive subclasses which have alignment and padding attributes.
  11 </para>
  12 <para>
  13 The horizontal and vertical padding attributes allows extra space to be
  14 added around the widget.
  15 </para>
  16 <para>
  17 The horizontal and vertical alignment attributes enable the widget to be
  18 positioned within its allocated area. Note that if the widget is added to
  19 a container in such a way that it expands automatically to fill its
  20 allocated area, the alignment settings will not alter the widgets position.
  21 </para>
  22
  23 <!-- ##### SECTION See_Also ##### -->
  24 <para>
  25
  26 </para>
  27
  28 <!-- ##### STRUCT GtkMisc ##### -->
  29 <para>
  30 The #GtkMisc-struct struct contains the following fields.
  31 (These fields should be considered read-only. They should never be set by
  32 an application.)
  33
  34 <informaltable pgwide="1" frame="none" role="struct">
  35 <tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/>
  36 <tbody>
  37
  38 <row>
  39 <entry>#gfloat <structfield>xalign</structfield>;</entry>
  40 <entry>the horizontal alignment, from 0 (left) to 1 (right).</entry>
  41 </row>
  42
  43 <row>
  44 <entry>#gfloat <structfield>yalign</structfield>;</entry>
  45 <entry>the vertical alignment, from 0 (top) to 1 (bottom).</entry>
  46 </row>
  47
  48 <row>
  49 <entry>#guint16 <structfield>xpad</structfield>;</entry>
  50 <entry>the amount of space to add on the left and right of the widget,
  51 in pixels.</entry>
  52 </row>
  53
  54 <row>
  55 <entry>#guint16 <structfield>ypad</structfield>;</entry>
  56 <entry>the amount of space to add on the top and bottom of the widget,
  57 in pixels.</entry>
  58 </row>
  59 </tbody></tgroup></informaltable>
  60 </para>
  61
  62
  63 <!-- ##### FUNCTION gtk_misc_set_alignment ##### -->
  64 <para>
  65 Sets the alignment of the widget.
  66 </para>
  67
  68 @misc: a #GtkMisc.
  69 @xalign: the horizontal alignment, from 0 (left) to 1 (right).
  70 @yalign: the vertical alignment, from 0 (top) to 1 (bottom).
  71
  72
  73 <!-- ##### FUNCTION gtk_misc_set_padding ##### -->
  74 <para>
  75 Sets the amount of space to add around the widget.
  76 </para>
  77
  78 @misc: a #GtkMisc.
  79 @xpad: the amount of space to add on the left and right of the widget,
  80 in pixels.
  81 @ypad: the amount of space to add on the top and bottom of the widget,
  82 in pixels.
  83
  84
  85 <!-- ##### FUNCTION gtk_misc_get_alignment ##### -->
  86 <para>
  87
  88 </para>
  89
  90 @misc:
  91 @xalign:
  92 @yalign:
  93
  94
  95 <!-- ##### FUNCTION gtk_misc_get_padding ##### -->
  96 <para>
  97
  98 </para>
  99
 100 @misc:
 101 @xpad:
 102 @ypad:
 103
 104
 105 <!-- ##### ARG GtkMisc:xalign ##### -->
 106 <para>
 107
 108 </para>
 109
 110 <!-- ##### ARG GtkMisc:yalign ##### -->
 111 <para>
 112
 113 </para>
 114
 115 <!-- ##### ARG GtkMisc:xpad ##### -->
 116 <para>
 117
 118 </para>
 119
 120 <!-- ##### ARG GtkMisc:ypad ##### -->
 121 <para>
 122
 123 </para>
 124