<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>gtkmm: Gtk::Ruler Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceGtk.html">Gtk</a>::<a class="el" href="classGtk_1_1Ruler.html">Ruler</a>
</div>
</div>
<div class="contents">
<h1>Gtk::Ruler Class Reference<br/>
<small>
[<a class="el" href="group__Widgets.html">Widgets</a>]</small>
</h1><!-- doxytag: class="Gtk::Ruler" --><!-- doxytag: inherits="Gtk::Widget" -->
<p>Base class for horizontal or vertical rulers. <a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classGtk_1_1Widget.html">Gtk::Widget</a>.</p>
<p>Inherited by <a class="el" href="classGtk_1_1HRuler.html">Gtk::HRuler</a>, and <a class="el" href="classGtk_1_1VRuler.html">Gtk::VRuler</a>.</p>
<div class="dynheader">
Collaboration diagram for Gtk::Ruler:</div>
<div class="dynsection">
<div class="center"><img src="classGtk_1_1Ruler__coll__graph.png" border="0" usemap="#Gtk_1_1Ruler_coll__map" alt="Collaboration graph"/></div>
<map name="Gtk_1_1Ruler_coll__map" id="Gtk_1_1Ruler_coll__map">
<area shape="rect" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)." alt="" coords="68,315,159,344"/><area shape="rect" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non-widget objects such..." alt="" coords="5,237,93,267"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="5,160,96,189"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="51,83,171,112"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="123,160,227,189"/><area shape="rect" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="57,5,164,35"/><area shape="rect" href="classAtk_1_1Implementor.html" title="Atk::Implementor" alt="" coords="117,237,237,267"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classGtk_1_1Ruler-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#a41190beee5e285d580d7b018d8ba24ed">~Ruler</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkRuler* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#ad8a837a3f262b4b654d29707d5184042">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#ad8a837a3f262b4b654d29707d5184042"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GtkRuler* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#a8a6bfd2d664c51ce588701c012687c4c">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#a8a6bfd2d664c51ce588701c012687c4c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#a632a58dfe2fc52f8763f4c8524f97cbd">set_metric</a> (<a class="el" href="group__gtkmmEnums.html#ga22dc1ec34acb004dd747bec08b35645b">MetricType</a> metric=PIXELS)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the desired metric of the ruler. <a href="#a632a58dfe2fc52f8763f4c8524f97cbd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__gtkmmEnums.html#ga22dc1ec34acb004dd747bec08b35645b">MetricType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#a940bea62fc64cc339c0d78ab9236ae87">get_metric</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the units used for a <a class="el" href="classGtk_1_1Ruler.html" title="Base class for horizontal or vertical rulers.">Gtk::Ruler</a>. <a href="#a940bea62fc64cc339c0d78ab9236ae87"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__gtkmmEnums.html#ga22dc1ec34acb004dd747bec08b35645b">MetricType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#af58d6e9b70486b32aa2482146b54a6e9">get_metric</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the units used for a <a class="el" href="classGtk_1_1Ruler.html" title="Base class for horizontal or vertical rulers.">Gtk::Ruler</a>. <a href="#af58d6e9b70486b32aa2482146b54a6e9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#ac62fa390f2bec13d89c4d1288264879d">get_range_lower</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#af57557b0e2bc0f4c029a14321ce52e6c">get_range_upper</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#aae0d333e26bb4171230ebeb18d666220">set_range</a> (double lower, double upper, double position, double max_size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">sets the range of the ruler. <a href="#aae0d333e26bb4171230ebeb18d666220"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#aa2507798293c573295a28e0e4be09010">get_range</a> (double& lower, double& upper, double& position, double& max_size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves values indicating the range and current position of a <a class="el" href="classGtk_1_1Ruler.html" title="Base class for horizontal or vertical rulers.">Gtk::Ruler</a>. <a href="#aa2507798293c573295a28e0e4be09010"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#a48ae4c80ff3f32e6dd8ee780a728a345">draw_ticks</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">draw tick marks on the ruler <a href="#a48ae4c80ff3f32e6dd8ee780a728a345"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#a787106dfe66b404e62c3060a34f919b3">draw_pos</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">draw a position indicator on the ruler <a href="#a787106dfe66b404e62c3060a34f919b3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#abcf51627a775eaf6d4d617396ba0c695">draw_ticks_vfunc</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#a8afa1706af6e5d00f271d3cc1260bdd9">draw_pos_vfunc</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#aa42355084a1abef5fe4c9c94b3f377b6">property_lower</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lower limit of ruler. <a href="#aa42355084a1abef5fe4c9c94b3f377b6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#a41323cef766198e4150d2f3d048561f5">property_lower</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lower limit of ruler. <a href="#a41323cef766198e4150d2f3d048561f5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#a465828cdefb780ceff461fb41a36b4d2">property_upper</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Upper limit of ruler. <a href="#a465828cdefb780ceff461fb41a36b4d2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#a044c6bdcc0b62d04d357c0d59875a467">property_upper</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Upper limit of ruler. <a href="#a044c6bdcc0b62d04d357c0d59875a467"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#a7ef7111f462befbc8dc651ab492ac7aa">property_position</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Position of mark on the ruler. <a href="#a7ef7111f462befbc8dc651ab492ac7aa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#ae3a4951fbb4f583fea79d884659346c1">property_position</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Position of mark on the ruler. <a href="#ae3a4951fbb4f583fea79d884659346c1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#a225a29d7d7453e7c446d93d4b321553d">property_max_size</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum size of the ruler. <a href="#a225a29d7d7453e7c446d93d4b321553d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#a51543bc337b18c82ebf9437b5ec80bcd">property_max_size</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum size of the ruler. <a href="#a51543bc337b18c82ebf9437b5ec80bcd"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#a33ca40fb8f3817780521ae2d3c037b94">Ruler</a> ()</td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1Ruler.html">Gtk::Ruler</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Ruler.html#a7bb855061d75c8e5f04c95802f6932a9">wrap</a> (GtkRuler* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a7bb855061d75c8e5f04c95802f6932a9"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Base class for horizontal or vertical rulers. </p>
<p>NOTE 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. Rulers are used to show the mouse pointer's location in a window. The ruler can either be horizontal or vertical. Within the ruler a small triangle indicates the location of the mouse relative to the horixontal or vertical ruler.</p>
<p>This is an abstract base for <a class="el" href="classGtk_1_1HRuler.html" title="Horizontal Ruler.">Gtk::HRuler</a> and <a class="el" href="classGtk_1_1VRuler.html" title="Vertical Ruler.">Gtk::VRuler</a>. Users should only instantiate those types. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a41190beee5e285d580d7b018d8ba24ed"></a><!-- doxytag: member="Gtk::Ruler::~Ruler" ref="a41190beee5e285d580d7b018d8ba24ed" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gtk::Ruler::~Ruler </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a33ca40fb8f3817780521ae2d3c037b94"></a><!-- doxytag: member="Gtk::Ruler::Ruler" ref="a33ca40fb8f3817780521ae2d3c037b94" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::Ruler::Ruler </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a787106dfe66b404e62c3060a34f919b3"></a><!-- doxytag: member="Gtk::Ruler::draw_pos" ref="a787106dfe66b404e62c3060a34f919b3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Ruler::draw_pos </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>draw a position indicator on the ruler </p>
</div>
</div>
<a class="anchor" id="a8afa1706af6e5d00f271d3cc1260bdd9"></a><!-- doxytag: member="Gtk::Ruler::draw_pos_vfunc" ref="a8afa1706af6e5d00f271d3cc1260bdd9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Gtk::Ruler::draw_pos_vfunc </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a48ae4c80ff3f32e6dd8ee780a728a345"></a><!-- doxytag: member="Gtk::Ruler::draw_ticks" ref="a48ae4c80ff3f32e6dd8ee780a728a345" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Ruler::draw_ticks </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>draw tick marks on the ruler </p>
</div>
</div>
<a class="anchor" id="abcf51627a775eaf6d4d617396ba0c695"></a><!-- doxytag: member="Gtk::Ruler::draw_ticks_vfunc" ref="abcf51627a775eaf6d4d617396ba0c695" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Gtk::Ruler::draw_ticks_vfunc </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af58d6e9b70486b32aa2482146b54a6e9"></a><!-- doxytag: member="Gtk::Ruler::get_metric" ref="af58d6e9b70486b32aa2482146b54a6e9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__gtkmmEnums.html#ga22dc1ec34acb004dd747bec08b35645b">MetricType</a> Gtk::Ruler::get_metric </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the units used for a <a class="el" href="classGtk_1_1Ruler.html" title="Base class for horizontal or vertical rulers.">Gtk::Ruler</a>. </p>
<p>See <a class="el" href="classGtk_1_1Ruler.html#a632a58dfe2fc52f8763f4c8524f97cbd" title="Sets the desired metric of the ruler.">set_metric()</a>. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000048">Deprecated:</a></b></dt><dd>Use the const version </dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The units currently used for <em>ruler</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="a940bea62fc64cc339c0d78ab9236ae87"></a><!-- doxytag: member="Gtk::Ruler::get_metric" ref="a940bea62fc64cc339c0d78ab9236ae87" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__gtkmmEnums.html#ga22dc1ec34acb004dd747bec08b35645b">MetricType</a> Gtk::Ruler::get_metric </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the units used for a <a class="el" href="classGtk_1_1Ruler.html" title="Base class for horizontal or vertical rulers.">Gtk::Ruler</a>. </p>
<p>See <a class="el" href="classGtk_1_1Ruler.html#a632a58dfe2fc52f8763f4c8524f97cbd" title="Sets the desired metric of the ruler.">set_metric()</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The units currently used for <em>ruler</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="aa2507798293c573295a28e0e4be09010"></a><!-- doxytag: member="Gtk::Ruler::get_range" ref="aa2507798293c573295a28e0e4be09010" args="(double &lower, double &upper, double &position, double &max_size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Ruler::get_range </td>
<td>(</td>
<td class="paramtype">double & </td>
<td class="paramname"> <em>lower</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double & </td>
<td class="paramname"> <em>upper</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double & </td>
<td class="paramname"> <em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double & </td>
<td class="paramname"> <em>max_size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves values indicating the range and current position of a <a class="el" href="classGtk_1_1Ruler.html" title="Base class for horizontal or vertical rulers.">Gtk::Ruler</a>. </p>
<p>See <a class="el" href="classGtk_1_1Ruler.html#aae0d333e26bb4171230ebeb18d666220" title="sets the range of the ruler.">set_range()</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>lower</em> </td><td>Location to store lower limit of the ruler, or <code>0</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>upper</em> </td><td>Location to store upper limit of the ruler, or <code>0</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>position</em> </td><td>Location to store the current position of the mark on the ruler, or <code>0</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>max_size</em> </td><td>Location to store the maximum size of the ruler used when calculating the space to leave for the text, or <code>0</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac62fa390f2bec13d89c4d1288264879d"></a><!-- doxytag: member="Gtk::Ruler::get_range_lower" ref="ac62fa390f2bec13d89c4d1288264879d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double Gtk::Ruler::get_range_lower </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000049">Deprecated:</a></b></dt><dd>Use <a class="el" href="classGtk_1_1Ruler.html#aa2507798293c573295a28e0e4be09010" title="Retrieves values indicating the range and current position of a Gtk::Ruler.">get_range()</a> instead. </dd></dl>
</div>
</div>
<a class="anchor" id="af57557b0e2bc0f4c029a14321ce52e6c"></a><!-- doxytag: member="Gtk::Ruler::get_range_upper" ref="af57557b0e2bc0f4c029a14321ce52e6c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double Gtk::Ruler::get_range_upper </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000050">Deprecated:</a></b></dt><dd>Use <a class="el" href="classGtk_1_1Ruler.html#aa2507798293c573295a28e0e4be09010" title="Retrieves values indicating the range and current position of a Gtk::Ruler.">get_range()</a> instead. </dd></dl>
</div>
</div>
<a class="anchor" id="a8a6bfd2d664c51ce588701c012687c4c"></a><!-- doxytag: member="Gtk::Ruler::gobj" ref="a8a6bfd2d664c51ce588701c012687c4c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GtkRuler* Gtk::Ruler::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GtkObject. </p>
<p>Reimplemented from <a class="el" href="classGtk_1_1Widget.html#ad998178529a53b80f3de96d10b1deffd">Gtk::Widget</a>.</p>
<p>Reimplemented in <a class="el" href="classGtk_1_1VRuler.html#a9b52189af94592ec8e9e35d0e7a68f1e">Gtk::VRuler</a>, and <a class="el" href="classGtk_1_1HRuler.html#ac10215e186955ff48d54c925a5f87986">Gtk::HRuler</a>.</p>
</div>
</div>
<a class="anchor" id="ad8a837a3f262b4b654d29707d5184042"></a><!-- doxytag: member="Gtk::Ruler::gobj" ref="ad8a837a3f262b4b654d29707d5184042" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkRuler* Gtk::Ruler::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GtkObject. </p>
<p>Reimplemented from <a class="el" href="classGtk_1_1Widget.html#a6667a82920375b2ebde07bc1ffdc3641">Gtk::Widget</a>.</p>
<p>Reimplemented in <a class="el" href="classGtk_1_1VRuler.html#acb6631190b8716f9aaa12d691cd5ffb9">Gtk::VRuler</a>, and <a class="el" href="classGtk_1_1HRuler.html#aa9ed13c23b0e1d9d65a1ccd635137a52">Gtk::HRuler</a>.</p>
</div>
</div>
<a class="anchor" id="a41323cef766198e4150d2f3d048561f5"></a><!-- doxytag: member="Gtk::Ruler::property_lower" ref="a41323cef766198e4150d2f3d048561f5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><double> Gtk::Ruler::property_lower </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Lower limit of ruler. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="aa42355084a1abef5fe4c9c94b3f377b6"></a><!-- doxytag: member="Gtk::Ruler::property_lower" ref="aa42355084a1abef5fe4c9c94b3f377b6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><double> Gtk::Ruler::property_lower </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Lower limit of ruler. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a51543bc337b18c82ebf9437b5ec80bcd"></a><!-- doxytag: member="Gtk::Ruler::property_max_size" ref="a51543bc337b18c82ebf9437b5ec80bcd" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><double> Gtk::Ruler::property_max_size </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Maximum size of the ruler. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a225a29d7d7453e7c446d93d4b321553d"></a><!-- doxytag: member="Gtk::Ruler::property_max_size" ref="a225a29d7d7453e7c446d93d4b321553d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><double> Gtk::Ruler::property_max_size </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Maximum size of the ruler. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="ae3a4951fbb4f583fea79d884659346c1"></a><!-- doxytag: member="Gtk::Ruler::property_position" ref="ae3a4951fbb4f583fea79d884659346c1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><double> Gtk::Ruler::property_position </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Position of mark on the ruler. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a7ef7111f462befbc8dc651ab492ac7aa"></a><!-- doxytag: member="Gtk::Ruler::property_position" ref="a7ef7111f462befbc8dc651ab492ac7aa" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><double> Gtk::Ruler::property_position </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Position of mark on the ruler. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a044c6bdcc0b62d04d357c0d59875a467"></a><!-- doxytag: member="Gtk::Ruler::property_upper" ref="a044c6bdcc0b62d04d357c0d59875a467" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><double> Gtk::Ruler::property_upper </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Upper limit of ruler. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a465828cdefb780ceff461fb41a36b4d2"></a><!-- doxytag: member="Gtk::Ruler::property_upper" ref="a465828cdefb780ceff461fb41a36b4d2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><double> Gtk::Ruler::property_upper </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Upper limit of ruler. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a632a58dfe2fc52f8763f4c8524f97cbd"></a><!-- doxytag: member="Gtk::Ruler::set_metric" ref="a632a58dfe2fc52f8763f4c8524f97cbd" args="(MetricType metric=PIXELS)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Ruler::set_metric </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__gtkmmEnums.html#ga22dc1ec34acb004dd747bec08b35645b">MetricType</a> </td>
<td class="paramname"> <em>metric</em> = <code>PIXELS</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the desired metric of the ruler. </p>
<p>The possible choices are: </p>
<ul>
<li>
<a class="el" href="group__gtkmmEnums.html#gga22dc1ec34acb004dd747bec08b35645bac089e72893404dbac06b1b8277e5473d">Gtk::PIXELS</a> </li>
<li>
<a class="el" href="group__gtkmmEnums.html#gga22dc1ec34acb004dd747bec08b35645ba7342539132c465d1d8ec4de493c73c89">Gtk::INCHES</a> </li>
<li>
<a class="el" href="group__gtkmmEnums.html#gga22dc1ec34acb004dd747bec08b35645ba500d37856dab279f66b26bea2dc286cd">Gtk::CENTIMETERS</a> </li>
</ul>
<p>The default metric is <a class="el" href="group__gtkmmEnums.html#gga22dc1ec34acb004dd747bec08b35645bac089e72893404dbac06b1b8277e5473d">Gtk::PIXELS</a>. </p>
</div>
</div>
<a class="anchor" id="aae0d333e26bb4171230ebeb18d666220"></a><!-- doxytag: member="Gtk::Ruler::set_range" ref="aae0d333e26bb4171230ebeb18d666220" args="(double lower, double upper, double position, double max_size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Ruler::set_range </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>lower</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>upper</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>max_size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>sets the range of the ruler. </p>
<p><em>upper</em> and <em>lower</em> arguments denote the extents of the <a class="el" href="classGtk_1_1Ruler.html" title="Base class for horizontal or vertical rulers.">Ruler</a>. <em>max_size</em> is the largest number displayed by the ruler. <em>position</em> gives the initial value of the ruler. Rulers do not have sane defaults so this function should always be called. </p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a7bb855061d75c8e5f04c95802f6932a9"></a><!-- doxytag: member="Gtk::Ruler::wrap" ref="a7bb855061d75c8e5f04c95802f6932a9" args="(GtkRuler *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1Ruler.html">Gtk::Ruler</a>* wrap </td>
<td>(</td>
<td class="paramtype">GtkRuler * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>gtkmm/ruler.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 13:22:00 2010 for gtkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
22e237efd6851989a23adf3360bb53d0
>
files
>
632
