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 gtk.print_operation.PrintOperation.new_ when the user selects to print. Then you set some properties on it, e.g. the page size, any #GtkPrintSettings from previous print operations, the number of pages, the current page, etc.

Then you start the print operation by calling gtk.print_operation.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 #GtkPrintOperation, the main one being #GtkPrintOperation::draw-page, which you are supposed to catch and render the page on the provided #GtkPrintContext 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 gtk.print_operation_preview.PrintOperationPreview.renderPage, gtk.print_operation_preview.PrintOperationPreview.endPreview and gtk.print_operation_preview.PrintOperationPreview.isSelected

are useful when implementing a print preview.

class PrintOperation : ObjectWrap , PrintOperationPreview {

this(void* ptr, Flag!"Take" take);

static GType _getGType();

GType _gType [@property getter];

PrintOperation self();

static PrintOperationGidBuilder builder();

bool allowAsync [@property getter];

bool allowAsync [@property setter];

int currentPage [@property getter];

int currentPage [@property setter];

string customTabLabel [@property getter];

string customTabLabel [@property setter];

gtk.page_setup.PageSetup defaultPageSetup [@property getter];

gtk.page_setup.PageSetup defaultPageSetup [@property setter];

bool embedPageSetup [@property getter];

bool embedPageSetup [@property setter];

string exportFilename [@property getter];

string exportFilename [@property setter];

bool hasSelection [@property getter];

bool hasSelection [@property setter];

string jobName [@property getter];

string jobName [@property setter];

int nPages [@property getter];

int nPages [@property setter];

int nPagesToPrint [@property getter];

gtk.print_settings.PrintSettings printSettings [@property getter];

gtk.print_settings.PrintSettings printSettings [@property setter];

bool showProgress [@property getter];

bool showProgress [@property setter];

gtk.types.PrintStatus status [@property getter];

string statusString [@property getter];

bool supportSelection [@property getter];

bool supportSelection [@property setter];

bool trackPrintStatus [@property getter];

bool trackPrintStatus [@property setter];

gtk.types.Unit unit [@property getter];

gtk.types.Unit unit [@property setter];

bool useFullPage [@property getter];

bool useFullPage [@property setter];

void cancel();

void drawPageFinish();

gtk.page_setup.PageSetup getDefaultPageSetup();

bool getEmbedPageSetup();

void getError();

bool getHasSelection();

int getNPagesToPrint();

gtk.print_settings.PrintSettings getPrintSettings();

gtk.types.PrintStatus getStatus();

string getStatusString();

bool getSupportSelection();

bool isFinished();

gtk.types.PrintOperationResult run(gtk.types.PrintOperationAction action, gtk.window.Window parent);

void setAllowAsync(bool allowAsync);

void setCurrentPage(int currentPage);

void setCustomTabLabel(string label);

void setDefaultPageSetup(gtk.page_setup.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(gtk.print_settings.PrintSettings printSettings);

void setShowProgress(bool showProgress);

void setSupportSelection(bool supportSelection);

void setTrackPrintStatus(bool trackStatus);

void setUnit(gtk.types.Unit unit);

void setUseFullPage(bool fullPage);

gulong connectBeginPrint(T callback, Flag!"After" after);

gulong connectCreateCustomWidget(T callback, Flag!"After" after);

gulong connectCustomWidgetApply(T callback, Flag!"After" after);

gulong connectDone(T callback, Flag!"After" after);

gulong connectDrawPage(T callback, Flag!"After" after);

gulong connectEndPrint(T callback, Flag!"After" after);

gulong connectPaginate(T callback, Flag!"After" after);

gulong connectPreview(T callback, Flag!"After" after);

gulong connectRequestPageSetup(T callback, Flag!"After" after);

gulong connectStatusChanged(T callback, Flag!"After" after);

gulong connectUpdateCustomWidget(T callback, Flag!"After" after);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(): Creates a new #GtkPrintOperation.

Members

Functions

cancel void cancel(): 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.
connectBeginPrint gulong connectBeginPrint(T callback, Flag!"After" after): Connect to BeginPrint signal.
connectCreateCustomWidget gulong connectCreateCustomWidget(T callback, Flag!"After" after): Connect to CreateCustomWidget signal.
connectCustomWidgetApply gulong connectCustomWidgetApply(T callback, Flag!"After" after): Connect to CustomWidgetApply signal.
connectDone gulong connectDone(T callback, Flag!"After" after): Connect to Done signal.
connectDrawPage gulong connectDrawPage(T callback, Flag!"After" after): Connect to DrawPage signal.
connectEndPrint gulong connectEndPrint(T callback, Flag!"After" after): Connect to EndPrint signal.
connectPaginate gulong connectPaginate(T callback, Flag!"After" after): Connect to Paginate signal.
connectPreview gulong connectPreview(T callback, Flag!"After" after): Connect to Preview signal.
connectRequestPageSetup gulong connectRequestPageSetup(T callback, Flag!"After" after): Connect to RequestPageSetup signal.
connectStatusChanged gulong connectStatusChanged(T callback, Flag!"After" after): Connect to StatusChanged signal.
connectUpdateCustomWidget gulong connectUpdateCustomWidget(T callback, Flag!"After" after): Connect to UpdateCustomWidget signal.
drawPageFinish void drawPageFinish(): Signalize that drawing of particular page is complete.
getDefaultPageSetup gtk.page_setup.PageSetup getDefaultPageSetup(): Returns the default page setup, see gtk.print_operation.PrintOperation.setDefaultPageSetup.
getEmbedPageSetup bool getEmbedPageSetup(): Gets the value of #GtkPrintOperation:embed-page-setup property.
getError void getError(): Call this when the result of a print operation is gtk.types.PrintOperationResult.Error, either as returned by gtk.print_operation.PrintOperation.run, or in the #GtkPrintOperation::done signal handler. The returned #GError will contain more details on what went wrong.
getHasSelection bool getHasSelection(): Gets the value of #GtkPrintOperation:has-selection property.
getNPagesToPrint int getNPagesToPrint(): Returns the number of pages that will be printed.
getPrintSettings gtk.print_settings.PrintSettings getPrintSettings(): Returns the current print settings.
getStatus gtk.types.PrintStatus getStatus(): Returns the status of the print operation. Also see gtk.print_operation.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 #GtkStatusbar.
getSupportSelection bool getSupportSelection(): Gets the value of #GtkPrintOperation:support-selection property.
isFinished bool isFinished(): A convenience function to find out if the print operation is finished, either successfully (gtk.types.PrintStatus.Finished) or unsuccessfully (gtk.types.PrintStatus.FinishedAborted).
run gtk.types.PrintOperationResult run(gtk.types.PrintOperationAction action, gtk.window.Window parent): Runs the print operation, by first letting the user modify print settings in the print dialog, and then print the document.
self PrintOperation self(): Returns this, for use in with statements.
setAllowAsync void setAllowAsync(bool allowAsync): Sets whether the gtk.print_operation.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(gtk.page_setup.PageSetup defaultPageSetup): Makes default_page_setup the default page setup for op.
setDeferDrawing void setDeferDrawing(): Sets up the #GtkPrintOperation to wait for calling of gtk.print_operation.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 #GtkPrintOperation.
setExportFilename void setExportFilename(string filename): 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.
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(gtk.print_settings.PrintSettings printSettings): Sets the print settings for op. This is typically used to re-establish print settings from a previous print operation, see gtk.print_operation.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 #GtkPrintOperation.
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(gtk.types.Unit unit): Sets up the transformation for the cairo context obtained from #GtkPrintContext 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 #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).

Properties

_gType GType _gType [@property getter]
allowAsync bool allowAsync [@property getter]: Get allowAsync property.
allowAsync bool allowAsync [@property setter]: Set allowAsync property.
currentPage int currentPage [@property getter]: Get currentPage property.
currentPage int currentPage [@property setter]: Set currentPage property.
customTabLabel string customTabLabel [@property getter]: Get customTabLabel property.
customTabLabel string customTabLabel [@property setter]: Set customTabLabel property.
defaultPageSetup gtk.page_setup.PageSetup defaultPageSetup [@property getter]: Get defaultPageSetup property.
defaultPageSetup gtk.page_setup.PageSetup defaultPageSetup [@property setter]: Set defaultPageSetup property.
embedPageSetup bool embedPageSetup [@property getter]: Get embedPageSetup property.
embedPageSetup bool embedPageSetup [@property setter]: Set embedPageSetup property.
exportFilename string exportFilename [@property getter]: Get exportFilename property.
exportFilename string exportFilename [@property setter]: Set exportFilename property.
hasSelection bool hasSelection [@property getter]: Get hasSelection property.
hasSelection bool hasSelection [@property setter]: Set hasSelection property.
jobName string jobName [@property getter]: Get jobName property.
jobName string jobName [@property setter]: Set jobName property.
nPages int nPages [@property getter]: Get nPages property.
nPages int nPages [@property setter]: Set nPages property.
nPagesToPrint int nPagesToPrint [@property getter]: Get nPagesToPrint property.
printSettings gtk.print_settings.PrintSettings printSettings [@property getter]: Get printSettings property.
printSettings gtk.print_settings.PrintSettings printSettings [@property setter]: Set printSettings property.
showProgress bool showProgress [@property getter]: Get showProgress property.
showProgress bool showProgress [@property setter]: Set showProgress property.
status gtk.types.PrintStatus status [@property getter]: Get status property.
statusString string statusString [@property getter]: Get statusString property.
supportSelection bool supportSelection [@property getter]: Get supportSelection property.
supportSelection bool supportSelection [@property setter]: Set supportSelection property.
trackPrintStatus bool trackPrintStatus [@property getter]: Get trackPrintStatus property.
trackPrintStatus bool trackPrintStatus [@property setter]: Set trackPrintStatus property.
unit gtk.types.Unit unit [@property getter]: Get unit property.
unit gtk.types.Unit unit [@property setter]: Set unit property.
useFullPage bool useFullPage [@property getter]: Get useFullPage property.
useFullPage bool useFullPage [@property setter]: Set useFullPage property.

Static functions

_getGType GType _getGType()
builder PrintOperationGidBuilder builder(): Get builder for gtk.print_operation.PrintOperation

Mixed In Members

From `mixin PrintOperationPreviewT!()`

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 #GtkPrintOperation::preview handler together with preview.
connectGotPageSize gulong connectGotPageSize(T callback, Flag!"After" after): Connect to GotPageSize signal.
connectReady gulong connectReady(T callback, Flag!"After" after): Connect to Ready signal.

Inherited Members

From ObjectWrap

_setGObject void _setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectWrap wrapper.
_cPtr void* _cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
_ref void* _ref(void* gObj): Calls g_object_ref() on a GObject.
_unref _unref(void* gObj): Calls g_object_unref() on a GObject.
_getGType GType _getGType(): Get the GType of an object.
_gType GType _gType [@property getter]: GObject GType property.
self ObjectWrap self(): Convenience method to return this cast to a type. For use in D with statements.
_getDObject T _getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure gulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.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.
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 gobject.object.ObjectWrap.refSink.
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 #GObject::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 gobject.object.ObjectWrap.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata.
getv void getv(string[] names, gobject.value.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(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectWrap refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
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.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
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(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata 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 gobject.object.ObjectWrap.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.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 gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectWrap.ref_ and gobject.object.ObjectWrap.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.
connectNotify gulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

From PrintOperationPreview

_getGType GType _getGType()
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 #GtkPrintOperation::preview handler together with preview.
connectGotPageSize gulong connectGotPageSize(T callback, Flag!"After" after): Connect to GotPageSize signal.
connectReady gulong connectReady(T callback, Flag!"After" after): Connect to Ready signal.

gtk print_operation classes