gtk.paper_size

Module for [PaperSize] class

Types 1

GtkPaperSize 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, GtkPaperSize allows to construct custom paper sizes with arbitrary dimensions.

The #GtkPaperSize object stores not only the dimensions (width and height) of a paper size and its name, it also provides default [print margins][print-margins].

Printing support has been added in GTK+ 2.10.

Methods

void * _cPtr(Flag!"Dup" dup = No.Dup)

GType _getGType()

GType _gType() @property

PaperSize self()Returns `this`, for use in `with` statements.

gtk.paper_size.PaperSize newCustom(string name,  string displayName,  double  width,  double  height,  gtk.types.Unit unit)

Creates a new #GtkPaperSize object with the given parameters.

gtk.paper_size.PaperSize newFromGvariant(glib.variant.Variant variant)Deserialize a paper size from an a{sv} variant in the format produced by [gtk.paper_size.PaperSize.toGvariant].

gtk.paper_size.PaperSize newFromIpp(string ippName, double width, double height)Creates a new #GtkPaperSize object by using IPP information.

gtk.paper_size.PaperSize newFromKeyFile(glib.key_file.KeyFile keyFile, string groupName = null)Reads a paper size from the group groupname in the key file keyfile.

gtk.paper_size.PaperSize newFromPpd(string ppdName, string ppdDisplayName, double width, double height)Creates a new #GtkPaperSize object by using PPD information.

gtk.paper_size.PaperSize copy()Copies an existing #GtkPaperSize. Returns: a copy of other

double getDefaultBottomMargin(gtk.types.Unit unit)Gets the default bottom margin for the #GtkPaperSize.

double getDefaultLeftMargin(gtk.types.Unit unit)Gets the default left margin for the #GtkPaperSize.

double getDefaultRightMargin(gtk.types.Unit unit)Gets the default right margin for the #GtkPaperSize.

double getDefaultTopMargin(gtk.types.Unit unit)Gets the default top margin for the #GtkPaperSize.

string getDisplayName()Gets the human-readable name of the #GtkPaperSize. Returns: the human-readable name of size

double getHeight(gtk.types.Unit unit)Gets the paper height of the #GtkPaperSize, in units of unit.

string getName()Gets the name of the #GtkPaperSize. Returns: the name of size

string getPpdName()Gets the PPD name of the #GtkPaperSize, which may be null. Returns: the PPD name of size

double getWidth(gtk.types.Unit unit)Gets the paper width of the #GtkPaperSize, in units of unit.

bool isCustom()Returns true if size is not a standard paper size. Returns: whether size is a custom paper size.

bool isEqual(gtk.paper_size.PaperSize size2)Compares two #GtkPaperSize objects.

bool isIpp()Returns true if size is an IPP standard paper size. Returns: whether size is not an IPP custom paper size.

void setSize(double width, double height, gtk.types.Unit unit)Changes the dimensions of a size to width x height.

glib.variant.Variant toGvariant()Serialize a paper size to an a{sv} variant. Returns: a new, floating, #GVariant

void toKeyFile(glib.key_file.KeyFile keyFile, string groupName)This function adds the paper size from size to key_file.

string getDefault()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.

gtk.paper_size.PaperSize[] getPaperSizes(bool includeCustom)Creates a list of known paper sizes.

Constructors

this(void * ptr, Flag!"Take" take)

this(string name = null)Creates a new #GtkPaperSize object by parsing a [PWG 5101.1-2002](ftp://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn10-20020226-5101.1.pdf) paper name.