Struct gtk4::PrintSettings

pub struct PrintSettings { /* private fields */ }

A PrintSettings object represents the settings of a print dialog in a system-independent way.

The main use for this object is that once you’ve printed you can get a settings object that represents the settings the user chose, and the next time you print you can pass that object in so that the user doesn’t have to re-set all his settings.

Its also possible to enumerate the settings so that you can easily save the settings for the next time your app runs, or even store them in a document. The predefined keys try to use shared values as much as possible so that moving such a document between systems still works.

Implements

[trait@glib::ObjectExt]

Implementations

impl PrintSettings

pub fn new() -> PrintSettings

Creates a new PrintSettings object.

Returns

a new PrintSettings object

pub fn from_file(file_name: impl AsRef<Path>) -> Result<PrintSettings, Error>

Reads the print settings from @file_name.

Returns a new PrintSettings object with the restored settings, or None if an error occurred. If the file could not be loaded then error is set to either a GFileError or GKeyFileError.

See to_file().

file_name

the filename to read the settings from

Returns

the restored PrintSettings

pub fn from_gvariant(variant: &Variant) -> PrintSettings

Deserialize print settings from an a{sv} variant.

The variant must be in the format produced by to_gvariant().

variant

an a{sv} GVariant

Returns

a new PrintSettings object

pub fn from_key_file( key_file: &KeyFile, group_name: Option<&str> ) -> Result<PrintSettings, Error>

Reads the print settings from the group @group_name in @key_file.

Returns a new PrintSettings object with the restored settings, or None if an error occurred. If the file could not be loaded then error is set to either GFileError or GKeyFileError.

key_file

the GKeyFile to retrieve the settings from

group_name

the name of the group to use, or None to use the default “Print Settings”

Returns

the restored PrintSettings

pub fn copy(&self) -> PrintSettings

pub fn foreach<P: FnMut(&str, &str)>(&self, func: P)

Calls @func for each key-value pair of @self.

func

the function to call

pub fn get(&self, key: &str) -> Option<GString>

Looks up the string value associated with @key.

key

a key

Returns

the string value for @key

pub fn bool(&self, key: &str) -> bool

Returns the boolean represented by the value that is associated with @key.

The string “true” represents true, any other string false.

key

a key

Returns

true, if @key maps to a true value.

pub fn is_collate(&self) -> bool

Gets the value of PRINT_SETTINGS_COLLATE.

Returns

whether to collate the printed pages

pub fn default_source(&self) -> Option<GString>

Gets the value of PRINT_SETTINGS_DEFAULT_SOURCE.

Returns

the default source

pub fn dither(&self) -> Option<GString>

Gets the value of PRINT_SETTINGS_DITHER.

Returns

the dithering that is used

pub fn double(&self, key: &str) -> f64

Returns the double value associated with @key, or 0.

key

a key

Returns

the double value of @key

pub fn double_with_default(&self, key: &str, def: f64) -> f64

Returns the floating point number represented by the value that is associated with @key, or @default_val if the value does not represent a floating point number.

Floating point numbers are parsed with g_ascii_strtod().

key

a key

def

the default value

Returns

the floating point number associated with @key

pub fn duplex(&self) -> PrintDuplex

Gets the value of PRINT_SETTINGS_DUPLEX.

Returns

whether to print the output in duplex.

pub fn finishings(&self) -> Option<GString>

Gets the value of PRINT_SETTINGS_FINISHINGS.

Returns

the finishings

pub fn int(&self, key: &str) -> i32

Returns the integer value of @key, or 0.

key

a key

Returns

the integer value of @key

pub fn int_with_default(&self, key: &str, def: i32) -> i32

Returns the value of @key, interpreted as an integer, or the default value.

key

a key

def

the default value

Returns

the integer value of @key

pub fn length(&self, key: &str, unit: Unit) -> f64

Returns the value associated with @key, interpreted as a length.

The returned value is converted to @units.

key

a key

unit

the unit of the return value

Returns

the length value of @key, converted to @unit

pub fn media_type(&self) -> Option<GString>

Gets the value of PRINT_SETTINGS_MEDIA_TYPE.

The set of media types is defined in PWG 5101.1-2002 PWG.

Returns

the media type

pub fn n_copies(&self) -> i32

Gets the value of PRINT_SETTINGS_N_COPIES.

Returns

the number of copies to print

pub fn number_up(&self) -> i32

Gets the value of PRINT_SETTINGS_NUMBER_UP.

Returns

the number of pages per sheet

pub fn number_up_layout(&self) -> NumberUpLayout

Gets the value of PRINT_SETTINGS_NUMBER_UP_LAYOUT.

Returns

layout of page in number-up mode

pub fn orientation(&self) -> PageOrientation

Get the value of PRINT_SETTINGS_ORIENTATION, converted to a PageOrientation.

Returns

the orientation

pub fn output_bin(&self) -> Option<GString>

Gets the value of PRINT_SETTINGS_OUTPUT_BIN.

Returns

the output bin

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

Gets the value of PRINT_SETTINGS_PAGE_RANGES.

Returns

an array of PageRanges. Use g_free() to free the array when it is no longer needed.

pub fn page_set(&self) -> PageSet

Gets the value of PRINT_SETTINGS_PAGE_SET.

Returns

the set of pages to print

pub fn paper_height(&self, unit: Unit) -> f64

Gets the value of PRINT_SETTINGS_PAPER_HEIGHT, converted to @unit.

unit

the unit for the return value

Returns

the paper height, in units of @unit

pub fn paper_size(&self) -> Option<PaperSize>

Gets the value of PRINT_SETTINGS_PAPER_FORMAT, converted to a PaperSize.

Returns

the paper size

pub fn paper_width(&self, unit: Unit) -> f64

Gets the value of PRINT_SETTINGS_PAPER_WIDTH, converted to @unit.

unit

the unit for the return value

Returns

the paper width, in units of @unit

pub fn print_pages(&self) -> PrintPages

Gets the value of PRINT_SETTINGS_PRINT_PAGES.

Returns

which pages to print

pub fn printer(&self) -> Option<GString>

Convenience function to obtain the value of PRINT_SETTINGS_PRINTER.

Returns

the printer name

pub fn printer_lpi(&self) -> f64

Gets the value of PRINT_SETTINGS_PRINTER_LPI.

Returns

the resolution in lpi (lines per inch)

pub fn quality(&self) -> PrintQuality

Gets the value of PRINT_SETTINGS_QUALITY.

Returns

the print quality

pub fn resolution(&self) -> i32

Gets the value of PRINT_SETTINGS_RESOLUTION.

Returns

the resolution in dpi

pub fn resolution_x(&self) -> i32

Gets the value of PRINT_SETTINGS_RESOLUTION_X.

Returns

the horizontal resolution in dpi

pub fn resolution_y(&self) -> i32

Gets the value of PRINT_SETTINGS_RESOLUTION_Y.

Returns

the vertical resolution in dpi

pub fn is_reverse(&self) -> bool

Gets the value of PRINT_SETTINGS_REVERSE.

Returns

whether to reverse the order of the printed pages

pub fn scale(&self) -> f64

Gets the value of PRINT_SETTINGS_SCALE.

Returns

the scale in percent

pub fn uses_color(&self) -> bool

Gets the value of PRINT_SETTINGS_USE_COLOR.

Returns

whether to use color

pub fn has_key(&self, key: &str) -> bool

Returns true, if a value is associated with @key.

key

a key

Returns

true, if @key has a value

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

Reads the print settings from @file_name.

If the file could not be loaded then error is set to either a GFileError or GKeyFileError.

See to_file().

file_name

the filename to read the settings from

Returns

true on success

pub fn load_key_file( &self, key_file: &KeyFile, group_name: Option<&str> ) -> Result<(), Error>

Reads the print settings from the group @group_name in @key_file.

If the file could not be loaded then error is set to either a GFileError or GKeyFileError.

key_file

the GKeyFile to retrieve the settings from

group_name

the name of the group to use, or None to use the default “Print Settings”

Returns

true on success

pub fn set(&self, key: &str, value: Option<&str>)

Associates @value with @key.

key

a key

value

a string value

pub fn set_bool(&self, key: &str, value: bool)

Sets @key to a boolean value.

key

a key

value

a boolean

pub fn set_collate(&self, collate: bool)

Sets the value of PRINT_SETTINGS_COLLATE.

collate

whether to collate the output

pub fn set_default_source(&self, default_source: &str)

Sets the value of PRINT_SETTINGS_DEFAULT_SOURCE.

default_source

the default source

pub fn set_dither(&self, dither: &str)

Sets the value of PRINT_SETTINGS_DITHER.

dither

the dithering that is used

pub fn set_double(&self, key: &str, value: f64)

Sets @key to a double value.

key

a key

value

a double value

pub fn set_duplex(&self, duplex: PrintDuplex)

Sets the value of PRINT_SETTINGS_DUPLEX.

duplex

a PrintDuplex value

pub fn set_finishings(&self, finishings: &str)

Sets the value of PRINT_SETTINGS_FINISHINGS.

finishings

the finishings

pub fn set_int(&self, key: &str, value: i32)

Sets @key to an integer value.

key

a key

value

an integer

pub fn set_length(&self, key: &str, value: f64, unit: Unit)

Associates a length in units of @unit with @key.

key

a key

value

a length

unit

the unit of @length

pub fn set_media_type(&self, media_type: &str)

Sets the value of PRINT_SETTINGS_MEDIA_TYPE.

The set of media types is defined in PWG 5101.1-2002 PWG.

media_type

the media type

pub fn set_n_copies(&self, num_copies: i32)

Sets the value of PRINT_SETTINGS_N_COPIES.

num_copies

the number of copies

pub fn set_number_up(&self, number_up: i32)

Sets the value of PRINT_SETTINGS_NUMBER_UP.

number_up

the number of pages per sheet

pub fn set_number_up_layout(&self, number_up_layout: NumberUpLayout)

Sets the value of PRINT_SETTINGS_NUMBER_UP_LAYOUT.

number_up_layout

a NumberUpLayout value

pub fn set_orientation(&self, orientation: PageOrientation)

Sets the value of PRINT_SETTINGS_ORIENTATION.

orientation

a page orientation

pub fn set_output_bin(&self, output_bin: &str)

Sets the value of PRINT_SETTINGS_OUTPUT_BIN.

output_bin

the output bin

pub fn set_page_set(&self, page_set: PageSet)

Sets the value of PRINT_SETTINGS_PAGE_SET.

page_set

a PageSet value

pub fn set_paper_height(&self, height: f64, unit: Unit)

Sets the value of PRINT_SETTINGS_PAPER_HEIGHT.

height

the paper height

unit

the units of @height

pub fn set_paper_size(&self, paper_size: &PaperSize)

Sets the value of PRINT_SETTINGS_PAPER_FORMAT, PRINT_SETTINGS_PAPER_WIDTH and PRINT_SETTINGS_PAPER_HEIGHT.

paper_size

a paper size

pub fn set_paper_width(&self, width: f64, unit: Unit)

Sets the value of PRINT_SETTINGS_PAPER_WIDTH.

width

the paper width

unit

the units of @width

pub fn set_print_pages(&self, pages: PrintPages)

Sets the value of PRINT_SETTINGS_PRINT_PAGES.

pages

a PrintPages value

pub fn set_printer(&self, printer: &str)

Convenience function to set PRINT_SETTINGS_PRINTER to @printer.

printer

the printer name

pub fn set_printer_lpi(&self, lpi: f64)

Sets the value of PRINT_SETTINGS_PRINTER_LPI.

lpi

the resolution in lpi (lines per inch)

pub fn set_quality(&self, quality: PrintQuality)

Sets the value of PRINT_SETTINGS_QUALITY.

quality

a PrintQuality value

pub fn set_resolution(&self, resolution: i32)

Sets the values of PRINT_SETTINGS_RESOLUTION, PRINT_SETTINGS_RESOLUTION_X and PRINT_SETTINGS_RESOLUTION_Y.

resolution

the resolution in dpi

pub fn set_resolution_xy(&self, resolution_x: i32, resolution_y: i32)

Sets the values of PRINT_SETTINGS_RESOLUTION, PRINT_SETTINGS_RESOLUTION_X and PRINT_SETTINGS_RESOLUTION_Y.

resolution_x

the horizontal resolution in dpi

resolution_y

the vertical resolution in dpi

pub fn set_reverse(&self, reverse: bool)

Sets the value of PRINT_SETTINGS_REVERSE.

reverse

whether to reverse the output

pub fn set_scale(&self, scale: f64)

Sets the value of PRINT_SETTINGS_SCALE.

scale

the scale in percent

pub fn set_use_color(&self, use_color: bool)

Sets the value of PRINT_SETTINGS_USE_COLOR.

use_color

whether to use color

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

This function saves the print settings from @self to @file_name.

If the file could not be written then error is set to either a GFileError or GKeyFileError.

file_name

the file to save to

Returns

true on success

pub fn to_gvariant(&self) -> Variant

Serialize print settings to an a{sv} variant.

Returns

a new, floating, GVariant

pub fn to_key_file(&self, key_file: &KeyFile, group_name: Option<&str>)

This function adds the print settings from @self to @key_file.

key_file

the GKeyFile to save the print settings to

group_name

the group to add the settings to in @key_file, or None to use the default “Print Settings”

pub fn unset(&self, key: &str)

Removes any value associated with @key.

This has the same effect as setting the value to None.

key

a key

impl PrintSettings

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

Sets the value of PRINT_SETTINGS_PAGE_RANGES.

page_ranges

an array of PageRanges

Trait Implementations

impl Clone for PrintSettings

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 PrintSettings

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

Formats the value using the given formatter.

impl Default for PrintSettings

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for PrintSettings

type ParamSpec = ParamSpecObject

type SetValue = PrintSettings

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for PrintSettings

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 PrintSettings

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 PrintSettings

type Parent = Object

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

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 PrintSettings

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 PrintSettings

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for PrintSettings