Package RASCAL.ToolboxPrint

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

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

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
PrintDBox_Generate_About_To_Be_Shown		16#1#	constant
Flags
PrintDBox_Generate_Dialogue_Completed		16#2#	constant
PrintDBox_Generate_Show_Setup_Action		16#4#	constant
PrintDBox_Include_All_From_To		16#8#	constant
PrintDBox_Include_Copies		16#10#	constant
PrintDBox_Include_Scale		16#20#	constant
PrintDBox_Include_Orientation		16#40#	constant
PrintDBox_Include_Save		16#80#	constant
PrintDBox_Include_Set_up		16#100#	constant
PrintDBox_Include_Draft		16#200#	constant
PrintDBox_Select_From_to		16#400#	constant
PrintDBox_Select_Sideways		16#800#	constant
PrintDBox_Select_Draft		16#1000#	constant
PrintDBox_Print_Sideways		16#1#	constant
PrintDBox_Print_Draft		16#2#	constant
PrintDBox_Page_Range_All		-1	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Toolbox_PrintDbox_AboutToBeShown_Pointer	access Toolbox_PrintDbox_AboutToBeShown
Toolbox_PrintDbox_DialogueCompleted_Pointer	access Toolbox_PrintDbox_DialogueCompleted
Toolbox_PrintDbox_Print_Pointer	access Toolbox_PrintDbox_Print
Toolbox_PrintDbox_Save_Pointer	access Toolbox_PrintDbox_Save
Toolbox_PrintDbox_Setup_Pointer	access Toolbox_PrintDbox_Setup
Toolbox_PrintDbox_SetupAboutToBeShown_Pointer	access Toolbox_PrintDbox_SetupAboutToBeShown

PrintDBoxTemplate	record
*Component*	*Type*	*Default*
Window	Address
Further_Options	Address
Scale	Integer
Copies	Integer
To	Integer
From	Integer
Flags	System.Unsigned_Types.Unsigned

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

ATEL_Toolbox_PrintDbox_AboutToBeShown	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_PrintDbox_AboutToBeShown, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_PrintDbox_AboutToBeShown_Pointer

Toolbox_PrintDbox_DialogueCompleted	record
Event is raised after the Print window has been hidden.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_PrintDbox_DialogueCompleted	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_PrintDbox_DialogueCompleted, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_PrintDbox_DialogueCompleted_Pointer

Toolbox_PrintDbox_Print	record
Event is raised when the user clicks on 'Print'.
*Component*	*Type*	*Default*
Scale_Factor	Integer
Copies	Integer
Finish_Page	Integer
Start_Page	Integer
Header	Toolbox_Event_Header

ATEL_Toolbox_PrintDbox_Print	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_PrintDbox_Print, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_PrintDbox_Print_Pointer

Toolbox_PrintDbox_Save	record
Event is raised when the user clicks on 'Save'.
*Component*	*Type*	*Default*
Scale_Factor	Integer
Copies	Integer
Finish_Page	Integer
Start_Page	Integer
Header	Toolbox_Event_Header

ATEL_Toolbox_PrintDbox_Save	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_PrintDbox_Save, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_PrintDbox_Save_Pointer

Toolbox_PrintDbox_Setup	record
Event is raised when the user clicks on 'Setup'.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_PrintDbox_Setup	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_PrintDbox_Setup, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_PrintDbox_Setup_Pointer

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

ATEL_Toolbox_PrintDbox_SetupAboutToBeShown	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_PrintDbox_SetupAboutToBeShown, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_PrintDbox_SetupAboutToBeShown_Pointer

Pragmas
Convention	(C, PrintDBoxTemplate)
Convention	(C, Toolbox_PrintDbox_AboutToBeShown)
Convention	(C, Toolbox_PrintDbox_DialogueCompleted)
Convention	(C, Toolbox_PrintDbox_Print)
Convention	(C, Toolbox_PrintDbox_Save)
Convention	(C, Toolbox_PrintDbox_Setup)
Convention	(C, Toolbox_PrintDbox_SetupAboutToBeShown)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Get_Copies	function
*Return*	integer
Returns the number of copies for the Print Dialogue.

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

is_Draft	function
*Return*	boolean
Returns the draft mode status.

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

Is_Upright	function
*Return*	boolean
Returns the page orientation.

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

Get_Page_Range	procedure
Returns the page range for the Print dialogue. (Start := -1 means all)

*Parameter name*	*Type*	*Mode*	*Default*
Print	Object_ID	in
Start_Page	integer	out
End_Page	integer	out
Flags	System.Unsigned_Types.Unsigned	in	0

Get_Scale	function
*Return*	integer
Returns the scale factor for the Print dialogue.

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

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

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

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

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

Set_Copies	procedure
Sets the number of copies for the Print dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
Print	Object_ID	in
Copies	integer	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Draft	procedure
Sets the draft printing mode for the Print dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
Print	Object_ID	in
Draft	boolean	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Orientation	procedure
Sets the page orientation for the Print dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
Print	Object_ID	in
Sideways	boolean	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Page_Range	procedure
Sets the page range for the Print dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
Print	Object_ID	in
Start_Page	integer	in
End_Page	integer	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Scale	procedure
Sets the scale for the Print dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
Print	Object_ID	in
Scale	integer	in
Flags	System.Unsigned_Types.Unsigned	in	0