Gtk-4.0 ▶ Gtk ▶ PaperSize

constructor

• new PaperSize(name?: string): Gtk.PaperSize

  Parameters

  • Optionalname: string

  Returns Gtk.PaperSize

Static$gtype

copy

• copy(): Gtk.PaperSize

  Copies an existing Gtk.PaperSize.

  Returns Gtk.PaperSize

  a copy of other

free

• free(): void

  Free the given Gtk.PaperSize object.

  Returns void

get_default_bottom_margin

• get_default_bottom_margin(unit: Gtk.Unit): number

  Gets the default bottom margin for the Gtk.PaperSize.

  Parameters

  • unit: Gtk.Unit

    the unit for the return value, not Gtk.Unit.NONE

  Returns number

  the default bottom margin

get_default_left_margin

• get_default_left_margin(unit: Gtk.Unit): number

  Gets the default left margin for the Gtk.PaperSize.

  Parameters

  • unit: Gtk.Unit

    the unit for the return value, not Gtk.Unit.NONE

  Returns number

  the default left margin

get_default_right_margin

• get_default_right_margin(unit: Gtk.Unit): number

  Gets the default right margin for the Gtk.PaperSize.

  Parameters

  • unit: Gtk.Unit

    the unit for the return value, not Gtk.Unit.NONE

  Returns number

  the default right margin

get_default_top_margin

• get_default_top_margin(unit: Gtk.Unit): number

  Gets the default top margin for the Gtk.PaperSize.

  Parameters

  • unit: Gtk.Unit

    the unit for the return value, not Gtk.Unit.NONE

  Returns number

  the default top margin

get_display_name

• get_display_name(): string

  Gets the human-readable name of the Gtk.PaperSize.

  Returns string

  the human-readable name of size

get_height

• get_height(unit: Gtk.Unit): number

  Gets the paper height of the Gtk.PaperSize, in units of unit.

  Parameters

  • unit: Gtk.Unit

    the unit for the return value, not Gtk.Unit.NONE

  Returns number

  the paper height

get_name

• get_name(): string

  Gets the name of the Gtk.PaperSize.

  Returns string

  the name of size

get_ppd_name

• get_ppd_name(): string

  Gets the PPD name of the Gtk.PaperSize, which may be null.

  Returns string

  the PPD name of size

get_width

• get_width(unit: Gtk.Unit): number

  Gets the paper width of the Gtk.PaperSize, in units of unit.

  Parameters

  • unit: Gtk.Unit

    the unit for the return value, not Gtk.Unit.NONE

  Returns number

  the paper width

is_custom

• is_custom(): boolean

  Returns true if size is not a standard paper size.

  Returns boolean

  whether size is a custom paper size.

is_equal

• is_equal(size2: Gtk.PaperSize): boolean

  Compares two Gtk.PaperSize objects.

  Parameters

  • size2: Gtk.PaperSize

    another Gtk.PaperSize object

  Returns boolean

  true, if size1 and size2 represent the same paper size

is_ipp

• is_ipp(): boolean

  Returns true if size is an IPP standard paper size.

  Returns boolean

  whether size is not an IPP custom paper size.

set_size

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

  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_gvariant

• to_gvariant(): GLib.Variant

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

  Returns GLib.Variant

  a new, floating, GLib.Variant

to_key_file

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

  This function adds the paper size from size to key_file.

  Parameters

  • key_file: GLib.KeyFile

    the GLib.KeyFile to save the paper size to

  • group_name: string

    the group to add the settings to in key_file

  Returns void

Staticget_default

• get_default(): string

  Returns the name of the default paper size, which depends on the current locale.

  Returns string

Staticget_paper_sizes

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

  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[]

Staticnew

• new(name?: string): Gtk.PaperSize

  Parameters

  • Optionalname: string

  Returns Gtk.PaperSize

Staticnew_custom

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

  Parameters

  • name: string
  • display_name: string
  • width: number
  • height: number
  • unit: Gtk.Unit

  Returns Gtk.PaperSize

Staticnew_from_gvariant

• new_from_gvariant(variant: GLib.Variant): Gtk.PaperSize

  Parameters

  • variant: GLib.Variant

  Returns Gtk.PaperSize

Staticnew_from_ipp

• new_from_ipp(ipp_name: string, width: number, height: number): Gtk.PaperSize

  Parameters

  • ipp_name: string
  • width: number
  • height: number

  Returns Gtk.PaperSize

Staticnew_from_key_file

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

  Parameters

  • key_file: GLib.KeyFile
  • Optionalgroup_name: string

  Returns Gtk.PaperSize

Staticnew_from_ppd

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

  Parameters

  • ppd_name: string
  • ppd_display_name: string
  • width: number
  • height: number

  Returns Gtk.PaperSize