Package RASCAL.ToolboxQuit

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

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

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
Quit_Generate_About_To_Be_Shown		16#1#	constant
Flags
Quit_Generate_Dialogue_Completed		16#2#	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Toolbox_Quit_AboutToBeShown_Pointer	access Toolbox_Quit_AboutToBeShown
Toolbox_Quit_Cancel_Pointer	access Toolbox_Quit_Cancel
Toolbox_Quit_DialogueCompleted_Pointer	access Toolbox_Quit_DialogueCompleted
Toolbox_Quit_Quit_Pointer	access Toolbox_Quit_Quit

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

Toolbox_Quit_AboutToBeShown	record
Raised when the Quit Dialogue is about to be shown to the user. Type lacks union.
*Component*	*Type*	*Default*
Info	Window_Position_Type (Full_Spec)
Show_Type	Integer
Header	Toolbox_Event_Header

ATEL_Toolbox_Quit_AboutToBeShown	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Quit_AboutToBeShown, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Quit_AboutToBeShown_Pointer

Toolbox_Quit_Cancel	record
Raised when the user clicks on the Cancel action button.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_Quit_Cancel	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Quit_Cancel, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Quit_Cancel_Pointer

Toolbox_Quit_DialogueCompleted	record
Raised after the Quit object has been closed.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_Quit_DialogueCompleted	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Quit_DialogueCompleted, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Quit_DialogueCompleted_Pointer

Toolbox_Quit_Quit	record
Raised when the user clicks on the Quit action button.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_Quit_Quit	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Quit_Quit, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Quit_Quit_Pointer

Pragmas
Convention	(C, QuitTemplate)
Convention	(C, Toolbox_Quit_AboutToBeShown)
Convention	(C, Toolbox_Quit_Cancel)
Convention	(C, Toolbox_Quit_DialogueCompleted)
Convention	(C, Toolbox_Quit_Quit)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Get_Window_ID	function
*Return*	Object_ID
Returns the Wimp id of the underlying window used for the quit dialogue.

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

Get_Message	function
*Return*	string
Returns the message displayed in the quit dialogue.

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

Get_Title	function
*Return*	string
Returns the title of the Quit dialogue.

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

Set_Message	procedure
Sets the message displayed in the quit dialogue.

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

Set_Title	procedure
Sets the title of the Quit dialogue.

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