Package RASCAL.ToolboxFileInfo

Description	Toolbox FileInfo 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.Time
RASCAL.Utility
System.Unsigned_Types
System

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

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
FileInfo_Generate_About_To_Be_Shown		16#1#	constant
Flags
FileInfo_Generate_Dialogue_Completed		16#2#	constant
FileInfo_Date		16#82AC01#	constant
FileInfo_File_Size		16#82AC02#	constant
FileInfo_File_Name		16#82AC03#	constant
FileInfo_File_type		16#82AC04#	constant
FileInfo_Modified		16#82AC05#	constant
FileInfo_File_Icon		16#82AC06#	constant
FileInfo_Date_Label		16#82AC07#	constant
FileInfo_File_Size_Label		16#82AC08#	constant
FileInfo_Modified_Label		16#82AC09#	constant
FileInfo_File_Type_Label		16#82AC0A#	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Licence_Type	(Public_Domain, Single_user, Single_Machine, Site, Network, Authority)
Toolbox_FileInfo_AboutToBeShown_Pointer	access Toolbox_FileInfo_AboutToBeShown
Toolbox_FileInfo_DialogueCompleted_Pointer	access Toolbox_FileInfo_DialogueCompleted

FileInfoTemplate	record
*Component*	*Type*	*Default*
Window	Address
UTC	UTC_Time_Type
FileSize	Integer
FileName	Address
FileType	Integer
Modified	Integer
Max_Title	Integer
Title	Address
Flags	System.Unsigned_Types.Unsigned

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

ATEL_Toolbox_FileInfo_AboutToBeShown	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_FileInfo_AboutToBeShown, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_FileInfo_AboutToBeShown_Pointer

Toolbox_FileInfo_DialogueCompleted	record
Event is raised after the FileInfo window is hidden.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_FileInfo_DialogueCompleted	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_FileInfo_DialogueCompleted, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_FileInfo_DialogueCompleted_Pointer

Pragmas
Convention	(C, FileInfoTemplate)
Convention	(C, Toolbox_FileInfo_AboutToBeShown)
Convention	(C, Toolbox_FileInfo_DialogueCompleted)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Get_Date	function
*Return*	Address
Returns the date string to be displayed in FileInfo dialogue.

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

Get_FileName	function
*Return*	string
Returns the filename displayed in the FileInfo dialogue.

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

Get_FileSize	function
*Return*	integer
Returns the size of the file to be displayed in the FileInfo dialogue.

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

Get_FileType	function
*Return*	integer
Returns the filetype of the file to be displayed in the FileInfo dialogue.

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

Get_Modified	function
*Return*	boolean
Returns true if the file has been modified.

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

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

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

Get_Window_ID	function
*Return*	Object_ID
Returns the id of the underlying Wimp window of the FileInfo dialogue.

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

Set_Date	procedure
Sets the date string displayed in the FileInfo dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
FileInfo	Object_ID	in
Date	UTC_Time_Type	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_FileName	procedure
Sets the filename to be displayed in the FileInfo dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
FileInfo	Object_ID	in
FileName	string	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_FileType	procedure
Sets the filetype of the file to be displayed in the FileInfo dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
FileInfo	Object_ID	in
FileType	integer	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_FileSize	procedure
Sets the size of the file to be displayed in the FileInfo dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
FileInfo	Object_ID	in
FileSize	integer	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Modified	procedure
Sets the 'modified' flag of the FileInfo dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
FileInfo	Object_ID	in
Modified	boolean	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Title	procedure
Sets the title of the FileInfo dialogue.

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