Package RASCAL.ToolboxScale

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

Clauses

Basic Objects
*Name*	*Type*	*Default*
Scale_generate_about_to_be_shown		16#1#	constant
Scale
Scale_generate_dialogue_completed		16#2#	constant
Scale_include_scale_to_fit		16#4#	constant
Scale_percent		16#82C000#	constant
Scale_std_value0		16#82C001#	constant
Scale_std_value1		16#82C002#	constant
Scale_std_value2		16#82C003#	constant
Scale_std_value3		16#82C004#	constant
Scale_cancel		16#82C005#	constant
Scale_scale		16#82C006#	constant
Scale_percent_label		16#82C007#	constant
Scale_scale_label		16#82C008#	constant
Scale_scale_to_fit		16#82C009#	constant
Action_Scale_About_To_Be_Shown		16#82C00#	constant
Action_Scale_Dialogue_Completed		16#82C01#	constant
Action_Scale_Apply_Factor		16#82C02#	constant
Error_Scale_Tasks_Active		16#80B700#	constant
Error_Scale_Alloc_Failed		16#80B701#	constant
Error_Scale_Short_Buffer		16#80B702#	constant
Error_Scale_No_Such_Task		16#80B711#	constant
Error_Scale_No_Such_Method		16#80B712#	constant
Error_Scale_No_Such_Misc_Op_Method		16#80B713#	constant
Scale_Set_Lower_Bound		16#1#	constant
Scale_Set_Upper_Bound		16#2#	constant
Scale_Set_Step_Size		16#4#	constant

Types
*Name*	*Declaration*
standard_value_array	array (Natural) of Integer
Toolbox_Scale_AboutToBeShown_Pointer	access Toolbox_Scale_AboutToBeShown
Toolbox_Scale_ApplyFactor_Pointer	access Toolbox_Scale_ApplyFactor
Toolbox_Scale_DialogueCompleted_Pointer	access Toolbox_Scale_DialogueCompleted

ScaleTemplate	record
*Component*	*Type*	*Default*
std_value	standard_value_array (0..3)
Window	RASCAL.Utility.Address
Max_Title	Integer
Title	RASCAL.Utility.Address
Step_Size	Integer
Min_Value	Integer
Max_Value	Integer
Flags	System.Unsigned_Types.Unsigned

Toolbox_Scale_AboutToBeShown	record
Event is raised just before the Scale dialogue is displayed. Type lacks union.
*Component*	*Type*	*Default*
Info	Window_Position_Type (Full_Spec)
Show_Type	Integer
Header	Toolbox_Event_Header

ATEL_Toolbox_Scale_AboutToBeShown	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Scale_AboutToBeShown, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Scale_AboutToBeShown_Pointer

Toolbox_Scale_ApplyFactor	record
Event is raised when the user clicks on the 'Scale' or 'Scale to Fit' button, or presses return.
*Component*	*Type*	*Default*
Factor	System.Unsigned_Types.Unsigned
Header	Toolbox_Event_Header

ATEL_Toolbox_Scale_ApplyFactor	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Scale_ApplyFactor, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Scale_ApplyFactor_Pointer

Toolbox_Scale_DialogueCompleted	record
Event is raised after the Scale dialogue is hidden.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_Scale_DialogueCompleted	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Scale_DialogueCompleted, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Scale_DialogueCompleted_Pointer

Pragmas
Convention	(C, ScaleTemplate)
Convention	(C, Toolbox_Scale_AboutToBeShown)
Convention	(C, Toolbox_Scale_ApplyFactor)
Convention	(C, Toolbox_Scale_DialogueCompleted)

Get_Title	function
*Return*	string
Returns the title of the Scale dialogue window.

*Parameter name*	*Type*	*Mode*	*Default*
Scale	Object_ID	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Title	procedure
Sets the title of the Scale dialogue window.

*Parameter name*	*Type*	*Mode*	*Default*
Scale	Object_ID	in
Title	string	in
Flags	System.Unsigned_Types.Unsigned	in	0

Get_Window_ID	function
*Return*	Object_ID
Returns the Wimp Id of the underlying window.

*Parameter name*	*Type*	*Mode*	*Default*
Scale	Object_ID	in
Flags	System.Unsigned_Types.Unsigned	in	0

Get_Value	function
*Return*	integer
Returns the value of the writable field of the scale dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
Scale	Object_ID	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Value	procedure
Sets the value of the writable field of the scale dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
Scale	Object_ID	in
Value	integer	in
Flags	System.Unsigned_Types.Unsigned	in	0

Get_Bounds	function
*Return*	integer
Returns the lower and upper bounds and step size of the writable field in the scale dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
Scale	Object_ID	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Bounds	procedure
Sets the lower and upper bounds and step size of the writable field in the scale dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
Scale	Object_ID	in
Bounds	integer	in
Flags	System.Unsigned_Types.Unsigned	in	0