Package RASCAL.WimpIcon

Description	Wimp icon related types and methods.
Author	bbracke
Date	2005/11/21 20:14:33
Revision	1.1

Clauses

Quick access : Clauses - Generics - Definitions - Subprograms

Context clauses
Interfaces.C
Kernel
System
RASCAL.OS
RASCAL.Memory

Use clauses
Interfaces.C
Kernel
System
RASCAL.OS
RASCAL.Memory

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
Wimp_SetCaretPosition	Interfaces.C.unsigned	16#400D2#	constant
Wimp_GetCaretPosition	Interfaces.C.unsigned	16#400D3#	constant
Wimp_CreateIcon	Interfaces.C.unsigned	16#400C2#	constant
Wimp_PlotIcon	Interfaces.C.unsigned	16#400E2#	constant
Wimp_ResizeIcon	Interfaces.C.unsigned	16#400FC#	constant
Wimp_SetIconState	Interfaces.C.unsigned	16#400CD#	constant
Wimp_GetIconState	Interfaces.C.unsigned	16#400CE#	constant
Wimp_WhichIcon	Interfaces.C.unsigned	16#400D6#	constant
Wimp_DeleteIcon	Interfaces.C.unsigned	16#400C4#	constant
f_IconHasText	integer	16#0#	constant
m_IconHasText	integer	16#1#	constant
f_IconIsSprite	integer	16#1#	constant
m_IconIsSprite	integer	16#2#	constant
f_IconHasBorder	integer	16#2#	constant
m_IconHasBorder	integer	16#4#	constant
f_IconHorizontalCentred	integer	16#3#	constant
m_IconHorizontalCentred	integer	16#8#	constant
f_IconVerticalCentred	integer	16#4#	constant
m_IconVerticalCentred	integer	16#10#	constant
f_IconFilled	integer	16#5#	constant
m_IconFilled	integer	16#20#	constant
f_IconAntiAliased	integer	16#6#	constant
m_IconAntiAliased	integer	16#40#	constant
f_IconNeedsHelp	integer	16#7#	constant
m_IconNeedsHelp	integer	16#80#	constant
f_IconIndirected	integer	16#8#	constant
m_IconIndirected	integer	16#100#	constant
f_IconRightJustified	integer	16#9#	constant
m_IconRightJustified	integer	16#200#	constant
f_IconAdjust	integer	16#a#	constant
m_IconAdjust	integer	16#400#	constant
f_IconHalfSprite	integer	16#b#	constant
m_IconHalfSprite	integer	16#800#	constant
f_IconSelected	integer	16#15#	constant
m_IconSelected	integer	16#200000#	constant
f_IconShaded	integer	16#16#	constant
m_IconShaded	integer	16#400000#	constant
f_IconDeleted	integer	16#17#	constant
m_IconDeleted	integer	16#800000#	constant
texticonssize	integer	2	constant
texticonbuffer	texticonbuffertyp
texticonbufferoffset	Integer	0

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
spriteareatyp	new Integer
iconhandletyp	new Integer
indirecteddataptr	new Integer
iconarray_type	array (0..63) of Integer
texticonbuffertyp	array (0..texticonssize - 1) of Character
Alignment_Type	(Left, Centre, Right)
derzeitiger Offset zum freien Element

Wimp_IconState_Type	record
*Component*	*Type*	*Default*
Data	Char_Array (1..12)
Flags	Integer
Max_Y	Integer
Max_X	Integer
Min_Y	Integer
Min_X	Integer
Icon	Icon_Handle_Type
Window	Wimp_Handle_Type

Wimp_CreateIcon_Type	record
*Component*	*Type*	*Default*
Data	Char_Array (1..12)
Flags	Integer	0
Max_Y	Integer	0
Max_X	Integer	0
Min_Y	Integer	0
Min_X	Integer	0
Window	Wimp_Handle_Type

Wimp_SetIconState_Tyoe	record
*Component*	*Type*	*Default*
Clear_Word	Integer
EOR_Word	Integer
Icon	Icon_Handle_Type
Window	Wimp_Handle_Type

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Get_Alignment	function
*Return*	Alignment_Type
Returns the alignment of the text in the icons.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in

Get_Validation	function
*Return*	String
Returns the validation string of the icon.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in

Set_Validation	procedure
Sets the validation string of the icon.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in
Validation	String	in
Redraw	Boolean	in	true

Get_Text	function
*Return*	String
Returns the icon's text value.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in

Set_Text	procedure
Sets the icon's text value.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in
Text	String	in
Redraw	Boolean	in	true

Set_State	procedure
Set the icon's flags.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in
Flags	Integer	in
Mask	Integer	in

Change_ButtonType	procedure
Changes the icon's button type.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in
Button	Integer	in

Redraw_Icon	procedure
Forces the icon to be redrawn.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in

Select_Icon	procedure
Select icon.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in

UnSelect	procedure
Unselect icon.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in

Is_Selectable	function
*Return*	Boolean
Returns true if icon is selectable.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in

Make_Selectable	procedure
Make icon selectable.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in

Make_Unselectable	procedure
Make icon unselectable.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in

Is_Selected	function
*Return*	Boolean
Return true if icon is selected.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in

Delete_Icon	procedure
Deletes the icon.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in

Create_Button	function
*Return*	Icon_Handle_Type
Creates a new button.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Min_X	Integer	in
Min_Y	Integer	in
Max_X	Integer	in
Max_Y	Integer	in
Text	String	in
Adresse	Address	in

Create_TextIcon	function
*Return*	Icon_Handle_Type
Create text icon

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Min_X	Integer	in
Min_Y	Integer	in
Max_X	Integer	in
Max_Y	Integer	in
Flags	Integer	in
Text	String	in
bufferlength	Integer	in
Adresse	Address	in

Create_TextIcon	function
*Return*	Icon_Handle_Type
Create text icon.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Min_X	Integer	in
Min_Y	Integer	in
Max_X	Integer	in
Max_Y	Integer	in
Flags	Integer	in
Text	String	in
bufferlength	Integer	in	0

Create_FrameIcon	procedure
Create frame icon.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Min_X	Integer	in
Min_Y	Integer	in
Max_X	Integer	in
Max_Y	Integer	in
Titel	String	in

Get_Foreground	function
*Return*	Wimp_Colour
Return foreground colour of icon.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in

Get_Background	function
*Return*	Wimp_Colour
Return background colour of icon.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in

Set_Background	procedure
Set the icons background colour.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in
Colour	Wimp_Colour	in

Set_Foreground	procedure
Set the icons foreground colour.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in
Colour	Wimp_Colour	in