Package RASCAL.Caret

Description	Caret related event definitions and subprograms.
Author	bbracke
Date	2005/11/21 20:14:33
Revision	1.1

Clauses

Quick access : Clauses - Generics - Definitions - Subprograms

Context clauses
RASCAL.OS

Use clauses
RASCAL.OS

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Reason_LoseCaret_Pointer	access Reason_LoseCaret
Reason_GainCaret_Pointer	access Reason_GainCaret

Reason_LoseCaret	record
The caret has been moved away from the window.
*Component*	*Type*	*Default*
Caret_Index	Integer
Caret_Height	Integer
Caret_Y_Offset	Integer
Caret_X_Offset	Integer
Icon_Handle	Icon_Handle_Type
Window_Handle	Wimp_Handle_Type

AWEL_Reason_LoseCaret	abstract tagged record
inheritance from	Wimp_EventListener (Reason_Event_LoseCaret, -1, -1)
*Component*	*Type*	*Default*
Event	Reason_LoseCaret_Pointer

Reason_GainCaret	record
The caret has been moved into the window.
*Component*	*Type*	*Default*
Caret_Index	Integer
Caret_Height	Integer
Caret_Y_Offset	Integer
Caret_X_Offset	Integer
Icon_Handle	Icon_Handle_Type
Window_Handle	Wimp_Handle_Type

AWEL_Reason_GainCaret	abstract tagged record
inheritance from	Wimp_EventListener (Reason_Event_GainCaret, -1, -1)
*Component*	*Type*	*Default*
Event	Reason_GainCaret_Pointer

Caret_Position_Type	record
*Component*	*Type*	*Default*
Index	Integer
Flags	Integer
Y_Offset	Integer
X_Offset	Integer
Icon	Icon_Handle_Type
Window	Wimp_Handle_Type

Pragmas
Convention	(C, Reason_LoseCaret)
Convention	(C, Reason_GainCaret)
Convention	(C, Caret_Position_Type)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Remove	procedure
Removes the Caret from wherever it currently is.

Get_Position	procedure
Returns information on the position of thw Caret.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	out
Icon	Icon_Handle_Type	out
X_Offset	Integer	out
Y_Offset	Integer	out
Flags	Integer	out
Index	Integer	out

Set_Position	procedure
This moves the caret to a new position. If the caret is moved to a new window, a LoseCaret message is sent to the owner of the old window, and a GainCaret message is sent to the owner of the new one.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in	-1
X_Offset	Integer	in	0
Y_Offset	Integer	in	0
Flags	Integer	in	-1
Index	Integer	in	-1