<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-gtkarrow">
  <refnamediv>
    <refname>gtk.Arrow</refname>
    <refpurpose>produces an arrow pointing in one of the four cardinal
directions.</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.Arrow</classname></ooclass>
      <ooclass><classname><link
linkend="class-gtkmisc">gtk.Misc</link></classname></ooclass>
      <constructorsynopsis language="python">
	<methodname><link linkend="constructor-gtkarrow">gtk.Arrow</link></methodname>
	<methodparam><parameter
		       role="keyword">arrow_type</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">shadow_type</parameter></methodparam>
      </constructorsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkarrow--set">set</link></methodname>
	<methodparam><parameter
		       role="keyword">arrow_type</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">shadow_type</parameter></methodparam>
      </methodsynopsis>
    </classsynopsis>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gtkobject">gtk.Object</link>
    +-- <link linkend="class-gtkwidget">gtk.Widget</link>
      +-- <link linkend="class-gtkmisc">gtk.Misc</link>
        +-- <link linkend="class-gtkarrow">gtk.Arrow</link>
</synopsis>

  </refsect1>
  
  <refsect1>
		<title>Implemented Interfaces</title>
		<para>
			<link linkend="class-gtkarrow"><classname>gtk.Arrow</classname></link>
			implements 
			<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
		</para>
	</refsect1>


  <refsect1 id="properties-gtkarrow">
    <title>gtk.Arrow Properties</title>

    <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
    <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
    <para><link linkend="properties-gtkmisc">gtk.Misc Properties</link></para>

    <blockquote role="properties">
      <informaltable pgwide="1" frame="none">
        <tgroup cols="3">
          <colspec column="1" colwidth="1in"/>
          <colspec column="2" colwidth="1in"/>
          <colspec column="3" colwidth="4.5in"/>
          <tbody>

            <row valign="top">
              <entry>"arrow-type"</entry>
              <entry>Read/Write</entry>
        <entry>The direction the arrow should point (gtk.ARROW_UP,
gtk.ARROW_DOWN, gtk.ARROW_LEFT, or gtk.ARROW_RIGHT)</entry>
          </row>

        <row valign="top">
          <entry>"shadow-type"</entry>
          <entry>Read/Write</entry>
          <entry>Appearance of the shadow surrounding the arrow
          (<literal>gtk.SHADOW IN, gtk.SHADOW OUT, gtk.ETCHED IN, or
          gtk.ETCHED OUT</literal>)</entry>
        </row>

        </tbody>
      </tgroup>
      </informaltable>
    </blockquote>

  </refsect1>

  <refsect1 id="style-properties-gtkarrow">
    <title>gtk.Arrow Style Properties</title>

    <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>


  </refsect1>

  <refsect1 id="signal-prototypes-gtkarrow">
    <title>gtk.Arrow Signal Prototypes</title>

    <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
</refsect1>

  <refsect1>
    <title>Description</title>

    <para>The <link
linkend="class-gtkarrow"><classname>gtk.Arrow</classname></link> is used to
draw simple arrows that point in one of the four cardinal directions
(gtk.ARROW_UP, gtk.ARROW_DOWN, gtk.ARROW_LEFT, or gtk.ARROW_RIGHT). The
shadow style of the arrow can be one of gtk.SHADOW IN, gtk.SHADOW OUT,
gtk.ETCHED IN, or gtk.ETCHED OUT.</para>

    <para>A <link
linkend="class-gtkarrow"><classname>gtk.Arrow</classname></link> will fill
any space alloted to it, but since it is inherited from <link
linkend="class-gtkmisc"><classname>gtk.Misc</classname></link>, it can be
padded and/or aligned, to fill exactly the space desired.</para>

    <para>Arrows are created with a call to <link
linkend="constructor-gtkarrow"><methodname>gtk.Arrow</methodname>()</link>.
The direction or style of an arrow can be changed after creation by using
<link
linkend="method-gtkarrow--set"><methodname>arrow_set</methodname>()</link>.</para>

  </refsect1>

  <refsect1 id="constructor-gtkarrow">
    <title>Constructor</title>

    <programlisting><constructorsynopsis language="python">
	<methodname>gtk.Arrow</methodname>
	<methodparam><parameter
		       role="keyword">arrow_type</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">shadow_type</parameter></methodparam>
      </constructorsynopsis></programlisting>
    <variablelist>
      <varlistentry>
	<term><parameter role="keyword">arrow_type</parameter>&nbsp;:</term>
	<listitem><simpara>one of the <xref linkend="gtk-arrow-type-constants"
endterm="gtk-arrow-type-constants-title"></xref></simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><parameter
role="keyword">shadow_type</parameter>&nbsp;:</term>
        <listitem><simpara>one
of the <xref linkend="gtk-shadow-type-constants"
endterm="gtk-shadow-type-constants-title"></xref></simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	<listitem><simpara>a <link
	linkend="class-gtkarrow"><classname>gtk.Arrow</classname></link>
	widget</simpara></listitem>
      </varlistentry>
    </variablelist>

    <para>Creates a new arrow widget with the specified
<parameter>arrow_type</parameter> and
<parameter>arrow_shadow</parameter>.</para>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-gtkarrow--set">
      <title>gtk.Arrow.set</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set</methodname>
	  <methodparam><parameter
			 role="keyword">arrow_type</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">shadow_type</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter
role="keyword">arrow_type</parameter>&nbsp;:</term>
	  <listitem><simpara>a GtkArrowType</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter
role="keyword">shadow_type</parameter>&nbsp;:</term>
	  <listitem><simpara>one of the <xref
linkend="gtk-shadow-type-constants"
endterm="gtk-shadow-type-constants-title"></xref></simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set</methodname>() method sets the
<parameter>arrow_type</parameter> and <parameter>shadow_type</parameter> of
the arrow widget.</para>

    </refsect2>

  </refsect1>

</refentry>
