Package org.gnome.gtk

Class Printer

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.Printer

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class Printer
extends GObject

A GtkPrinter object represents a printer.

You only need to deal directly with printers if you use the non-portable 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 PrintJob object, which lets you print to the printer.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Printer.Builder<B extends Printer.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	Printer.DetailsAcquiredCallback	Functional interface declaration of the DetailsAcquiredCallback callback.

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
Printer(MemorySegment address)	Create a Printer proxy instance for the provided memory address.
Printer(String name, PrintBackend backend, boolean virtual)	Creates a new GtkPrinter.

Method Summary

Modifier and Type	Method	Description
boolean	acceptsPdf()	Returns whether the printer accepts input in PDF format.
boolean	acceptsPs()	Returns whether the printer accepts input in PostScript format.
protected Printer	asParent()	Returns this instance as if it were its parent type.
static Printer.Builder<? extends Printer.Builder>	builder()	A Printer.Builder object constructs a Printer with the specified properties.
int	compare(Printer b)	Compares two printers.
void	emitDetailsAcquired(boolean success)	Emits the "details-acquired" signal.
PrintBackend	getBackend()	Returns the backend of the printer.
Set<PrintCapabilities>	getCapabilities()	Returns the printer’s capabilities.
PageSetup	getDefaultPageSize()	Returns default page size of this Printer.
String	getDescription()	Gets the description of the printer.
boolean	getHardMargins(Out<Double> top, Out<Double> bottom, Out<Double> left, Out<Double> right)	Retrieve the hard margins of this Printer.
boolean	getHardMarginsForPaperSize(PaperSize paperSize, Out<Double> top, Out<Double> bottom, Out<Double> left, Out<Double> right)	Retrieve the hard margins of this Printer for paperSize.
String	getIconName()	Gets the name of the icon to use for the printer.
int	getJobCount()	Gets the number of jobs currently queued on the printer.
String	getLocation()	Returns a description of the location of the printer.
String	getName()	Returns the name of the printer.
String	getStateMessage()	Returns the state message describing the current state of the printer.
static Type	getType()	Get the GType of the Printer class
boolean	hasDetails()	Returns whether the printer details are available.
boolean	isAcceptingJobs()	Returns whether the printer is accepting jobs
boolean	isActive()	Returns whether the printer is currently active (i.e.
boolean	isDefault()	Returns whether the printer is the default printer.
boolean	isPaused()	Returns whether the printer is currently paused.
boolean	isVirtual()	Returns whether the printer is virtual (i.e.
List<PageSetup>	listPapers()	Lists all the paper sizes this Printer supports.
SignalConnection<Printer.DetailsAcquiredCallback>	onDetailsAcquired(Printer.DetailsAcquiredCallback handler)	Emitted in response to a request for detailed information about a printer from the print backend.
void	requestDetails()	Requests the printer details.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Printer

public Printer(MemorySegment address)

Create a Printer proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Printer

public Printer(String name,
 PrintBackend backend,
 boolean virtual)
        throws UnsupportedPlatformException

Creates a new GtkPrinter.

Parameters:

name - the name of the printer

backend - a GtkPrintBackend

virtual - whether the printer is virtual

Throws:

UnsupportedPlatformException - when run on a platform other than linux or macos

Method Details

getType

public static Type getType()

Get the GType of the Printer class

Returns:

the GType

asParent

protected Printer asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

acceptsPdf

public boolean acceptsPdf()

Returns whether the printer accepts input in PDF format.

Returns:

true if this Printer accepts PDF

acceptsPs

public boolean acceptsPs()

Returns whether the printer accepts input in PostScript format.

Returns:

true if this Printer accepts PostScript

compare

public int compare(Printer b)

Compares two printers.

Parameters:

b - another GtkPrinter

Returns:

0 if the printer match, a negative value if this Printer < b, or a positive value if this Printer > b

getBackend

public PrintBackend getBackend()

Returns the backend of the printer.

Returns:

the backend of this Printer

getCapabilities

public Set<PrintCapabilities> getCapabilities()

Returns the printer’s capabilities.

This is useful when you’re using GtkPrintUnixDialog’s manual-capabilities setting and need to know which settings the printer can handle and which you must handle yourself.

This will return 0 unless the printer’s details are available, see hasDetails() and requestDetails().

Returns:

the printer’s capabilities

getDefaultPageSize

public PageSetup getDefaultPageSize()

Returns default page size of this Printer.

Returns:

a newly allocated GtkPageSetup with default page size of the printer.

getDescription

public String getDescription()

Gets the description of the printer.

Returns:

the description of this Printer

getHardMargins

public boolean getHardMargins(Out<Double> top,
 Out<Double> bottom,
 Out<Double> left,
 Out<Double> right)

Retrieve the hard margins of this Printer.

These are the margins that define the area at the borders of the paper that the printer cannot print to.

Note: This will not succeed unless the printer’s details are available, see hasDetails() and requestDetails().

Parameters:

top - a location to store the top margin in

bottom - a location to store the bottom margin in

left - a location to store the left margin in

right - a location to store the right margin in

Returns:

true iff the hard margins were retrieved

getHardMarginsForPaperSize

public boolean getHardMarginsForPaperSize(PaperSize paperSize,
 Out<Double> top,
 Out<Double> bottom,
 Out<Double> left,
 Out<Double> right)

Retrieve the hard margins of this Printer for paperSize.

These are the margins that define the area at the borders of the paper that the printer cannot print to.

Note: This will not succeed unless the printer’s details are available, see hasDetails() and requestDetails().

Parameters:

paperSize - a GtkPaperSize

top - a location to store the top margin in

bottom - a location to store the bottom margin in

left - a location to store the left margin in

right - a location to store the right margin in

Returns:

true iff the hard margins were retrieved

getIconName

public String getIconName()

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

Returns:

the icon name for this Printer

getJobCount

public int getJobCount()

Gets the number of jobs currently queued on the printer.

Returns:

the number of jobs on this Printer

getLocation

public String getLocation()

Returns a description of the location of the printer.

Returns:

the location of this Printer

getName

public String getName()

Returns the name of the printer.

Returns:

the name of this Printer

getStateMessage

public String getStateMessage()

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

Returns:

the state message of this Printer

hasDetails

public boolean hasDetails()

Returns whether the printer details are available.

Returns:

true if this Printer details are available

isAcceptingJobs

public boolean isAcceptingJobs()

Returns whether the printer is accepting jobs

Returns:

true if this Printer is accepting jobs

isActive

public boolean isActive()

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

Returns:

true if this Printer is active

isDefault

public boolean isDefault()

Returns whether the printer is the default printer.

Returns:

true if this Printer is the default

isPaused

public boolean isPaused()

Returns whether the printer is currently paused.

A paused printer still accepts jobs, but it is not printing them.

Returns:

true if this Printer is paused

isVirtual

public boolean isVirtual()

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

Returns:

true if this Printer is virtual

listPapers

public List<PageSetup> listPapers()

Lists all the paper sizes this Printer supports.

This will return and empty list unless the printer’s details are available, see hasDetails() and requestDetails().

Returns:

a newly allocated list of newly allocated GtkPageSetups.

requestDetails

public void requestDetails()

Requests the printer details.

When the details are available, the Gtk.Printer::details-acquired signal will be emitted on this Printer.

onDetailsAcquired

public SignalConnection<Printer.DetailsAcquiredCallback> onDetailsAcquired(Printer.DetailsAcquiredCallback handler)

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

The success parameter indicates if the information was actually obtained.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Printer.DetailsAcquiredCallback.run(boolean)

emitDetailsAcquired

public void emitDetailsAcquired(boolean success)

Emits the "details-acquired" signal. See onDetailsAcquired(org.gnome.gtk.Printer.DetailsAcquiredCallback).

builder

public static Printer.Builder<? extends Printer.Builder> builder()

A Printer.Builder object constructs a Printer with the specified properties. Use the various set...() methods to set properties, and finish construction with Printer.Builder.build().