<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkRuler: GTK+ 2 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
<link rel="up" href="SpecialObjects.html" title="Special-purpose features">
<link rel="prev" href="GtkGammaCurve.html" title="GtkGammaCurve">
<link rel="next" href="GtkHRuler.html" title="GtkHRuler">
<meta name="generator" content="GTK-Doc V1.26.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GtkRuler.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GtkRuler.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GtkRuler.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GtkRuler.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="SpecialObjects.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkGammaCurve.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkHRuler.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkRuler"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkRuler.top_of_page"></a>GtkRuler</span></h2>
<p>GtkRuler</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkRuler.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkRuler.html#gtk-ruler-set-metric" title="gtk_ruler_set_metric ()">gtk_ruler_set_metric</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkRuler.html#gtk-ruler-set-range" title="gtk_ruler_set_range ()">gtk_ruler_set_range</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gtk2-Standard-Enumerations.html#GtkMetricType" title="enum GtkMetricType"><span class="returnvalue">GtkMetricType</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkRuler.html#gtk-ruler-get-metric" title="gtk_ruler_get_metric ()">gtk_ruler_get_metric</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkRuler.html#gtk-ruler-get-range" title="gtk_ruler_get_range ()">gtk_ruler_get_range</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkRuler.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="GtkRuler.html#GtkRuler--lower" title="The “lower” property">lower</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="GtkRuler.html#GtkRuler--max-size" title="The “max-size” property">max-size</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="gtk2-Standard-Enumerations.html#GtkMetricType" title="enum GtkMetricType"><span class="type">GtkMetricType</span></a></td>
<td class="property_name"><a class="link" href="GtkRuler.html#GtkRuler--metric" title="The “metric” property">metric</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="GtkRuler.html#GtkRuler--position" title="The “position” property">position</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="GtkRuler.html#GtkRuler--upper" title="The “upper” property">upper</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkRuler.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkRuler.html#GtkRuler-struct" title="struct GtkRuler">GtkRuler</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkRuler.html#GtkRulerMetric" title="struct GtkRulerMetric">GtkRulerMetric</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkRuler.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
<span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
<span class="lineart">╰──</span> GtkRuler
<span class="lineart">├──</span> <a class="link" href="GtkHRuler.html" title="GtkHRuler">GtkHRuler</a>
<span class="lineart">╰──</span> <a class="link" href="GtkVRuler.html" title="GtkVRuler">GtkVRuler</a>
</pre>
</div>
<div class="refsect1">
<a name="GtkRuler.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkRuler implements
AtkImplementorIface, <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a> and <a class="link" href="gtk2-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkRuler.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gtk/gtk.h>
</pre>
</div>
<div class="refsect1">
<a name="GtkRuler.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="GtkRuler.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-ruler-set-metric"></a><h3>gtk_ruler_set_metric ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_ruler_set_metric (<em class="parameter"><code><a class="link" href="GtkRuler.html" title="GtkRuler"><span class="type">GtkRuler</span></a> *ruler</code></em>,
<em class="parameter"><code><a class="link" href="gtk2-Standard-Enumerations.html#GtkMetricType" title="enum GtkMetricType"><span class="type">GtkMetricType</span></a> metric</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_ruler_set_metric</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-ruler-set-range"></a><h3>gtk_ruler_set_range ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_ruler_set_range (<em class="parameter"><code><a class="link" href="GtkRuler.html" title="GtkRuler"><span class="type">GtkRuler</span></a> *ruler</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> lower</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> upper</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> position</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> max_size</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_ruler_set_range</code> is deprecated and should not be used in newly-written code.</p></div>
<p>This sets the range of the ruler. </p>
<p><em class="parameter"><code>Deprecated</code></em>
: 2.24: <a class="link" href="GtkRuler.html" title="GtkRuler"><span class="type">GtkRuler</span></a> has been removed from GTK 3 for being
unmaintained and too specialized. There is no replacement.</p>
<div class="refsect3">
<a name="gtk-ruler-set-range.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>ruler</p></td>
<td class="parameter_description"><p>the gtkruler</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>lower</p></td>
<td class="parameter_description"><p>the lower limit of the ruler</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>upper</p></td>
<td class="parameter_description"><p>the upper limit of the ruler</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>position</p></td>
<td class="parameter_description"><p>the mark on the ruler</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>max_size</p></td>
<td class="parameter_description"><p>the maximum size of the ruler used when calculating the space to
leave for the text</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-ruler-get-metric"></a><h3>gtk_ruler_get_metric ()</h3>
<pre class="programlisting"><a class="link" href="gtk2-Standard-Enumerations.html#GtkMetricType" title="enum GtkMetricType"><span class="returnvalue">GtkMetricType</span></a>
gtk_ruler_get_metric (<em class="parameter"><code><a class="link" href="GtkRuler.html" title="GtkRuler"><span class="type">GtkRuler</span></a> *ruler</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_ruler_get_metric</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Gets the units used for a <a class="link" href="GtkRuler.html" title="GtkRuler"><span class="type">GtkRuler</span></a>. See <a class="link" href="GtkRuler.html#gtk-ruler-set-metric" title="gtk_ruler_set_metric ()"><code class="function">gtk_ruler_set_metric()</code></a>.</p>
<div class="refsect3">
<a name="gtk-ruler-get-metric.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>ruler</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkRuler.html" title="GtkRuler"><span class="type">GtkRuler</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-ruler-get-metric.returns"></a><h4>Returns</h4>
<p> the units currently used for <em class="parameter"><code>ruler</code></em>
</p>
<p><em class="parameter"><code>Deprecated</code></em>
: 2.24: <a class="link" href="GtkRuler.html" title="GtkRuler"><span class="type">GtkRuler</span></a> has been removed from GTK 3 for being
unmaintained and too specialized. There is no replacement.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-ruler-get-range"></a><h3>gtk_ruler_get_range ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_ruler_get_range (<em class="parameter"><code><a class="link" href="GtkRuler.html" title="GtkRuler"><span class="type">GtkRuler</span></a> *ruler</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *lower</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *upper</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *position</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *max_size</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_ruler_get_range</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Retrieves values indicating the range and current position of a <a class="link" href="GtkRuler.html" title="GtkRuler"><span class="type">GtkRuler</span></a>.
See <a class="link" href="GtkRuler.html#gtk-ruler-set-range" title="gtk_ruler_set_range ()"><code class="function">gtk_ruler_set_range()</code></a>.</p>
<p><em class="parameter"><code>Deprecated</code></em>
: 2.24: <a class="link" href="GtkRuler.html" title="GtkRuler"><span class="type">GtkRuler</span></a> has been removed from GTK 3 for being
unmaintained and too specialized. There is no replacement.</p>
<div class="refsect3">
<a name="gtk-ruler-get-range.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>ruler</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkRuler.html" title="GtkRuler"><span class="type">GtkRuler</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>lower</p></td>
<td class="parameter_description"><p>location to store lower limit of the ruler, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>upper</p></td>
<td class="parameter_description"><p>location to store upper limit of the ruler, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>position</p></td>
<td class="parameter_description"><p>location to store the current position of the mark on the ruler, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>max_size</p></td>
<td class="parameter_description"><p>location to store the maximum size of the ruler used when calculating
the space to leave for the text, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GtkRuler.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkRuler-struct"></a><h3>struct GtkRuler</h3>
<pre class="programlisting">struct GtkRuler;</pre>
<div class="warning"><p><code class="literal">GtkRuler</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="GtkRulerMetric"></a><h3>struct GtkRulerMetric</h3>
<pre class="programlisting">struct GtkRulerMetric {
gchar *metric_name;
gchar *abbrev;
/* This should be points_per_unit. This is the size of the unit
* in 1/72nd's of an inch and has nothing to do with screen pixels */
gdouble pixels_per_unit;
gdouble ruler_scale[10];
gint subdivide[5]; /* five possible modes of subdivision */
};
</pre>
<div class="warning"><p><code class="literal">GtkRulerMetric</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
</div>
<div class="refsect1">
<a name="GtkRuler.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkRuler--lower"></a><h3>The <code class="literal">“lower”</code> property</h3>
<pre class="programlisting"> “lower” <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>Lower limit of ruler.</p>
<p>Flags: Read / Write</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkRuler--max-size"></a><h3>The <code class="literal">“max-size”</code> property</h3>
<pre class="programlisting"> “max-size” <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>Maximum size of the ruler.</p>
<p>Flags: Read / Write</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkRuler--metric"></a><h3>The <code class="literal">“metric”</code> property</h3>
<pre class="programlisting"> “metric” <a class="link" href="gtk2-Standard-Enumerations.html#GtkMetricType" title="enum GtkMetricType"><span class="type">GtkMetricType</span></a></pre>
<p>The metric used for the ruler.</p>
<p>Flags: Read / Write</p>
<p>Default value: GTK_PIXELS</p>
<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkRuler--position"></a><h3>The <code class="literal">“position”</code> property</h3>
<pre class="programlisting"> “position” <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>Position of mark on the ruler.</p>
<p>Flags: Read / Write</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkRuler--upper"></a><h3>The <code class="literal">“upper”</code> property</h3>
<pre class="programlisting"> “upper” <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>Upper limit of ruler.</p>
<p>Flags: Read / Write</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.26.1</div>
</body>
</html>