Package RASCAL.ToolboxProgInfo

Description	Toolbox ProgInfo 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.Utility
Interfaces.C
System.Unsigned_Types
System

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

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
ProgInfo_Generate_About_To_Be_Shown		16#1#	constant
Flags
ProgInfo_Generate_Dialogue_Completed		16#2#	constant
ProgInfo_Include_Licence_Type		16#4#	constant
ProgInfo_Include_Web_Page_Button		16#8#	constant
ProgInfo_Generate_Web_Page_Clicked		16#10#	constant
ProgInfo_Licence_Public_Domain		16#0#	constant
ProgInfo_Licence_Single_User		16#1#	constant
ProgInfo_Licence_Single_Machine		16#2#	constant
ProgInfo_Licence_Site		16#3#	constant
ProgInfo_Licence_Network		16#4#	constant
ProgInfo_Licence_Authority		16#5#	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
License_Type	(Public_Domain, Single_user, Single_Machine, Site, Network, Authority)
Toolbox_ProgInfo_AboutToBeShown_Pointer	access Toolbox_ProgInfo_AboutToBeShown
Toolbox_ProgInfo_DialogueCompleted_Pointer	access Toolbox_ProgInfo_DialogueCompleted
Toolbox_ProgInfo_LaunchWebPage_Pointer	access Toolbox_ProgInfo_LaunchWebPage

ProgInfoTemplate	record
*Component*	*Type*	*Default*
Window	Address
Version	Address
Licence_Type	Integer
Author	Address
Purpose	Address
Max_Title	Integer
Title	Address
Flags	System.Unsigned_Types.Unsigned

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

ATEL_Toolbox_ProgInfo_AboutToBeShown	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_ProgInfo_AboutToBeShown, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_ProgInfo_AboutToBeShown_Pointer

Toolbox_ProgInfo_DialogueCompleted	record
Event is raised after the Prog Info window has been hidden.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_ProgInfo_DialogueCompleted	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_ProgInfo_DialogueCompleted, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_ProgInfo_DialogueCompleted_Pointer

Toolbox_ProgInfo_LaunchWebPage	record
Event is raised after the Prog Info Launch Web Page action button is clicked.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_ProgInfo_LaunchWebPage	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_ProgInfo_LaunchWebPage, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_ProgInfo_LaunchWebPage_Pointer

Pragmas
Convention	(C, ProgInfoTemplate)
Convention	(C, Toolbox_ProgInfo_AboutToBeShown)
Convention	(C, Toolbox_ProgInfo_DialogueCompleted)
Convention	(C, Toolbox_ProgInfo_LaunchWebPage)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Get_Window_ID	function
*Return*	Object_ID
Returns the ID of the underlying Window object used for the Prog Info object.

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

Get_URI	function
*Return*	string
Returns the URI launched by the web page button.

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

Get_Title	function
*Return*	string
Returns the window title being used in the Prog Info object.

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

Set_URI	procedure
Sets the URI to be launched by the web page button.

*Parameter name*	*Type*	*Mode*	*Default*
ProgInfo	Object_ID	in
URI	string	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Title	procedure
Sets the window title to be used in the Prog Info object.

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

Get_License_Type	function
*Return*	License_Type
Returns the license type used in the Prog Info object.

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

Set_License_Type	procedure
Sets the license type to be used in the Prog Info object.

*Parameter name*	*Type*	*Mode*	*Default*
ProgInfo	Object_ID	in
License	License_Type	in
Flags	System.Unsigned_Types.Unsigned	in	0

Get_Version	function
*Return*	string
Returns the version string used in the Prog Info object.

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

Set_Version	procedure
Sets the version string used in the Prog Info object.

*Parameter name*	*Type*	*Mode*	*Default*
ProgInfo	Object_ID	in
Version	string	in
Flags	System.Unsigned_Types.Unsigned	in	0

Get_Web_Event	function
*Return*	Toolbox_Event_Code_Type
Returns the event generated by a click on the web page button.

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

Set_Web_Event	procedure
Sets the event generated by a click on the web page button.

*Parameter name*	*Type*	*Mode*	*Default*
ProgInfo	Object_ID	in
Event	Toolbox_Event_Code_Type	in
Flags	System.Unsigned_Types.Unsigned	in	0