Class
WebKit2PrintOperation
Description [src]
class WebKit2.PrintOperation : GObject.Object {
parent: GObject
}
Controls a print operation.
A WebKitPrintOperation
controls a print operation in WebKit. With
a similar API to GtkPrintOperation
, it lets you set the print
settings with webkit_print_operation_set_print_settings()
or
display the print dialog with webkit_print_operation_run_dialog().
Constructors
webkit_print_operation_new
Create a new WebKitPrintOperation
to print web_view
contents.
Instance methods
webkit_print_operation_get_page_setup
Return the current page setup of print_operation
. It returns NULL
until
either webkit_print_operation_set_page_setup()
or webkit_print_operation_run_dialog()
have been called.
webkit_print_operation_get_print_settings
Return the current print settings of print_operation
. It returns NULL
until
either webkit_print_operation_set_print_settings()
or webkit_print_operation_run_dialog()
have been called.
webkit_print_operation_print
Start a print operation using current print settings and page setup
without showing the print dialog. If either print settings or page setup
are not set with webkit_print_operation_set_print_settings()
and
webkit_print_operation_set_page_setup(), the default options will be used
and the print job will be sent to the default printer.
The WebKitPrintOperation::finished
signal is emitted when the printing
operation finishes. If an error occurs while printing the signal
WebKitPrintOperation::failed
is emitted before WebKitPrintOperation::finished
.
webkit_print_operation_run_dialog
Run the print dialog and start printing using the options selected by
the user. This method returns when the print dialog is closed.
If the print dialog is cancelled WEBKIT_PRINT_OPERATION_RESPONSE_CANCEL
is returned. If the user clicks on the print button, WEBKIT_PRINT_OPERATION_RESPONSE_PRINT
is returned and the print operation starts. In this case, the WebKitPrintOperation::finished
signal is emitted when the operation finishes. If an error occurs while printing, the signal
WebKitPrintOperation::failed
is emitted before WebKitPrintOperation::finished
.
If the print dialog is not cancelled current print settings and page setup of print_operation
are updated with options selected by the user when Print button is pressed in print dialog.
You can get the updated print settings and page setup by calling
webkit_print_operation_get_print_settings()
and webkit_print_operation_get_page_setup()
after this method.
webkit_print_operation_set_page_setup
Set the current page setup of print_operation
. Current page setup is used for the
initial values of the print dialog when webkit_print_operation_run_dialog()
is called.
webkit_print_operation_set_print_settings
Set the current print settings of print_operation
. Current print settings are used for
the initial values of the print dialog when webkit_print_operation_run_dialog()
is called.
Properties
WebKit2.PrintOperation:page-setup
The initial GtkPageSetup
for the print operation.
WebKit2.PrintOperation:print-settings
The initial GtkPrintSettings
for the print operation.
WebKit2.PrintOperation:web-view
The WebKitWebView
that will be printed.
Signals
WebKit2.PrintOperation::create-custom-widget
Emitted when displaying the print dialog with webkit_print_operation_run_dialog().
The returned WebKitPrintCustomWidget
will be added to the print dialog and
it will be owned by the print_operation
. However, the object is guaranteed
to be alive until the WebKitPrintCustomWidget::apply
is emitted.
Available since: 2.16
WebKit2.PrintOperation::failed
Emitted when an error occurs while printing. The given error
, of the domain
WEBKIT_PRINT_ERROR
, contains further details of the failure.
The WebKitPrintOperation::finished
signal is emitted after this one.
WebKit2.PrintOperation::finished
Emitted when the print operation has finished doing everything required for printing.
Signals inherited from GObject (1)
GObject.Object::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Class structure
struct WebKit2PrintOperationClass {
GObjectClass parent_class;
void (* _webkit_reserved0) (
void
);
void (* _webkit_reserved1) (
void
);
void (* _webkit_reserved2) (
void
);
void (* _webkit_reserved3) (
void
);
}
Class members
parent_class |
|
No description available. | |
_webkit_reserved0 |
|
No description available. | |
_webkit_reserved1 |
|
No description available. | |
_webkit_reserved2 |
|
No description available. | |
_webkit_reserved3 |
|
No description available. |