Package RASCAL.ToolboxSaveAs

Description	ToolboxSaveAs 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

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Toolbox_SaveAs_AboutToBeShown_Pointer	access Toolbox_SaveAs_AboutToBeShown
Toolbox_SaveAs_DialogueCompleted_Pointer	access Toolbox_SaveAs_DialogueCompleted
Toolbox_SaveAs_SaveToFile_Pointer	access Toolbox_SaveAs_SaveToFile
Toolbox_SaveAs_FillBuffer_Pointer	access Toolbox_SaveAs_FillBuffer
Toolbox_SaveAs_SaveCompleted_Pointer	access Toolbox_SaveAs_SaveCompleted

SaveAsTemplate	record
*Component*	*Type*	*Default*
Window	Address
Max_Title	Integer
Title	Address
Filetype	Integer
Filename	Address
Flags	System.Unsigned_Types.Unsigned

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

ATEL_Toolbox_SaveAs_AboutToBeShown	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_SaveAs_AboutToBeShown, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_SaveAs_AboutToBeShown_Pointer

Toolbox_SaveAs_DialogueCompleted	record
Event is raised after the SaveAs object has been hidden.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_SaveAs_DialogueCompleted	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_SaveAs_DialogueCompleted, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_SaveAs_DialogueCompleted_Pointer

Toolbox_SaveAs_SaveToFile	record
Event is raised to request that the client shoudl save its data to the given filename.
*Component*	*Type*	*Default*
Filename	Char_Array (1..212)
Header	Toolbox_Event_Header

ATEL_Toolbox_SaveAs_SaveToFile	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_SaveAs_SaveToFile, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_SaveAs_SaveToFile_Pointer

Toolbox_SaveAs_FillBuffer	record
Event is raised to request that the client should fill the given buffer.
*Component*	*Type*	*Default*
No_Bytes	Integer
Buffer	Address
Size	Integer
Header	Toolbox_Event_Header

ATEL_Toolbox_SaveAs_FillBuffer	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_SaveAs_FillBuffer, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_SaveAs_FillBuffer_Pointer

Toolbox_SaveAs_SaveCompleted	record
Event is raised when the save is successfully completed.
*Component*	*Type*	*Default*
FileName	Char_Array (1..208)
Message	Integer
Header	Toolbox_Event_Header

ATEL_Toolbox_SaveAs_SaveCompleted	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_SaveAs_SaveCompleted, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_SaveAs_SaveCompleted_Pointer

Pragmas
Convention	(C, SaveAsTemplate)
Convention	(C, Toolbox_SaveAs_AboutToBeShown)
Convention	(C, Toolbox_SaveAs_DialogueCompleted)
Convention	(C, Toolbox_SaveAs_SaveToFile)
Convention	(C, Toolbox_SaveAs_FillBuffer)
Convention	(C, Toolbox_SaveAs_SaveCompleted)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

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

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

Get_Title	function
*Return*	string
Returns the title of the SaveAs window.

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

Set_Title	procedure
Sets the title of the SaveAs window.

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

Get_FileName	function
*Return*	string
Returns the filename being used in the saveAs dialogue.

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

Set_FileName	procedure
Sets the filename being used in the saveAs dialogue.

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

Get_File_Size	function
*Return*	integer
Returns the file size (bytes) for the SaveAs dialogue.

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

Set_File_Size	procedure
Sets the file size (bytes) for the SaveAs dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
SaveAs	Object_ID	in
File_Size	integer	in
Flags	System.Unsigned_Types.Unsigned	in	0

Get_File_Type	function
*Return*	integer
Returns the file type for the SaveAs dialogue.

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

Set_File_Type	procedure
Sets the file type for the SaveAs dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
SaveAs	Object_ID	in
File_Type	integer	in
Flags	System.Unsigned_Types.Unsigned	in	0

Save_Completed	procedure
Report whether an attempt to save data to a file was successful or not.

*Parameter name*	*Type*	*Mode*	*Default*
SaveAs	Object_ID	in
FileName	string	in
Flags	System.Unsigned_Types.Unsigned	in	1

Set_Data_Address	procedure
indicates the address of the block of memory containg the data to be saved.

*Parameter name*	*Type*	*Mode*	*Default*
SaveAs	Object_ID	in
Data	Address	in
Data_Size	integer	in
Selection	Address	in
Selection_Size	integer	in
Flags	System.Unsigned_Types.Unsigned	in	0

Buffer_Filled	procedure
Confirms that the rquested buffer fill has taken place.

*Parameter name*	*Type*	*Mode*	*Default*
SaveAs	Object_ID	in
Buffer	Address	in
Buffer_Size	integer	in
Flags	System.Unsigned_Types.Unsigned	in	0

Selection_Available	procedure
Indicates whether there is a current selection.

*Parameter name*	*Type*	*Mode*	*Default*
SaveAs	Object_ID	in
Selection	boolean	in
Flags	System.Unsigned_Types.Unsigned	in	0