gtk2/docs/reference/gtk/tmpl/gtkruler.sgml
Havoc Pennington 372853b107 put GtkPacker back in here so it won't be in gtk-unused.txt, but don't put
2001-09-08  Havoc Pennington  <hp@pobox.com>

	* gtk/gtk-sections.txt: put GtkPacker back in here so it won't be
	in gtk-unused.txt, but don't put it back in gtk-docs.sgml.

	Tons of other additions from gtk-unused.txt, but mostly skipping
	all the tree stuff for now.

2001-09-08  Havoc Pennington  <hp@pobox.com>

	* gtk/gtktreeviewcolumn.c (gtk_tree_view_column_add_attribute):
	docs fixes

	* gtk/gtktable.c (gtk_table_get_col_spacing): docs fixes

	* gtk/gtkspinbutton.c (gtk_spin_button_get_increments): docs fixes

	* gtk/gtksocket.c (gtk_socket_steal): docs fixes

	* gtk/gtkscrolledwindow.h: docs fixes

	* gtk/gtkimage.c (gtk_image_new): docs fixes
2001-09-08 06:24:46 +00:00

113 lines
2.6 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
GtkRuler
<!-- ##### SECTION Short_Description ##### -->
Base class for horizontal or vertical rulers
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<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
<!-- ##### FUNCTION gtk_ruler_get_metric ##### -->
<para>
</para>
@ruler:
@Returns:
<!-- ##### FUNCTION gtk_ruler_get_range ##### -->
<para>
</para>
@ruler:
@lower:
@upper:
@position:
@max_size:
<!-- ##### ARG GtkRuler:lower ##### -->
<para>
</para>
<!-- ##### ARG GtkRuler:upper ##### -->
<para>
</para>
<!-- ##### ARG GtkRuler:position ##### -->
<para>
</para>
<!-- ##### ARG GtkRuler:max-size ##### -->
<para>
</para>