PrintOperation

GtkPrintOperation is the high-level, portable printing API. It looks a bit different than other GTK+ dialogs such as the GtkFileChooser, since some platforms don’t expose enough infrastructure to implement a good print dialog. On such platforms, GtkPrintOperation uses the native print dialog. On platforms which do not provide a native print dialog, GTK+ uses its own, see GtkPrintUnixDialog

The typical way to use the high-level printing API is to create a GtkPrintOperation object with PrintOperation.new when the user selects to print. Then you set some properties on it, e.g. the page size, any gtk.PrintSettings from previous print operations, the number of pages, the current page, etc.

Then you start the print operation by calling PrintOperation.run. It will then show a dialog, let the user select a printer and options. When the user finished the dialog various signals will be emitted on the gtk.PrintOperation, the main one being draw-page, which you are supposed to catch and render the page on the provided gtk.PrintContext using Cairo.

The high-level printing API

static GtkPrintSettings *settings = NULL;

static void
do_print (void)
{
GtkPrintOperation *print;
GtkPrintOperationResult res;

print = gtk_print_operation_new ();

if (settings != NULL)
gtk_print_operation_set_print_settings (print, settings);

g_signal_connect (print, "begin_print", G_CALLBACK (begin_print), NULL);
g_signal_connect (print, "draw_page", G_CALLBACK (draw_page), NULL);

res = gtk_print_operation_run (print, GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG,
GTK_WINDOW (main_window), NULL);

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));
}

g_object_unref (print);
}

By default GtkPrintOperation uses an external application to do print preview. To implement a custom print preview, an application must connect to the preview signal. The functions PrintOperation.previewRenderPage, PrintOperation.previewEndPreview and PrintOperation.previewIsSelected

are useful when implementing a print preview.

class PrintOperation : ObjectG , PrintOperationPreviewIF {

GtkPrintOperation* gtkPrintOperation;

GtkPrintOperation* getPrintOperationStruct(bool transferOwnership);

void* getStruct();

this(GtkPrintOperation* gtkPrintOperation, bool ownedRef);

static GType getType();

void cancel();

void drawPageFinish();

PageSetup getDefaultPageSetup();

bool getEmbedPageSetup();

void getError();

bool getHasSelection();

int getNPagesToPrint();

PrintSettings getPrintSettings();

GtkPrintStatus getStatus();

string getStatusString();

bool getSupportSelection();

bool isFinished();

GtkPrintOperationResult run(GtkPrintOperationAction action, Window parent);

void setAllowAsync(bool allowAsync);

void setCurrentPage(int currentPage);

void setCustomTabLabel(string label);

void setDefaultPageSetup(PageSetup defaultPageSetup);

void setDeferDrawing();

void setEmbedPageSetup(bool embed);

void setExportFilename(string filename);

void setHasSelection(bool hasSelection);

void setJobName(string jobName);

void setNPages(int nPages);

void setPrintSettings(PrintSettings printSettings);

void setShowProgress(bool showProgress);

void setSupportSelection(bool supportSelection);

void setTrackPrintStatus(bool trackStatus);

void setUnit(GtkUnit unit);

void setUseFullPage(bool fullPage);

gulong addOnBeginPrint(void delegate(PrintContext, PrintOperation) dlg, ConnectFlags connectFlags);

gulong addOnCreateCustomWidget(ObjectG delegate(PrintOperation) dlg, ConnectFlags connectFlags);

gulong addOnCustomWidgetApply(void delegate(Widget, PrintOperation) dlg, ConnectFlags connectFlags);

gulong addOnDone(void delegate(GtkPrintOperationResult, PrintOperation) dlg, ConnectFlags connectFlags);

gulong addOnDrawPage(void delegate(PrintContext, int, PrintOperation) dlg, ConnectFlags connectFlags);

gulong addOnEndPrint(void delegate(PrintContext, PrintOperation) dlg, ConnectFlags connectFlags);

gulong addOnPaginate(bool delegate(PrintContext, PrintOperation) dlg, ConnectFlags connectFlags);

gulong addOnPreview(bool delegate(PrintOperationPreviewIF, PrintContext, Window, PrintOperation) dlg, ConnectFlags connectFlags);

gulong addOnRequestPageSetup(void delegate(PrintContext, int, PageSetup, PrintOperation) dlg, ConnectFlags connectFlags);

gulong addOnStatusChanged(void delegate(PrintOperation) dlg, ConnectFlags connectFlags);

gulong addOnUpdateCustomWidget(void delegate(Widget, PageSetup, PrintSettings, PrintOperation) dlg, ConnectFlags connectFlags);

static PageSetup printRunPageSetupDialog(Window parent, PageSetup pageSetup, PrintSettings settings);

static void printRunPageSetupDialogAsync(Window parent, PageSetup pageSetup, PrintSettings settings, GtkPageSetupDoneFunc doneCb, void* data);

}

Constructors

this this(GtkPrintOperation* gtkPrintOperation, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Creates a new gtk.PrintOperation

Members

Functions

addOnBeginPrint gulong addOnBeginPrint(void delegate(PrintContext, PrintOperation) dlg, ConnectFlags connectFlags): Emitted after the user has finished changing print settings in the dialog, before the actual rendering starts.
addOnCreateCustomWidget gulong addOnCreateCustomWidget(ObjectG delegate(PrintOperation) dlg, ConnectFlags connectFlags): 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.
addOnCustomWidgetApply gulong addOnCustomWidgetApply(void delegate(Widget, PrintOperation) dlg, ConnectFlags connectFlags): Emitted right before begin-print if you added a custom widget in the 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.
addOnDone gulong addOnDone(void delegate(GtkPrintOperationResult, PrintOperation) dlg, ConnectFlags connectFlags): Emitted when the print operation run has finished doing everything required for printing.
addOnDrawPage gulong addOnDrawPage(void delegate(PrintContext, int, PrintOperation) dlg, ConnectFlags connectFlags): 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 PrintContext.getCairoContext.
addOnEndPrint gulong addOnEndPrint(void delegate(PrintContext, PrintOperation) dlg, ConnectFlags connectFlags): Emitted after all pages have been rendered. A handler for this signal can clean up any resources that have been allocated in the begin-print handler.
addOnPaginate gulong addOnPaginate(bool delegate(PrintContext, PrintOperation) dlg, ConnectFlags connectFlags): Emitted after the begin-print signal, but before the actual rendering starts. It keeps getting emitted until a connected signal handler returns TRUE.
addOnPreview gulong addOnPreview(bool delegate(PrintOperationPreviewIF, PrintContext, Window, PrintOperation) dlg, ConnectFlags connectFlags): Gets emitted when a preview is requested from the native dialog.
addOnRequestPageSetup gulong addOnRequestPageSetup(void delegate(PrintContext, int, PageSetup, PrintOperation) dlg, ConnectFlags connectFlags): 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.
addOnStatusChanged gulong addOnStatusChanged(void delegate(PrintOperation) dlg, ConnectFlags connectFlags): Emitted at between the various phases of the print operation. See GtkPrintStatus for the phases that are being discriminated. Use PrintOperation.getStatus to find out the current status.
addOnUpdateCustomWidget gulong addOnUpdateCustomWidget(void delegate(Widget, PageSetup, PrintSettings, PrintOperation) dlg, ConnectFlags connectFlags): 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.
cancel void cancel(): Cancels a running print operation. This function may be called from a begin-print, paginate or draw-page signal handler to stop the currently running print operation.
drawPageFinish void drawPageFinish(): Signalize that drawing of particular page is complete.
getDefaultPageSetup PageSetup getDefaultPageSetup(): Returns the default page setup, see PrintOperation.setDefaultPageSetup.
getEmbedPageSetup bool getEmbedPageSetup(): Gets the value of embed-page-setup property.
getError void getError(): Call this when the result of a print operation is GTK_PRINT_OPERATION_RESULT_ERROR, either as returned by PrintOperation.run, or in the done signal handler. The returned GError will contain more details on what went wrong.
getHasSelection bool getHasSelection(): Gets the value of has-selection property.
getNPagesToPrint int getNPagesToPrint(): Returns the number of pages that will be printed.
getPrintOperationStruct GtkPrintOperation* getPrintOperationStruct(bool transferOwnership): Get the main Gtk struct
getPrintSettings PrintSettings getPrintSettings(): Returns the current print settings.
getStatus GtkPrintStatus getStatus(): Returns the status of the print operation. Also see PrintOperation.getStatusString.
getStatusString string getStatusString(): 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 gtk.Statusbar
getStruct void* getStruct(): the main Gtk struct as a void*
getSupportSelection bool getSupportSelection(): Gets the value of support-selection property.
isFinished bool isFinished(): 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).
run GtkPrintOperationResult run(GtkPrintOperationAction action, Window parent): Runs the print operation, by first letting the user modify print settings in the print dialog, and then print the document.
setAllowAsync void setAllowAsync(bool allowAsync): Sets whether the PrintOperation.run may return before the print operation is completed. Note that some platforms may not allow asynchronous operation.
setCurrentPage void setCurrentPage(int currentPage): Sets the current page.
setCustomTabLabel void setCustomTabLabel(string label): Sets the label for the tab holding custom widgets.
setDefaultPageSetup void setDefaultPageSetup(PageSetup defaultPageSetup): Makes default_page_setup the default page setup for op.
setDeferDrawing void setDeferDrawing(): Sets up the gtk.PrintOperation to wait for calling of PrintOperation.drawPageFinish from application. It can be used for drawing page in another thread.
setEmbedPageSetup void setEmbedPageSetup(bool embed): Embed page size combo box and orientation combo box into page setup page. Selected page setup is stored as default page setup in gtk.PrintOperation
setExportFilename void setExportFilename(string filename): Sets up the gtk.PrintOperation 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.
setHasSelection void setHasSelection(bool hasSelection): Sets whether there is a selection to print.
setJobName void setJobName(string jobName): Sets the name of the print job. The name is used to identify the job (e.g. in monitoring applications like eggcups).
setNPages void setNPages(int nPages): Sets the number of pages in the document.
setPrintSettings void setPrintSettings(PrintSettings printSettings): Sets the print settings for op. This is typically used to re-establish print settings from a previous print operation, see PrintOperation.run.
setShowProgress void setShowProgress(bool showProgress): If show_progress is TRUE, the print operation will show a progress dialog during the print operation.
setSupportSelection void setSupportSelection(bool supportSelection): Sets whether selection is supported by gtk.PrintOperation
setTrackPrintStatus void setTrackPrintStatus(bool trackStatus): 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.
setUnit void setUnit(GtkUnit unit): Sets up the transformation for the cairo context obtained from gtk.PrintContext in such a way that distances are measured in units of unit.
setUseFullPage void setUseFullPage(bool fullPage): If full_page is TRUE, the transformation for the cairo context obtained from gtk.PrintContext 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).

Static functions

getType GType getType()
printRunPageSetupDialog PageSetup printRunPageSetupDialog(Window parent, PageSetup pageSetup, PrintSettings settings): Runs a page setup dialog, letting the user modify the values from page_setup. If the user cancels the dialog, the returned gtk.PageSetup is identical to the passed in page_setup, otherwise it contains the modifications done in the dialog.
printRunPageSetupDialogAsync void printRunPageSetupDialogAsync(Window parent, PageSetup pageSetup, PrintSettings settings, GtkPageSetupDoneFunc doneCb, void* data): Runs a page setup dialog, letting the user modify the values from page_setup.

Variables

gtkPrintOperation GtkPrintOperation* gtkPrintOperation;: the main Gtk struct

Inherited Members

From ObjectG

gObject GObject* gObject;: the main Gtk struct
getObjectGStruct GObject* getObjectGStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
opCast T opCast()
getDObject RT getDObject(U obj, bool ownedRef): Gets a D Object from the objects table of associations.
setProperty void setProperty(string propertyName, T value)
addOnNotify gulong addOnNotify(void delegate(ParamSpec, ObjectG) dlg, string property, ConnectFlags connectFlags): The notify signal is emitted on an object when one of its properties has been changed. Note that getting this signal doesn't guarantee that the value of the property has actually changed, it may also be emitted when the setter for the property is called to reinstate the previous value.
getType GType getType()
compatControl size_t compatControl(size_t what, void* data)
interfaceFindProperty ParamSpec interfaceFindProperty(TypeInterface gIface, string propertyName): Find the gobject.ParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().
interfaceInstallProperty void interfaceInstallProperty(TypeInterface gIface, ParamSpec pspec): Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created gobject.ParamSpec, but normally ObjectClass.overrideProperty will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
interfaceListProperties ParamSpec[] interfaceListProperties(TypeInterface gIface): Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().
addToggleRef void addToggleRef(GToggleNotify notify, void* data): Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established.
addWeakPointer void addWeakPointer(void* weakPointerLocation): Adds a weak reference from weak_pointer to object to indicate that the pointer located at weak_pointer_location is only valid during the lifetime of object. When the object is finalized, weak_pointer will be set to NULL.
bindProperty Binding bindProperty(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags): Creates a binding between source_property on source and target_property on target. Whenever the source_property is changed the target_property is updated using the same value. For instance:
bindPropertyFull Binding bindPropertyFull(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, GBindingTransformFunc transformTo, GBindingTransformFunc transformFrom, void* userData, GDestroyNotify notify): Complete version of g_object_bind_property().
bindPropertyWithClosures Binding bindPropertyWithClosures(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, Closure transformTo, Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
dupData void* dupData(string key, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_data() which returns a 'duplicate' of the value. dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
dupQdata void* dupQdata(GQuark quark, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
forceFloating void forceFloating(): This function is intended for GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see g_object_set_data()).
getProperty void getProperty(string propertyName, Value value): Gets a property of an object.
getQdata void* getQdata(GQuark quark): This function gets back user data pointers stored via g_object_set_qdata().
getValist void getValist(string firstPropertyName, void* varArgs): Gets properties of an object.
getv void getv(string[] names, Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
ref_ ObjectG ref_(): Increases the reference count of object.
refSink ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
removeToggleRef void removeToggleRef(GToggleNotify notify, void* data): Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one.
removeWeakPointer void removeWeakPointer(void* weakPointerLocation): Removes a weak reference from object that was previously added using g_object_add_weak_pointer(). The weak_pointer_location has to match the one used with g_object_add_weak_pointer().
replaceData bool replaceData(string key, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key key on object with oldval, and if they are the same, replaces oldval with newval.
replaceQdata bool replaceQdata(GQuark quark, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key quark on object with oldval, and if they are the same, replaces oldval with newval.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setDataFull void setDataFull(string key, void* data, GDestroyNotify destroy): Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed.
setProperty void setProperty(string propertyName, Value value): Sets a property on an object.
setQdata void setQdata(GQuark quark, void* data): This sets an opaque, named pointer on an object. The name is specified through a GQuark (retrived e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the object with g_object_get_qdata() until the object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using NULL as pointer essentially removes the data stored.
setQdataFull void setQdataFull(GQuark quark, void* data, GDestroyNotify destroy): This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with data as argument when the object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same quark.
setValist void setValist(string firstPropertyName, void* varArgs): Sets properties on an object.
setv void setv(string[] names, Value[] values): Sets n_properties properties for an object. Properties to be set will be taken from values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(GQuark quark): This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
unref void unref(): Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).
watchClosure void watchClosure(Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
weakRef void weakRef(GWeakNotify notify, void* data): Adds a weak reference callback to an object. Weak references are used for notification when an object is finalized. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).
weakUnref void weakUnref(GWeakNotify notify, void* data): Removes a weak reference callback to an object.
clearObject void clearObject(ObjectG objectPtr): Clears a reference to a GObject

From PrintOperationPreviewIF

getPrintOperationPreviewStruct GtkPrintOperationPreview* getPrintOperationPreviewStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
endPreview void endPreview(): Ends a preview.
isSelected bool isSelected(int pageNr): Returns whether the given page is included in the set of pages that have been selected for printing.
renderPage void renderPage(int pageNr): Renders a page to the preview, using the print context that was passed to the preview handler together with preview.
addOnGotPageSize gulong addOnGotPageSize(void delegate(PrintContext, PageSetup, PrintOperationPreviewIF) dlg, ConnectFlags connectFlags): The ::got-page-size signal is emitted once for each page that gets rendered to the preview.
addOnReady gulong addOnReady(void delegate(PrintContext, PrintOperationPreviewIF) dlg, ConnectFlags connectFlags): The ::ready signal gets emitted once per preview operation, before the first page is rendered.

gtk PrintOperation classes

PrintOperation