Package RASCAL.ToolboxDisplayField

Description	Toolbox DisplayField 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
RASCAL.Toolbox
RASCAL.OS
RASCAL.WimpIcon
System.Unsigned_Types

Use clauses
RASCAL.Toolbox
RASCAL.OS
RASCAL.WimpIcon
System.Unsigned_Types

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
DisplayField_RJustified		16#2#	constant
Flags
DisplayField_HCentred		16#4#	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Get_Alignment	function
*Return*	Alignment_Type
How is the text in the displayfield aligned ?

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in

Get_Value	function
*Return*	String
Returns the text string shown in the display field.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Font	procedure
Sets the font used in the display field. Default is the system font.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Font	string	in
Font_Width	integer	in
Font_Height	integer	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Value	procedure
Sets the text string shown in the display field. The screen display is immediately updated if the window is on screen.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
New_Value	String	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_TruncatedValue	procedure
Sets the text string shown in the display field. The screen display is immediately updated if the window is on screen. The text is truncated to the size of the displayfield and an ellipsis is added.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
New_Value	String	in
Flags	System.Unsigned_Types.Unsigned	in	0