Class TRbwRuler

Description

Hierarchy

Fields

Methods

Properties

Unit

RbwRuler

Declaration

type TRbwRuler = class(TPaintBox)

Description

TRbwRuler draws a ruler.

The orientation, scaling, number format, and position of the ruler can be controlled through properties. Rotated text will only work if a TrueType font is used.

Hierarchy

TPaintBox
TRbwRuler

Overview

Fields

FPainter: TRulerPainter;

Methods

	`procedure SetRulerDesiredSpacing(const Value: integer);`
	`procedure SetRulerDigits(Value: integer);`
	`procedure SetRulerLinePosition(const Value: integer);`
	`procedure SetRulerMajorTickLength(const Value: integer);`
	`procedure SetRulerMinorTickLength(const Value: integer);`
	`procedure SetRulerEnds(const Value: TRulerPositions);`
	`procedure SetRulerPrecision(Value: integer);`
	`procedure SetRulerPosition(const Value: TRulerPosition);`
	`procedure SetRulerStart(const Value: TStart);`
	`procedure SetRulerTextOffset(const Value: integer);`
	`procedure SetRulerTextPosition(const Value: TTextPosition);`
	`procedure SetRulerValues(const Value: TRulerValues);`
	`function GetRulerDesiredSpacing: integer;`
	`procedure PainterInvalidate(Sender: TObject);`
	`function GetRulerDigits: integer;`
	`function GetRulerEnds: TRulerPositions;`
	`function GetRulerLinePosition: integer;`
	`function GetRulerMajorTickLength: integer;`
	`function GetRulerMinorTickLength: integer;`
	`function GetRulerPosition: TRulerPosition;`
	`function GetRulerPrecision: integer;`
	`function GetRulerStart: TStart;`
	`function GetRulerTextOffset: integer;`
	`function GetRulerTextPosition: TTextPosition;`
	`function GetRulerValues: TRulerValues;`
	`procedure Paint; override;`
	`constructor Create(AOwner: TComponent); override;`
	`destructor Destroy; override;`
	`procedure PaintRotated(ACanvas: TCanvas; const X, Y, Angle: double; const Text: string); virtual;`

Properties

	`property Painter: TRulerPainter read FPainter;`
	`property RulerDesiredSpacing: integer read GetRulerDesiredSpacing write SetRulerDesiredSpacing default 60;`
	`property RulerDigits: integer read GetRulerDigits write SetRulerDigits;`
	`property RulerEnds: TRulerPositions read GetRulerEnds write SetRulerEnds;`
	`property RulerLinePosition: integer read GetRulerLinePosition write SetRulerLinePosition;`
	`property RulerMajorTickLength: integer read GetRulerMajorTickLength write SetRulerMajorTickLength;`
	`property RulerMinorTickLength: integer read GetRulerMinorTickLength write SetRulerMinorTickLength;`
	`property RulerPosition: TRulerPosition read GetRulerPosition write SetRulerPosition;`
	`property RulerPrecision: integer read GetRulerPrecision write SetRulerPrecision;`
	`property RulerStart: TStart read GetRulerStart write SetRulerStart;`
	`property RulerTextOffset: integer read GetRulerTextOffset write SetRulerTextOffset;`
	`property RulerTextPosition: TTextPosition read GetRulerTextPosition write SetRulerTextPosition;`
	`property RulerValues: TRulerValues read GetRulerValues write SetRulerValues;`

Description

Fields

	`FPainter: TRulerPainter;`

Methods

	`procedure SetRulerDesiredSpacing(const Value: integer);`
See RulerDesiredSpacing.

	`procedure SetRulerDigits(Value: integer);`
See RulerDigits.

	`procedure SetRulerLinePosition(const Value: integer);`
See RulerLinePosition.

	`procedure SetRulerMajorTickLength(const Value: integer);`
See RulerMajorTickLength.

	`procedure SetRulerMinorTickLength(const Value: integer);`
See RulerMinorTickLength.

	`procedure SetRulerEnds(const Value: TRulerPositions);`
See RulerEnds.

	`procedure SetRulerPrecision(Value: integer);`
See RulerPrecision.

	`procedure SetRulerPosition(const Value: TRulerPosition);`
See RulerPosition.

	`procedure SetRulerStart(const Value: TStart);`
See RulerStart.

	`procedure SetRulerTextOffset(const Value: integer);`
See RulerTextOffset.

	`procedure SetRulerTextPosition(const Value: TTextPosition);`
See RulerTextPosition.

	`procedure SetRulerValues(const Value: TRulerValues);`
See RulerValues.

	`function GetRulerDesiredSpacing: integer;`
See RulerDesiredSpacing.

	`procedure PainterInvalidate(Sender: TObject);`
`PainterInvalidate` is the event handler for OnInvalidate. It calls Invalidate.

	`function GetRulerDigits: integer;`
See RulerDigits.

	`function GetRulerEnds: TRulerPositions;`
See RulerEnds.

	`function GetRulerLinePosition: integer;`
See RulerLinePosition.

	`function GetRulerMajorTickLength: integer;`
See RulerMajorTickLength.

	`function GetRulerMinorTickLength: integer;`
See RulerMinorTickLength.

	`function GetRulerPosition: TRulerPosition;`
See RulerPosition.

	`function GetRulerPrecision: integer;`
See RulerPrecision.

	`function GetRulerStart: TStart;`
See RulerStart.

	`function GetRulerTextOffset: integer;`
See RulerTextOffset.

	`function GetRulerTextPosition: TTextPosition;`
See RulerTextPosition.

	`function GetRulerValues: TRulerValues;`
See RulerValues.

	`procedure Paint; override;`
`Paint` calls inherited `Paint` and then draws the ruler.

	`constructor Create(AOwner: TComponent); override;`
`Create` creates and instance of `TRbwRuler`

	`destructor Destroy; override;`
`Destroy` destroys the current instance of `TRbwRuler`. Do not call `Destroy` directly. Call Free instead.

	`procedure PaintRotated(ACanvas: TCanvas; const X, Y, Angle: double; const Text: string); virtual;`
`PaintRotated` draws Text at the position X,Y at the angle specified by Angle. X and Y are in pixels (despite being real numbers). Angle is measured in degrees in a clockwise direction. The font must be a TrueType Font for `PaintRotated` to work properly.

Properties

	`property Painter: TRulerPainter read FPainter;`

	`property RulerDesiredSpacing: integer read GetRulerDesiredSpacing write SetRulerDesiredSpacing default 60;`
`RulerDesiredSpacing` is the desired spacing between major ticks in pixels. The actual spacing will, in most cases, be slightly different from `RulerDesiredSpacing`.

	`property RulerDigits: integer read GetRulerDigits write SetRulerDigits;`
`RulerDigits` specifies how many digits will appear in the exponent portion of numbers on the ruler.

	`property RulerEnds: TRulerPositions read GetRulerEnds write SetRulerEnds;`
`RulerEnds` specifies the positions, in pixels, of the starting and ending ends of the main line of the ruler.

	`property RulerLinePosition: integer read GetRulerLinePosition write SetRulerLinePosition;`
`RulerLinePosition` specifies the distance of the main line of the ruler from the left, top, right, or bottom edge in pixels. Which one is determined by RulerPosition.

	`property RulerMajorTickLength: integer read GetRulerMajorTickLength write SetRulerMajorTickLength;`
`RulerMajorTickLength` is the length of the major ticks in pixels.

	`property RulerMinorTickLength: integer read GetRulerMinorTickLength write SetRulerMinorTickLength;`
`RulerMinorTickLength` is the length of the minor ticks in pixels.

	`property RulerPosition: TRulerPosition read GetRulerPosition write SetRulerPosition;`
See RulerPosition.

	`property RulerPrecision: integer read GetRulerPrecision write SetRulerPrecision;`
`RulerPrecision` specifies how many digits appear in the number in the ruler.

	`property RulerStart: TStart read GetRulerStart write SetRulerStart;`
`RulerStart` specifies the end of the ruler that has the lower value of the ruler.

	`property RulerTextOffset: integer read GetRulerTextOffset write SetRulerTextOffset;`
`RulerTextOffset` specifies the distance from the main line of the ruler to the labels on the ruler.

	`property RulerTextPosition: TTextPosition read GetRulerTextPosition write SetRulerTextPosition;`
`RulerTextPosition` specifies whether the labels are inside or outside the ruler.

	`property RulerValues: TRulerValues read GetRulerValues write SetRulerValues;`
`RulerValues` specifies the values of the lower and upper end of the ruler line. Thus the ruler represents a length equal to TRulerValues.Upper minus TRulerValues.Lower

Generated by PasDoc 0.12.1 on 2013-05-13 15:42:00