gtk2/docs/reference/gtk/tmpl/gtkarrow.sgml
Owen Taylor c26e3eeebc Restore build.
Mon Jan  8 15:21:15 2001  Owen Taylor  <otaylor@redhat.com>

	* Makefile.am (SUBDIRS): Restore build.

	* gdk/gdk-sections.txt gdk/gdk-docs.sgml
	  gdk-pixbuf/gdk-pixbuf-sections.txt
	  gtk/gtk-sections.txt gtk/gtk-docs.sgml: : Update.

	* */tmpl/*: Changes from update.
2001-01-09 16:41:17 +00:00

90 lines
2.4 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
GtkArrow
<!-- ##### SECTION Short_Description ##### -->
produces an arrow pointing in one of the four cardinal directions.
<!-- ##### SECTION Long_Description ##### -->
<para>
GtkArrow should be used to draw simple arrows that need to point in
one of the four cardinal directions (up, down, left, or right). The
style of the arrow can be one of shadow in, shadow out, etched in, or
etched out. Note that these directions and style types may be
ammended in versions of Gtk to come.
</para>
<para>
GtkArrow will fill any space alloted to it, but since it is inherited
from #GtkMisc, it can be padded and/or aligned, to fill exactly the
space the programmer desires.
</para>
<para>
Arrows are created with a call to gtk_arrow_new(). The direction or
style of an arrow can be changed after creation by using gtk_arrow_set().
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>gtk_paint_arrow()</term>
<listitem><para>the function used internally to paint the arrow.</para></listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### STRUCT GtkArrow ##### -->
<para>
The #GtkArrow-struct containes 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>#gint16 <structfield>arrow_type</structfield>;</entry>
<entry>the direction of the arrow, one of #GtkArrowType.</entry>
</row>
<row>
<entry>#gint16 <structfield>shadow_type</structfield>;</entry>
<entry>the style of the arrow, one of #GtkShadowType.</entry>
</row>
</tbody></tgroup></informaltable>
</para>
<!-- ##### FUNCTION gtk_arrow_new ##### -->
<para>
Creates a new arrow widget.
</para>
@arrow_type: a valid #GtkArrowType.
@shadow_type: a valid #GtkShadowType.
@Returns: the new #GtkArrow widget.
<!-- ##### FUNCTION gtk_arrow_set ##### -->
<para>
Sets the direction and style of the #GtkArrow, @arrow.
</para>
@arrow: a widget of type #GtkArrow.
@arrow_type: a valid #GtkArrowType.
@shadow_type: a valid #GtkShadowType.
<!-- ##### ARG GtkArrow:arrow-type ##### -->
<para>
the arrow direction, one of #GtkArrowType.
</para>
<!-- ##### ARG GtkArrow:shadow-type ##### -->
<para>
the arrow style, one of #GtkShadowType.
</para>