Struct PageSetup 

pub struct PageSetup { /* private fields */ }

static GtkPrintSettings *settings = NULL; static GtkPageSetup *page_setup = NULL;

static void do_page_setup (void) { GtkPageSetup *new_page_setup;

if (settings == NULL) settings = gtk_print_settings_new ();

new_page_setup = gtk_print_run_page_setup_dialog (GTK_WINDOW (main_window), page_setup, settings);

if (page_setup) g_object_unref (page_setup);

page_setup = new_page_setup; } ]|

Printing support was added in GTK+ 2.10.

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl PageSetup

pub fn new() -> PageSetup

Creates a new PageSetup.

Returns

a new PageSetup.

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

Reads the page setup from the file file_name. Returns a new PageSetup object with the restored page setup, or None if an error occurred. See to_file().

file_name

the filename to read the page setup from

Returns

the restored PageSetup

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

Desrialize a page setup from an a{sv} variant in the format produced by to_gvariant().

variant

an a{sv} glib::Variant

Returns

a new PageSetup object

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

Reads the page setup from the group group_name in the key file key_file. Returns a new PageSetup object with the restored page setup, or None if an error occurred.

key_file

the glib::KeyFile to retrieve the page_setup from

group_name

the name of the group in the key_file to read, or None to use the default name “Page Setup”

Returns

the restored PageSetup

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

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

Gets the bottom margin in units of unit.

unit

the unit for the return value

Returns

the bottom margin

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

Gets the left margin in units of unit.

unit

the unit for the return value

Returns

the left margin

pub fn orientation(&self) -> PageOrientation

Gets the page orientation of the PageSetup.

Returns

the page orientation

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

Returns the page height in units of unit.

Note that this function takes orientation and margins into consideration. See paper_height().

unit

the unit for the return value

Returns

the page height.

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

Returns the page width in units of unit.

Note that this function takes orientation and margins into consideration. See paper_width().

unit

the unit for the return value

Returns

the page width.

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

Returns the paper height in units of unit.

Note that this function takes orientation, but not margins into consideration. See page_height().

unit

the unit for the return value

Returns

the paper height.

pub fn paper_size(&self) -> PaperSize

Gets the paper size of the PageSetup.

Returns

the paper size

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

Returns the paper width in units of unit.

Note that this function takes orientation, but not margins into consideration. See page_width().

unit

the unit for the return value

Returns

the paper width.

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

Gets the right margin in units of unit.

unit

the unit for the return value

Returns

the right margin

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

Gets the top margin in units of unit.

unit

the unit for the return value

Returns

the top margin

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

Reads the page setup from the file file_name. See to_file().

file_name

the filename to read the page setup from

Returns

true on success

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

Reads the page setup from the group group_name in the key file key_file.

key_file

the glib::KeyFile to retrieve the page_setup from

group_name

the name of the group in the key_file to read, or None to use the default name “Page Setup”

Returns

true on success

pub fn set_bottom_margin(&self, margin: f64, unit: Unit)

Sets the bottom margin of the PageSetup.

margin

the new bottom margin in units of unit

unit

the units for margin

pub fn set_left_margin(&self, margin: f64, unit: Unit)

Sets the left margin of the PageSetup.

margin

the new left margin in units of unit

unit

the units for margin

pub fn set_orientation(&self, orientation: PageOrientation)

Sets the page orientation of the PageSetup.

orientation

a PageOrientation value

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

Sets the paper size of the PageSetup without changing the margins. See set_paper_size_and_default_margins().

size

a PaperSize

pub fn set_paper_size_and_default_margins(&self, size: &PaperSize)

Sets the paper size of the PageSetup and modifies the margins according to the new paper size.

size

a PaperSize

pub fn set_right_margin(&self, margin: f64, unit: Unit)

Sets the right margin of the PageSetup.

margin

the new right margin in units of unit

unit

the units for margin

pub fn set_top_margin(&self, margin: f64, unit: Unit)

Sets the top margin of the PageSetup.

margin

the new top margin in units of unit

unit

the units for margin

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

This function saves the information from self to file_name.

file_name

the file to save to

Returns

true on success

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

Serialize page setup to an a{sv} variant.

Returns

a new, floating, glib::Variant

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

This function adds the page setup from self to key_file.

key_file

the glib::KeyFile to save the page setup to

group_name

the group to add the settings to in key_file, or None to use the default name “Page Setup”

Trait Implementations

impl Clone for PageSetup

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for PageSetup

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

Formats the value using the given formatter.

impl Default for PageSetup

fn default() -> Self

Returns the “default value” for a type.

impl Eq for PageSetup

impl HasParamSpec for PageSetup

type ParamSpec = ParamSpecObject

type SetValue = PageSetup

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for PageSetup

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

where H: Hasher,

Hashes the memory address of this object.

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 PageSetup

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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,

Restrict a value to a certain interval.

impl ParentClassIs for PageSetup

type Parent = Object

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

Inequality operator !=.

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

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for PageSetup

fn static_type() -> Type

Returns the type identifier of Self.