Gtk::Ruler Class Reference
[Widgets]

Base class for horizontal or vertical rulers. More...

Inherited by Gtk::HRuler, and Gtk::VRuler.

Collaboration diagram for Gtk::Ruler:

Public Member Functions
virtual	~Ruler ()
GtkRuler*	gobj ()
	Provides access to the underlying C GtkObject.
const GtkRuler*	gobj () const
	Provides access to the underlying C GtkObject.
void	set_metric (MetricType metric=PIXELS)
	Sets the desired metric of the ruler.
MetricType	get_metric () const
	Gets the units used for a Gtk::Ruler.
MetricType	get_metric ()
	Gets the units used for a Gtk::Ruler.
double	get_range_lower () const
double	get_range_upper () const
void	set_range (double lower, double upper, double position, double max_size)
	sets the range of the ruler.
void	get_range (double& lower, double& upper, double& position, double& max_size)
	Retrieves values indicating the range and current position of a Gtk::Ruler.
void	draw_ticks ()
	draw tick marks on the ruler
void	draw_pos ()
	draw a position indicator on the ruler
virtual void	draw_ticks_vfunc ()
virtual void	draw_pos_vfunc ()
Glib::PropertyProxy< double >	property_lower ()
	Lower limit of ruler.
Glib::PropertyProxy_ReadOnly < double >	property_lower () const
	Lower limit of ruler.
Glib::PropertyProxy< double >	property_upper ()
	Upper limit of ruler.
Glib::PropertyProxy_ReadOnly < double >	property_upper () const
	Upper limit of ruler.
Glib::PropertyProxy< double >	property_position ()
	Position of mark on the ruler.
Glib::PropertyProxy_ReadOnly < double >	property_position () const
	Position of mark on the ruler.
Glib::PropertyProxy< double >	property_max_size ()
	Maximum size of the ruler.
Glib::PropertyProxy_ReadOnly < double >	property_max_size () const
	Maximum size of the ruler.
Protected Member Functions
	Ruler ()
Related Functions
(Note that these are not member functions.)
Gtk::Ruler*	wrap (GtkRuler* object, bool take_copy=false)
	A Glib::wrap() method for this object.

Detailed Description

Base class for horizontal or vertical rulers.

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.

This is an abstract base for Gtk::HRuler and Gtk::VRuler. Users should only instantiate those types.

Constructor & Destructor Documentation

virtual Gtk::Ruler::~Ruler ( ) [virtual]

Gtk::Ruler::Ruler ( ) [protected]

Member Function Documentation

void Gtk::Ruler::draw_pos ( )

draw a position indicator on the ruler

virtual void Gtk::Ruler::draw_pos_vfunc ( ) [virtual]

void Gtk::Ruler::draw_ticks ( )

draw tick marks on the ruler

virtual void Gtk::Ruler::draw_ticks_vfunc ( ) [virtual]

MetricType Gtk::Ruler::get_metric ( )

Gets the units used for a Gtk::Ruler.

See set_metric().

Deprecated:: Use the const version

Returns:: The units currently used for ruler.

MetricType Gtk::Ruler::get_metric ( ) const

Gets the units used for a Gtk::Ruler.

See set_metric().

Returns:: The units currently used for ruler.

void Gtk::Ruler::get_range	(	double &	lower,
		double &	upper,
		double &	position,
		double &	max_size
	)

Retrieves values indicating the range and current position of a Gtk::Ruler.

See set_range().

Parameters:

	lower	Location to store lower limit of the ruler, or `0`.
	upper	Location to store upper limit of the ruler, or `0`.
	position	Location to store the current position of the mark on the ruler, or `0`.
	max_size	Location to store the maximum size of the ruler used when calculating the space to leave for the text, or `0`.

double Gtk::Ruler::get_range_lower ( ) const

Deprecated:: Use get_range() instead.

double Gtk::Ruler::get_range_upper ( ) const

Deprecated:: Use get_range() instead.

const GtkRuler* Gtk::Ruler::gobj ( ) const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Widget.

Reimplemented in Gtk::VRuler, and Gtk::HRuler.

GtkRuler* Gtk::Ruler::gobj ( ) [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Widget.

Reimplemented in Gtk::VRuler, and Gtk::HRuler.

Glib::PropertyProxy_ReadOnly<double> Gtk::Ruler::property_lower ( ) const

Lower limit of ruler.