Printer

Instances of this class are used to print to a printer. Applications create a GC on a printer using <code>new GC(printer)</code> and then draw on the printer GC using the usual graphics calls. A <code>Printer</code> object may be constructed by providing a <code>PrinterData</code> object which identifies the printer. A <code>PrintDialog</code> presents a print dialog to the user and returns an initialized instance of <code>PrinterData</code>. Alternatively, calling <code>new Printer()</code> will construct a printer object for the user's default printer. Application code must explicitly invoke the <code>Printer.dispose()</code> method to release the operating system resources managed by each instance when those instances are no longer required.

@see PrinterData @see PrintDialog @see <a href="http://www.eclipse.org/swt/snippets/#printing">Printing snippets</a> @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>

final

class Printer : Device {

PrinterData[] printerList;

PrinterData data;

GtkPrinter* printer;

GtkPrintJob* printJob;

GtkPrintSettings* settings;

void* pageSetup;

org.eclipse.swt.internal.gtk.OS.cairo_surface_t* surface;

org.eclipse.swt.internal.gtk.OS.cairo_t* cairo;

bool isGCCreated;

Font systemFont;

String settingsData;

int start;

int end;

String GTK_LPR_BACKEND;

bool disablePrinting;

static PrinterData[] getPrinterList();

static PrinterData getDefaultPrinterData();

this();

this(PrinterData data);

Font getSystemFont();

GdkGC* internal_new_GC(GCData data);

void internal_dispose_GC(GdkGC* gdkGC, GCData data);

void release();

bool startJob(String jobName);

void destroy();

void endJob();

void cancelJob();

bool startPage();

void endPage();

Point getDPI();

Rectangle getBounds();

Rectangle getClientArea();

Rectangle computeTrim(int x, int y, int width, int height);

void create(DeviceData deviceData);

void init_();

PrinterData getPrinterData();

}

Constructors

this this(): Constructs a new printer representing the default printer. You must dispose the printer when it is no longer required.
this this(PrinterData data): Constructs a new printer given a <code>PrinterData</code> object representing the desired printer. You must dispose the printer when it is no longer required.

Members

Functions

cancelJob void cancelJob(): Cancels a print job in progress.
computeTrim Rectangle computeTrim(int x, int y, int width, int height): Given a client area (as described by the arguments), returns a rectangle, relative to the client area's coordinates, that is the client area expanded by the printer's trim (or minimum margins). Most printers have a minimum margin on each edge of the paper where the printer device is unable to print. This margin is known as the "trim." This method can be used to calculate the printer's minimum margins by passing in a client area of 0, 0, 0, 0 and then using the resulting x and y coordinates (which will be <= 0) to determine the minimum margins for the top and left edges of the paper, and the resulting width and height (offset by the resulting x and y) to determine the minimum margins for the bottom and right edges of the paper, as follows: <ul> <li>The left trim width is -x pixels</li> <li>The top trim height is -y pixels</li> <li>The right trim width is (x + width) pixels</li> <li>The bottom trim height is (y + height) pixels</li> </ul>
create void create(DeviceData deviceData): Creates the printer handle. This method is called internally by the instance creation mechanism of the <code>Device</code> class. @param deviceData the device data
destroy void destroy(): Destroys the printer handle. This method is called internally by the dispose mechanism of the <code>Device</code> class.
endJob void endJob(): Ends the current print job.
endPage void endPage(): Ends the current page.
getBounds Rectangle getBounds(): Returns a rectangle describing the receiver's size and location. For a printer, this is the size of the physical page, in pixels.
getClientArea Rectangle getClientArea(): Returns a rectangle which describes the area of the receiver which is capable of displaying data. For a printer, this is the size of the printable area of the page, in pixels.
getDPI Point getDPI(): Returns a point whose x coordinate is the horizontal dots per inch of the printer, and whose y coordinate is the vertical dots per inch of the printer.
getPrinterData PrinterData getPrinterData(): Returns a <code>PrinterData</code> object representing the target printer for this print job.
getSystemFont Font getSystemFont(): Returns a reasonable font for applications to use. On some platforms, this will match the "default font" or "system font" if such can be found. This font should not be free'd because it was allocated by the system, not the application. Typically, applications which want the default look should simply not set the font on the widgets they create. Widgets are always created with the correct default font for the class of user-interface component they represent.
init_ void init_(): Initializes any internal resources needed by the device. This method is called after <code>create</code>. If subclasses reimplement this method, they must call the <code>super</code> implementation.
internal_dispose_GC void internal_dispose_GC(GdkGC* gdkGC, GCData data): Invokes platform specific functionality to dispose a GC handle. IMPORTANT: This method is not part of the public API for <code>Printer</code>. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms, and should never be called from application code.
internal_new_GC GdkGC* internal_new_GC(GCData data): Invokes platform specific functionality to allocate a new GC handle. IMPORTANT: This method is not part of the public API for <code>Printer</code>. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms, and should never be called from application code.
release void release(): Releases any internal state prior to destroying this printer. This method is called internally by the dispose mechanism of the <code>Device</code> class.
startJob bool startJob(String jobName): Starts a print job and returns true if the job started successfully and false otherwise. This must be the first method called to initiate a print job, followed by any number of startPage/endPage calls, followed by endJob. Calling startPage, endPage, or endJob before startJob will result in undefined behavior.
startPage bool startPage(): Starts a page and returns true if the page started successfully and false otherwise. After calling startJob, this method may be called any number of times along with a matching endPage.

Static functions

getDefaultPrinterData PrinterData getDefaultPrinterData(): Returns a <code>PrinterData</code> object representing the default printer or <code>null</code> if there is no printer available on the System.
getPrinterList PrinterData[] getPrinterList(): Returns an array of <code>PrinterData</code> objects representing all available printers.

Variables

isGCCreated bool isGCCreated;: whether or not a GC was created for this printer

Inherited Members

From Device

xDisplay void* xDisplay;: the handle to the X Display (Warning: This field is platform dependent) IMPORTANT: This field is not part of the SWT public API. It is marked protected only so that it can be shared within the packages provided by SWT. It is not available on all platforms and should never be accessed from application code.
checkDevice void checkDevice(): Throws an <code>SWTException</code> if the receiver can not be accessed by the caller. This may include both checks on the state of the receiver and more generally on the entire execution context. This method should be called by device implementors to enforce the standard SWT invariants. Currently, it is an error to invoke any method (other than <code>isDisposed()</code> and <code>dispose()</code>) on a device that has had its <code>dispose()</code> method called. In future releases of SWT, there may be more or fewer error checks and exceptions may be thrown for different reasons.
create void create(DeviceData data): Creates the device in the operating system. If the device does not have a handle, this method may do nothing depending on the device. This method is called before <code>init</code>. Subclasses are supposed to reimplement this method and not call the <code>super</code> implementation.
dispose void dispose(): Disposes of the operating system resources associated with the receiver. After this method has been invoked, the receiver will answer <code>true</code> when sent the message <code>isDisposed()</code>.
destroy void destroy(): Destroys the device in the operating system and releases the device's handle. If the device does not have a handle, this method may do nothing depending on the device. This method is called after <code>release</code>. Subclasses are supposed to reimplement this method and not call the <code>super</code> implementation.
getBounds Rectangle getBounds(): Returns a rectangle describing the receiver's size and location.
getDeviceData DeviceData getDeviceData(): Returns a <code>DeviceData</code> based on the receiver. Modifications made to this <code>DeviceData</code> will not affect the receiver.
getClientArea Rectangle getClientArea(): Returns a rectangle which describes the area of the receiver which is capable of displaying data.
getDepth int getDepth(): Returns the bit depth of the screen, which is the number of bits it takes to represent the number of unique colors that the screen is currently capable of displaying. This number will typically be one of 1, 8, 15, 16, 24 or 32.
getDPI Point getDPI(): Returns a point whose x coordinate is the horizontal dots per inch of the display, and whose y coordinate is the vertical dots per inch of the display.
getFontList FontData[] getFontList(String faceName, bool scalable): Returns <code>FontData</code> objects which describe the fonts that match the given arguments. If the <code>faceName</code> is null, all fonts will be returned.
getSystemColor Color getSystemColor(int id): Returns the matching standard color for the given constant, which should be one of the color constants specified in class <code>SWT</code>. Any value other than one of the SWT color constants which is passed in will result in the color black. This color should not be freed because it was allocated by the system, not the application.
getSystemFont Font getSystemFont(): Returns a reasonable font for applications to use. On some platforms, this will match the "default font" or "system font" if such can be found. This font should not be freed because it was allocated by the system, not the application. Typically, applications which want the default look should simply not set the font on the widgets they create. Widgets are always created with the correct default font for the class of user-interface component they represent.
getWarnings bool getWarnings(): Returns <code>true</code> if the underlying window system prints out warning messages on the console, and <code>setWarnings</code> had previously been called with <code>true</code>.
init_ void init_(): Initializes any internal resources needed by the device. This method is called after <code>create</code>. If subclasses reimplement this method, they must call the <code>super</code> implementation.
internal_new_GC GdkGC* internal_new_GC(GCData data): Invokes platform specific functionality to allocate a new GC handle. IMPORTANT: This method is not part of the public API for <code>Device</code>. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms, and should never be called from application code.
internal_dispose_GC void internal_dispose_GC(GdkGC* handle, GCData data): Invokes platform specific functionality to dispose a GC handle. IMPORTANT: This method is not part of the public API for <code>Device</code>. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms, and should never be called from application code.
isDisposed bool isDisposed(): Returns <code>true</code> if the device has been disposed, and <code>false</code> otherwise. This method gets the dispose state for the device. When a device has been disposed, it is an error to invoke any other method using the device.
loadFont bool loadFont(String path): Loads the font specified by a file. The font will be present in the list of fonts available to the application.
release void release(): Releases any internal resources back to the operating system and clears all fields except the device handle. When a device is destroyed, resources that were acquired on behalf of the programmer need to be returned to the operating system. For example, if the device allocated a font to be used as the system font, this font would be freed in <code>release</code>. Also,to assist the garbage collector and minimize the amount of memory that is not reclaimed when the programmer keeps a reference to a disposed device, all fields except the handle are zero'd. The handle is needed by <code>destroy</code>. This method is called before <code>destroy</code>. If subclasses reimplement this method, they must call the <code>super</code> implementation.
setWarnings void setWarnings(bool warnings): If the underlying window system supports printing warning messages to the console, setting warnings to <code>false</code> prevents these messages from being printed. If the argument is <code>true</code> then message printing is not blocked.