Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gtk.PageSetup

Class Gtk.PageSetup

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-3.0.gir
C documentation:	GtkPageSetup
Class :	PageSetup
Extends:	GObject.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 GtkPrintOperation when printing.
The benefit of splitting this out of the GtkPrintSettings is that
these affect the actual layout of the page, and thus need to be set
long before user prints.

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 GtkPageSetup use gtk_page_setup_new() to get the defaults,
or use gtk_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.

Properties
None

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.PageSetup () Create a new Gtk.PageSetup Create a new Gtk.PageSetup
	new Gtk.PageSetup.from_file (String *file_name) : Gtk.PageSetup Create a new Gtk.PageSetup Create a new Gtk.PageSetup Parameters: String file_name* Required (not null) the filename to read the page setup from Returns: Gtk.PageSetup the restored GtkPageSetup
	new Gtk.PageSetup.from_key_file (KeyFile *key_file, String group_name) : Gtk.PageSetup Create a new Gtk.PageSetup Create a new Gtk.PageSetup Parameters: GLib.KeyFile key_file* Required (not null) the GKeyFile to retrieve the page_setup from String group_name the name of the group in the key_file to read, or NULL to use the default name "Page Setup" Returns: Gtk.PageSetup the restored GtkPageSetup
	copy () : Gtk.PageSetup Copies a GtkPageSetup. Copies a GtkPageSetup. Returns: Gtk.PageSetup a copy of other	Gtk.PageSetup
	get_bottom_margin (Unit *unit) : gdouble Gets the bottom margin in units of unit. Gets the bottom margin in units of unit. Parameters: Gtk.Unit unit* Required (not null) the unit for the return value Returns: gdouble the bottom margin	Gtk.PageSetup
	get_left_margin (Unit *unit) : gdouble Gets the left margin in units of unit. Gets the left margin in units of unit. Parameters: Gtk.Unit unit* Required (not null) the unit for the return value Returns: gdouble the left margin	Gtk.PageSetup
	get_orientation () : Gtk.PageOrientation Gets the page orientation of the GtkPageSetup. Gets the page orientation of the GtkPageSetup. Returns: Gtk.PageOrientation the page orientation	Gtk.PageSetup
	get_page_height (Unit *unit) : gdouble Returns the page height in units of unit. Returns the page height in units of unit. Note that this function takes orientation and margins into consideration. See gtk_page_setup_get_paper_height(). Parameters: Gtk.Unit unit* Required (not null) the unit for the return value Returns: gdouble the page height.	Gtk.PageSetup
	get_page_width (Unit *unit) : gdouble Returns the page width in units of unit. Returns the page width in units of unit. Note that this function takes orientation and margins into consideration. See gtk_page_setup_get_paper_width(). Parameters: Gtk.Unit unit* Required (not null) the unit for the return value Returns: gdouble the page width.	Gtk.PageSetup
	get_paper_height (Unit *unit) : gdouble Returns the paper height in units of unit. Returns the paper height in units of unit. Note that this function takes orientation, but not margins into consideration. See gtk_page_setup_get_page_height(). Parameters: Gtk.Unit unit* Required (not null) the unit for the return value Returns: gdouble the paper height.	Gtk.PageSetup
	get_paper_size () : Gtk.PaperSize Gets the paper size of the GtkPageSetup. Gets the paper size of the GtkPageSetup. Returns: Gtk.PaperSize the paper size	Gtk.PageSetup
	get_paper_width (Unit *unit) : gdouble Returns the paper width in units of unit. Returns the paper width in units of unit. Note that this function takes orientation, but not margins into consideration. See gtk_page_setup_get_page_width(). Parameters: Gtk.Unit unit* Required (not null) the unit for the return value Returns: gdouble the paper width.	Gtk.PageSetup
	get_right_margin (Unit *unit) : gdouble Gets the right margin in units of unit. Gets the right margin in units of unit. Parameters: Gtk.Unit unit* Required (not null) the unit for the return value Returns: gdouble the right margin	Gtk.PageSetup
	get_top_margin (Unit *unit) : gdouble Gets the top margin in units of unit. Gets the top margin in units of unit. Parameters: Gtk.Unit unit* Required (not null) the unit for the return value Returns: gdouble the top margin	Gtk.PageSetup
	load_file (String *file_name) : gboolean Reads the page setup from the file file_name. Reads the page setup from the file file_name. See gtk_page_setup_to_file(). Parameters: String file_name* Required (not null) the filename to read the page setup from Returns: gboolean TRUE on success	Gtk.PageSetup
	load_key_file (KeyFile *key_file, String group_name) : gboolean Reads the page setup from the group group_name* in the key file Reads the page setup from the group group_name in the key file Parameters: GLib.KeyFile key_file Required (not null) the GKeyFile to retrieve the page_setup from String group_name the name of the group in the key_file to read, or NULL to use the default name "Page Setup" Returns: gboolean TRUE on success	Gtk.PageSetup
	set_bottom_margin (gdouble *margin, Unit unit) : none Sets the bottom margin of the GtkPageSetup. Sets the bottom margin of the GtkPageSetup. Parameters: gdouble margin* Required (not null) the new bottom margin in units of unit Gtk.Unit unit Required (not null) the units for margin Returns: none	Gtk.PageSetup
	set_left_margin (gdouble *margin, Unit unit) : none Sets the left margin of the GtkPageSetup. Sets the left margin of the GtkPageSetup. Parameters: gdouble margin* Required (not null) the new left margin in units of unit Gtk.Unit unit Required (not null) the units for margin Returns: none	Gtk.PageSetup
	set_orientation (PageOrientation *orientation) : none Sets the page orientation of the GtkPageSetup. Sets the page orientation of the GtkPageSetup. Parameters: Gtk.PageOrientation orientation* Required (not null) a GtkPageOrientation value Returns: none	Gtk.PageSetup
	set_paper_size (PaperSize *size) : none Sets the paper size of the GtkPageSetup* without changing the margins. Sets the paper size of the GtkPageSetup without changing the margins. See gtk_page_setup_set_paper_size_and_default_margins(). Parameters: Gtk.PaperSize size Required (not null) a GtkPaperSize Returns: none	Gtk.PageSetup
	set_paper_size_and_default_margins (PaperSize *size) : none Sets the paper size of the GtkPageSetup* and modifies the margins according to the new paper size. Sets the paper size of the GtkPageSetup and modifies the margins according to the new paper size. Parameters: Gtk.PaperSize size Required (not null) a GtkPaperSize Returns: none	Gtk.PageSetup
	set_right_margin (gdouble *margin, Unit unit) : none Sets the right margin of the GtkPageSetup. Sets the right margin of the GtkPageSetup. Parameters: gdouble margin* Required (not null) the new right margin in units of unit Gtk.Unit unit Required (not null) the units for margin Returns: none	Gtk.PageSetup
	set_top_margin (gdouble *margin, Unit unit) : none Sets the top margin of the GtkPageSetup. Sets the top margin of the GtkPageSetup. Parameters: gdouble margin* Required (not null) the new top margin in units of unit Gtk.Unit unit Required (not null) the units for margin Returns: none	Gtk.PageSetup
	to_file (String *file_name) : gboolean This function saves the information from setup* to file_name. This function saves the information from setup to file_name. Parameters: String file_name Required (not null) the file to save to Returns: gboolean TRUE on success	Gtk.PageSetup
	to_key_file (KeyFile *key_file, String group_name) : none This function adds the page setup from setup* to key_file. This function adds the page setup from setup to key_file. Parameters: GLib.KeyFile key_file Required (not null) the GKeyFile to save the page setup to String group_name Required (not null) the group to add the settings to in key_file, or NULL to use the default name "Page Setup" Returns: none	Gtk.PageSetup

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
EvinceView.PrintOperation Method	set_default_page_setup (PageSetup *page_setup*) : none
Gtk Method	Gtk.print_run_page_setup_dialog (Window *parent, PageSetup page_setup, PrintSettings settings) : Gtk.PageSetup Runs a page setup dialog, letting the user modify the values from is identical to the passed in page_setup*, otherwise it contains the modifications done in the dialog.
Gtk Method	Gtk.print_run_page_setup_dialog_async (Window *parent, PageSetup page_setup, PrintSettings settings, Function done_cb, void *data) : none Runs a page setup dialog, letting the user modify the values from page_setup*.
Gtk.PrintContext Method	get_page_setup () : Gtk.PageSetup Obtains the GtkPageSetup that determines the page dimensions of the GtkPrintContext.
Gtk.PrintOperation Property	default_page_setup : Gtk.PageSetup The GtkPageSetup used by default.
Gtk.PrintOperation Signal	request_page_setup (PrintOperation *self, PrintContext context, gint32 page_nr, PageSetup setup*) : none Emitted once for every page that is printed, to give the application a chance to modify the page setup.
Gtk.PrintOperation Signal	update_custom_widget (PrintOperation *self, Widget widget, PageSetup setup, PrintSettings settings*) : none Emitted after change of selected printer.
Gtk.PrintOperation Method	get_default_page_setup () : Gtk.PageSetup Returns the default page setup, see gtk_print_operation_set_default_page_setup().
Gtk.PrintOperation Method	set_default_page_setup (PageSetup *default_page_setup) : none Makes default_page_setup* the default page setup for op.
Gtk.PrintOperationPreview Signal	got_page_size (PrintOperationPreview *self, PrintContext context, PageSetup page_setup*) : none The ::got-page-size signal is emitted once for each page that gets rendered to the preview.