gwy.Ruler

Module gwy :: Class Ruler

[show private | hide private]

Class Ruler

Method Summary
	`draw_pos()` Draws a position marker.
	`get_range(lower, upper, position, max_size)` Retrieves values indicating the range and current position of a `Ruler`.
	`get_si_unit()` Returns: The units the rules uses.
	`get_units_placement()` Gets current units placement of ruler `ruler`.
	`set_range(lower, upper, position, max_size)` Sets range and current value of a ruler.
	`set_si_unit(units)` Sets the base units a ruler displays.
	`set_units_placement(placement)` Sets whether and where units should be placed on the ruler.

Method Details

Draws a position marker.

This method is intended primarily for subclass implementation.

Retrieves values indicating the range and current position of a Ruler. See Ruler.set_range().

Parameters:: lower - Location to store lower limit of the ruler, or NULL (float); upper - Location to store upper limit of the ruler, or NULL (float); position - Location to store the current position of the mark on the ruler, or NULL (float); max_size - Location to store the maximum size of the ruler used when calculating the space to leave for the text, or NULL. (float)

Returns: The units the rules uses.

Gets current units placement of ruler ruler.

Sets range and current value of a ruler.

Parameters:: lower - Lower limit of the ruler. (float); upper - Upper limit of the ruler. (float); position - Current position of the mark on the ruler. (float); max_size - Maximum value used for calculating size of text labels. (float)

Sets the base units a ruler displays.

Setting units to NULL effectively disables them.

Parameters:: units - The base units this ruler should display. (SIUnit)

Sets whether and where units should be placed on the ruler.

Parameters:: placement - Units placement specification.Expected values: UNITS_PLACEMENT_NONE, UNITS_PLACEMENT_AT_ZERO, (UnitsPlacement)

Generated by Epydoc 2.1 on Tue Dec 30 04:01:41 2008