<?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-gtkvruler">
  <refnamediv>
    <refname>gtk.VRuler</refname>
    <refpurpose>a vertical ruler.</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.VRuler</classname></ooclass>
      <ooclass><classname><link
linkend="class-gtkruler">gtk.Ruler</link></classname></ooclass>
      <constructorsynopsis language="python">
	<methodname><link
linkend="constructor-gtkvruler">gtk.VRuler</link></methodname>
	<methodparam></methodparam>  </constructorsynopsis>
    </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-gtkruler">gtk.Ruler</link>
        +-- <link linkend="class-gtkvruler">gtk.VRuler</link>
</synopsis>

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

  <refsect1 id="properties-gtkvruler">
    <title>gtk.VRuler 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-gtkruler">gtk.Ruler Properties</link></para>

  </refsect1>

  <refsect1 id="style-properties-gtkvruler">
    <title>gtk.VRuler Style Properties</title>

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

  </refsect1>

  <refsect1 id="signal-prototypes-gtkvruler">
    <title>gtk.VRuler 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>

    <note>
      <para>This widget is considered too specialized or little-used for
PyGTK, and will in the future be moved to some other package. If your
application needs this widget, feel free to use it, as the widget does work
and is useful in some applications; it's just not of general interest.
However, it will eventually move out of the PyGTK distribution.</para>
    </note>

    <para>The <link
linkend="class-gtkvruler"><classname>gtk.VRuler</classname></link> widget is
arranged vertically creating a ruler that is used in conjunction with other
widgets such as a text widget. The ruler is used to show the location of the
mouse on the window and to show the size of the window in specified units.
The available units of measurement are <literal>gtk.PIXELS</literal> (the
default), <literal>gtk.INCHES</literal> and
<literal>gtk.CENTIMETERS</literal>. See the <link
linkend="class-gtkruler"><classname>gtk.Ruler</classname></link> description
for more information on the methods that are used to manage a <link
linkend="class-gtkvruler"><classname>gtk.VRuler</classname></link>.</para>

  </refsect1>

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

    <programlisting><constructorsynopsis language="python">
	<methodname>gtk.VRuler</methodname>
	<methodparam></methodparam>  </constructorsynopsis></programlisting>
    <variablelist>
      <varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	<listitem><simpara>a new <link
linkend="class-gtkvruler"><classname>gtk.VRuler</classname></link>
widget</simpara></listitem>
      </varlistentry>
    </variablelist>

    <para>Creates a new <link
linkend="class-gtkvruler"><classname>gtk.VRuler</classname></link>
widget.</para>

  </refsect1>

</refentry>
