PaperSize

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.

class PaperSize : Boxed {

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

void* _cPtr(Flag!"Dup" dup);

static GType _getGType();

GType _gType [@property getter];

PaperSize self();

this(string name);

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

static gtk.paper_size.PaperSize newFromGvariant(glib.variant.Variant variant);

static gtk.paper_size.PaperSize newFromIpp(string ippName, double width, double height);

static gtk.paper_size.PaperSize newFromKeyFile(glib.key_file.KeyFile keyFile, string groupName);

static gtk.paper_size.PaperSize newFromPpd(string ppdName, string ppdDisplayName, double width, double height);

gtk.paper_size.PaperSize copy();

double getDefaultBottomMargin(gtk.types.Unit unit);

double getDefaultLeftMargin(gtk.types.Unit unit);

double getDefaultRightMargin(gtk.types.Unit unit);

double getDefaultTopMargin(gtk.types.Unit unit);

string getDisplayName();

double getHeight(gtk.types.Unit unit);

string getName();

string getPpdName();

double getWidth(gtk.types.Unit unit);

bool isCustom();

bool isEqual(gtk.paper_size.PaperSize size2);

bool isIpp();

void setSize(double width, double height, gtk.types.Unit unit);

glib.variant.Variant toGvariant();

void toKeyFile(glib.key_file.KeyFile keyFile, string groupName);

static string getDefault();

static gtk.paper_size.PaperSize[] getPaperSizes(bool includeCustom);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(string name): Creates a new #GtkPaperSize object by parsing a PWG 5101.1-2002
paper name.

Members

Functions

_cPtr void* _cPtr(Flag!"Dup" dup)
copy gtk.paper_size.PaperSize copy(): Copies an existing #GtkPaperSize.
getDefaultBottomMargin double getDefaultBottomMargin(gtk.types.Unit unit): Gets the default bottom margin for the #GtkPaperSize.
getDefaultLeftMargin double getDefaultLeftMargin(gtk.types.Unit unit): Gets the default left margin for the #GtkPaperSize.
getDefaultRightMargin double getDefaultRightMargin(gtk.types.Unit unit): Gets the default right margin for the #GtkPaperSize.
getDefaultTopMargin double getDefaultTopMargin(gtk.types.Unit unit): Gets the default top margin for the #GtkPaperSize.
getDisplayName string getDisplayName(): Gets the human-readable name of the #GtkPaperSize.
getHeight double getHeight(gtk.types.Unit unit): Gets the paper height of the #GtkPaperSize, in units of unit.
getName string getName(): Gets the name of the #GtkPaperSize.
getPpdName string getPpdName(): Gets the PPD name of the #GtkPaperSize, which may be null.
getWidth double getWidth(gtk.types.Unit unit): Gets the paper width of the #GtkPaperSize, in units of unit.
isCustom bool isCustom(): Returns true if size is not a standard paper size.
isEqual bool isEqual(gtk.paper_size.PaperSize size2): Compares two #GtkPaperSize objects.
isIpp bool isIpp(): Returns true if size is an IPP standard paper size.
self PaperSize self(): Returns this, for use in with statements.
setSize void setSize(double width, double height, gtk.types.Unit unit): Changes the dimensions of a size to width x height.
toGvariant glib.variant.Variant toGvariant(): Serialize a paper size to an a{sv} variant.
toKeyFile void toKeyFile(glib.key_file.KeyFile keyFile, string groupName): This function adds the paper size from size to key_file.

Properties

_gType GType _gType [@property getter]

Static functions

_getGType GType _getGType()
getDefault string getDefault(): Returns the name of the default paper size, which depends on the current locale.
getPaperSizes gtk.paper_size.PaperSize[] getPaperSizes(bool includeCustom): Creates a list of known paper sizes.
newCustom 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.
newFromGvariant 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.
newFromIpp gtk.paper_size.PaperSize newFromIpp(string ippName, double width, double height): Creates a new #GtkPaperSize object by using IPP information.
newFromKeyFile gtk.paper_size.PaperSize newFromKeyFile(glib.key_file.KeyFile keyFile, string groupName): Reads a paper size from the group group_name in the key file key_file.
newFromPpd gtk.paper_size.PaperSize newFromPpd(string ppdName, string ppdDisplayName, double width, double height): Creates a new #GtkPaperSize object by using PPD information.

Inherited Members

From Boxed

_cInstancePtr void* _cInstancePtr;: Pointer to the C boxed value
_getGType GType _getGType(): Get the GType of this boxed type.
_gType GType _gType [@property getter]: Boxed GType property.
self Boxed self(): Convenience method to return this cast to a type. For use in D with statements.
boxCopy void* boxCopy(): Make a copy of the wrapped C boxed data.
boxedCopy void* boxedCopy(void* cBoxed): Copy a C boxed value using g_boxed_copy.
boxedFree void boxedFree(void* cBoxed): Free a C boxed value using g_boxed_free.

gtk paper_size classes

PaperSize