GObject.Object
Gtk.PrintOperation
Import line: | Gtk = imports.gi.Gtk; |
GIR File: | Gtk-3.0.gir |
C documentation: | GtkPrintOperation |
Class : | PrintOperation |
Implements: | Gtk.PrintOperationPreview |
Extends: | GObject.Object |
Properties | Defined By | |
---|---|---|
allow_async : gboolean
Determines whether the print operation may run asynchronously or not.
Determines whether the print operation may run asynchronously or not.
Some systems don't support asynchronous printing, but those that do will return GTK_PRINT_OPERATION_RESULT_IN_PROGRESS as the status, and emit the GtkPrintOperation::done signal when the operation is actually done. The Windows port does not support asynchronous operation at all (this is unlikely to change). On other platforms, all actions except for GTK_PRINT_OPERATION_ACTION_EXPORT support asynchronous operation. |
Gtk.PrintOperation | |
current_page : gint32
The current page in the document.
The current page in the document.
If this is set before gtk_print_operation_run(), the user will be able to select to print only the current page. Note that this only makes sense for pre-paginated documents. |
Gtk.PrintOperation | |
custom_tab_label : String
Used as the label of the tab containing custom widgets.
Used as the label of the tab containing custom widgets.
Note that this property may be ignored on some platforms. If this is NULL, GTK+ uses a default label. |
Gtk.PrintOperation | |
default_page_setup : Gtk.PageSetup
The GtkPageSetup used by default.
The GtkPageSetup used by default.
This page setup will be used by gtk_print_operation_run(), but it can be overridden on a per-page basis by connecting to the GtkPrintOperation::request-page-setup signal. |
Gtk.PrintOperation | |
embed_page_setup : gboolean
If TRUE, page size combo box and orientation combo box are embedded into page setup page.
If TRUE, page size combo box and orientation combo box are embedded into page setup page.
|
Gtk.PrintOperation | |
export_filename : String
The name of a file to generate instead of showing the print dialog.
The name of a file to generate instead of showing the print dialog.
Currently, PDF is the only supported format. The intended use of this property is for implementing "Export to PDF" actions. "Print to PDF" support is independent of this and is done by letting the user pick the "Print to PDF" item from the list of printers in the print dialog. |
Gtk.PrintOperation | |
has_selection : gboolean
Determines whether there is a selection in your application.
Determines whether there is a selection in your application.
This can allow your application to print the selection. This is typically used to make a "Selection" button sensitive. |
Gtk.PrintOperation | |
job_name : String
A string used to identify the job (e.g.
A string used to identify the job (e.g. in monitoring
applications like eggcups). If you don't set a job name, GTK+ picks a default one by numbering successive print jobs. |
Gtk.PrintOperation | |
n_pages : gint32
The number of pages in the document.
The number of pages in the document.
This before the rendering starts. It may be set in a GtkPrintOperation::begin-print signal hander. Note that the page numbers passed to the GtkPrintOperation::request-page-setup and GtkPrintOperation::draw-page signals are 0-based, i.e. if the user chooses to print all pages, the last ::draw-page signal will be for page n_pages - 1. |
Gtk.PrintOperation | |
n_pages_to_print : gint32
read only
The number of pages that will be printed.
The number of pages that will be printed.
Note that this value is set during print preparation phase (GTK_PRINT_STATUS_PREPARING), so this value should never be get before the data generation phase (GTK_PRINT_STATUS_GENERATING_DATA). You can connect to the GtkPrintOperation::status-changed signal and call gtk_print_operation_get_n_pages_to_print() when print status is GTK_PRINT_STATUS_GENERATING_DATA. This is typically used to track the progress of print operation. |
Gtk.PrintOperation | |
parent_instance : GObject.Object
read only
|
Gtk.PrintOperation | |
print_settings : Gtk.PrintSettings
The GtkPrintSettings used for initializing the dialog.
The GtkPrintSettings used for initializing the dialog.
Setting this property is typically used to re-establish print settings from a previous print operation, see gtk_print_operation_run(). |
Gtk.PrintOperation | |
priv : Gtk.PrintOperationPrivate
read only
|
Gtk.PrintOperation | |
show_progress : gboolean
Determines whether to show a progress dialog during the
print operation. Determines whether to show a progress dialog during the
print operation. |
Gtk.PrintOperation | |
status : Gtk.PrintStatus
read only
The status of the print operation.
The status of the print operation.
|
Gtk.PrintOperation | |
status_string : String
read only
A string representation of the status of the print operation.
A string representation of the status of the print operation.
The string is translated and suitable for displaying the print status e.g. in a GtkStatusbar. See the GtkPrintOperation:status property for a status value that is suitable for programmatic use. |
Gtk.PrintOperation | |
support_selection : gboolean
If TRUE, the print operation will support print of selection.
If TRUE, the print operation will support print of selection.
This allows the print dialog to show a "Selection" button. |
Gtk.PrintOperation | |
track_print_status : gboolean
If TRUE, the print operation will try to continue report on
the status of the print job in the printer queues and printer. If TRUE, the print operation will try to continue report on
the status of the print job in the printer queues and printer. This can allow your application to show things like "out of paper" issues, and when the print job actually reaches the printer. However, this is often implemented using polling, and should not be enabled unless needed. |
Gtk.PrintOperation | |
unit : Gtk.Unit
The transformation for the cairo context obtained from
GtkPrintContext is set up in such a way that distances are measured in units of unit. The transformation for the cairo context obtained from
GtkPrintContext is set up in such a way that distances are measured in units of unit. |
Gtk.PrintOperation | |
use_full_page : gboolean
If TRUE, the transformation for the cairo context obtained
from GtkPrintContext puts the origin at the top left corner of the page (which may not be the top left corner of the sheet, depending on page orientation and the number of pages per sheet). If TRUE, the transformation for the cairo context obtained
from GtkPrintContext puts the origin at the top left corner of the page (which may not be the top left corner of the sheet, depending on page orientation and the number of pages per sheet). Otherwise, the origin is at the top left corner of the imageable area (i.e. inside the margins). |
Gtk.PrintOperation |
Method / Constructor | Defined By | |
---|---|---|
new Gtk.PrintOperation
(Object properties)
Create a new Gtk.PrintOperation
Create a new Gtk.PrintOperation
|
||
cancel
()
:
none
Cancels a running print operation.
Cancels a running print operation. This function may
be called from a GtkPrintOperation::begin-print, GtkPrintOperation::paginate or GtkPrintOperation::draw-page signal handler to stop the currently running print operation.
|
Gtk.PrintOperation | |
draw_page_finish
()
:
none
Signalize that drawing of particular page is complete.
Signalize that drawing of particular page is complete.
It is called after completion of page drawing (e.g. drawing in another thread). If gtk_print_operation_set_defer_drawing() was called before, then this function has to be called by application. In another case it is called by the library itself.
|
Gtk.PrintOperation | |
end_preview
()
:
none
Ends a preview.
Ends a preview.
This function must be called to finish a custom print preview.
|
Gtk.PrintOperationPreview | |
get_default_page_setup
()
:
Gtk.PageSetup
Returns the default page setup, see
gtk_print_operation_set_default_page_setup().
Returns the default page setup, see
gtk_print_operation_set_default_page_setup().
|
Gtk.PrintOperation | |
get_embed_page_setup
()
:
gboolean
Gets the value of GtkPrintOperation::embed-page-setup property.
Gets the value of GtkPrintOperation::embed-page-setup property.
|
Gtk.PrintOperation | |
get_error
()
:
none
Call this when the result of a print operation is
GTK_PRINT_OPERATION_RESULT_ERROR, either as returned by gtk_print_operation_run(), or in the GtkPrintOperation::done signal handler.
Call this when the result of a print operation is
GTK_PRINT_OPERATION_RESULT_ERROR, either as returned by gtk_print_operation_run(), or in the GtkPrintOperation::done signal handler. The returned GError will contain more details on what went wrong.
|
Gtk.PrintOperation | |
get_has_selection
()
:
gboolean
Gets the value of GtkPrintOperation::has-selection property.
Gets the value of GtkPrintOperation::has-selection property.
|
Gtk.PrintOperation | |
get_n_pages_to_print
()
:
gint32
Returns the number of pages that will be printed.
Returns the number of pages that will be printed.
Note that this value is set during print preparation phase (GTK_PRINT_STATUS_PREPARING), so this function should never be called before the data generation phase (GTK_PRINT_STATUS_GENERATING_DATA). You can connect to the GtkPrintOperation::status-changed signal and call gtk_print_operation_get_n_pages_to_print() when print status is GTK_PRINT_STATUS_GENERATING_DATA. This is typically used to track the progress of print operation.
|
Gtk.PrintOperation | |
get_print_settings
()
:
Gtk.PrintSettings
Returns the current print settings.
Returns the current print settings.
Note that the return value is NULL until either gtk_print_operation_set_print_settings() or gtk_print_operation_run() have been called.
|
Gtk.PrintOperation | |
get_status
()
:
Gtk.PrintStatus
Returns the status of the print operation.
Returns the status of the print operation.
Also see gtk_print_operation_get_status_string().
|
Gtk.PrintOperation | |
get_status_string
()
:
String
Returns a string representation of the status of the
print operation.
Returns a string representation of the status of the
print operation. The string is translated and suitable for displaying the print status e.g. in a GtkStatusbar. Use gtk_print_operation_get_status() to obtain a status value that is suitable for programmatic use. of the print operation
|
Gtk.PrintOperation | |
get_support_selection
()
:
gboolean
Gets the value of GtkPrintOperation::support-selection property.
Gets the value of GtkPrintOperation::support-selection property.
|
Gtk.PrintOperation | |
is_finished
()
:
gboolean
A convenience function to find out if the print operation
is finished, either successfully (GTK_PRINT_STATUS_FINISHED) or unsuccessfully (GTK_PRINT_STATUS_FINISHED_ABORTED).
A convenience function to find out if the print operation
is finished, either successfully (GTK_PRINT_STATUS_FINISHED) or unsuccessfully (GTK_PRINT_STATUS_FINISHED_ABORTED). can be in a non-finished state even after done has been called, as the operation status then tracks the print job status on the printer.
|
Gtk.PrintOperation | |
Returns whether the given page is included in the set of pages that
have been selected for printing. |
Gtk.PrintOperationPreview | |
render_page
(gint32 page_nr)
:
none
Renders a page to the preview, using the print context that
was passed to the GtkPrintOperation::preview handler together with preview.
Renders a page to the preview, using the print context that
was passed to the GtkPrintOperation::preview handler together with preview. A custom iprint preview should use this function in its ::expose handler to render the currently selected page. Note that this function requires a suitable cairo context to be associated with the print context.
|
Gtk.PrintOperationPreview | |
Runs the print operation, by first letting the user modify
print settings in the print dialog, and then print the document.
Runs the print operation, by first letting the user modify
print settings in the print dialog, and then print the document. Normally that this function does not return until the rendering of all pages is complete. You can connect to the GtkPrintOperation::status-changed signal on op to obtain some information about the progress of the print operation. Furthermore, it may use a recursive mainloop to show the print dialog. If you call gtk_print_operation_set_allow_async() or set the GtkPrintOperation:allow-async property the operation will run asynchronously if this is supported on the platform. The GtkPrintOperation::done signal will be emitted with the result of the operation when the it is done (i.e. when the dialog is canceled, or when the print succeeds or fails). |[ if (settings != NULL) gtk_print_operation_set_print_settings (print, settings); if (page_setup != NULL) gtk_print_operation_set_default_page_setup (print, page_setup); g_signal_connect (print, "begin-print", G_CALLBACK (begin_print), &data); g_signal_connect (print, "draw-page", G_CALLBACK (draw_page), &data); res = gtk_print_operation_run (print, GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG, parent, &error); if (res == GTK_PRINT_OPERATION_RESULT_ERROR) { error_dialog = gtk_message_dialog_new (GTK_WINDOW (parent), GTK_DIALOG_DESTROY_WITH_PARENT, GTK_MESSAGE_ERROR, GTK_BUTTONS_CLOSE, "Error printing file:\ns", error->message); g_signal_connect (error_dialog, "response", G_CALLBACK (gtk_widget_destroy), NULL); gtk_widget_show (error_dialog); g_error_free (error); } else if (res == GTK_PRINT_OPERATION_RESULT_APPLY) { if (settings != NULL) g_object_unref (settings); settings = g_object_ref (gtk_print_operation_get_print_settings (print)); } ]| Note that gtk_print_operation_run() can only be called once on a given GtkPrintOperation. GTK_PRINT_OPERATION_RESULT_APPLY indicates that the printing was completed successfully. In this case, it is a good idea to obtain the used print settings with gtk_print_operation_get_print_settings() and store them for reuse with the next print operation. A value of GTK_PRINT_OPERATION_RESULT_IN_PROGRESS means the operation is running asynchronously, and will emit the GtkPrintOperation::done signal when done.
|
Gtk.PrintOperation | |
set_allow_async
(gboolean allow_async)
:
none
Sets whether the gtk_print_operation_run() may return
before the print operation is completed.
Sets whether the gtk_print_operation_run() may return
before the print operation is completed. Note that some platforms may not allow asynchronous operation.
|
Gtk.PrintOperation | |
set_current_page
(gint32 current_page)
:
none
Sets the current page.
Sets the current page.
If this is called before gtk_print_operation_run(), the user will be able to select to print only the current page. Note that this only makes sense for pre-paginated documents.
|
Gtk.PrintOperation | |
set_custom_tab_label
(String label)
:
none
Sets the label for the tab holding custom widgets.
Sets the label for the tab holding custom widgets.
|
Gtk.PrintOperation | |
set_default_page_setup
(PageSetup default_page_setup)
:
none
Makes default_page_setup the default page setup for op.
Makes default_page_setup the default page setup for op.
This page setup will be used by gtk_print_operation_run(), but it can be overridden on a per-page basis by connecting to the GtkPrintOperation::request-page-setup signal.
|
Gtk.PrintOperation | |
set_defer_drawing
()
:
none
Sets up the GtkPrintOperation to wait for calling of
gtk_print_operation_draw_page_finish() from application.
Sets up the GtkPrintOperation to wait for calling of
gtk_print_operation_draw_page_finish() from application. It can be used for drawing page in another thread. This function must be called in the callback of "draw-page" signal.
|
Gtk.PrintOperation | |
set_embed_page_setup
(gboolean embed)
:
none
Embed page size combo box and orientation combo box into page setup page.
Embed page size combo box and orientation combo box into page setup page.
Selected page setup is stored as default page setup in GtkPrintOperation.
|
Gtk.PrintOperation | |
set_export_filename
(String filename)
:
none
Sets up the GtkPrintOperation to generate a file instead
of showing the print dialog.
Sets up the GtkPrintOperation to generate a file instead
of showing the print dialog. The indended use of this function is for implementing "Export to PDF" actions. Currently, PDF is the only supported format. "Print to PDF" support is independent of this and is done by letting the user pick the "Print to PDF" item from the list of printers in the print dialog.
|
Gtk.PrintOperation | |
set_has_selection
(gboolean has_selection)
:
none
Sets whether there is a selection to print.
Sets whether there is a selection to print.
Application has to set number of pages to which the selection will draw by gtk_print_operation_set_n_pages() in a callback of GtkPrintOperation::begin-print.
|
Gtk.PrintOperation | |
set_job_name
(String job_name)
:
none
Sets the name of the print job.
Sets the name of the print job. The name is used to identify
the job (e.g. in monitoring applications like eggcups). If you don't set a job name, GTK+ picks a default one by numbering successive print jobs.
|
Gtk.PrintOperation | |
set_n_pages
(gint32 n_pages)
:
none
Sets the number of pages in the document.
Sets the number of pages in the document.
This before the rendering starts. It may be set in a GtkPrintOperation::begin-print signal hander. Note that the page numbers passed to the GtkPrintOperation::request-page-setup and GtkPrintOperation::draw-page signals are 0-based, i.e. if the user chooses to print all pages, the last ::draw-page signal will be for page n_pages - 1.
|
Gtk.PrintOperation | |
set_print_settings
(PrintSettings print_settings)
:
none
Sets the print settings for op.
Sets the print settings for op. This is typically used to
re-establish print settings from a previous print operation, see gtk_print_operation_run().
|
Gtk.PrintOperation | |
set_show_progress
(gboolean show_progress)
:
none
If show_progress is TRUE, the print operation will show a
progress dialog during the print operation.
If show_progress is TRUE, the print operation will show a
progress dialog during the print operation.
|
Gtk.PrintOperation | |
set_support_selection
(gboolean support_selection)
:
none
Sets whether selection is supported by GtkPrintOperation.
Sets whether selection is supported by GtkPrintOperation.
|
Gtk.PrintOperation | |
set_track_print_status
(gboolean track_status)
:
none
If track_status is TRUE, the print operation will try to continue report
on the status of the print job in the printer queues and printer.
If track_status is TRUE, the print operation will try to continue report
on the status of the print job in the printer queues and printer. This can allow your application to show things like "out of paper" issues, and when the print job actually reaches the printer. This function is often implemented using some form of polling, so it should not be enabled unless needed.
|
Gtk.PrintOperation | |
set_unit
(Unit unit)
:
none
Sets up the transformation for the cairo context obtained from
GtkPrintContext in such a way that distances are measured in units of unit.
Sets up the transformation for the cairo context obtained from
GtkPrintContext in such a way that distances are measured in units of unit.
|
Gtk.PrintOperation | |
set_use_full_page
(gboolean full_page)
:
none
If full_page is TRUE, the transformation for the cairo context
obtained from GtkPrintContext puts the origin at the top left corner of the page (which may not be the top left corner of the sheet, depending on page orientation and the number of pages per sheet).
If full_page is TRUE, the transformation for the cairo context
obtained from GtkPrintContext puts the origin at the top left corner of the page (which may not be the top left corner of the sheet, depending on page orientation and the number of pages per sheet). Otherwise, the origin is at the top left corner of the imageable area (i.e. inside the margins).
|
Gtk.PrintOperation |
Event | Defined By | |
---|---|---|
begin_print (PrintOperation self, PrintContext context)
:
none
Emitted after the user has finished changing print settings
in the dialog, before the actual rendering starts.
Emitted after the user has finished changing print settings
in the dialog, before the actual rendering starts. A typical use for ::begin-print is to use the parameters from the GtkPrintContext and paginate the document accordingly, and then set the number of pages with gtk_print_operation_set_n_pages().
|
Gtk.PrintOperation | |
create_custom_widget (PrintOperation self)
:
GObject.Object
Emitted when displaying the print dialog.
Emitted when displaying the print dialog. If you return a
widget in a handler for this signal it will be added to a custom tab in the print dialog. You typically return a container widget with multiple widgets in it. The print dialog owns the returned widget, and its lifetime is not controlled by the application. However, the widget is guaranteed to stay around until the GtkPrintOperation::custom-widget-apply signal is emitted on the operation. Then you can read out any information you need from the widgets. the print dialog, or NULL
|
Gtk.PrintOperation | |
custom_widget_apply (PrintOperation self, Widget widget)
:
none
Emitted right before GtkPrintOperation::begin-print if you added
a custom widget in the GtkPrintOperation::create-custom-widget handler.
Emitted right before GtkPrintOperation::begin-print if you added
a custom widget in the GtkPrintOperation::create-custom-widget handler. When you get this signal you should read the information from the custom widgets, as the widgets are not guaraneed to be around at a later time.
|
Gtk.PrintOperation | |
done (PrintOperation self, PrintOperationResult result)
:
none
Emitted when the print operation run has finished doing
everything required for printing.
Emitted when the print operation run has finished doing
everything required for printing. If result is GTK_PRINT_OPERATION_RESULT_ERROR then you can call gtk_print_operation_get_error() for more information. If you enabled print status tracking then gtk_print_operation_is_finished() may still return FALSE after GtkPrintOperation::done was emitted.
|
Gtk.PrintOperation | |
Emitted for every page that is printed.
Emitted for every page that is printed. The signal handler
must render the page_nr's page onto the cairo context obtained from context using gtk_print_context_get_cairo_context(). |[ static void draw_page (GtkPrintOperation *operation, GtkPrintContext *context, gint page_nr, gpointer user_data) { cairo_t *cr; PangoLayout *layout; gdouble width, text_height; gint layout_height; PangoFontDescription *desc; cr = gtk_print_context_get_cairo_context (context); width = gtk_print_context_get_width (context); cairo_rectangle (cr, 0, 0, width, HEADER_HEIGHT); cairo_set_source_rgb (cr, 0.8, 0.8, 0.8); cairo_fill (cr); layout = gtk_print_context_create_pango_layout (context); desc = pango_font_description_from_string ("sans 14"); pango_layout_set_font_description (layout, desc); pango_font_description_free (desc); pango_layout_set_text (layout, "some text", -1); pango_layout_set_width (layout, width * PANGO_SCALE); pango_layout_set_alignment (layout, PANGO_ALIGN_CENTER); pango_layout_get_size (layout, NULL, &layout_height); text_height = (gdouble)layout_height / PANGO_SCALE; cairo_move_to (cr, width / 2, (HEADER_HEIGHT - text_height) / 2); pango_cairo_show_layout (cr, layout); g_object_unref (layout); } ]| Use gtk_print_operation_set_use_full_page() and gtk_print_operation_set_unit() before starting the print operation to set up the transformation of the cairo context according to your needs.
|
Gtk.PrintOperation | |
end_print (PrintOperation self, PrintContext context)
:
none
Emitted after all pages have been rendered.
Emitted after all pages have been rendered.
A handler for this signal can clean up any resources that have been allocated in the GtkPrintOperation::begin-print handler.
|
Gtk.PrintOperation | |
The ::got-page-size signal is emitted once for each page
that gets rendered to the preview.
The ::got-page-size signal is emitted once for each page
that gets rendered to the preview. A handler for this signal should update the context according to page_setup and set up a suitable cairo context, using gtk_print_context_set_cairo_context().
|
Gtk.PrintOperationPreview | |
Emitted after the GtkPrintOperation::begin-print signal, but before
the actual rendering starts.
Emitted after the GtkPrintOperation::begin-print signal, but before
the actual rendering starts. It keeps getting emitted until a connected signal handler returns TRUE. The ::paginate signal is intended to be used for paginating a document in small chunks, to avoid blocking the user interface for a long time. The signal handler should update the number of pages using gtk_print_operation_set_n_pages(), and return TRUE if the document has been completely paginated. If you don't need to do pagination in chunks, you can simply do it all in the ::begin-print handler, and set the number of pages from there.
|
Gtk.PrintOperation | |
preview (PrintOperation self, PrintOperationPreview preview, PrintContext context, Window parent)
:
gboolean
Gets emitted when a preview is requested from the native dialog.
Gets emitted when a preview is requested from the native dialog.
The default handler for this signal uses an external viewer application to preview. To implement a custom print preview, an application must return TRUE from its handler for this signal. In order to use the provided context for the preview implementation, it must be given a suitable cairo context with gtk_print_context_set_cairo_context(). The custom preview implementation can use gtk_print_operation_preview_is_selected() and gtk_print_operation_preview_render_page() to find pages which are selected for print and render them. The preview must be finished by calling gtk_print_operation_preview_end_preview() (typically in response to the user clicking a close button).
|
Gtk.PrintOperation | |
ready (PrintOperationPreview self, PrintContext context)
:
none
The ::ready signal gets emitted once per preview operation,
before the first page is rendered.
The ::ready signal gets emitted once per preview operation,
before the first page is rendered. A handler for this signal can be used for setup tasks.
|
Gtk.PrintOperationPreview | |
request_page_setup (PrintOperation self, PrintContext context, gint32 page_nr, PageSetup setup)
:
none
Emitted once for every page that is printed, to give
the application a chance to modify the page setup.
Emitted once for every page that is printed, to give
the application a chance to modify the page setup. Any changes done to setup will be in force only for printing this page.
|
Gtk.PrintOperation | |
status_changed (PrintOperation self)
:
none
Emitted at between the various phases of the print operation.
Emitted at between the various phases of the print operation.
See GtkPrintStatus for the phases that are being discriminated. Use gtk_print_operation_get_status() to find out the current status.
|
Gtk.PrintOperation | |
update_custom_widget (PrintOperation self, Widget widget, PageSetup setup, PrintSettings settings)
:
none
Emitted after change of selected printer.
Emitted after change of selected printer. The actual page setup and
print settings are passed to the custom widget, which can actualize itself according to this change.
|
Gtk.PrintOperation |
Class / Namespace | Method / Signal / Properties |
---|---|
WebKit.WebFrame
Method |
Prints the given WebKitWebFrame, using the given GtkPrintOperation
and GtkPrintOperationAction. |