Class TCursorControl

Fields

Unit

Declaration

type TCursorControl = class(TReferenceCounted)

Description

Interface to manipulate the mouse cursor.

Hierarchy

TInterfacedObject
TWrapper
TReferenceCounted
TCursorControl

Overview

Methods

	`procedure ResetReferenceRect; inline;`
	`procedure SetReferenceRect(const NewRect: TRect); inline;`

Properties

	`property Position: TPoint read GetPosition write SetPosition;`
	`property RelativePosition: TVector2D read GetRelativePosition write SetRelativePosition;`
	`property Visible: Boolean read IsVisible write SetVisible;`

Description

Methods

	`procedure ResetReferenceRect; inline;`
Resets the reference rect to the render window bounds.

	`procedure SetReferenceRect(const NewRect: TRect); inline;`
Sets an absolute reference rect for setting and retrieving the cursor position. If this rect is set, the cursor position is not being calculated relative to the rendering window but to this rect. This feature is useful when rendering into parts of foreign windows for example in an editor.

Properties

	`property Position: TPoint read GetPosition write SetPosition;`
The cursor `position` in pixel coordinates.

	`property RelativePosition: TVector2D read GetRelativePosition write SetRelativePosition;`
The current position of the cursor relative to the render window's border. The returned position is a value between (0.0f, 0.0f) and (1.0f, 1.0f), where (0.0f, 0.0f) is the top left corner and (1.0f, 1.0f) is the bottom right corner of the render window.

	`property Visible: Boolean read IsVisible write SetVisible;`
Specifies whether the cursor is currently `visible`.

Generated by PasDoc 0.12.1 on 2012-09-14 17:32:22