gtk4/org.gtkkn.bindings.gtk/Printer

Printer

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

A GtkPrinter object represents a printer.

You only need to deal directly with printers if you use the non-portable class@Gtk.PrintUnixDialog API.

A GtkPrinter allows to get status information about the printer, such as its description, its location, the number of queued jobs, etc. Most importantly, a GtkPrinter object can be used to create a class@Gtk.PrintJob object, which lets you print to the printer.

Skipped during bindings generation

  • method get_backend: Return type PrintBackend is unsupported

  • parameter top: top: Out parameter is not supported

  • parameter top: top: Out parameter is not supported

  • method accepting-jobs: Property has no getter nor setter

  • method accepts-pdf: Property has no getter nor setter

  • method accepts-ps: Property has no getter nor setter

  • method is-virtual: Property has no getter nor setter

  • method paused: Property has no getter nor setter

  • parameter backend: PrintBackend

Constructors

Link copied to clipboard
constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val gtkPrinterPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open val iconName: String

Icon name to use for the printer.

Link copied to clipboard
open val jobCount: Int

Number of jobs queued in the printer.

Link copied to clipboard
open val location: String

Information about the location of the printer.

Link copied to clipboard
open val name: String

The name of the printer.

Link copied to clipboard
open val stateMessage: String

String giving the current status of the printer.

Functions

Link copied to clipboard
open fun acceptsPdf(): Boolean

Returns whether the printer accepts input in PDF format.

Link copied to clipboard
open fun acceptsPs(): Boolean

Returns whether the printer accepts input in PostScript format.

Link copied to clipboard
open fun compare(b: Printer): Int

Compares two printers.

Link copied to clipboard
fun connectDetailsAcquired(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (success: Boolean) -> Unit): <Error class: unknown class>

Emitted in response to a request for detailed information about a printer from the print backend.

Link copied to clipboard
open fun getCapabilities(): PrintCapabilities

Returns the printer’s capabilities.

Link copied to clipboard
open fun getDefaultPageSize(): PageSetup

Returns default page size of @printer.

Link copied to clipboard
open fun getDescription(): String

Gets the description of the printer.

Link copied to clipboard
open fun getIconName(): String

Gets the name of the icon to use for the printer.

Link copied to clipboard
open fun getJobCount(): Int

Gets the number of jobs currently queued on the printer.

Link copied to clipboard
open fun getLocation(): String

Returns a description of the location of the printer.

Link copied to clipboard
open fun getName(): String

Returns the name of the printer.

Link copied to clipboard
open fun getStateMessage(): String

Returns the state message describing the current state of the printer.

Link copied to clipboard
open fun hasDetails(): Boolean

Returns whether the printer details are available.

Link copied to clipboard
open fun isAcceptingJobs(): Boolean

Returns whether the printer is accepting jobs

Link copied to clipboard
open fun isActive(): Boolean

Returns whether the printer is currently active (i.e. accepts new jobs).

Link copied to clipboard
open fun isDefault(): Boolean

Returns whether the printer is the default printer.

Link copied to clipboard
open fun isPaused(): Boolean

Returns whether the printer is currently paused.

Link copied to clipboard
open fun isVirtual(): Boolean

Returns whether the printer is virtual (i.e. does not represent actual printer hardware, but something like a CUPS class).

Link copied to clipboard
open fun listPapers(): <Error class: unknown class>

Lists all the paper sizes @printer supports.

Link copied to clipboard
open fun requestDetails()

Requests the printer details.