Struct gtk4::PaperSize

pub struct PaperSize(_);

PaperSize handles paper sizes.

It uses the standard called PWG 5101.1-2002 PWG: Standard for Media Standardized Names to name the paper sizes (and to get the data for the page sizes). In addition to standard paper sizes, PaperSize allows to construct custom paper sizes with arbitrary dimensions.

The PaperSize object stores not only the dimensions (width and height) of a paper size and its name, it also provides default print margins.

Implementations

impl PaperSize

pub fn new(name: Option<&str>) -> PaperSize

Creates a new PaperSize object by parsing a PWG 5101.1-2002 paper name.

If name is None, the default paper size is returned, see default().

name

a paper size name

Returns

a new PaperSize, use Gtk::PaperSize::free()`` to free it

pub fn new_custom(
    name: &str,
    display_name: &str,
    width: f64,
    height: f64,
    unit: Unit
) -> PaperSize

Creates a new PaperSize object with the given parameters.

name

the paper name

display_name

the human-readable name

width

the paper width, in units of unit

height

the paper height, in units of unit

unit

the unit for width and height. not Unit::None.

Returns

a new PaperSize object, use Gtk::PaperSize::free()`` to free it

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

Deserialize a paper size from a GVariant.

The GVariant must be in the format produced by [``to_gvariant()``][Self::to_gvariant()`].

variant

an a{sv} GVariant

Returns

a new PaperSize object

pub fn from_ipp(ipp_name: &str, width: f64, height: f64) -> PaperSize

Creates a new PaperSize object by using IPP information.

If ipp_name is not a recognized paper name, width and height are used to construct a custom PaperSize object.

ipp_name

an IPP paper name

width

the paper width, in points

height

the paper height in points

Returns

a new PaperSize, use Gtk::PaperSize::free()`` to free it

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

Reads a paper size from the group group_name in the key file key_file.

key_file

the GKeyFile to retrieve the papersize from

group_name

the name of the group in the key file to read, or None to read the first group

Returns

a new PaperSize object with the restored paper size

pub fn from_ppd(
    ppd_name: &str,
    ppd_display_name: &str,
    width: f64,
    height: f64
) -> PaperSize

Creates a new PaperSize object by using PPD information.

If ppd_name is not a recognized PPD paper name, ppd_display_name, width and height are used to construct a custom PaperSize object.

ppd_name

a PPD paper name

ppd_display_name

the corresponding human-readable name

width

the paper width, in points

height

the paper height in points

Returns

a new PaperSize, use Gtk::PaperSize::free()`` to free it

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

Gets the default bottom margin for the PaperSize.

unit

the unit for the return value, not Unit::None

Returns

the default bottom margin

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

Gets the default left margin for the PaperSize.

unit

the unit for the return value, not Unit::None

Returns

the default left margin

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

Gets the default right margin for the PaperSize.

unit

the unit for the return value, not Unit::None

Returns

the default right margin

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

Gets the default top margin for the PaperSize.

unit

the unit for the return value, not Unit::None

Returns

the default top margin

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

Gets the human-readable name of the PaperSize.

Returns

the human-readable name of self

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

Gets the paper height of the PaperSize, in units of unit.

unit

the unit for the return value, not Unit::None

Returns

the paper height

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

Gets the name of the PaperSize.

Returns

the name of self

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

Gets the PPD name of the PaperSize, which may be None.

Returns

the PPD name of self

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

Gets the paper width of the PaperSize, in units of unit.

unit

the unit for the return value, not Unit::None

Returns

the paper width

pub fn is_custom(&self) -> bool

Returns true if self is not a standard paper size.

Returns

whether self is a custom paper size.

pub fn is_ipp(&self) -> bool

Returns true if self is an IPP standard paper size.

Returns

whether self is not an IPP custom paper size.

pub fn set_size(&mut self, width: f64, height: f64, unit: Unit)

Changes the dimensions of a self to width x height.

width

the new width in units of unit

height

the new height in units of unit

unit

the unit for width and height

pub fn to_gvariant(&mut self) -> Option<Variant>

Serialize a paper size to an a{sv} variant.

Returns

a new, floating, GVariant

pub fn to_key_file(&mut self, key_file: &KeyFile, group_name: &str)

This function adds the paper size from self to key_file.

key_file

the GKeyFile to save the paper size to

group_name

the group to add the settings to in key_file

pub fn default() -> Option<GString>

Returns the name of the default paper size, which depends on the current locale.

Returns

the name of the default paper size. The string is owned by GTK and should not be modified.

pub fn paper_sizes(include_custom: bool) -> Vec<PaperSize>

Creates a list of known paper sizes.

include_custom

whether to include custom paper sizes as defined in the page setup dialog

Returns

a newly allocated list of newly allocated PaperSize objects

Trait Implementations

impl Clone for PaperSize

fn clone(&self) -> PaperSize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PaperSize

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

Formats the value using the given formatter.

impl Hash for PaperSize

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for PaperSize

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<PaperSize> for PaperSize

fn eq(&self, other: &Self) -> 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 !=.

impl PartialOrd<PaperSize> for PaperSize

fn partial_cmp(&self, other: &PaperSize) -> 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 PaperSize

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for PaperSize