|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /usr/share/gtk-doc/html/gtk/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GtkRuler</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GTK+ 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.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="WindowWidgets.html" title="Windows">
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
<link rel="chapter" href="Ornaments.html" title="Ornaments">
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
<link rel="chapter" href="Printing.html" title="Printing">
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and
GtkComboBoxEntry">
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
</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="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkGammaCurve.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="SpecialObjects.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ Reference Manual</th>
<td><a accesskey="n" href="GtkHRuler.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3774354" class="shortcut">Top</a>
 | 
<a href="#id3775486" class="shortcut">Description</a>
 | 
<a href="#id3775301" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id3775362" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id3775385" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkRuler"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id3774354"></a><span class="refentrytitle">GtkRuler</span>
</h2>
<p>GtkRuler — Base class for horizontal or vertical rulers</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <gtk/gtk.h>
<a href="GtkRuler.html#GtkRuler-struct">GtkRuler</a>;
<a href="GtkRuler.html#GtkRulerMetric">GtkRulerMetric</a>;
void <a href="GtkRuler.html#gtk-ruler-set-metric">gtk_ruler_set_metric</a> (<a href="GtkRuler.html" title="GtkRuler">GtkRuler</a> *ruler,
<a href="gtk-Standard-Enumerations.html#GtkMetricType">GtkMetricType</a> metric);
void <a href="GtkRuler.html#gtk-ruler-set-range">gtk_ruler_set_range</a> (<a href="GtkRuler.html" title="GtkRuler">GtkRuler</a> *ruler,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> lower,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> upper,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> position,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> max_size);
<a href="gtk-Standard-Enumerations.html#GtkMetricType">GtkMetricType</a> <a href="GtkRuler.html#gtk-ruler-get-metric">gtk_ruler_get_metric</a> (<a href="GtkRuler.html" title="GtkRuler">GtkRuler</a> *ruler);
void <a href="GtkRuler.html#gtk-ruler-get-range">gtk_ruler_get_range</a> (<a href="GtkRuler.html" title="GtkRuler">GtkRuler</a> *ruler,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *lower,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *upper,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *position,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *max_size);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3775301"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a href="GtkObject.html" title="GtkObject">GtkObject</a>
+----<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
+----GtkRuler
+----<a href="GtkHRuler.html" title="GtkHRuler">GtkHRuler</a>
+----<a href="GtkVRuler.html" title="GtkVRuler">GtkVRuler</a>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3775362"></a><h2>Implemented Interfaces</h2>
<p>
GtkRuler implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id3775385"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GtkRuler.html#GtkRuler--lower">lower</a>" <a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> : Read / Write
"<a href="GtkRuler.html#GtkRuler--max-size">max-size</a>" <a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> : Read / Write
"<a href="GtkRuler.html#GtkRuler--metric">metric</a>" <a href="gtk-Standard-Enumerations.html#GtkMetricType">GtkMetricType</a> : Read / Write
"<a href="GtkRuler.html#GtkRuler--position">position</a>" <a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> : Read / Write
"<a href="GtkRuler.html#GtkRuler--upper">upper</a>" <a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3775486"></a><h2>Description</h2>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
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.
</p>
</div>
<p>
The GTKRuler widget is a base class for horizontal and vertical rulers. Rulers
are used to show the mouse pointer's location in a window. The ruler can either
be horizontal or vertical on the window. Within the ruler a small triangle
indicates the location of the mouse relative to the horizontal or vertical
ruler. See <a href="GtkHRuler.html" title="GtkHRuler"><span class="type">GtkHRuler</span></a> to learn how to create a new horizontal ruler. See
<a href="GtkVRuler.html" title="GtkVRuler"><span class="type">GtkVRuler</span></a> to learn how to create a new vertical ruler.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id3775536"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id3775547"></a><h3>
<a name="GtkRuler-struct"></a>GtkRuler</h3>
<a class="indexterm" name="id3775560"></a><pre class="programlisting">typedef struct _GtkRuler GtkRuler;</pre>
<p>
All distances are in 1/72nd's of an inch. (According to Adobe thats a point, but
points are really 1/72.27 in.)
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3775577"></a><h3>
<a name="GtkRulerMetric"></a>GtkRulerMetric</h3>
<a class="indexterm" name="id3775590"></a><pre class="programlisting">typedef struct {
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 */
} GtkRulerMetric;
</pre>
<p>
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.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3775612"></a><h3>
<a name="gtk-ruler-set-metric"></a>gtk_ruler_set_metric ()</h3>
<a class="indexterm" name="id3775626"></a><pre class="programlisting">void gtk_ruler_set_metric (<a href="GtkRuler.html" title="GtkRuler">GtkRuler</a> *ruler,
<a href="gtk-Standard-Enumerations.html#GtkMetricType">GtkMetricType</a> metric);</pre>
<p>
This calls the <span class="type">GTKMetricType</span> to set the ruler to units defined. Available units
are GTK_PIXELS, GTK_INCHES, or GTK_CENTIMETERS. The default unit of measurement
is GTK_PIXELS.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>ruler</code></em> :</span></td>
<td>the gtkruler
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>metric</code></em> :</span></td>
<td>the unit of measurement
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3775706"></a><h3>
<a name="gtk-ruler-set-range"></a>gtk_ruler_set_range ()</h3>
<a class="indexterm" name="id3775720"></a><pre class="programlisting">void gtk_ruler_set_range (<a href="GtkRuler.html" title="GtkRuler">GtkRuler</a> *ruler,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> lower,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> upper,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> position,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> max_size);</pre>
<p>
This sets the range of the ruler using gfloat lower, gfloat upper, gfloat position, and gfloat max_size.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>ruler</code></em> :</span></td>
<td>the gtkruler
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>lower</code></em> :</span></td>
<td>the lower limit of the ruler
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>upper</code></em> :</span></td>
<td>the upper limit of the ruler
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>position</code></em> :</span></td>
<td>the mark on the ruler
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>max_size</code></em> :</span></td>
<td>the maximum size of the ruler
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3775855"></a><h3>
<a name="gtk-ruler-get-metric"></a>gtk_ruler_get_metric ()</h3>
<a class="indexterm" name="id3775868"></a><pre class="programlisting"><a href="gtk-Standard-Enumerations.html#GtkMetricType">GtkMetricType</a> gtk_ruler_get_metric (<a href="GtkRuler.html" title="GtkRuler">GtkRuler</a> *ruler);</pre>
<p>
Gets the units used for a <a href="GtkRuler.html" title="GtkRuler"><span class="type">GtkRuler</span></a>. See <a href="GtkRuler.html#gtk-ruler-set-metric"><code class="function">gtk_ruler_set_metric()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>ruler</code></em> :</span></td>
<td> a <a href="GtkRuler.html" title="GtkRuler"><span class="type">GtkRuler</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the units currently used for <em class="parameter"><code>ruler</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3775961"></a><h3>
<a name="gtk-ruler-get-range"></a>gtk_ruler_get_range ()</h3>
<a class="indexterm" name="id3775975"></a><pre class="programlisting">void gtk_ruler_get_range (<a href="GtkRuler.html" title="GtkRuler">GtkRuler</a> *ruler,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *lower,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *upper,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *position,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *max_size);</pre>
<p>
Retrieves values indicating the range and current position of a <a href="GtkRuler.html" title="GtkRuler"><span class="type">GtkRuler</span></a>.
See <a href="GtkRuler.html#gtk-ruler-set-range"><code class="function">gtk_ruler_set_range()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>ruler</code></em> :</span></td>
<td> a <a href="GtkRuler.html" title="GtkRuler"><span class="type">GtkRuler</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>lower</code></em> :</span></td>
<td> location to store lower limit of the ruler, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>upper</code></em> :</span></td>
<td> location to store upper limit of the ruler, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>position</code></em> :</span></td>
<td> 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>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>max_size</code></em> :</span></td>
<td> 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>.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3776182"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id3776193"></a><h3>
<a name="GtkRuler--lower"></a>The "<code class="literal">lower</code>" property</h3>
<a class="indexterm" name="id3776209"></a><pre class="programlisting"> "lower" <a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> : Read / Write</pre>
<p>Lower limit of ruler.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3776235"></a><h3>
<a name="GtkRuler--max-size"></a>The "<code class="literal">max-size</code>" property</h3>
<a class="indexterm" name="id3776251"></a><pre class="programlisting"> "max-size" <a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> : Read / Write</pre>
<p>Maximum size of the ruler.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3776278"></a><h3>
<a name="GtkRuler--metric"></a>The "<code class="literal">metric</code>" property</h3>
<a class="indexterm" name="id3776294"></a><pre class="programlisting"> "metric" <a href="gtk-Standard-Enumerations.html#GtkMetricType">GtkMetricType</a> : Read / Write</pre>
<p>
The metric used for the ruler.</p>
<p>
</p>
<p>Default value: GTK_PIXELS</p>
<p>Since 2.8
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3776329"></a><h3>
<a name="GtkRuler--position"></a>The "<code class="literal">position</code>" property</h3>
<a class="indexterm" name="id3776345"></a><pre class="programlisting"> "position" <a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> : Read / Write</pre>
<p>Position of mark on the ruler.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3776372"></a><h3>
<a name="GtkRuler--upper"></a>The "<code class="literal">upper</code>" property</h3>
<a class="indexterm" name="id3776388"></a><pre class="programlisting"> "upper" <a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> : Read / Write</pre>
<p>Upper limit of ruler.</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3776415"></a><h2>See Also</h2>
<p>
<a href="GtkHRuler.html" title="GtkHRuler"><span class="type">GtkHRuler</span></a>, <a href="GtkVRuler.html" title="GtkVRuler"><span class="type">GtkVRuler</span></a>
</p>
</div>
</div>
</body>
</html>