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

   1 <!-- ##### SECTION Title ##### -->
   2 GtkMisc
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 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 <!-- ##### SECTION Stability_Level ##### -->
  29
  30
  31 <!-- ##### STRUCT GtkMisc ##### -->
  32 <para>
  33 The #GtkMisc-struct struct contains the following fields.
  34 (These fields should be considered read-only. They should never be set by
  35 an application.)
  36
  37 <informaltable pgwide="1" frame="none" role="struct">
  38 <tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/>
  39 <tbody>
  40
  41 <row>
  42 <entry>#gfloat <structfield>xalign</structfield>;</entry>
  43 <entry>the horizontal alignment, from 0 (left) to 1 (right).</entry>
  44 </row>
  45
  46 <row>
  47 <entry>#gfloat <structfield>yalign</structfield>;</entry>
  48 <entry>the vertical alignment, from 0 (top) to 1 (bottom).</entry>
  49 </row>
  50
  51 <row>
  52 <entry>#guint16 <structfield>xpad</structfield>;</entry>
  53 <entry>the amount of space to add on the left and right of the widget,
  54 in pixels.</entry>
  55 </row>
  56
  57 <row>
  58 <entry>#guint16 <structfield>ypad</structfield>;</entry>
  59 <entry>the amount of space to add on the top and bottom of the widget,
  60 in pixels.</entry>
  61 </row>
  62 </tbody></tgroup></informaltable>
  63 </para>
  64
  65
  66 <!-- ##### ARG GtkMisc:xalign ##### -->
  67 <para>
  68
  69 </para>
  70
  71 <!-- ##### ARG GtkMisc:xpad ##### -->
  72 <para>
  73
  74 </para>
  75
  76 <!-- ##### ARG GtkMisc:yalign ##### -->
  77 <para>
  78
  79 </para>
  80
  81 <!-- ##### ARG GtkMisc:ypad ##### -->
  82 <para>
  83
  84 </para>
  85
  86 <!-- ##### FUNCTION gtk_misc_set_alignment ##### -->
  87 <para>
  88 Sets the alignment of the widget.
  89 </para>
  90
  91 @misc: a #GtkMisc.
  92 @xalign: the horizontal alignment, from 0 (left) to 1 (right).
  93 @yalign: the vertical alignment, from 0 (top) to 1 (bottom).
  94
  95
  96 <!-- ##### FUNCTION gtk_misc_set_padding ##### -->
  97 <para>
  98 Sets the amount of space to add around the widget.
  99 </para>
 100
 101 @misc: a #GtkMisc.
 102 @xpad: the amount of space to add on the left and right of the widget,
 103 in pixels.
 104 @ypad: the amount of space to add on the top and bottom of the widget,
 105 in pixels.
 106
 107
 108 <!-- ##### FUNCTION gtk_misc_get_alignment ##### -->
 109 <para>
 110
 111 </para>
 112
 113 @misc:
 114 @xalign:
 115 @yalign:
 116
 117
 118 <!-- ##### FUNCTION gtk_misc_get_padding ##### -->
 119 <para>
 120
 121 </para>
 122
 123 @misc:
 124 @xpad:
 125 @ypad:
 126
 127