gtk4/org.gtkkn.bindings.gtk/PrintSettings

PrintSettings

open class PrintSettings(pointer: <Error class: unknown class><<Error class: unknown class>>)

A GtkPrintSettings object represents the settings of a print dialog in a system-independent way.

The main use for this object is that once you’ve printed you can get a settings object that represents the settings the user chose, and the next time you print you can pass that object in so that the user doesn’t have to re-set all his settings.

Its also possible to enumerate the settings so that you can easily save the settings for the next time your app runs, or even store them in a document. The predefined keys try to use shared values as much as possible so that moving such a document between systems still works.

Skipped during bindings generation

parameter num_ranges: num_ranges: Out parameter is not supported
parameter page_ranges: PageRange

Constructors

PrintSettings

constructor()

Creates a new GtkPrintSettings object.

constructor(fileName: String)

Reads the print settings from @file_name.

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

Deserialize print settings from an a{sv} variant.

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

Reads the print settings from the group @group_name in @key_file.

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

Types

Companion

object Companion

Properties

gtkPrintSettingsPointer

val gtkPrintSettingsPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

copy

open fun copy(): PrintSettings

Copies a GtkPrintSettings object.

foreach

open fun foreach(func: PrintSettingsFunc)

Calls @func for each key-value pair of @settings.

get

open fun get(key: String): String?

Looks up the string value associated with @key.

getBool

open fun getBool(key: String): Boolean

Returns the boolean represented by the value that is associated with @key.

getCollate

open fun getCollate(): Boolean

Gets the value of %GTK_PRINT_SETTINGS_COLLATE.

getDefaultSource

open fun getDefaultSource(): String?

Gets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE.

getDither

open fun getDither(): String?

Gets the value of %GTK_PRINT_SETTINGS_DITHER.

getDouble

open fun getDouble(key: String): Double

Returns the double value associated with @key, or 0.

getDoubleWithDefault

open fun getDoubleWithDefault(key: String, def: Double): Double

Returns the floating point number represented by the value that is associated with @key, or @default_val if the value does not represent a floating point number.

getDuplex

open fun getDuplex(): PrintDuplex

Gets the value of %GTK_PRINT_SETTINGS_DUPLEX.

getFinishings

open fun getFinishings(): String?

Gets the value of %GTK_PRINT_SETTINGS_FINISHINGS.

getInt

open fun getInt(key: String): Int

Returns the integer value of @key, or 0.

getIntWithDefault

open fun getIntWithDefault(key: String, def: Int): Int

Returns the value of @key, interpreted as an integer, or the default value.

getLength

open fun getLength(key: String, unit: Unit): Double

Returns the value associated with @key, interpreted as a length.

getMediaType

open fun getMediaType(): String?

Gets the value of %GTK_PRINT_SETTINGS_MEDIA_TYPE.

getNCopies

open fun getNCopies(): Int

Gets the value of %GTK_PRINT_SETTINGS_N_COPIES.

getNumberUp

open fun getNumberUp(): Int

Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP.

getNumberUpLayout

open fun getNumberUpLayout(): NumberUpLayout

Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT.

getOrientation

open fun getOrientation(): PageOrientation

Get the value of %GTK_PRINT_SETTINGS_ORIENTATION, converted to a GtkPageOrientation.

getOutputBin

open fun getOutputBin(): String?

Gets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN.

getPageSet

open fun getPageSet(): PageSet

Gets the value of %GTK_PRINT_SETTINGS_PAGE_SET.

getPaperHeight

open fun getPaperHeight(unit: Unit): Double

Gets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT, converted to @unit.

getPaperSize

open fun getPaperSize(): PaperSize?

Gets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT, converted to a GtkPaperSize.

getPaperWidth

open fun getPaperWidth(unit: Unit): Double

Gets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH, converted to @unit.

getPrinter

open fun getPrinter(): String?

Convenience function to obtain the value of %GTK_PRINT_SETTINGS_PRINTER.

getPrinterLpi

open fun getPrinterLpi(): Double

Gets the value of %GTK_PRINT_SETTINGS_PRINTER_LPI.

getPrintPages

open fun getPrintPages(): PrintPages

Gets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES.

getQuality

open fun getQuality(): PrintQuality

Gets the value of %GTK_PRINT_SETTINGS_QUALITY.

getResolution

open fun getResolution(): Int

Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION.

getResolutionX

open fun getResolutionX(): Int

Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_X.

getResolutionY

open fun getResolutionY(): Int

Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_Y.

getReverse

open fun getReverse(): Boolean

Gets the value of %GTK_PRINT_SETTINGS_REVERSE.

getScale

open fun getScale(): Double

Gets the value of %GTK_PRINT_SETTINGS_SCALE.

getUseColor

open fun getUseColor(): Boolean

Gets the value of %GTK_PRINT_SETTINGS_USE_COLOR.

hasKey

open fun hasKey(key: String): Boolean

Returns true, if a value is associated with @key.

loadFile

open fun loadFile(fileName: String): <Error class: unknown class><Boolean>

Reads the print settings from @file_name.

loadKeyFile

open fun loadKeyFile(keyFile: <Error class: unknown class>, groupName: String? = null): <Error class: unknown class><Boolean>

Reads the print settings from the group @group_name in @key_file.

set

open fun set(key: String, value: String? = null)

Associates @value with @key.

setBool

open fun setBool(key: String, value: Boolean)

Sets @key to a boolean value.

setCollate

open fun setCollate(collate: Boolean)

Sets the value of %GTK_PRINT_SETTINGS_COLLATE.

setDefaultSource

open fun setDefaultSource(defaultSource: String)

Sets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE.

setDither

open fun setDither(dither: String)

Sets the value of %GTK_PRINT_SETTINGS_DITHER.

setDouble

open fun setDouble(key: String, value: Double)

Sets @key to a double value.

setDuplex

open fun setDuplex(duplex: PrintDuplex)

Sets the value of %GTK_PRINT_SETTINGS_DUPLEX.

setFinishings

open fun setFinishings(finishings: String)

Sets the value of %GTK_PRINT_SETTINGS_FINISHINGS.

setInt

open fun setInt(key: String, value: Int)

Sets @key to an integer value.

setLength

open fun setLength(key: String, value: Double, unit: Unit)

Associates a length in units of @unit with @key.

setMediaType

open fun setMediaType(mediaType: String)

Sets the value of %GTK_PRINT_SETTINGS_MEDIA_TYPE.

setNCopies

open fun setNCopies(numCopies: Int)

Sets the value of %GTK_PRINT_SETTINGS_N_COPIES.

setNumberUp

open fun setNumberUp(numberUp: Int)

Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP.

setNumberUpLayout

open fun setNumberUpLayout(numberUpLayout: NumberUpLayout)

Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT.

setOrientation

open fun setOrientation(orientation: PageOrientation)

Sets the value of %GTK_PRINT_SETTINGS_ORIENTATION.

setOutputBin

open fun setOutputBin(outputBin: String)

Sets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN.

setPageSet

open fun setPageSet(pageSet: PageSet)

Sets the value of %GTK_PRINT_SETTINGS_PAGE_SET.

setPaperHeight

open fun setPaperHeight(height: Double, unit: Unit)

Sets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT.

setPaperSize

open fun setPaperSize(paperSize: PaperSize)

Sets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT, %GTK_PRINT_SETTINGS_PAPER_WIDTH and %GTK_PRINT_SETTINGS_PAPER_HEIGHT.

setPaperWidth

open fun setPaperWidth(width: Double, unit: Unit)

Sets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH.

setPrinter

open fun setPrinter(printer: String)

Convenience function to set %GTK_PRINT_SETTINGS_PRINTER to @printer.

setPrinterLpi

open fun setPrinterLpi(lpi: Double)

Sets the value of %GTK_PRINT_SETTINGS_PRINTER_LPI.

setPrintPages

open fun setPrintPages(pages: PrintPages)

Sets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES.

setQuality

open fun setQuality(quality: PrintQuality)

Sets the value of %GTK_PRINT_SETTINGS_QUALITY.

setResolution

open fun setResolution(resolution: Int)

Sets the values of %GTK_PRINT_SETTINGS_RESOLUTION, %GTK_PRINT_SETTINGS_RESOLUTION_X and %GTK_PRINT_SETTINGS_RESOLUTION_Y.

setResolutionXy

open fun setResolutionXy(resolutionX: Int, resolutionY: Int)

Sets the values of %GTK_PRINT_SETTINGS_RESOLUTION, %GTK_PRINT_SETTINGS_RESOLUTION_X and %GTK_PRINT_SETTINGS_RESOLUTION_Y.

setReverse

open fun setReverse(reverse: Boolean)

Sets the value of %GTK_PRINT_SETTINGS_REVERSE.

setScale

open fun setScale(scale: Double)

Sets the value of %GTK_PRINT_SETTINGS_SCALE.

setUseColor

open fun setUseColor(useColor: Boolean)

Sets the value of %GTK_PRINT_SETTINGS_USE_COLOR.

toFile

open fun toFile(fileName: String): <Error class: unknown class><Boolean>

This function saves the print settings from @settings to @file_name.

toGvariant

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

Serialize print settings to an a{sv} variant.

toKeyFile

open fun toKeyFile(keyFile: <Error class: unknown class>, groupName: String? = null)

This function adds the print settings from @settings to @key_file.

unset

open fun unset(key: String)

Removes any value associated with @key.