gtk4/org.gtkkn.bindings.gtk/PaperSize

PaperSize

class PaperSize(val gtkPaperSizePointer: <Error class: unknown class><<Error class: unknown class>>)(source)

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.

Constructors

constructor(name: String? = null)

Creates a new GtkPaperSize object by parsing a PWG 5101.1-2002 paper name.

constructor(name: String, displayName: String, width: <Error class: unknown class>, height: <Error class: unknown class>, unit: Unit)

Creates a new GtkPaperSize object with the given parameters.

constructor(variant: <Error class: unknown class>)

Deserialize a paper size from a GVariant.

constructor(ippName: String, width: <Error class: unknown class>, height: <Error class: unknown class>)

Creates a new GtkPaperSize object by using IPP information.

constructor(keyFile: <Error class: unknown class>, groupName: String? = null)

Reads a paper size from the group @group_name in the key file

constructor(ppdName: String, ppdDisplayName: String, width: <Error class: unknown class>, height: <Error class: unknown class>)

Creates a new GtkPaperSize object by using PPD information.

constructor(gtkPaperSizePointer: <Error class: unknown class><<Error class: unknown class>>)

Types

object Companion

Properties

gtkPaperSizePointer

val gtkPaperSizePointer: <Error class: unknown class><<Error class: unknown class>>

Functions

fun copy(): PaperSize

Copies an existing GtkPaperSize.

fun free()

Free the given GtkPaperSize object.

getDefaultBottomMargin

fun getDefaultBottomMargin(unit: Unit): <Error class: unknown class>

Gets the default bottom margin for the GtkPaperSize.

getDefaultLeftMargin

fun getDefaultLeftMargin(unit: Unit): <Error class: unknown class>

Gets the default left margin for the GtkPaperSize.

getDefaultRightMargin

fun getDefaultRightMargin(unit: Unit): <Error class: unknown class>

Gets the default right margin for the GtkPaperSize.

getDefaultTopMargin

fun getDefaultTopMargin(unit: Unit): <Error class: unknown class>

Gets the default top margin for the GtkPaperSize.

fun getDisplayName(): String

Gets the human-readable name of the GtkPaperSize.

fun getHeight(unit: Unit): <Error class: unknown class>

Gets the paper height of the GtkPaperSize, in units of @unit.

fun getName(): String

Gets the name of the GtkPaperSize.

fun getPpdName(): String

Gets the PPD name of the GtkPaperSize, which may be null.

fun getWidth(unit: Unit): <Error class: unknown class>

Gets the paper width of the GtkPaperSize, in units of @unit.

fun isCustom(): Boolean

Returns true if @size is not a standard paper size.

fun isEqual(size2: PaperSize): Boolean

Compares two GtkPaperSize objects.

fun isIpp(): Boolean

Returns true if @size is an IPP standard paper size.

fun setSize(width: <Error class: unknown class>, height: <Error class: unknown class>, unit: Unit)

Changes the dimensions of a @size to @width x @height.

fun toGvariant(): <Error class: unknown class>

Serialize a paper size to an a{sv} variant.

fun toKeyFile(keyFile: <Error class: unknown class>, groupName: String)

This function adds the paper size from @size to @key_file.