gtk2/docs/reference/gtk/tmpl/gtkruler.sgml
Owen Taylor 71337db92e Move gtk-reference files into GTK+ tree proper.
Thu Sep  7 14:15:03 2000  Owen Taylor  <otaylor@redhat.com>

        * gdk/* gtk/*: Move gtk-reference files into GTK+ tree proper.

	* Update sections.txt files to correspond to current code,
	tweak .sgml files and Makefiles to correspond.

	* gtk/tmpl/gtkradiomenuitem.sgml (this): Remove extra <para>
2000-09-07 18:17:06 +00:00

83 lines
2.0 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
GtkRuler
<!-- ##### SECTION Short_Description ##### -->
Base class for horizontal or vertical rulers
<!-- ##### SECTION Long_Description ##### -->
<para>
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 horixontal or vertical
ruler. See #GtkHRuler to learn how to create a new horizontal ruler. See
#GtkVRuler to learn how to create a new vertical ruler.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GtkHRuler, #GtkVRuler
</para>
<!-- ##### STRUCT GtkRuler ##### -->
<para>
All distances are in 1/72nd's of an inch. (According to Adobe thats a point, but
points are really 1/72.27 in.)
</para>
<!-- ##### STRUCT GtkRulerMetric ##### -->
<para>
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.
</para>
@metric_name:
@abbrev:
@pixels_per_unit:
@ruler_scale:
@subdivide:
<!-- ##### FUNCTION gtk_ruler_set_metric ##### -->
<para>
This calls the #GTKMetricType 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.
</para>
@ruler: the gtkruler
@metric: the unit of measurement
<!-- ##### FUNCTION gtk_ruler_set_range ##### -->
<para>
This sets the range of the ruler using gfloat lower, gfloat upper, gfloat position, and gfloat max_size.
</para>
@ruler: the gtkruler
@lower: the upper limit of the ruler
@upper: the lower limit of the ruler
@position: the mark on the ruler
@max_size: the maximum size of the ruler
<!-- ##### ARG GtkRuler:lower ##### -->
<para>
</para>
<!-- ##### ARG GtkRuler:upper ##### -->
<para>
</para>
<!-- ##### ARG GtkRuler:position ##### -->
<para>
</para>
<!-- ##### ARG GtkRuler:max_size ##### -->
<para>
</para>