.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Gtk2::PrintOperation 3pm" .TH Gtk2::PrintOperation 3pm "2019-09-16" "perl v5.28.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Gtk2::PrintOperation \- wrapper for GtkPrintOperation .SH "HIERARCHY" .IX Header "HIERARCHY" .Vb 2 \& Glib::Object \& +\-\-\-\-Gtk2::PrintOperation .Ve .SH "INTERFACES" .IX Header "INTERFACES" .Vb 1 \& Gtk2::PrintOperationPreview .Ve .SH "METHODS" .IX Header "METHODS" .SS "printoperation = Gtk2::PrintOperation\->\fBnew\fP" .IX Subsection "printoperation = Gtk2::PrintOperation->new" .ie n .SS "$op\->\fBset_allow_async\fP ($allow_async)" .el .SS "\f(CW$op\fP\->\fBset_allow_async\fP ($allow_async)" .IX Subsection "$op->set_allow_async ($allow_async)" .IP "\(bu" 4 \&\f(CW$allow_async\fR (boolean) .ie n .SS "$op\->\fBcancel\fP" .el .SS "\f(CW$op\fP\->\fBcancel\fP" .IX Subsection "$op->cancel" .ie n .SS "$op\->\fBset_current_page\fP ($current_page)" .el .SS "\f(CW$op\fP\->\fBset_current_page\fP ($current_page)" .IX Subsection "$op->set_current_page ($current_page)" .IP "\(bu" 4 \&\f(CW$current_page\fR (integer) .ie n .SS "$op\->\fBset_custom_tab_label\fP ($label)" .el .SS "\f(CW$op\fP\->\fBset_custom_tab_label\fP ($label)" .IX Subsection "$op->set_custom_tab_label ($label)" .IP "\(bu" 4 \&\f(CW$label\fR (string) .ie n .SS "pagesetup or undef = $op\->\fBget_default_page_setup\fP" .el .SS "pagesetup or undef = \f(CW$op\fP\->\fBget_default_page_setup\fP" .IX Subsection "pagesetup or undef = $op->get_default_page_setup" .ie n .SS "$op\->\fBset_default_page_setup\fP ($default_page_setup)" .el .SS "\f(CW$op\fP\->\fBset_default_page_setup\fP ($default_page_setup)" .IX Subsection "$op->set_default_page_setup ($default_page_setup)" .IP "\(bu" 4 \&\f(CW$default_page_setup\fR (Gtk2::PageSetup or undef) .ie n .SS "$op\->\fBset_defer_drawing\fP ()" .el .SS "\f(CW$op\fP\->\fBset_defer_drawing\fP ()" .IX Subsection "$op->set_defer_drawing ()" The method \fBset_defer_drawing()\fR can only be called from the callback \&\f(CW\*(Aqdraw\-page\*(Aq\fR. .PP Since: gtk+ 2.16 .ie n .SS "$op\->\fBdraw_page_finish\fP ()" .el .SS "\f(CW$op\fP\->\fBdraw_page_finish\fP ()" .IX Subsection "$op->draw_page_finish ()" The method \fBdraw_page_finish()\fR can only be called if the method \&\fBset_defer_drawing()\fR has been called previously otherwise a segmentation fault will occur. This means that the application will crash and even an eval will not be able to recover from that error. .PP Since: gtk+ 2.16 .ie n .SS "boolean = $op\->\fBget_embed_page_setup\fP" .el .SS "boolean = \f(CW$op\fP\->\fBget_embed_page_setup\fP" .IX Subsection "boolean = $op->get_embed_page_setup" Since: gtk+ 2.18 .ie n .SS "$op\->\fBset_embed_page_setup\fP ($embed)" .el .SS "\f(CW$op\fP\->\fBset_embed_page_setup\fP ($embed)" .IX Subsection "$op->set_embed_page_setup ($embed)" .IP "\(bu" 4 \&\f(CW$embed\fR (boolean) .PP Since: gtk+ 2.18 .ie n .SS "scalar = $op\->\fBget_error\fP" .el .SS "scalar = \f(CW$op\fP\->\fBget_error\fP" .IX Subsection "scalar = $op->get_error" .ie n .SS "$op\->\fBset_export_filename\fP ($filename)" .el .SS "\f(CW$op\fP\->\fBset_export_filename\fP ($filename)" .IX Subsection "$op->set_export_filename ($filename)" .IP "\(bu" 4 \&\f(CW$filename\fR (string) .ie n .SS "boolean = $op\->\fBget_has_selection\fP" .el .SS "boolean = \f(CW$op\fP\->\fBget_has_selection\fP" .IX Subsection "boolean = $op->get_has_selection" Since: gtk+ 2.18 .ie n .SS "$op\->\fBset_has_selection\fP ($has_selection)" .el .SS "\f(CW$op\fP\->\fBset_has_selection\fP ($has_selection)" .IX Subsection "$op->set_has_selection ($has_selection)" .IP "\(bu" 4 \&\f(CW$has_selection\fR (boolean) .PP Since: gtk+ 2.18 .ie n .SS "boolean = $op\->\fBis_finished\fP" .el .SS "boolean = \f(CW$op\fP\->\fBis_finished\fP" .IX Subsection "boolean = $op->is_finished" .ie n .SS "$op\->\fBset_job_name\fP ($job_name)" .el .SS "\f(CW$op\fP\->\fBset_job_name\fP ($job_name)" .IX Subsection "$op->set_job_name ($job_name)" .IP "\(bu" 4 \&\f(CW$job_name\fR (string) .ie n .SS "$op\->\fBset_n_pages\fP ($n_pages)" .el .SS "\f(CW$op\fP\->\fBset_n_pages\fP ($n_pages)" .IX Subsection "$op->set_n_pages ($n_pages)" .IP "\(bu" 4 \&\f(CW$n_pages\fR (integer) .ie n .SS "integer = $op\->\fBget_n_pages_to_print\fP" .el .SS "integer = \f(CW$op\fP\->\fBget_n_pages_to_print\fP" .IX Subsection "integer = $op->get_n_pages_to_print" Since: gtk+ 2.18 .ie n .SS "printsettings or undef = $op\->\fBget_print_settings\fP" .el .SS "printsettings or undef = \f(CW$op\fP\->\fBget_print_settings\fP" .IX Subsection "printsettings or undef = $op->get_print_settings" .ie n .SS "$op\->\fBset_print_settings\fP ($print_settings)" .el .SS "\f(CW$op\fP\->\fBset_print_settings\fP ($print_settings)" .IX Subsection "$op->set_print_settings ($print_settings)" .IP "\(bu" 4 \&\f(CW$print_settings\fR (Gtk2::PrintSettings or undef) .ie n .SS "printoperationresult = $op\->\fBrun\fP ($action, $parent)" .el .SS "printoperationresult = \f(CW$op\fP\->\fBrun\fP ($action, \f(CW$parent\fP)" .IX Subsection "printoperationresult = $op->run ($action, $parent)" .IP "\(bu" 4 \&\f(CW$action\fR (Gtk2::PrintOperationAction) .IP "\(bu" 4 \&\f(CW$parent\fR (Gtk2::Window or undef) .PP May croak with a Glib::Error in $@ on failure. .ie n .SS "$op\->\fBset_show_progress\fP ($show_progress)" .el .SS "\f(CW$op\fP\->\fBset_show_progress\fP ($show_progress)" .IX Subsection "$op->set_show_progress ($show_progress)" .IP "\(bu" 4 \&\f(CW$show_progress\fR (boolean) .ie n .SS "printstatus = $op\->\fBget_status\fP" .el .SS "printstatus = \f(CW$op\fP\->\fBget_status\fP" .IX Subsection "printstatus = $op->get_status" .ie n .SS "string = $op\->\fBget_status_string\fP" .el .SS "string = \f(CW$op\fP\->\fBget_status_string\fP" .IX Subsection "string = $op->get_status_string" .ie n .SS "boolean = $op\->\fBget_support_selection\fP" .el .SS "boolean = \f(CW$op\fP\->\fBget_support_selection\fP" .IX Subsection "boolean = $op->get_support_selection" Since: gtk+ 2.18 .ie n .SS "$op\->\fBset_support_selection\fP ($support_selection)" .el .SS "\f(CW$op\fP\->\fBset_support_selection\fP ($support_selection)" .IX Subsection "$op->set_support_selection ($support_selection)" .IP "\(bu" 4 \&\f(CW$support_selection\fR (boolean) .PP Since: gtk+ 2.18 .ie n .SS "$op\->\fBset_track_print_status\fP ($track_status)" .el .SS "\f(CW$op\fP\->\fBset_track_print_status\fP ($track_status)" .IX Subsection "$op->set_track_print_status ($track_status)" .IP "\(bu" 4 \&\f(CW$track_status\fR (boolean) .ie n .SS "$op\->\fBset_unit\fP ($unit)" .el .SS "\f(CW$op\fP\->\fBset_unit\fP ($unit)" .IX Subsection "$op->set_unit ($unit)" .IP "\(bu" 4 \&\f(CW$unit\fR (Gtk2::Unit) .ie n .SS "$op\->\fBset_use_full_page\fP ($full_page)" .el .SS "\f(CW$op\fP\->\fBset_use_full_page\fP ($full_page)" .IX Subsection "$op->set_use_full_page ($full_page)" .IP "\(bu" 4 \&\f(CW$full_page\fR (boolean) .SH "PROPERTIES" .IX Header "PROPERTIES" .IP "'allow\-async' (boolean : default false : readable / writable / private)" 4 .IX Item "'allow-async' (boolean : default false : readable / writable / private)" \&\s-1TRUE\s0 if print process may run asynchronous. .IP "'current\-page' (integer : default \-1 : readable / writable / private)" 4 .IX Item "'current-page' (integer : default -1 : readable / writable / private)" The current page in the document .IP "'custom\-tab\-label' (string : default undef : readable / writable / private)" 4 .IX Item "'custom-tab-label' (string : default undef : readable / writable / private)" Label for the tab containing custom widgets. .IP "'default\-page\-setup' (Gtk2::PageSetup : default undef : readable / writable / private)" 4 .IX Item "'default-page-setup' (Gtk2::PageSetup : default undef : readable / writable / private)" The GtkPageSetup used by default .IP "'embed\-page\-setup' (boolean : default false : readable / writable / private)" 4 .IX Item "'embed-page-setup' (boolean : default false : readable / writable / private)" \&\s-1TRUE\s0 if page setup combos are embedded in GtkPrintDialog .IP "'export\-filename' (string : default undef : readable / writable / private)" 4 .IX Item "'export-filename' (string : default undef : readable / writable / private)" Export filename .IP "'has\-selection' (boolean : default false : readable / writable / private)" 4 .IX Item "'has-selection' (boolean : default false : readable / writable / private)" \&\s-1TRUE\s0 if a selection exists. .ie n .IP "'job\-name' (string : default """" : readable / writable / private)" 4 .el .IP "'job\-name' (string : default ``'' : readable / writable / private)" 4 .IX Item "'job-name' (string : default """" : readable / writable / private)" A string used for identifying the print job. .IP "'n\-pages' (integer : default \-1 : readable / writable / private)" 4 .IX Item "'n-pages' (integer : default -1 : readable / writable / private)" The number of pages in the document. .IP "'n\-pages\-to\-print' (integer : default \-1 : readable / private)" 4 .IX Item "'n-pages-to-print' (integer : default -1 : readable / private)" The number of pages that will be printed. .IP "'print\-settings' (Gtk2::PrintSettings : default undef : readable / writable / private)" 4 .IX Item "'print-settings' (Gtk2::PrintSettings : default undef : readable / writable / private)" The GtkPrintSettings used for initializing the dialog .IP "'show\-progress' (boolean : default false : readable / writable / private)" 4 .IX Item "'show-progress' (boolean : default false : readable / writable / private)" \&\s-1TRUE\s0 if a progress dialog is shown while printing. .ie n .IP "'status' (Gtk2::PrintStatus : default ""initial"" : readable / private)" 4 .el .IP "'status' (Gtk2::PrintStatus : default ``initial'' : readable / private)" 4 .IX Item "'status' (Gtk2::PrintStatus : default initial : readable / private)" The status of the print operation .ie n .IP "'status\-string' (string : default """" : readable / private)" 4 .el .IP "'status\-string' (string : default ``'' : readable / private)" 4 .IX Item "'status-string' (string : default """" : readable / private)" A human-readable description of the status .IP "'support\-selection' (boolean : default false : readable / writable / private)" 4 .IX Item "'support-selection' (boolean : default false : readable / writable / private)" \&\s-1TRUE\s0 if the print operation will support print of selection. .IP "'track\-print\-status' (boolean : default false : readable / writable / private)" 4 .IX Item "'track-print-status' (boolean : default false : readable / writable / private)" \&\s-1TRUE\s0 if the print operation will continue to report on the print job status after the print data has been sent to the printer or print server. .ie n .IP "'unit' (Gtk2::Unit : default ""pixel"" : readable / writable / private)" 4 .el .IP "'unit' (Gtk2::Unit : default ``pixel'' : readable / writable / private)" 4 .IX Item "'unit' (Gtk2::Unit : default pixel : readable / writable / private)" The unit in which distances can be measured in the context .IP "'use\-full\-page' (boolean : default false : readable / writable / private)" 4 .IX Item "'use-full-page' (boolean : default false : readable / writable / private)" \&\s-1TRUE\s0 if the origin of the context should be at the corner of the page and not the corner of the imageable area .SH "SIGNALS" .IX Header "SIGNALS" .IP "\fBbegin-print\fR (Gtk2::PrintOperation, Gtk2::PrintContext)" 4 .IX Item "begin-print (Gtk2::PrintOperation, Gtk2::PrintContext)" .PD 0 .IP "Glib::Object = \fBcreate-custom-widget\fR (Gtk2::PrintOperation)" 4 .IX Item "Glib::Object = create-custom-widget (Gtk2::PrintOperation)" .IP "\fBcustom-widget-apply\fR (Gtk2::PrintOperation, Gtk2::Widget)" 4 .IX Item "custom-widget-apply (Gtk2::PrintOperation, Gtk2::Widget)" .IP "\fBdone\fR (Gtk2::PrintOperation, Gtk2::PrintOperationResult)" 4 .IX Item "done (Gtk2::PrintOperation, Gtk2::PrintOperationResult)" .IP "\fBdraw-page\fR (Gtk2::PrintOperation, Gtk2::PrintContext, integer)" 4 .IX Item "draw-page (Gtk2::PrintOperation, Gtk2::PrintContext, integer)" .IP "\fBend-print\fR (Gtk2::PrintOperation, Gtk2::PrintContext)" 4 .IX Item "end-print (Gtk2::PrintOperation, Gtk2::PrintContext)" .IP "boolean = \fBpaginate\fR (Gtk2::PrintOperation, Gtk2::PrintContext)" 4 .IX Item "boolean = paginate (Gtk2::PrintOperation, Gtk2::PrintContext)" .IP "boolean = \fBpreview\fR (Gtk2::PrintOperation, Gtk2::PrintOperationPreview, Gtk2::PrintContext, Gtk2::Window)" 4 .IX Item "boolean = preview (Gtk2::PrintOperation, Gtk2::PrintOperationPreview, Gtk2::PrintContext, Gtk2::Window)" .IP "\fBrequest-page-setup\fR (Gtk2::PrintOperation, Gtk2::PrintContext, integer, Gtk2::PageSetup)" 4 .IX Item "request-page-setup (Gtk2::PrintOperation, Gtk2::PrintContext, integer, Gtk2::PageSetup)" .IP "\fBstatus-changed\fR (Gtk2::PrintOperation)" 4 .IX Item "status-changed (Gtk2::PrintOperation)" .IP "\fBupdate-custom-widget\fR (Gtk2::PrintOperation, Gtk2::Widget, Gtk2::PageSetup, Gtk2::PrintSettings)" 4 .IX Item "update-custom-widget (Gtk2::PrintOperation, Gtk2::Widget, Gtk2::PageSetup, Gtk2::PrintSettings)" .PD .SH "ENUMS AND FLAGS" .IX Header "ENUMS AND FLAGS" .SS "enum Gtk2::PrintOperationAction" .IX Subsection "enum Gtk2::PrintOperationAction" .IP "\(bu" 4 \&'print\-dialog' / '\s-1GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG\s0' .IP "\(bu" 4 \&'print' / '\s-1GTK_PRINT_OPERATION_ACTION_PRINT\s0' .IP "\(bu" 4 \&'preview' / '\s-1GTK_PRINT_OPERATION_ACTION_PREVIEW\s0' .IP "\(bu" 4 \&'export' / '\s-1GTK_PRINT_OPERATION_ACTION_EXPORT\s0' .SS "enum Gtk2::PrintOperationResult" .IX Subsection "enum Gtk2::PrintOperationResult" .IP "\(bu" 4 \&'error' / '\s-1GTK_PRINT_OPERATION_RESULT_ERROR\s0' .IP "\(bu" 4 \&'apply' / '\s-1GTK_PRINT_OPERATION_RESULT_APPLY\s0' .IP "\(bu" 4 \&'cancel' / '\s-1GTK_PRINT_OPERATION_RESULT_CANCEL\s0' .IP "\(bu" 4 \&'in\-progress' / '\s-1GTK_PRINT_OPERATION_RESULT_IN_PROGRESS\s0' .SS "enum Gtk2::PrintStatus" .IX Subsection "enum Gtk2::PrintStatus" .IP "\(bu" 4 \&'initial' / '\s-1GTK_PRINT_STATUS_INITIAL\s0' .IP "\(bu" 4 \&'preparing' / '\s-1GTK_PRINT_STATUS_PREPARING\s0' .IP "\(bu" 4 \&'generating\-data' / '\s-1GTK_PRINT_STATUS_GENERATING_DATA\s0' .IP "\(bu" 4 \&'sending\-data' / '\s-1GTK_PRINT_STATUS_SENDING_DATA\s0' .IP "\(bu" 4 \&'pending' / '\s-1GTK_PRINT_STATUS_PENDING\s0' .IP "\(bu" 4 \&'pending\-issue' / '\s-1GTK_PRINT_STATUS_PENDING_ISSUE\s0' .IP "\(bu" 4 \&'printing' / '\s-1GTK_PRINT_STATUS_PRINTING\s0' .IP "\(bu" 4 \&'finished' / '\s-1GTK_PRINT_STATUS_FINISHED\s0' .IP "\(bu" 4 \&'finished\-aborted' / '\s-1GTK_PRINT_STATUS_FINISHED_ABORTED\s0' .SS "enum Gtk2::Unit" .IX Subsection "enum Gtk2::Unit" .IP "\(bu" 4 \&'pixel' / '\s-1GTK_UNIT_PIXEL\s0' .IP "\(bu" 4 \&'points' / '\s-1GTK_UNIT_POINTS\s0' .IP "\(bu" 4 \&'inch' / '\s-1GTK_UNIT_INCH\s0' .IP "\(bu" 4 \&'mm' / '\s-1GTK_UNIT_MM\s0' .SH "SEE ALSO" .IX Header "SEE ALSO" Gtk2, Glib::Object .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2003\-2011 by the gtk2\-perl team. .PP This software is licensed under the \s-1LGPL.\s0 See Gtk2 for a full notice.