Package RASCAL.ToolboxTextArea

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

Clauses

Quick access : Clauses - Generics - Definitions - Subprograms

Context clauses
System
System.Unsigned_Types
RASCAL.Toolbox
RASCAL.ToolboxWindow
RASCAL.OS

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

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
TextArea_Scrollbar_Vertical	Integer	16#1#	constant
Flags
TextArea_Scrollbar_Horizontal	Integer	16#2#	constant
TextArea_WordWrap	Integer	16#4#	constant
TextArea_AllowSelection	Integer	16#8#	constant
TextArea_AllowSave	Integer	16#10#	constant
TextArea_AllowLoad	Integer	16#20#	constant
TextArea_Clipboard	Integer	16#40#	constant
TextArea_AutoScroll	Integer	16#80#	constant
TextArea_KeyNotification	Integer	16#100#	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Toolbox_TextArea_DataLoaded_Pointer	access Toolbox_TextArea_DataLoaded

Toolbox_TextArea_DataLoaded	record
This toolbox event is raised when the user drags a file into the textarea.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_TextArea_DataLoaded	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_TextArea_DataLoaded, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_TextArea_DataLoaded_Pointer

Pragmas
Convention	(C, Toolbox_TextArea_DataLoaded)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Get_State	function
*Return*	integer
Returns the state (flags) of the TextArea.

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

Set_State	procedure
Sets the state (flags) of the textarea.

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

Set_Text	procedure
Sets the text of the TextArea.

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

Get_Text	function
*Return*	String
Returns the text of the TextArea.

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

Insert_Text	procedure
Inserts text into TexTArea at specified position.

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

Replace_Text	procedure
Replaces text at the specified position in TextArea.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Text	string	in
End_Index	integer	in	0
Start_Index	integer	in	0
Flags	System.Unsigned_Types.Unsigned	in	0

Get_Selection	function
*Return*	String
Returns the selected text in the TextArea.

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

Get_Selection_Index	procedure
Returns the index values of the selections start and end in the TextArea.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Start_Index	integer	out
End_Index	integer	out

Set_Selection	procedure
Selects text by the TextArea.

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

Set_Font	procedure
Sets the font used in by the TextArea.

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

Set_Colour	procedure
Sets the foreground and background colour used by the TextArea.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Foreground	OS_Colour	in
Background	OS_Colour	in

Set_Colour	procedure
Sets the foreground and background colour used by the TextArea.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Foreground	Toolbox_Colour	in	7
Background	Toolbox_Colour	in	0

Get_Colour	procedure
Returns the background and foreground colours of the TextArea.

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

Get_WindowID	function
*Return*	Object_ID
Returns the object Id of the nested window used to implement a TextArea gadget. Requires version 0.77 of the TextGadgets module.

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

Set_Background	procedure
Sets a sprite as the background image of the textarea. Requires version 0.77 of the TextGadgets module.

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

Set_TextBorder	procedure
Sets the border width of the TextArea.

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