Package RASCAL.ToolboxDCS

Description	ToolboxDCS 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
System
System.Unsigned_Types
RASCAL.Utility
RASCAL.Toolbox
RASCAL.OS

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

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
DCS_Generate_About_To_Be_Shown		16#1#	constant
Flags
DCS_Generate_Dialogue_Completed		16#2#	constant
DCS_File_Icon		16#82A800#	constant
DCS_Discard		16#82A801#	constant
DCS_Cancel		16#82A802#	constant
DCS_Save		16#82A803#	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Toolbox_DCS_AboutToBeShown_Pointer	access Toolbox_DCS_AboutToBeShown
Toolbox_DCS_Cancel_Pointer	access Toolbox_DCS_Cancel
Toolbox_DCS_DialogueCompleted_Pointer	access Toolbox_DCS_DialogueCompleted
Toolbox_DCS_Discard_Pointer	access Toolbox_DCS_Discard
Toolbox_DCS_Save_Pointer	access Toolbox_DCS_Save

DCSTemplate	record
*Component*	*Type*	*Default*
Window	Address
Max_Message	Integer
Message	Address
Max_Title	Integer
Title	Address
Flags	System.Unsigned_Types.Unsigned

Toolbox_DCS_AboutToBeShown	record
Event is raised just before the DCS window is opened. Type lacks union.
*Component*	*Type*	*Default*
Info	Window_Position_Type (Full_Spec)
Show_Type	Integer
Header	Toolbox_Event_Header

ATEL_Toolbox_DCS_AboutToBeShown	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_DCS_AboutToBeShown, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_DCS_AboutToBeShown_Pointer

Toolbox_DCS_Cancel	record
Event is raised when the user clicks on the 'Cancel' button.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_DCS_Cancel	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_DCS_Cancel, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_DCS_Cancel_Pointer

Toolbox_DCS_DialogueCompleted	record
Event is raised when the DCS window is hidden.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_DCS_DialogueCompleted	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_DCS_DialogueCompleted, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_DCS_DialogueCompleted_Pointer

Toolbox_DCS_Discard	record
Event is raised when the user clicks on the 'Discard' button.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_DCS_Discard	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_DCS_Discard, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_DCS_Discard_Pointer

Toolbox_DCS_Save	record
Event is raised when the user clicks on the 'Save' button.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_DCS_Save	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_DCS_Save, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_DCS_Save_Pointer

Pragmas
Convention	(C, DCSTemplate)
Convention	(C, Toolbox_DCS_AboutToBeShown)
Convention	(C, Toolbox_DCS_Cancel)
Convention	(C, Toolbox_DCS_DialogueCompleted)
Convention	(C, Toolbox_DCS_Discard)
Convention	(C, Toolbox_DCS_Save)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Get_Message	function
*Return*	string
Returns the message used in the DCS dialog.

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

Get_Title	function
*Return*	string
Returns the title of the DCS dialog.

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

Get_Window_ID	function
*Return*	Object_ID
Returns the id of the underlying toolbox window object for the DCS dialogue.

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

Set_Message	procedure
Sets the message used in the DCS dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
DCS	Object_ID	in
Message	string	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Title	procedure
Sets the title of the DCS dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
DCS	Object_ID	in
Titel	string	in
Flags	System.Unsigned_Types.Unsigned	in	0