#include <cairo.h>
#include <gtk/gtk.h>
#include <gtk/print/gtkpagesetup.h>
#include <gtk/print/gtkprintsettings.h>
#include <gtk/print/gtkprintcontext.h>
#include <gtk/print/gtkprintoperationpreview.h>

Data Structures
struct	_GtkPrintOperation

struct	_GtkPrintOperationClass

Macros
#define	GTK_TYPE_PRINT_OPERATION (gtk_print_operation_get_type ())

#define	GTK_PRINT_OPERATION(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_PRINT_OPERATION, GtkPrintOperation))

#define	GTK_PRINT_OPERATION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PRINT_OPERATION, GtkPrintOperationClass))

#define	GTK_IS_PRINT_OPERATION(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_PRINT_OPERATION))

#define	GTK_IS_PRINT_OPERATION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PRINT_OPERATION))

#define	GTK_PRINT_OPERATION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PRINT_OPERATION, GtkPrintOperationClass))

#define	GTK_PRINT_ERROR gtk_print_error_quark ()

Typedefs
typedef struct _GtkPrintOperationClass	GtkPrintOperationClass

typedef struct _GtkPrintOperationPrivate	GtkPrintOperationPrivate

typedef struct _GtkPrintOperation	GtkPrintOperation

typedef void(*	GtkPageSetupDoneFunc) (GtkPageSetup *page_setup, gpointer data)

Enumerations
enum	GtkPrintStatus { GTK_PRINT_STATUS_INITIAL , GTK_PRINT_STATUS_PREPARING , GTK_PRINT_STATUS_GENERATING_DATA , GTK_PRINT_STATUS_SENDING_DATA , GTK_PRINT_STATUS_PENDING , GTK_PRINT_STATUS_PENDING_ISSUE , GTK_PRINT_STATUS_PRINTING , GTK_PRINT_STATUS_FINISHED , GTK_PRINT_STATUS_FINISHED_ABORTED }

enum	GtkPrintOperationResult { GTK_PRINT_OPERATION_RESULT_ERROR , GTK_PRINT_OPERATION_RESULT_APPLY , GTK_PRINT_OPERATION_RESULT_CANCEL , GTK_PRINT_OPERATION_RESULT_IN_PROGRESS }

enum	GtkPrintOperationAction { GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG , GTK_PRINT_OPERATION_ACTION_PRINT , GTK_PRINT_OPERATION_ACTION_PREVIEW , GTK_PRINT_OPERATION_ACTION_EXPORT }

enum	GtkPrintError { GTK_PRINT_ERROR_GENERAL , GTK_PRINT_ERROR_INTERNAL_ERROR , GTK_PRINT_ERROR_NOMEM , GTK_PRINT_ERROR_INVALID_FILE }

Functions
GDK_AVAILABLE_IN_ALL GQuark	gtk_print_error_quark (void)

GDK_AVAILABLE_IN_ALL GType	gtk_print_operation_get_type (void) G_GNUC_CONST

GDK_AVAILABLE_IN_ALL GtkPrintOperation *	gtk_print_operation_new (void)

GDK_AVAILABLE_IN_ALL void	gtk_print_operation_set_default_page_setup (GtkPrintOperation op, GtkPageSetup default_page_setup)

GDK_AVAILABLE_IN_ALL GtkPageSetup *	gtk_print_operation_get_default_page_setup (GtkPrintOperation *op)

GDK_AVAILABLE_IN_ALL void	gtk_print_operation_set_print_settings (GtkPrintOperation op, GtkPrintSettings print_settings)

GDK_AVAILABLE_IN_ALL GtkPrintSettings *	gtk_print_operation_get_print_settings (GtkPrintOperation *op)

GDK_AVAILABLE_IN_ALL void	gtk_print_operation_set_job_name (GtkPrintOperation op, const char job_name)

GDK_AVAILABLE_IN_ALL void	gtk_print_operation_set_n_pages (GtkPrintOperation *op, int n_pages)

GDK_AVAILABLE_IN_ALL void	gtk_print_operation_set_current_page (GtkPrintOperation *op, int current_page)

GDK_AVAILABLE_IN_ALL void	gtk_print_operation_set_use_full_page (GtkPrintOperation *op, gboolean full_page)

GDK_AVAILABLE_IN_ALL void	gtk_print_operation_set_unit (GtkPrintOperation *op, GtkUnit unit)

GDK_AVAILABLE_IN_ALL void	gtk_print_operation_set_export_filename (GtkPrintOperation op, const char filename)

GDK_AVAILABLE_IN_ALL void	gtk_print_operation_set_track_print_status (GtkPrintOperation *op, gboolean track_status)

GDK_AVAILABLE_IN_ALL void	gtk_print_operation_set_show_progress (GtkPrintOperation *op, gboolean show_progress)

GDK_AVAILABLE_IN_ALL void	gtk_print_operation_set_allow_async (GtkPrintOperation *op, gboolean allow_async)

GDK_AVAILABLE_IN_ALL void	gtk_print_operation_set_custom_tab_label (GtkPrintOperation op, const char label)

GDK_AVAILABLE_IN_ALL GtkPrintOperationResult	gtk_print_operation_run (GtkPrintOperation op, GtkPrintOperationAction action, GtkWindow parent, GError **error)

GDK_AVAILABLE_IN_ALL void	gtk_print_operation_get_error (GtkPrintOperation op, GError *error)

GDK_AVAILABLE_IN_ALL GtkPrintStatus	gtk_print_operation_get_status (GtkPrintOperation *op)

GDK_AVAILABLE_IN_ALL const char *	gtk_print_operation_get_status_string (GtkPrintOperation *op)

GDK_AVAILABLE_IN_ALL gboolean	gtk_print_operation_is_finished (GtkPrintOperation *op)

GDK_AVAILABLE_IN_ALL void	gtk_print_operation_cancel (GtkPrintOperation *op)

GDK_AVAILABLE_IN_ALL void	gtk_print_operation_draw_page_finish (GtkPrintOperation *op)

GDK_AVAILABLE_IN_ALL void	gtk_print_operation_set_defer_drawing (GtkPrintOperation *op)

GDK_AVAILABLE_IN_ALL void	gtk_print_operation_set_support_selection (GtkPrintOperation *op, gboolean support_selection)

GDK_AVAILABLE_IN_ALL gboolean	gtk_print_operation_get_support_selection (GtkPrintOperation *op)

GDK_AVAILABLE_IN_ALL void	gtk_print_operation_set_has_selection (GtkPrintOperation *op, gboolean has_selection)

GDK_AVAILABLE_IN_ALL gboolean	gtk_print_operation_get_has_selection (GtkPrintOperation *op)

GDK_AVAILABLE_IN_ALL void	gtk_print_operation_set_embed_page_setup (GtkPrintOperation *op, gboolean embed)

GDK_AVAILABLE_IN_ALL gboolean	gtk_print_operation_get_embed_page_setup (GtkPrintOperation *op)

GDK_AVAILABLE_IN_ALL int	gtk_print_operation_get_n_pages_to_print (GtkPrintOperation *op)

GDK_AVAILABLE_IN_ALL GtkPageSetup *	gtk_print_run_page_setup_dialog (GtkWindow parent, GtkPageSetup page_setup, GtkPrintSettings *settings)

GDK_AVAILABLE_IN_ALL void	gtk_print_run_page_setup_dialog_async (GtkWindow parent, GtkPageSetup page_setup, GtkPrintSettings *settings, GtkPageSetupDoneFunc done_cb, gpointer data)

Macro Definition Documentation

◆ GTK_IS_PRINT_OPERATION

#define GTK_IS_PRINT_OPERATION ( obj ) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_PRINT_OPERATION))

Definition at line 40 of file gtkprintoperation.h.

◆ GTK_IS_PRINT_OPERATION_CLASS

#define GTK_IS_PRINT_OPERATION_CLASS ( klass ) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PRINT_OPERATION))

Definition at line 41 of file gtkprintoperation.h.

◆ GTK_PRINT_ERROR

#define GTK_PRINT_ERROR gtk_print_error_quark ()

GTK_PRINT_ERROR:

The error domain for GtkPrintError errors.

Definition at line 199 of file gtkprintoperation.h.

◆ GTK_PRINT_OPERATION

#define GTK_PRINT_OPERATION ( obj ) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_PRINT_OPERATION, GtkPrintOperation))

Definition at line 38 of file gtkprintoperation.h.

◆ GTK_PRINT_OPERATION_CLASS

#define GTK_PRINT_OPERATION_CLASS ( klass ) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PRINT_OPERATION, GtkPrintOperationClass))

Definition at line 39 of file gtkprintoperation.h.

◆ GTK_PRINT_OPERATION_GET_CLASS

#define GTK_PRINT_OPERATION_GET_CLASS ( obj ) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PRINT_OPERATION, GtkPrintOperationClass))

Definition at line 42 of file gtkprintoperation.h.

◆ GTK_TYPE_PRINT_OPERATION

#define GTK_TYPE_PRINT_OPERATION (gtk_print_operation_get_type ())

Definition at line 37 of file gtkprintoperation.h.

Typedef Documentation

◆ GtkPageSetupDoneFunc

typedef void(* GtkPageSetupDoneFunc) (GtkPageSetup *page_setup, gpointer data)

GtkPageSetupDoneFunc: @page_setup: the GtkPageSetup that has been passed to gtk_print_run_page_setup_dialog_async() @data: (closure): user data that has been passed to gtk_print_run_page_setup_dialog_async()

The type of function that is passed to gtk_print_run_page_setup_dialog_async().

This function will be called when the page setup dialog is dismissed, and also serves as destroy notify for @data.

Definition at line 323 of file gtkprintoperation.h.

◆ GtkPrintOperation

typedef struct _GtkPrintOperation GtkPrintOperation

Definition at line 46 of file gtkprintoperation.h.

◆ GtkPrintOperationClass

typedef struct _GtkPrintOperationClass GtkPrintOperationClass

Definition at line 44 of file gtkprintoperation.h.

◆ GtkPrintOperationPrivate

typedef struct _GtkPrintOperationPrivate GtkPrintOperationPrivate

Definition at line 45 of file gtkprintoperation.h.

Enumeration Type Documentation

◆ GtkPrintError

enum GtkPrintError

GtkPrintError: @GTK_PRINT_ERROR_GENERAL: An unspecified error occurred. @GTK_PRINT_ERROR_INTERNAL_ERROR: An internal error occurred. @GTK_PRINT_ERROR_NOMEM: A memory allocation failed. @GTK_PRINT_ERROR_INVALID_FILE: An error occurred while loading a page setup or paper size from a key file.

Error codes that identify various errors that can occur while using the GTK printing support.

Enumerator
GTK_PRINT_ERROR_GENERAL
GTK_PRINT_ERROR_INTERNAL_ERROR
GTK_PRINT_ERROR_NOMEM
GTK_PRINT_ERROR_INVALID_FILE

Definition at line 212 of file gtkprintoperation.h.

{
  GTK_PRINT_ERROR_GENERAL,
  GTK_PRINT_ERROR_INTERNAL_ERROR,
  GTK_PRINT_ERROR_NOMEM,
  GTK_PRINT_ERROR_INVALID_FILE
} GtkPrintError;

◆ GtkPrintOperationAction

enum GtkPrintOperationAction

GtkPrintOperationAction: @GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG: Show the print dialog. @GTK_PRINT_OPERATION_ACTION_PRINT: Start to print without showing the print dialog, based on the current print settings. @GTK_PRINT_OPERATION_ACTION_PREVIEW: Show the print preview. @GTK_PRINT_OPERATION_ACTION_EXPORT: Export to a file. This requires the export-filename property to be set.

Determines what action the print operation should perform.

A parameter of this typs is passed to [metho.nosp@m.d@Gt.nosp@m.k.Pri.nosp@m.ntOp.nosp@m.erati.nosp@m.on.r.nosp@m.un].

Enumerator
GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG
GTK_PRINT_OPERATION_ACTION_PRINT
GTK_PRINT_OPERATION_ACTION_PREVIEW
GTK_PRINT_OPERATION_ACTION_EXPORT

Definition at line 114 of file gtkprintoperation.h.

             {
  GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG,
  GTK_PRINT_OPERATION_ACTION_PRINT,
  GTK_PRINT_OPERATION_ACTION_PREVIEW,
  GTK_PRINT_OPERATION_ACTION_EXPORT
} GtkPrintOperationAction;

◆ GtkPrintOperationResult

enum GtkPrintOperationResult

GtkPrintOperationResult: @GTK_PRINT_OPERATION_RESULT_ERROR: An error has occurred. @GTK_PRINT_OPERATION_RESULT_APPLY: The print settings should be stored. @GTK_PRINT_OPERATION_RESULT_CANCEL: The print operation has been canceled, the print settings should not be stored. @GTK_PRINT_OPERATION_RESULT_IN_PROGRESS: The print operation is not complete yet. This value will only be returned when running asynchronously.

The result of a print operation.

A value of this type is returned by [metho.nosp@m.d@Gt.nosp@m.k.Pri.nosp@m.ntOp.nosp@m.erati.nosp@m.on.r.nosp@m.un].

Enumerator
GTK_PRINT_OPERATION_RESULT_ERROR
GTK_PRINT_OPERATION_RESULT_APPLY
GTK_PRINT_OPERATION_RESULT_CANCEL
GTK_PRINT_OPERATION_RESULT_IN_PROGRESS

Definition at line 94 of file gtkprintoperation.h.

             {
  GTK_PRINT_OPERATION_RESULT_ERROR,
  GTK_PRINT_OPERATION_RESULT_APPLY,
  GTK_PRINT_OPERATION_RESULT_CANCEL,
  GTK_PRINT_OPERATION_RESULT_IN_PROGRESS
} GtkPrintOperationResult;

◆ GtkPrintStatus

enum GtkPrintStatus

GtkPrintStatus: @GTK_PRINT_STATUS_INITIAL: The printing has not started yet; this status is set initially, and while the print dialog is shown. @GTK_PRINT_STATUS_PREPARING: This status is set while the begin-print signal is emitted and during pagination. @GTK_PRINT_STATUS_GENERATING_DATA: This status is set while the pages are being rendered. @GTK_PRINT_STATUS_SENDING_DATA: The print job is being sent off to the printer. @GTK_PRINT_STATUS_PENDING: The print job has been sent to the printer, but is not printed for some reason, e.g. the printer may be stopped. @GTK_PRINT_STATUS_PENDING_ISSUE: Some problem has occurred during printing, e.g. a paper jam. @GTK_PRINT_STATUS_PRINTING: The printer is processing the print job. @GTK_PRINT_STATUS_FINISHED: The printing has been completed successfully. @GTK_PRINT_STATUS_FINISHED_ABORTED: The printing has been aborted.

The status gives a rough indication of the completion of a running print operation.

Enumerator
GTK_PRINT_STATUS_INITIAL
GTK_PRINT_STATUS_PREPARING
GTK_PRINT_STATUS_GENERATING_DATA
GTK_PRINT_STATUS_SENDING_DATA
GTK_PRINT_STATUS_PENDING
GTK_PRINT_STATUS_PENDING_ISSUE
GTK_PRINT_STATUS_PRINTING
GTK_PRINT_STATUS_FINISHED
GTK_PRINT_STATUS_FINISHED_ABORTED

Definition at line 69 of file gtkprintoperation.h.

             {
  GTK_PRINT_STATUS_INITIAL,
  GTK_PRINT_STATUS_PREPARING,
  GTK_PRINT_STATUS_GENERATING_DATA,
  GTK_PRINT_STATUS_SENDING_DATA,
  GTK_PRINT_STATUS_PENDING,
  GTK_PRINT_STATUS_PENDING_ISSUE,
  GTK_PRINT_STATUS_PRINTING,
  GTK_PRINT_STATUS_FINISHED,
  GTK_PRINT_STATUS_FINISHED_ABORTED
} GtkPrintStatus;

Function Documentation

◆ gtk_print_error_quark()

GDK_AVAILABLE_IN_ALL GQuark gtk_print_error_quark ( void )

◆ gtk_print_operation_cancel()

GDK_AVAILABLE_IN_ALL void gtk_print_operation_cancel ( GtkPrintOperation * op )

◆ gtk_print_operation_draw_page_finish()

GDK_AVAILABLE_IN_ALL void gtk_print_operation_draw_page_finish ( GtkPrintOperation * op )

◆ gtk_print_operation_get_default_page_setup()

GDK_AVAILABLE_IN_ALL GtkPageSetup * gtk_print_operation_get_default_page_setup ( GtkPrintOperation * op )

◆ gtk_print_operation_get_embed_page_setup()

GDK_AVAILABLE_IN_ALL gboolean gtk_print_operation_get_embed_page_setup ( GtkPrintOperation * op )

◆ gtk_print_operation_get_error()

GDK_AVAILABLE_IN_ALL void gtk_print_operation_get_error	(	GtkPrintOperation *	op,
		GError **	error )

◆ gtk_print_operation_get_has_selection()

GDK_AVAILABLE_IN_ALL gboolean gtk_print_operation_get_has_selection ( GtkPrintOperation * op )

◆ gtk_print_operation_get_n_pages_to_print()

GDK_AVAILABLE_IN_ALL int gtk_print_operation_get_n_pages_to_print ( GtkPrintOperation * op )

◆ gtk_print_operation_get_print_settings()

GDK_AVAILABLE_IN_ALL GtkPrintSettings * gtk_print_operation_get_print_settings ( GtkPrintOperation * op )

◆ gtk_print_operation_get_status()

GDK_AVAILABLE_IN_ALL GtkPrintStatus gtk_print_operation_get_status ( GtkPrintOperation * op )

◆ gtk_print_operation_get_status_string()

GDK_AVAILABLE_IN_ALL const char * gtk_print_operation_get_status_string ( GtkPrintOperation * op )

◆ gtk_print_operation_get_support_selection()

GDK_AVAILABLE_IN_ALL gboolean gtk_print_operation_get_support_selection ( GtkPrintOperation * op )

◆ gtk_print_operation_get_type()

GDK_AVAILABLE_IN_ALL GType gtk_print_operation_get_type ( void )

◆ gtk_print_operation_is_finished()

GDK_AVAILABLE_IN_ALL gboolean gtk_print_operation_is_finished ( GtkPrintOperation * op )

◆ gtk_print_operation_new()

GDK_AVAILABLE_IN_ALL GtkPrintOperation * gtk_print_operation_new ( void )

◆ gtk_print_operation_run()

GDK_AVAILABLE_IN_ALL GtkPrintOperationResult gtk_print_operation_run	(	GtkPrintOperation *	op,
		GtkPrintOperationAction	action,
		GtkWindow *	parent,
		GError **	error )

◆ gtk_print_operation_set_allow_async()

GDK_AVAILABLE_IN_ALL void gtk_print_operation_set_allow_async	(	GtkPrintOperation *	op,
		gboolean	allow_async )

◆ gtk_print_operation_set_current_page()

GDK_AVAILABLE_IN_ALL void gtk_print_operation_set_current_page	(	GtkPrintOperation *	op,
		int	current_page )

◆ gtk_print_operation_set_custom_tab_label()

GDK_AVAILABLE_IN_ALL void gtk_print_operation_set_custom_tab_label	(	GtkPrintOperation *	op,
		const char *	label )

◆ gtk_print_operation_set_default_page_setup()

GDK_AVAILABLE_IN_ALL void gtk_print_operation_set_default_page_setup	(	GtkPrintOperation *	op,
		GtkPageSetup *	default_page_setup )

◆ gtk_print_operation_set_defer_drawing()

GDK_AVAILABLE_IN_ALL void gtk_print_operation_set_defer_drawing ( GtkPrintOperation * op )

◆ gtk_print_operation_set_embed_page_setup()

GDK_AVAILABLE_IN_ALL void gtk_print_operation_set_embed_page_setup	(	GtkPrintOperation *	op,
		gboolean	embed )

◆ gtk_print_operation_set_export_filename()

GDK_AVAILABLE_IN_ALL void gtk_print_operation_set_export_filename	(	GtkPrintOperation *	op,
		const char *	filename )

◆ gtk_print_operation_set_has_selection()

GDK_AVAILABLE_IN_ALL void gtk_print_operation_set_has_selection	(	GtkPrintOperation *	op,
		gboolean	has_selection )

◆ gtk_print_operation_set_job_name()

GDK_AVAILABLE_IN_ALL void gtk_print_operation_set_job_name	(	GtkPrintOperation *	op,
		const char *	job_name )

◆ gtk_print_operation_set_n_pages()

GDK_AVAILABLE_IN_ALL void gtk_print_operation_set_n_pages	(	GtkPrintOperation *	op,
		int	n_pages )

◆ gtk_print_operation_set_print_settings()

GDK_AVAILABLE_IN_ALL void gtk_print_operation_set_print_settings	(	GtkPrintOperation *	op,
		GtkPrintSettings *	print_settings )

◆ gtk_print_operation_set_show_progress()

GDK_AVAILABLE_IN_ALL void gtk_print_operation_set_show_progress	(	GtkPrintOperation *	op,
		gboolean	show_progress )

◆ gtk_print_operation_set_support_selection()

GDK_AVAILABLE_IN_ALL void gtk_print_operation_set_support_selection	(	GtkPrintOperation *	op,
		gboolean	support_selection )

◆ gtk_print_operation_set_track_print_status()

GDK_AVAILABLE_IN_ALL void gtk_print_operation_set_track_print_status	(	GtkPrintOperation *	op,
		gboolean	track_status )

◆ gtk_print_operation_set_unit()

GDK_AVAILABLE_IN_ALL void gtk_print_operation_set_unit	(	GtkPrintOperation *	op,
		GtkUnit	unit )

◆ gtk_print_operation_set_use_full_page()

GDK_AVAILABLE_IN_ALL void gtk_print_operation_set_use_full_page	(	GtkPrintOperation *	op,
		gboolean	full_page )

◆ gtk_print_run_page_setup_dialog()

GDK_AVAILABLE_IN_ALL GtkPageSetup * gtk_print_run_page_setup_dialog	(	GtkWindow *	parent,
		GtkPageSetup *	page_setup,
		GtkPrintSettings *	settings )

◆ gtk_print_run_page_setup_dialog_async()

GDK_AVAILABLE_IN_ALL void gtk_print_run_page_setup_dialog_async	(	GtkWindow *	parent,
		GtkPageSetup *	page_setup,
		GtkPrintSettings *	settings,
		GtkPageSetupDoneFunc	done_cb,
		gpointer	data )

Data Structures

Macros

Typedefs

Enumerations

Functions