Class PaperSize

Hierarchy

PaperSize

Constructors

constructor

new PaperSize(name: string): Gtk.PaperSize

- Defined in @types/Gjs/Gtk-2.0.d.ts:60298
Creates a new #GtkPaperSize object by parsing a PWG 5101.1-2002 paper name.

If name is %NULL, the default paper size is returned, see gtk_paper_size_get_default().

Parameters
- name: string
  
  a paper size name, or %NULL
Returns Gtk.PaperSize

Properties

Static name

name: string

Methods

copy

copy(): Gtk.PaperSize

- Defined in @types/Gjs/Gtk-2.0.d.ts:60206
Copies an existing #GtkPaperSize.

Returns Gtk.PaperSize

free

free(): void

- Defined in @types/Gjs/Gtk-2.0.d.ts:60210
Free the given #GtkPaperSize object.

Returns void

get_default_bottom_margin

get_default_bottom_margin(unit: Gtk.Unit): number

- Defined in @types/Gjs/Gtk-2.0.d.ts:60215
Gets the default bottom margin for the #GtkPaperSize.

Parameters
- unit: Gtk.Unit
  
  the unit for the return value
Returns number

get_default_left_margin

get_default_left_margin(unit: Gtk.Unit): number

- Defined in @types/Gjs/Gtk-2.0.d.ts:60220
Gets the default left margin for the #GtkPaperSize.

Parameters
- unit: Gtk.Unit
  
  the unit for the return value
Returns number

get_default_right_margin

get_default_right_margin(unit: Gtk.Unit): number

- Defined in @types/Gjs/Gtk-2.0.d.ts:60225
Gets the default right margin for the #GtkPaperSize.

Parameters
- unit: Gtk.Unit
  
  the unit for the return value
Returns number

get_default_top_margin

get_default_top_margin(unit: Gtk.Unit): number

- Defined in @types/Gjs/Gtk-2.0.d.ts:60230
Gets the default top margin for the #GtkPaperSize.

Parameters
- unit: Gtk.Unit
  
  the unit for the return value
Returns number

get_display_name

get_display_name(): string

- Defined in @types/Gjs/Gtk-2.0.d.ts:60234
Gets the human-readable name of the #GtkPaperSize.

Returns string

get_height

get_height(unit: Gtk.Unit): number

- Defined in @types/Gjs/Gtk-2.0.d.ts:60240
Gets the paper height of the #GtkPaperSize, in units of unit.

Parameters
- unit: Gtk.Unit
  
  the unit for the return value
Returns number

get_name

get_name(): string

- Defined in @types/Gjs/Gtk-2.0.d.ts:60244
Gets the name of the #GtkPaperSize.

Returns string

get_ppd_name

get_ppd_name(): string

- Defined in @types/Gjs/Gtk-2.0.d.ts:60249
Gets the PPD name of the #GtkPaperSize, which may be %NULL.

Returns string

get_width

get_width(unit: Gtk.Unit): number

- Defined in @types/Gjs/Gtk-2.0.d.ts:60255
Gets the paper width of the #GtkPaperSize, in units of unit.

Parameters
- unit: Gtk.Unit
  
  the unit for the return value
Returns number

is_custom

is_custom(): boolean

- Defined in @types/Gjs/Gtk-2.0.d.ts:60259
Returns %TRUE if size is not a standard paper size.

Returns boolean

is_equal

is_equal(size2: Gtk.PaperSize): boolean

- Defined in @types/Gjs/Gtk-2.0.d.ts:60264
Compares two #GtkPaperSize objects.

Parameters
- size2: Gtk.PaperSize
  
  another #GtkPaperSize object
Returns boolean

set_size

set_size(width: number, height: number, unit: Gtk.Unit): void

- Defined in @types/Gjs/Gtk-2.0.d.ts:60271
Changes the dimensions of a size to width x height.

Parameters
- width: number
  
  the new width in units of unit
- height: number
  
  the new height in units of unit
- unit: Gtk.Unit
  
  the unit for width and height
Returns void

to_key_file

to_key_file(key_file: GLib.KeyFile, group_name: string): void

- Defined in @types/Gjs/Gtk-2.0.d.ts:60277
This function adds the paper size from size to key_file.

Parameters
- key_file: GLib.KeyFile
  
  the #GKeyFile to save the paper size to
- group_name: string
  
  the group to add the settings to in key_file
Returns void

Static get_default

get_default(): string

- Defined in @types/Gjs/Gtk-2.0.d.ts:60347
Returns the name of the default paper size, which depends on the current locale.

Returns string

Static get_paper_sizes

get_paper_sizes(include_custom: boolean): Gtk.PaperSize[]

- Defined in @types/Gjs/Gtk-2.0.d.ts:60352
Creates a list of known paper sizes.

Parameters
- include_custom: boolean
  
  whether to include custom paper sizes as defined in the page setup dialog
Returns Gtk.PaperSize[]

Static new

new(name: string): Gtk.PaperSize

- Defined in @types/Gjs/Gtk-2.0.d.ts:60309
Creates a new #GtkPaperSize object by parsing a PWG 5101.1-2002 paper name.

If name is %NULL, the default paper size is returned, see gtk_paper_size_get_default().

Parameters
- name: string
  
  a paper size name, or %NULL
Returns Gtk.PaperSize

Static new_custom

new_custom(name: string, display_name: string, width: number, height: number, unit: Gtk.Unit): Gtk.PaperSize

- Defined in @types/Gjs/Gtk-2.0.d.ts:60320
Creates a new #GtkPaperSize object with the given parameters.

Parameters
- name: string
  
  the paper name
- display_name: string
  
  the human-readable name
- width: number
  
  the paper width, in units of unit
- height: number
  
  the paper height, in units of unit
- unit: Gtk.Unit
  
  the unit for width and height
Returns Gtk.PaperSize

Static new_from_key_file

new_from_key_file(key_file: GLib.KeyFile, group_name: string): Gtk.PaperSize

- Defined in @types/Gjs/Gtk-2.0.d.ts:60328
Reads a paper size from the group group_name in the key file key_file.

Parameters
- key_file: GLib.KeyFile
  
  the #GKeyFile to retrieve the papersize from
- group_name: string
  
  the name ofthe group in the key file to read, or %NULL to read the first group
Returns Gtk.PaperSize

Static new_from_ppd

new_from_ppd(ppd_name: string, ppd_display_name: string, width: number, height: number): Gtk.PaperSize

- Defined in @types/Gjs/Gtk-2.0.d.ts:60342
Creates a new #GtkPaperSize object by using PPD information.

If ppd_name is not a recognized PPD paper name, ppd_display_name, width and height are used to construct a custom #GtkPaperSize object.

Parameters
- ppd_name: string
  
  a PPD paper name
- ppd_display_name: string
  
  the corresponding human-readable name
- width: number
  
  the paper width, in points
- height: number
  
  the paper height in points
Returns Gtk.PaperSize