PageSetup

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_page_setup_get_type ()" ) ]
public sealed class PageSetup : Object

A GtkPageSetup 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 PageSetup 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

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.

Namespace: Gtk

Package: gtk+-3.0

Content:

Creation methods:

public PageSetup ()
Creates a new PageSetup.
public PageSetup.from_file (string file_name) throws Error
Reads the page setup from the file file_name.
public PageSetup.from_gvariant (Variant variant)
Desrialize a page setup from an a{sv} variant in the format produced by to_gvariant.
public PageSetup.from_key_file (KeyFile key_file, string? group_name) throws Error
Reads the page setup from the group group_name in the key file key_file.

Methods:

public PageSetup copy ()
Copies a PageSetup.
public double get_bottom_margin (Unit unit)
Gets the bottom margin in units of unit.
public double get_left_margin (Unit unit)
Gets the left margin in units of unit.
public PageOrientation get_orientation ()
Gets the page orientation of the PageSetup.
public double get_page_height (Unit unit)
Returns the page height in units of unit.
public double get_page_width (Unit unit)
Returns the page width in units of unit.
public double get_paper_height (Unit unit)
Returns the paper height in units of unit.
public unowned PaperSize get_paper_size ()
Gets the paper size of the PageSetup.
public double get_paper_width (Unit unit)
Returns the paper width in units of unit.
public double get_right_margin (Unit unit)
Gets the right margin in units of unit.
public double get_top_margin (Unit unit)
Gets the top margin in units of unit.
public bool load_file (string file_name) throws Error
Reads the page setup from the file file_name.
public bool load_key_file (KeyFile key_file, string? group_name) throws Error
Reads the page setup from the group group_name in the key file key_file.
public void set_bottom_margin (double margin, Unit unit)
Sets the bottom margin of the PageSetup.
public void set_left_margin (double margin, Unit unit)
Sets the left margin of the PageSetup.
public void set_orientation (PageOrientation orientation)
Sets the page orientation of the PageSetup.
public void set_paper_size (PaperSize size)
Sets the paper size of the PageSetup without changing the margins.
public void set_paper_size_and_default_margins (PaperSize size)
Sets the paper size of the PageSetup and modifies the margins according to the new paper size.
public void set_right_margin (double margin, Unit unit)
Sets the right margin of the PageSetup.
public void set_top_margin (double margin, Unit unit)
Sets the top margin of the PageSetup.
public bool to_file (string file_name) throws Error
This function saves the information from this to file_name.
public Variant to_gvariant ()
Serialize page setup to an a{sv} variant.
public void to_key_file (KeyFile key_file, string? group_name)
This function adds the page setup from this to key_file.

Inherited Members:

All known members inherited from class GLib.Object