Struct gtk4::PrintJob[][src]

pub struct PrintJob(_);
Expand description

A PrintJob object represents a job that is sent to a printer.

You only need to deal directly with print jobs if you use the non-portable PrintUnixDialog API.

Use surface() to obtain the cairo surface onto which the pages must be drawn. Use send() to send the finished job to the printer. If you don’t use cairo PrintJob also supports printing of manually generated PostScript, via set_source_file().

Implements

glib::ObjectExt

Implementations

This is supported on Linux only.
This is supported on Linux only.

Creates a new builder-pattern struct instance to construct PrintJob objects.

This method returns an instance of PrintJobBuilder which can be used to create PrintJob objects.

This is supported on Linux only.

Gets whether this job is printed collated.

Returns

whether the job is printed collated

This is supported on Linux only.

Gets the n-up setting for this job.

Returns

the n-up setting

This is supported on Linux only.

Gets the n-up layout setting for this job.

Returns

the n-up layout

This is supported on Linux only.

Gets the number of copies of this job.

Returns

the number of copies

This is supported on Linux only.

Gets the page ranges for this job.

Returns

a pointer to an array of PageRange structs

This is supported on Linux only.

Gets the PageSet setting for this job.

Returns

the PageSet setting

This is supported on Linux only.

Gets the PrintPages setting for this job.

Returns

the PrintPages setting

This is supported on Linux only.

Gets the Printer of the print job.

Returns

the printer of self

This is supported on Linux only.

Gets whether this job is printed reversed.

Returns

whether the job is printed reversed.

This is supported on Linux only.

Gets whether the job is printed rotated.

Returns

whether the job is printed rotated

This is supported on Linux only.

Gets the scale for this job.

Returns

the scale

This is supported on Linux only.

Gets the PrintSettings of the print job.

Returns

the settings of self

This is supported on Linux only.

Gets the status of the print job.

Returns

the status of self

This is supported on Linux only.

Gets a cairo surface onto which the pages of the print job should be rendered.

Returns

the cairo surface of self

This is supported on Linux only.

Gets the job title.

Returns

the title of self

This is supported on Linux only.

Returns whether jobs will be tracked after printing.

For details, see set_track_print_status().

Returns

true if print job status will be reported after printing

This is supported on Linux only.

Sets whether this job is printed collated.

collate

whether the job is printed collated

This is supported on Linux only.

Sets the n-up setting for this job.

n_up

the n-up value

This is supported on Linux only.

Sets the n-up layout setting for this job.

layout

the n-up layout setting

This is supported on Linux only.

Sets the number of copies for this job.

num_copies

the number of copies

This is supported on Linux only.

Sets the PageSet setting for this job.

page_set

a PageSet setting

This is supported on Linux only.

Sets the PrintPages setting for this job.

pages

the PrintPages setting

This is supported on Linux only.

Sets whether this job is printed reversed.

reverse

whether the job is printed reversed

This is supported on Linux only.

Sets whether this job is printed rotated.

rotate

whether to print rotated

This is supported on Linux only.

Sets the scale for this job.

1.0 means unscaled.

scale

the scale

This is supported on Linux only.

Make the PrintJob send an existing document to the printing system.

The file can be in any format understood by the platforms printing system (typically PostScript, but on many platforms PDF may work too). See Printer::accepts_pdf() and Printer::accepts_ps().

This is similar to set_source_file(), but takes expects an open file descriptor for the file, instead of a filename.

fd

a file descriptor

Returns

false if an error occurred

This is supported on Linux only.

Make the PrintJob send an existing document to the printing system.

The file can be in any format understood by the platforms printing system (typically PostScript, but on many platforms PDF may work too). See Printer::accepts_pdf() and Printer::accepts_ps().

filename

the file to be printed

Returns

false if an error occurred

This is supported on Linux only.

If track_status is true, the print job 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.

track_status

true to track status after printing

This is supported on Linux only.

Page setup.

This is supported on Linux only.

Emitted when the status of a job changes.

The signal handler can use status() to obtain the new status.

This is supported on Linux only.
This is supported on Linux only.

Sends the print job off to the printer.

callback

function to call when the job completes or an error occurs

This is supported on Linux only.

Sets the page ranges for this job.

ranges

pointer to an array of PageRange structs

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Formats the value using the given formatter. Read more

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

This method returns an ordering between self and other values if one exists. Read more

This method tests less than (for self and other) and is used by the < operator. Read more

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

This method tests greater than (for self and other) and is used by the > operator. Read more

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Returns the type identifier of Self.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Upcasts an object to a superclass or interface T. Read more

Upcasts an object to a reference of its superclass or interface T. Read more

Tries to downcast to a subclass or interface implementor T. Read more

Tries to downcast to a reference of its subclass or interface implementor T. Read more

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

Casts to T unconditionally. Read more

Casts to &T unconditionally. Read more

Performs the conversion.

Performs the conversion.

Returns true if the object is an instance of (can be cast to) T.

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Same as connect but takes a SignalId instead of a signal name.

Same as connect_local but takes a SignalId instead of a signal name.

Same as connect_unsafe but takes a SignalId instead of a signal name.

Emit signal by signal id.

Same as emit but takes Value for the arguments.

Emit signal by its name.

Same as emit_by_name but takes Value for the arguments.

Emit signal with details by signal id.

Same as emit_with_details but takes Value for the arguments.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

Returns a SendValue clone of self.

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.