diff options
Diffstat (limited to 'docs/reference/gtk/tmpl/gtkmisc.sgml')
-rw-r--r-- | docs/reference/gtk/tmpl/gtkmisc.sgml | 109 |
1 files changed, 109 insertions, 0 deletions
diff --git a/docs/reference/gtk/tmpl/gtkmisc.sgml b/docs/reference/gtk/tmpl/gtkmisc.sgml new file mode 100644 index 000000000..10f5662c6 --- /dev/null +++ b/docs/reference/gtk/tmpl/gtkmisc.sgml @@ -0,0 +1,109 @@ +<!-- ##### SECTION Title ##### --> +GtkMisc + +<!-- ##### SECTION Short_Description ##### --> +a base class for widgets with alignments and padding. + +<!-- ##### SECTION Long_Description ##### --> +<para> +The #GtkMisc widget is an abstract widget which is not useful itself, but +is used to derive subclasses which have alignment and padding attributes. +</para> +<para> +The horizontal and vertical padding attributes allows extra space to be +added around the widget. +</para> +<para> +The horizontal and vertical alignment attributes enable the widget to be +positioned within its allocated area. Note that if the widget is added to +a container in such a way that it expands automatically to fill its +allocated area, the alignment settings will not alter the widgets position. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT GtkMisc ##### --> +<para> +The #GtkMisc-struct struct contains the following fields. +(These fields should be considered read-only. They should never be set by +an application.) + +<informaltable pgwide=1 frame="none" role="struct"> +<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*"> +<tbody> + +<row> +<entry>#gfloat <structfield>xalign</structfield>;</entry> +<entry>the horizontal alignment, from 0 (left) to 1 (right).</entry> +</row> + +<row> +<entry>#gfloat <structfield>yalign</structfield>;</entry> +<entry>the vertical alignment, from 0 (top) to 1 (bottom).</entry> +</row> + +<row> +<entry>#guint16 <structfield>xpad</structfield>;</entry> +<entry>the amount of space to add on the left and right of the widget, +in pixels.</entry> +</row> + +<row> +<entry>#guint16 <structfield>ypad</structfield>;</entry> +<entry>the amount of space to add on the top and bottom of the widget, +in pixels.</entry> +</row> +</informaltable> +</para> + +@widget: +@xalign: +@yalign: +@xpad: +@ypad: + +<!-- ##### FUNCTION gtk_misc_set_alignment ##### --> +<para> +Sets the alignment of the widget. +</para> + +@misc: a #GtkMisc. +@xalign: the horizontal alignment, from 0 (left) to 1 (right). +@yalign: the vertical alignment, from 0 (top) to 1 (bottom). + + +<!-- ##### FUNCTION gtk_misc_set_padding ##### --> +<para> +Sets the amount of space to add around the widget. +</para> + +@misc: a #GtkMisc. +@xpad: the amount of space to add on the left and right of the widget, +in pixels. +@ypad: the amount of space to add on the top and bottom of the widget, +in pixels. + + +<!-- ##### ARG GtkMisc:xalign ##### --> +<para> +the horizontal alignment, from 0 (left) to 1 (right). +</para> + +<!-- ##### ARG GtkMisc:yalign ##### --> +<para> +the vertical alignment, from 0 (top) to 1 (bottom). +</para> + +<!-- ##### ARG GtkMisc:xpad ##### --> +<para> +the amount of space to add on the left and right of the widget, in pixels. +</para> + +<!-- ##### ARG GtkMisc:ypad ##### --> +<para> +the amount of space to add on the top and bottom of the widget, in pixels. +</para> + |