Struct gtk4::PaperSize[][src]

pub struct PaperSize(_);
Expand description

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

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, or None

Returns

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

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

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

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

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, or None if an error occurred

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

Gets the default bottom margin for the PaperSize.

unit

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

Returns

the default bottom margin

Gets the default left margin for the PaperSize.

unit

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

Returns

the default left margin

Gets the default right margin for the PaperSize.

unit

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

Returns

the default right margin

Gets the default top margin for the PaperSize.

unit

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

Returns

the default top margin

Gets the human-readable name of the PaperSize.

Returns

the human-readable name of self

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

Gets the name of the PaperSize.

Returns

the name of self

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

Returns

the PPD name of self

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

Returns true if self is not a standard paper size.

Returns

whether self is a custom paper size.

Returns true if self is an IPP standard paper size.

Returns

whether self is not an IPP custom paper size.

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

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

Returns

a new, floating, GVariant

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

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.

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

Returns a copy of the value. Read more

Performs copy-assignment from source. 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

Performs the conversion.

Performs the conversion.

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

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.