Struct gtk4::PageSetup

source ·

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

Expand description

A PageSetup object stores the page size, orientation and margins.

The idea is that you can get one of these from the page setup dialog and then pass it to the PrintOperation when printing. The benefit of splitting this out of the PrintSettings is that these affect the actual layout of the page, and thus need to be set long before user prints.

Margins

The margins specified in this object are the “print margins”, i.e. the parts of the page that the printer cannot print on. These are different from the layout margins that a word processor uses; they are typically used to determine the minimal size for the layout margins.

To obtain a PageSetup use new() to get the defaults, or use print_run_page_setup_dialog() to show the page setup dialog and receive the resulting page setup.

A page setup dialog

⚠️ The following code is in c ⚠️

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;
}

Struct gtk4::PageSetup

Implementations§

impl PageSetup

pub fn new() -> PageSetup

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

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

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

pub fn copy(&self) -> PageSetup

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

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

pub fn orientation(&self) -> PageOrientation

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

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

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

pub fn paper_size(&self) -> PaperSize

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

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

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

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

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

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

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

pub fn set_orientation(&self, orientation: PageOrientation)

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

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

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

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

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

pub fn to_gvariant(&self) -> Variant

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

Trait Implementations§

impl Clone for PageSetup

fn clone(&self) -> Self

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

impl Debug for PageSetup

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

impl Default for PageSetup

fn default() -> Self

impl Display for PageSetup

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

impl HasParamSpec for PageSetup

type ParamSpec = ParamSpecObject

type SetValue = PageSetup

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,

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

impl Ord for PageSetup

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

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

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

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

impl ParentClassIs for PageSetup

type Parent = Object

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

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

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

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

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

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

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

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

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

impl StaticType for PageSetup

fn static_type() -> Type

impl Eq for PageSetup

Auto Trait Implementations§

impl RefUnwindSafe for PageSetup

impl !Send for PageSetup

impl !Sync for PageSetup

impl Unpin for PageSetup

impl UnwindSafe for PageSetup

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T