annotate dwt/printing/Printer.d @ 212:ab60f3309436

reverted the char[] to String and use the an alias.
author Frank Benoit <benoit@tionex.de>
date Mon, 05 May 2008 00:12:38 +0200
parents af0e7b559478
children 36f5cb12e1a2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
151
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2006 IBM Corporation and others.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 * Port to the D programming language:
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 * Frank Benoit <benoit@tionex.de>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwt.printing.Printer;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 import dwt.DWT;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 import dwt.DWTError;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 import dwt.DWTException;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 import dwt.graphics.Device;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 import dwt.graphics.DeviceData;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 import dwt.graphics.GCData;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 import dwt.graphics.Point;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 import dwt.graphics.Rectangle;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 import dwt.internal.win32.OS;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 import dwt.printing.PrinterData;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 import dwt.dwthelper.utils;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 * Instances of this class are used to print to a printer.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * Applications create a GC on a printer using <code>new GC(printer)</code>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * and then draw on the printer GC using the usual graphics calls.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * <p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * A <code>Printer</code> object may be constructed by providing
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * a <code>PrinterData</code> object which identifies the printer.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * A <code>PrintDialog</code> presents a print dialog to the user
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * and returns an initialized instance of <code>PrinterData</code>.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * Alternatively, calling <code>new Printer()</code> will construct a
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * printer object for the user's default printer.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 * </p><p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 * Application code must explicitly invoke the <code>Printer.dispose()</code>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 * method to release the operating system resources managed by each instance
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 * when those instances are no longer required.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 * </p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 * @see PrinterData
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 * @see PrintDialog
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 public final class Printer : Device {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 * the handle to the printer DC
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 * (Warning: This field is platform dependent)
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 * <p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 * <b>IMPORTANT:</b> This field is <em>not</em> part of the DWT
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 * public API. It is marked public only so that it can be shared
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 * within the packages provided by DWT. It is not available on all
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 * platforms and should never be accessed from application code.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 * </p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 public HANDLE handle;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 * the printer data describing this printer
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 PrinterData data;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 * whether or not a GC was created for this printer
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 bool isGCCreated = false;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 * strings used to access the Windows registry
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 static TCHAR[] profile;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 static TCHAR[] appName;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 static TCHAR[] keyName;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 static this() {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 profile = StrToTCHARs(0, "PrinterPorts", true); //$NON-NLS-1$
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 appName = StrToTCHARs(0, "windows", true); //$NON-NLS-1$
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 keyName = StrToTCHARs(0, "device", true); //$NON-NLS-1$
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 * Returns an array of <code>PrinterData</code> objects
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 * representing all available printers.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 * @return the list of available printers
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 public static PrinterData[] getPrinterList() {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 int length = 1024;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 /* Use the character encoding for the default locale */
212
ab60f3309436 reverted the char[] to String and use the an alias.
Frank Benoit <benoit@tionex.de>
parents: 151
diff changeset
94 String buf = new String(length);
151
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 int n = OS.GetProfileString( TCHARsToStr(profile), null, null, buf, length);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 if (n is 0) return null;
212
ab60f3309436 reverted the char[] to String and use the an alias.
Frank Benoit <benoit@tionex.de>
parents: 151
diff changeset
97 String[] deviceNames = new String[](5);
151
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 int nameCount = 0;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 int index = 0;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 for (int i = 0; i < n; i++) {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 if (buf[i] is 0) {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 if (nameCount is deviceNames.length) {
212
ab60f3309436 reverted the char[] to String and use the an alias.
Frank Benoit <benoit@tionex.de>
parents: 151
diff changeset
103 String[] newNames = new String[](deviceNames.length + 5);
151
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 System.arraycopy(deviceNames, 0, newNames, 0, deviceNames.length);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 deviceNames = newNames;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 deviceNames[nameCount] = buf[index .. i ].dup;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 nameCount++;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
109 index = i + 1;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
110 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
111 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
112 PrinterData printerList[] = new PrinterData[nameCount];
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
113 for (int p = 0; p < nameCount; p++) {
212
ab60f3309436 reverted the char[] to String and use the an alias.
Frank Benoit <benoit@tionex.de>
parents: 151
diff changeset
114 String device = deviceNames[p];
ab60f3309436 reverted the char[] to String and use the an alias.
Frank Benoit <benoit@tionex.de>
parents: 151
diff changeset
115 String driver = ""; //$NON-NLS-1$
151
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
116 if (OS.GetProfileString(TCHARsToStr(profile), device, null, buf, length) > 0) {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
117 int commaIndex = 0;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
118 while (buf[commaIndex] !is ',' && commaIndex < length) commaIndex++;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
119 if (commaIndex < length) {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
120 driver = buf[0 .. commaIndex].dup;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
121 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
122 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
123 printerList[p] = new PrinterData(driver, device);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
124 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
125 return printerList;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
126 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
127
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
128 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
129 * Returns a <code>PrinterData</code> object representing
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
130 * the default printer or <code>null</code> if there is no
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
131 * printer available on the System.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
132 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
133 * @return the default printer data or null
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
134 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
135 * @since 2.1
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
136 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
137 public static PrinterData getDefaultPrinterData() {
212
ab60f3309436 reverted the char[] to String and use the an alias.
Frank Benoit <benoit@tionex.de>
parents: 151
diff changeset
138 String deviceName = null;
151
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
139 int length = 1024;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
140 /* Use the character encoding for the default locale */
212
ab60f3309436 reverted the char[] to String and use the an alias.
Frank Benoit <benoit@tionex.de>
parents: 151
diff changeset
141 String buf = new String(length);
151
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
142 int n = OS.GetProfileString(TCHARsToStr(appName), TCHARsToStr(keyName), null, buf, length);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
143 if (n is 0) return null;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
144 int commaIndex = 0;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
145 while(buf[commaIndex] !is ',' && commaIndex < length) commaIndex++;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
146 if (commaIndex < length) {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
147 deviceName = buf[0 .. commaIndex].dup;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
148 }
212
ab60f3309436 reverted the char[] to String and use the an alias.
Frank Benoit <benoit@tionex.de>
parents: 151
diff changeset
149 String driver = ""; //$NON-NLS-1$
151
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
150 if (OS.GetProfileString(TCHARsToStr(profile), deviceName, null, buf, length) > 0) {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
151 commaIndex = 0;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
152 while (buf[commaIndex] !is ',' && commaIndex < length) commaIndex++;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
153 if (commaIndex < length) {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
154 driver = buf[0 .. commaIndex].dup;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
155 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
156 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
157 return new PrinterData(driver, deviceName);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
158 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
159
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
160 static DeviceData checkNull (PrinterData data) {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
161 if (data is null) data = new PrinterData();
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
162 if (data.driver is null || data.name is null) {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
163 PrinterData defaultPrinter = getDefaultPrinterData();
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
164 if (defaultPrinter is null) DWT.error(DWT.ERROR_NO_HANDLES);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
165 data.driver = defaultPrinter.driver;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
166 data.name = defaultPrinter.name;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
167 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
168 return data;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
169 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
170
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
171 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
172 * Constructs a new printer representing the default printer.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
173 * <p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
174 * You must dispose the printer when it is no longer required.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
175 * </p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
176 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
177 * @exception DWTError <ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
178 * <li>ERROR_NO_HANDLES - if there are no valid printers
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
179 * </ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
180 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
181 * @see Device#dispose
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
182 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
183 public this() {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
184 this(null);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
185 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
186
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
187 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
188 * Constructs a new printer given a <code>PrinterData</code>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
189 * object representing the desired printer.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
190 * <p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
191 * You must dispose the printer when it is no longer required.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
192 * </p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
193 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
194 * @param data the printer data for the specified printer
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
195 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
196 * @exception IllegalArgumentException <ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
197 * <li>ERROR_INVALID_ARGUMENT - if the specified printer data does not represent a valid printer
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
198 * </ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
199 * @exception DWTError <ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
200 * <li>ERROR_NO_HANDLES - if there are no valid printers
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
201 * </ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
202 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
203 * @see Device#dispose
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
204 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
205 public this(PrinterData data) {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
206 super(checkNull(data));
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
207 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
208
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
209 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
210 * Creates the printer handle.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
211 * This method is called internally by the instance creation
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
212 * mechanism of the <code>Device</code> class.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
213 * @param deviceData the device data
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
214 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
215 protected void create(DeviceData deviceData) {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
216 data = cast(PrinterData)deviceData;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
217 /* Use the character encoding for the default locale */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
218 TCHAR[] driver = StrToTCHARs(0, data.driver, true);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
219 TCHAR[] device = StrToTCHARs(0, data.name, true);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
220 DEVMODE* lpInitData;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
221 byte buffer [] = data.otherData;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
222 auto hHeap = OS.GetProcessHeap();
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
223 if (buffer !is null && buffer.length !is 0) {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
224 /* If user setup info from a print dialog was specified, restore the DEVMODE struct. */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
225 lpInitData = cast(DEVMODE*)OS.HeapAlloc(hHeap, OS.HEAP_ZERO_MEMORY, buffer.length);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
226 OS.MoveMemory(lpInitData, buffer.ptr, buffer.length);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
227 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
228 handle = OS.CreateDC(driver.ptr, device.ptr, null, lpInitData);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
229 if (lpInitData !is null) OS.HeapFree(hHeap, 0, lpInitData);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
230 if (handle is null) DWT.error(DWT.ERROR_NO_HANDLES);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
231 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
232
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
233 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
234 * Invokes platform specific functionality to allocate a new GC handle.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
235 * <p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
236 * <b>IMPORTANT:</b> This method is <em>not</em> part of the public
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
237 * API for <code>Printer</code>. It is marked public only so that it
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
238 * can be shared within the packages provided by DWT. It is not
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
239 * available on all platforms, and should never be called from
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
240 * application code.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
241 * </p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
242 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
243 * @param data the platform specific GC data
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
244 * @return the platform specific GC handle
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
245 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
246 public HDC internal_new_GC(GCData data) {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
247 if (handle is null) DWT.error(DWT.ERROR_NO_HANDLES);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
248 if (data !is null) {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
249 if (isGCCreated) DWT.error(DWT.ERROR_INVALID_ARGUMENT);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
250 int mask = DWT.LEFT_TO_RIGHT | DWT.RIGHT_TO_LEFT;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
251 if ((data.style & mask) !is 0) {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
252 data.layout = (data.style & DWT.RIGHT_TO_LEFT) !is 0 ? OS.LAYOUT_RTL : 0;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
253 } else {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
254 data.style |= DWT.LEFT_TO_RIGHT;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
255 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
256 data.device = this;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
257 data.hFont = OS.GetCurrentObject(handle, OS.OBJ_FONT);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
258 isGCCreated = true;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
259 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
260 return handle;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
261 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
262
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
263 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
264 * Invokes platform specific functionality to dispose a GC handle.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
265 * <p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
266 * <b>IMPORTANT:</b> This method is <em>not</em> part of the public
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
267 * API for <code>Printer</code>. It is marked public only so that it
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
268 * can be shared within the packages provided by DWT. It is not
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
269 * available on all platforms, and should never be called from
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
270 * application code.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
271 * </p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
272 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
273 * @param hDC the platform specific GC handle
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
274 * @param data the platform specific GC data
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
275 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
276 public void internal_dispose_GC(HDC hDC, GCData data) {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
277 if (data !is null) isGCCreated = false;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
278 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
279
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
280 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
281 * Starts a print job and returns true if the job started successfully
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
282 * and false otherwise.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
283 * <p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
284 * This must be the first method called to initiate a print job,
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
285 * followed by any number of startPage/endPage calls, followed by
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
286 * endJob. Calling startPage, endPage, or endJob before startJob
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
287 * will result in undefined behavior.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
288 * </p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
289 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
290 * @param jobName the name of the print job to start
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
291 * @return true if the job started successfully and false otherwise.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
292 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
293 * @exception DWTException <ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
294 * <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
295 * </ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
296 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
297 * @see #startPage
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
298 * @see #endPage
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
299 * @see #endJob
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
300 */
212
ab60f3309436 reverted the char[] to String and use the an alias.
Frank Benoit <benoit@tionex.de>
parents: 151
diff changeset
301 public bool startJob(String jobName) {
151
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
302 checkDevice();
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
303 DOCINFO di;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
304 di.cbSize = DOCINFO.sizeof;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
305 auto hHeap = OS.GetProcessHeap();
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
306 TCHAR* lpszDocName;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
307 if (jobName !is null && jobName.length !is 0) {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
308 /* Use the character encoding for the default locale */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
309 TCHAR[] buffer = StrToTCHARs(0, jobName, true);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
310 int byteCount = buffer.length * TCHAR.sizeof;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
311 lpszDocName = cast(TCHAR*) OS.HeapAlloc(hHeap, OS.HEAP_ZERO_MEMORY, byteCount);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
312 OS.MoveMemory(lpszDocName, buffer.ptr, byteCount);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
313 di.lpszDocName = lpszDocName;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
314 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
315 TCHAR* lpszOutput;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
316 if (data.printToFile && data.fileName !is null) {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
317 /* Use the character encoding for the default locale */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
318 TCHAR[] buffer = StrToTCHARs(0, data.fileName, true);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
319 int byteCount = buffer.length * TCHAR.sizeof;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
320 lpszOutput = cast(TCHAR*) OS.HeapAlloc(hHeap, OS.HEAP_ZERO_MEMORY, byteCount);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
321 OS.MoveMemory(lpszOutput, buffer.ptr, byteCount);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
322 di.lpszOutput = lpszOutput;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
323 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
324 int rc = OS.StartDoc(handle, &di);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
325 if (lpszDocName !is null) OS.HeapFree(hHeap, 0, lpszDocName);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
326 if (lpszOutput !is null) OS.HeapFree(hHeap, 0, lpszOutput);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
327 return rc > 0;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
328 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
329
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
330 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
331 * Ends the current print job.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
332 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
333 * @exception DWTException <ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
334 * <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
335 * </ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
336 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
337 * @see #startJob
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
338 * @see #startPage
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
339 * @see #endPage
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
340 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
341 public void endJob() {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
342 checkDevice();
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
343 OS.EndDoc(handle);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
344 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
345
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
346 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
347 * Cancels a print job in progress.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
348 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
349 * @exception DWTException <ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
350 * <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
351 * </ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
352 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
353 public void cancelJob() {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
354 checkDevice();
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
355 OS.AbortDoc(handle);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
356 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
357
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
358 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
359 * Starts a page and returns true if the page started successfully
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
360 * and false otherwise.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
361 * <p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
362 * After calling startJob, this method may be called any number of times
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
363 * along with a matching endPage.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
364 * </p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
365 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
366 * @return true if the page started successfully and false otherwise.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
367 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
368 * @exception DWTException <ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
369 * <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
370 * </ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
371 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
372 * @see #endPage
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
373 * @see #startJob
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
374 * @see #endJob
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
375 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
376 public bool startPage() {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
377 checkDevice();
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
378 int rc = OS.StartPage(handle);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
379 if (rc <= 0) OS.AbortDoc(handle);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
380 return rc > 0;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
381 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
382
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
383 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
384 * Ends the current page.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
385 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
386 * @exception DWTException <ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
387 * <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
388 * </ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
389 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
390 * @see #startPage
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
391 * @see #startJob
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
392 * @see #endJob
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
393 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
394 public void endPage() {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
395 checkDevice();
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
396 OS.EndPage(handle);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
397 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
398
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
399 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
400 * Returns a point whose x coordinate is the horizontal
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
401 * dots per inch of the printer, and whose y coordinate
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
402 * is the vertical dots per inch of the printer.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
403 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
404 * @return the horizontal and vertical DPI
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
405 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
406 * @exception DWTException <ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
407 * <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
408 * </ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
409 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
410 public Point getDPI() {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
411 checkDevice();
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
412 int dpiX = OS.GetDeviceCaps(handle, OS.LOGPIXELSX);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
413 int dpiY = OS.GetDeviceCaps(handle, OS.LOGPIXELSY);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
414 return new Point(dpiX, dpiY);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
415 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
416
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
417 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
418 * Returns a rectangle describing the receiver's size and location.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
419 * For a printer, this is the size of a physical page, in pixels.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
420 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
421 * @return the bounding rectangle
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
422 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
423 * @exception DWTException <ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
424 * <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
425 * </ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
426 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
427 * @see #getClientArea
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
428 * @see #computeTrim
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
429 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
430 public Rectangle getBounds() {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
431 checkDevice();
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
432 int width = OS.GetDeviceCaps(handle, OS.PHYSICALWIDTH);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
433 int height = OS.GetDeviceCaps(handle, OS.PHYSICALHEIGHT);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
434 return new Rectangle(0, 0, width, height);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
435 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
436
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
437 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
438 * Returns a rectangle which describes the area of the
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
439 * receiver which is capable of displaying data.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
440 * For a printer, this is the size of the printable area
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
441 * of a page, in pixels.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
442 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
443 * @return the client area
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
444 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
445 * @exception DWTException <ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
446 * <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
447 * </ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
448 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
449 * @see #getBounds
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
450 * @see #computeTrim
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
451 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
452 public Rectangle getClientArea() {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
453 checkDevice();
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
454 int width = OS.GetDeviceCaps(handle, OS.HORZRES);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
455 int height = OS.GetDeviceCaps(handle, OS.VERTRES);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
456 return new Rectangle(0, 0, width, height);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
457 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
458
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
459 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
460 * Given a desired <em>client area</em> for the receiver
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
461 * (as described by the arguments), returns the bounding
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
462 * rectangle which would be required to produce that client
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
463 * area.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
464 * <p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
465 * In other words, it returns a rectangle such that, if the
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
466 * receiver's bounds were set to that rectangle, the area
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
467 * of the receiver which is capable of displaying data
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
468 * (that is, not covered by the "trimmings") would be the
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
469 * rectangle described by the arguments (relative to the
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
470 * receiver's parent).
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
471 * </p><p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
472 * Note that there is no setBounds for a printer. This method
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
473 * is usually used by passing in the client area (the 'printable
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
474 * area') of the printer. It can also be useful to pass in 0, 0, 0, 0.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
475 * </p>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
476 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
477 * @param x the desired x coordinate of the client area
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
478 * @param y the desired y coordinate of the client area
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
479 * @param width the desired width of the client area
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
480 * @param height the desired height of the client area
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
481 * @return the required bounds to produce the given client area
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
482 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
483 * @exception DWTException <ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
484 * <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
485 * </ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
486 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
487 * @see #getBounds
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
488 * @see #getClientArea
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
489 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
490 public Rectangle computeTrim(int x, int y, int width, int height) {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
491 checkDevice();
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
492 int printX = -OS.GetDeviceCaps(handle, OS.PHYSICALOFFSETX);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
493 int printY = -OS.GetDeviceCaps(handle, OS.PHYSICALOFFSETY);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
494 int printWidth = OS.GetDeviceCaps(handle, OS.HORZRES);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
495 int printHeight = OS.GetDeviceCaps(handle, OS.VERTRES);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
496 int paperWidth = OS.GetDeviceCaps(handle, OS.PHYSICALWIDTH);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
497 int paperHeight = OS.GetDeviceCaps(handle, OS.PHYSICALHEIGHT);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
498 int hTrim = paperWidth - printWidth;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
499 int vTrim = paperHeight - printHeight;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
500 return new Rectangle(x + printX, y + printY, width + hTrim, height + vTrim);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
501 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
502
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
503 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
504 * Returns a <code>PrinterData</code> object representing the
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
505 * target printer for this print job.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
506 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
507 * @return a PrinterData object describing the receiver
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
508 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
509 public PrinterData getPrinterData() {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
510 return data;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
511 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
512
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
513 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
514 * Checks the validity of this device.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
515 *
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
516 * @exception DWTException <ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
517 * <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
518 * </ul>
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
519 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
520 protected void checkDevice() {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
521 if (handle is null) DWT.error(DWT.ERROR_DEVICE_DISPOSED);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
522 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
523
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
524 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
525 * Releases any internal state prior to destroying this printer.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
526 * This method is called internally by the dispose
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
527 * mechanism of the <code>Device</code> class.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
528 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
529 protected void release() {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
530 super.release();
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
531 data = null;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
532 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
533
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
534 /**
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
535 * Destroys the printer handle.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
536 * This method is called internally by the dispose
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
537 * mechanism of the <code>Device</code> class.
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
538 */
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
539 protected void destroy() {
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
540 if (handle !is null) OS.DeleteDC(handle);
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
541 handle = null;
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
542 }
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
543
af0e7b559478 Printer
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
544 }