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