Struct gtk4::Printer

#[repr(transparent)]
pub struct Printer { /* private fields */ }

Available on Linux only.

A Printer object represents a printer.

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

A Printer allows to get status information about the printer, such as its description, its location, the number of queued jobs, etc. Most importantly, a Printer object can be used to create a PrintJob object, which lets you print to the printer.

Properties

accepting-jobs

true if the printer is accepting jobs.

Readable

accepts-pdf

true if this printer can accept PDF.

Readable | Writeable | Construct Only

accepts-ps

true if this printer can accept PostScript.

Readable | Writeable | Construct Only

icon-name

Icon name to use for the printer.

Readable

is-virtual

false if this represents a real hardware device.

Readable | Writeable | Construct Only

job-count

Number of jobs queued in the printer.

Readable

location

Information about the location of the printer.

Readable

name

The name of the printer.

Readable | Writeable | Construct Only

paused

true if this printer is paused.

A paused printer still accepts jobs, but it does not print them.

Readable

state-message

String giving the current status of the printer.

Readable

Signals

details-acquired

Emitted in response to a request for detailed information about a printer from the print backend.

The @success parameter indicates if the information was actually obtained.

Implements

glib::ObjectExt

Implementations

impl Printer

pub fn accepts_pdf(&self) -> bool

Returns whether the printer accepts input in PDF format.

Returns

true if @self accepts PDF

pub fn accepts_ps(&self) -> bool

Returns whether the printer accepts input in PostScript format.

Returns

true if @self accepts PostScript

pub fn compare(&self, b: &Printer) -> i32

pub fn capabilities(&self) -> PrintCapabilities

Returns the printer’s capabilities.

This is useful when you’re using PrintUnixDialog’s manual-capabilities setting and need to know which settings the printer can handle and which you must handle yourself.

This will return 0 unless the printer’s details are available, see has_details() and request_details().

Returns

the printer’s capabilities

pub fn default_page_size(&self) -> PageSetup

Returns default page size of @self.

Returns

a newly allocated PageSetup with default page size of the printer.

pub fn description(&self) -> GString

Gets the description of the printer.

Returns

the description of @self

pub fn hard_margins(&self) -> Option<(f64, f64, f64, f64)>

Retrieve the hard margins of @self.

These are the margins that define the area at the borders of the paper that the printer cannot print to.

Note: This will not succeed unless the printer’s details are available, see has_details() and request_details().

Returns

true iff the hard margins were retrieved

top

a location to store the top margin in

bottom

a location to store the bottom margin in

left

a location to store the left margin in

right

a location to store the right margin in

pub fn hard_margins_for_paper_size( &self, paper_size: &mut PaperSize ) -> Option<(f64, f64, f64, f64)>

Retrieve the hard margins of @self for @paper_size.

These are the margins that define the area at the borders of the paper that the printer cannot print to.

Note: This will not succeed unless the printer’s details are available, see has_details() and request_details().

paper_size

a PaperSize

Returns

true iff the hard margins were retrieved

top

a location to store the top margin in

bottom

a location to store the bottom margin in

left

a location to store the left margin in

right

a location to store the right margin in

pub fn icon_name(&self) -> GString

Gets the name of the icon to use for the printer.

Returns

the icon name for @self

pub fn job_count(&self) -> i32

Gets the number of jobs currently queued on the printer.

Returns

the number of jobs on @self

pub fn location(&self) -> GString

Returns a description of the location of the printer.

Returns

the location of @self

pub fn name(&self) -> GString

Returns the name of the printer.

Returns

the name of @self

pub fn state_message(&self) -> GString

Returns the state message describing the current state of the printer.

Returns

the state message of @self

pub fn has_details(&self) -> bool

Returns whether the printer details are available.

Returns

true if @self details are available

pub fn is_accepting_jobs(&self) -> bool

Returns whether the printer is accepting jobs

Returns

true if @self is accepting jobs

pub fn is_active(&self) -> bool

Returns whether the printer is currently active (i.e. accepts new jobs).

Returns

true if @self is active

pub fn is_default(&self) -> bool

Returns whether the printer is the default printer.

Returns

true if @self is the default

pub fn is_paused(&self) -> bool

Returns whether the printer is currently paused.

A paused printer still accepts jobs, but it is not printing them.

Returns

true if @self is paused

pub fn is_virtual(&self) -> bool

Returns whether the printer is virtual (i.e. does not represent actual printer hardware, but something like a CUPS class).

Returns

true if @self is virtual

pub fn list_papers(&self) -> Vec<PageSetup>

Lists all the paper sizes @self supports.

This will return and empty list unless the printer’s details are available, see has_details() and request_details().

Returns

a newly allocated list of newly allocated PageSetups.

pub fn request_details(&self)

Requests the printer details.

When the details are available, the details-acquired signal will be emitted on @self.

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

Emitted in response to a request for detailed information about a printer from the print backend.

The @success parameter indicates if the information was actually obtained.

success

true if the details were successfully acquired

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

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

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

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

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

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

Trait Implementations

impl Clone for Printer

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 Printer

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

Formats the value using the given formatter.

impl Display for Printer

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

Formats the value using the given formatter.

impl HasParamSpec for Printer

type ParamSpec = ParamSpecObject

type SetValue = Printer

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Printer

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 Printer

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for Printer

type Parent = Object

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

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 Printer

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 Printer

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Printer