<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
]>
<!--ENTITY index-Objects-Grouped SYSTEM "objects_grouped.sgml"-->
<refentry id="GtkHRuler">
<refmeta>
<refentrytitle role="top_of_page" id="GtkHRuler.top_of_page">GtkHRuler</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GtkHRuler</refname>
<refpurpose>A horizontal ruler</refpurpose>
</refnamediv>

<refsynopsisdiv id="GtkHRuler.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>

#include &lt;gtk/gtk.h&gt;

                    <link linkend="GtkHRuler-struct">GtkHRuler</link>;
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gtk-hruler-new">gtk_hruler_new</link>                      (void);
</synopsis>
</refsynopsisdiv>

<refsect1 id="GtkHRuler.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----<link linkend="GtkRuler">GtkRuler</link>
                           +----GtkHRuler
</synopsis>
</refsect1>



<refsect1 id="GtkHRuler.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GtkHRuler implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkBuildable">GtkBuildable</link> and  <link linkend="GtkOrientable">GtkOrientable</link>.</para>
</refsect1>





<refsect1 id="GtkHRuler.description" role="desc">
<title role="desc.title">Description</title>
<note>
<para>
 This widget is considered too specialized/little-used for
 GTK+, 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, we are not accepting new features for
 the widget, and it will eventually move out of the GTK+
 distribution.
</para>
</note>
<para>
The HRuler widget is a widget arranged horizontally creating a ruler that is
utilized around 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 GTK_PIXELS, GTK_INCHES
and GTK_CENTIMETERS. GTK_PIXELS is the default.
rulers.
</para>
</refsect1>

<refsect1 id="GtkHRuler.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GtkHRuler-struct" role="struct">
<title>GtkHRuler</title>
<indexterm zone="GtkHRuler-struct"><primary sortas="HRuler">GtkHRuler</primary></indexterm><programlisting>typedef struct _GtkHRuler GtkHRuler;</programlisting>
<para>
The <link linkend="GtkHRuler"><type>GtkHRuler</type></link> struct contains private data and should be accessed
with the functions below.
</para></refsect2>
<refsect2 id="gtk-hruler-new" role="function">
<title>gtk_hruler_new ()</title>
<indexterm zone="gtk-hruler-new"><primary sortas="hruler_new">gtk_hruler_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gtk_hruler_new                      (void);</programlisting>
<para>
Creates a new horizontal ruler.
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>a new <link linkend="GtkHRuler"><type>GtkHRuler</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
