Struct gtk4::PrintJob

pub struct PrintJob { /* private fields */ }

Available on Linux only.

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().

Properties

page-setup

Page setup.

Readable | Writeable | Construct Only

printer

The printer to send the job to.

Readable | Writeable | Construct Only

settings

Printer settings.

Readable | Writeable | Construct Only

title

The title of the print job.

Readable | Writeable | Construct Only

track-print-status

true if the print job will continue to emit status-changed signals after the print data has been setn to the printer.

Readable | Writeable

Signals

status-changed

Emitted when the status of a job changes.

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

Implements

[trait@glib::ObjectExt]

Implementations

impl PrintJob

pub fn new( title: &str, printer: &Printer, settings: &PrintSettings, page_setup: &PageSetup ) -> PrintJob

Creates a new PrintJob.

title

the job title

printer

a Printer

settings

a PrintSettings

page_setup

a PageSetup

Returns

a new PrintJob

pub fn is_collate(&self) -> bool

Gets whether this job is printed collated.

Returns

whether the job is printed collated

pub fn n_up(&self) -> u32

Gets the n-up setting for this job.

Returns

the n-up setting

pub fn n_up_layout(&self) -> NumberUpLayout

Gets the n-up layout setting for this job.

Returns

the n-up layout

pub fn num_copies(&self) -> i32

Gets the number of copies of this job.

Returns

the number of copies

pub fn page_ranges(&self) -> Vec<PageRange>

Gets the page ranges for this job.

Returns

a pointer to an array of PageRange structs

pub fn page_set(&self) -> PageSet

Gets the PageSet setting for this job.

Returns

the PageSet setting

pub fn pages(&self) -> PrintPages

Gets the PrintPages setting for this job.

Returns

the PrintPages setting

pub fn printer(&self) -> Printer

Gets the Printer of the print job.

Returns

the printer of @self

pub fn is_reverse(&self) -> bool

Gets whether this job is printed reversed.

Returns

whether the job is printed reversed.

pub fn is_rotate(&self) -> bool

Gets whether the job is printed rotated.

Returns

whether the job is printed rotated

pub fn scale(&self) -> f64

Gets the scale for this job.

Returns

the scale

pub fn settings(&self) -> PrintSettings

Gets the PrintSettings of the print job.

Returns

the settings of @self

pub fn status(&self) -> PrintStatus

Gets the status of the print job.

Returns

the status of @self

pub fn surface(&self) -> Result<Surface, Error>

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

Returns

the cairo surface of @self

pub fn title(&self) -> GString

Gets the job title.

Returns

the title of @self

pub fn tracks_print_status(&self) -> bool

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

pub fn set_collate(&self, collate: bool)

Sets whether this job is printed collated.

collate

whether the job is printed collated

pub fn set_n_up(&self, n_up: u32)

Sets the n-up setting for this job.

n_up

the n-up value

pub fn set_n_up_layout(&self, layout: NumberUpLayout)

Sets the n-up layout setting for this job.

layout

the n-up layout setting

pub fn set_num_copies(&self, num_copies: i32)

Sets the number of copies for this job.

num_copies

the number of copies

pub fn set_page_ranges(&self, ranges: &[PageRange])

Sets the page ranges for this job.

ranges

pointer to an array of PageRange structs

pub fn set_page_set(&self, page_set: PageSet)

Sets the PageSet setting for this job.

page_set

a PageSet setting

pub fn set_pages(&self, pages: PrintPages)

Sets the PrintPages setting for this job.

pages

the PrintPages setting

pub fn set_reverse(&self, reverse: bool)

Sets whether this job is printed reversed.

reverse

whether the job is printed reversed

pub fn set_rotate(&self, rotate: bool)

Sets whether this job is printed rotated.

rotate

whether to print rotated

pub fn set_scale(&self, scale: f64)

Sets the scale for this job.

1.0 means unscaled.

scale

the scale

pub fn set_source_fd(&self, fd: i32) -> Result<(), Error>

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

pub fn set_source_file(&self, filename: impl AsRef<Path>) -> Result<(), Error>

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

pub fn set_track_print_status(&self, track_status: bool)

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

pub fn page_setup(&self) -> Option<PageSetup>

Page setup.

pub fn connect_status_changed<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted when the status of a job changes.

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

pub fn connect_track_print_status_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

impl PrintJob

pub fn send<P: Fn(&PrintJob, Result<(), Error>) + 'static>(&self, callback: P)

Sends the print job off to the printer.

callback

function to call when the job completes or an error occurs

Trait Implementations

impl Clone for PrintJob

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PrintJob

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for PrintJob

type ParamSpec = ParamSpecObject

type SetValue = PrintJob

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, PrintJob>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for PrintJob

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PrintJob

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for PrintJob

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for PrintJob

fn eq(&self, other: &OT) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for PrintJob

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

fn ge(&self, other: &Rhs) -> bool

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

impl StaticType for PrintJob

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for PrintJob