Gtk2::PrintOperation(3pm)

1Gtk2::PrintOperation(3)User Contributed Perl DocumentatioGntk2::PrintOperation(3)
2
3
4

NAME

6       Gtk2::PrintOperation
7

HIERARCHY

9         Glib::Object
10         +----Gtk2::PrintOperation
11

INTERFACES

13         Gtk2::PrintOperationPreview
14

METHODS

16       printoperation = Gtk2::PrintOperation->new
17
18       $op->set_allow_async ($allow_async)
19
20           * $allow_async (boolean)
21
22       $op->cancel
23
24       $op->set_current_page ($current_page)
25
26           * $current_page (integer)
27
28       $op->set_custom_tab_label ($label)
29
30           * $label (string)
31
32       pagesetup or undef = $op->get_default_page_setup
33
34       $op->set_default_page_setup ($default_page_setup)
35
36           * $default_page_setup (Gtk2::PageSetup or undef)
37
38       scalar = $op->get_error
39
40       $op->set_export_filename ($filename)
41
42           * $filename (string)
43
44       boolean = $op->is_finished
45
46       $op->set_job_name ($job_name)
47
48           * $job_name (string)
49
50       $op->set_n_pages ($n_pages)
51
52           * $n_pages (integer)
53
54       printsettings or undef = $op->get_print_settings
55
56       $op->set_print_settings ($print_settings)
57
58           * $print_settings (Gtk2::PrintSettings or undef)
59
60       printoperationresult = $op->run ($action, $parent)
61
62           * $action (Gtk2::PrintOperationAction)
63           * $parent (Gtk2::Window or undef)
64
65           May croak with a Glib::Error in $@ on failure.
66
67       $op->set_show_progress ($show_progress)
68
69           * $show_progress (boolean)
70
71       printstatus = $op->get_status
72
73       string = $op->get_status_string
74
75       $op->set_track_print_status ($track_status)
76
77           * $track_status (boolean)
78
79       $op->set_unit ($unit)
80
81           * $unit (Gtk2::Unit)
82
83       $op->set_use_full_page ($full_page)
84
85           * $full_page (boolean)
86

PROPERTIES

88       'allow-async' (boolean : readable / writable / private)
89           TRUE if print process may run asynchronous.
90
91       'current-page' (integer : readable / writable / private)
92           The current page in the document
93
94       'custom-tab-label' (string : readable / writable / private)
95           Label for the tab containing custom widgets.
96
97       'default-page-setup' (Gtk2::PageSetup : readable / writable / private)
98           The GtkPageSetup used by default
99
100       'export-filename' (string : readable / writable / private)
101           Export filename
102
103       'job-name' (string : readable / writable / private)
104           A string used for identifying the print job.
105
106       'n-pages' (integer : readable / writable / private)
107           The number of pages in the document.
108
109       'print-settings' (Gtk2::PrintSettings : readable / writable / private)
110           The GtkPrintSettings used for initializing the dialog
111
112       'show-progress' (boolean : readable / writable / private)
113           TRUE if a progress dialog is shown while printing.
114
115       'status' (Gtk2::PrintStatus : readable / private)
116           The status of the print operation
117
118       'status-string' (string : readable / private)
119           A human-readable description of the status
120
121       'track-print-status' (boolean : readable / writable / private)
122           TRUE if the print operation will continue to report on the print
123           job status after the print data has been sent to the printer or
124           print server.
125
126       'unit' (Gtk2::Unit : readable / writable / private)
127           The unit in which distances can be measured in the context
128
129       'use-full-page' (boolean : readable / writable / private)
130           TRUE if the the origin of the context should be at the corner of
131           the page and not the corner of the imageable area
132

SIGNALS

134       done (Gtk2::PrintOperation, Gtk2::PrintOperationResult)
135       begin-print (Gtk2::PrintOperation, Gtk2::PrintContext)
136       boolean = paginate (Gtk2::PrintOperation, Gtk2::PrintContext)
137       request-page-setup (Gtk2::PrintOperation, Gtk2::PrintContext, integer,
138       Gtk2::PageSetup)
139       draw-page (Gtk2::PrintOperation, Gtk2::PrintContext, integer)
140       end-print (Gtk2::PrintOperation, Gtk2::PrintContext)
141       status-changed (Gtk2::PrintOperation)
142       Glib::Object = create-custom-widget (Gtk2::PrintOperation)
143       custom-widget-apply (Gtk2::PrintOperation, Gtk2::Widget)
144       boolean = preview (Gtk2::PrintOperation, Gtk2::PrintOperationPreview,
145       Gtk2::PrintContext, Gtk2::Window)
146

ENUMS AND FLAGS

148       enum Gtk2::PrintOperationAction
149
150       * 'print-dialog' / 'GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG'
151       * 'print' / 'GTK_PRINT_OPERATION_ACTION_PRINT'
152       * 'preview' / 'GTK_PRINT_OPERATION_ACTION_PREVIEW'
153       * 'export' / 'GTK_PRINT_OPERATION_ACTION_EXPORT'
154
155       enum Gtk2::PrintOperationResult
156
157       * 'error' / 'GTK_PRINT_OPERATION_RESULT_ERROR'
158       * 'apply' / 'GTK_PRINT_OPERATION_RESULT_APPLY'
159       * 'cancel' / 'GTK_PRINT_OPERATION_RESULT_CANCEL'
160       * 'in-progress' / 'GTK_PRINT_OPERATION_RESULT_IN_PROGRESS'
161
162       enum Gtk2::PrintStatus
163
164       * 'initial' / 'GTK_PRINT_STATUS_INITIAL'
165       * 'preparing' / 'GTK_PRINT_STATUS_PREPARING'
166       * 'generating-data' / 'GTK_PRINT_STATUS_GENERATING_DATA'
167       * 'sending-data' / 'GTK_PRINT_STATUS_SENDING_DATA'
168       * 'pending' / 'GTK_PRINT_STATUS_PENDING'
169       * 'pending-issue' / 'GTK_PRINT_STATUS_PENDING_ISSUE'
170       * 'printing' / 'GTK_PRINT_STATUS_PRINTING'
171       * 'finished' / 'GTK_PRINT_STATUS_FINISHED'
172       * 'finished-aborted' / 'GTK_PRINT_STATUS_FINISHED_ABORTED'
173
174       enum Gtk2::Unit
175
176       * 'pixel' / 'GTK_UNIT_PIXEL'
177       * 'points' / 'GTK_UNIT_POINTS'
178       * 'inch' / 'GTK_UNIT_INCH'
179       * 'mm' / 'GTK_UNIT_MM'
180

COPYRIGHT

185       Copyright (C) 2003-2007 by the gtk2-perl team.
186
187       This software is licensed under the LGPL.  See Gtk2 for a full notice.
188
189
190
191perl v5.8.8                       2007-03-18           Gtk2::PrintOperation(3)