annotate dwt/graphics/Cursor.d @ 28:b868bfa989cd

Cursor
author Frank Benoit <benoit@tionex.de>
date Mon, 28 Jan 2008 00:22:22 +0100
parents
children 9a64a7781bab
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
28
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2005 IBM Corporation and others.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 *******************************************************************************/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 module dwt.graphics.Cursor;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14 import dwt.DWT;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 import dwt.DWTError;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 import dwt.internal.win32.OS;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 import dwt.graphics.Resource;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 import dwt.graphics.Device;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 import dwt.graphics.ImageData;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 import dwt.graphics.RGB;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 import dwt.graphics.PaletteData;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 import dwt.graphics.Image;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 import tango.text.convert.Format;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * Instances of this class manage operating system resources that
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * specify the appearance of the on-screen pointer. To create a
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * cursor you specify the device and either a simple cursor style
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 * describing one of the standard operating system provided cursors
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * or the image and mask data for the desired appearance.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * <p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * Application code must explicitly invoke the <code>Cursor.dispose()</code>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * method to release the operating system resources managed by each instance
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * when those instances are no longer required.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * </p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * <dl>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * <dt><b>Styles:</b></dt>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * <dd>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 * CURSOR_ARROW, CURSOR_WAIT, CURSOR_CROSS, CURSOR_APPSTARTING, CURSOR_HELP,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 * CURSOR_SIZEALL, CURSOR_SIZENESW, CURSOR_SIZENS, CURSOR_SIZENWSE, CURSOR_SIZEWE,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 * CURSOR_SIZEN, CURSOR_SIZES, CURSOR_SIZEE, CURSOR_SIZEW, CURSOR_SIZENE, CURSOR_SIZESE,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 * CURSOR_SIZESW, CURSOR_SIZENW, CURSOR_UPARROW, CURSOR_IBEAM, CURSOR_NO, CURSOR_HAND
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 * </dd>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 * </dl>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 * <p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 * Note: Only one of the above styles may be specified.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 * </p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 public final class Cursor : Resource {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 * the handle to the OS cursor resource
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 * (Warning: This field is platform dependent)
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 * <p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 * <b>IMPORTANT:</b> This field is <em>not</em> part of the DWT
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 * public API. It is marked public only so that it can be shared
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 * within the packages provided by DWT. It is not available on all
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 * platforms and should never be accessed from application code.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 * </p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 public HCURSOR handle;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 bool isIcon;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 * data used to create a HAND cursor.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 static const byte[] HAND_SOURCE = [
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 cast(byte)0xf9,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 cast(byte)0xf0,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 cast(byte)0xf0,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 cast(byte)0xf0,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 cast(byte)0xf0,cast(byte)0x3f,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 cast(byte)0xf0,cast(byte)0x07,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 cast(byte)0xf0,cast(byte)0x03,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 cast(byte)0xf0,cast(byte)0x00,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 cast(byte)0x10,cast(byte)0x00,cast(byte)0x7f,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 cast(byte)0x00,cast(byte)0x00,cast(byte)0x7f,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 cast(byte)0x80,cast(byte)0x00,cast(byte)0x7f,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 cast(byte)0xc0,cast(byte)0x00,cast(byte)0x7f,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 cast(byte)0xe0,cast(byte)0x00,cast(byte)0x7f,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 cast(byte)0xf0,cast(byte)0x00,cast(byte)0x7f,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 cast(byte)0xf8,cast(byte)0x00,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 cast(byte)0xfc,cast(byte)0x01,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 cast(byte)0xff,cast(byte)0xff,cast(byte)0xff,cast(byte)0xff
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 ];
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 static const byte[] HAND_MASK = [
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
109 cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
110 cast(byte)0x06,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
111 cast(byte)0x06,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
112 cast(byte)0x06,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
113 cast(byte)0x06,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
114 cast(byte)0x06,cast(byte)0xc0,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
115 cast(byte)0x06,cast(byte)0xd8,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
116 cast(byte)0x06,cast(byte)0xd8,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
117
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
118 cast(byte)0x07,cast(byte)0xdb,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
119 cast(byte)0x67,cast(byte)0xfb,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
120 cast(byte)0x3f,cast(byte)0xff,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
121 cast(byte)0x1f,cast(byte)0xff,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
122 cast(byte)0x0f,cast(byte)0xff,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
123 cast(byte)0x07,cast(byte)0xff,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
124 cast(byte)0x03,cast(byte)0xfe,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
125 cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
126
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
127 cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
128 cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
129 cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
130 cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
131 cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
132 cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
133 cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
134 cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
135
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
136 cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
137 cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
138 cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
139 cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
140 cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
141 cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
142 cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
143 cast(byte)0x00,cast(byte)0x00,cast(byte)0x00,cast(byte)0x00
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
144 ];
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
145
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
146 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
147 * Prevents uninitialized instances from being created outside the package.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
148 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
149 this() {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
150 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
151
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
152 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
153 * Constructs a new cursor given a device and a style
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
154 * constant describing the desired cursor appearance.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
155 * <p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
156 * You must dispose the cursor when it is no longer required.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
157 * </p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
158 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
159 * @param device the device on which to allocate the cursor
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
160 * @param style the style of cursor to allocate
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
161 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
162 * @exception IllegalArgumentException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
163 * <li>ERROR_NULL_ARGUMENT - if device is null and there is no current device</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
164 * <li>ERROR_INVALID_ARGUMENT - when an unknown style is specified</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
165 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
166 * @exception DWTError <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
167 * <li>ERROR_NO_HANDLES - if a handle could not be obtained for cursor creation</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
168 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
169 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
170 * @see DWT#CURSOR_ARROW
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
171 * @see DWT#CURSOR_WAIT
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
172 * @see DWT#CURSOR_CROSS
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
173 * @see DWT#CURSOR_APPSTARTING
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
174 * @see DWT#CURSOR_HELP
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
175 * @see DWT#CURSOR_SIZEALL
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
176 * @see DWT#CURSOR_SIZENESW
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
177 * @see DWT#CURSOR_SIZENS
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
178 * @see DWT#CURSOR_SIZENWSE
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
179 * @see DWT#CURSOR_SIZEWE
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
180 * @see DWT#CURSOR_SIZEN
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
181 * @see DWT#CURSOR_SIZES
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
182 * @see DWT#CURSOR_SIZEE
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
183 * @see DWT#CURSOR_SIZEW
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
184 * @see DWT#CURSOR_SIZENE
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
185 * @see DWT#CURSOR_SIZESE
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
186 * @see DWT#CURSOR_SIZESW
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
187 * @see DWT#CURSOR_SIZENW
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
188 * @see DWT#CURSOR_UPARROW
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
189 * @see DWT#CURSOR_IBEAM
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
190 * @see DWT#CURSOR_NO
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
191 * @see DWT#CURSOR_HAND
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
192 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
193 public this(Device device, int style) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
194 if (device is null) device = Device.getDevice();
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
195 if (device is null) DWT.error(DWT.ERROR_NULL_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
196 this.device = device;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
197 int lpCursorName = 0;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
198 switch (style) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
199 case DWT.CURSOR_HAND: lpCursorName = OS.IDC_HAND; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
200 case DWT.CURSOR_ARROW: lpCursorName = OS.IDC_ARROW; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
201 case DWT.CURSOR_WAIT: lpCursorName = OS.IDC_WAIT; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
202 case DWT.CURSOR_CROSS: lpCursorName = OS.IDC_CROSS; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
203 case DWT.CURSOR_APPSTARTING: lpCursorName = OS.IDC_APPSTARTING; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
204 case DWT.CURSOR_HELP: lpCursorName = OS.IDC_HELP; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
205 case DWT.CURSOR_SIZEALL: lpCursorName = OS.IDC_SIZEALL; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
206 case DWT.CURSOR_SIZENESW: lpCursorName = OS.IDC_SIZENESW; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
207 case DWT.CURSOR_SIZENS: lpCursorName = OS.IDC_SIZENS; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
208 case DWT.CURSOR_SIZENWSE: lpCursorName = OS.IDC_SIZENWSE; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
209 case DWT.CURSOR_SIZEWE: lpCursorName = OS.IDC_SIZEWE; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
210 case DWT.CURSOR_SIZEN: lpCursorName = OS.IDC_SIZENS; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
211 case DWT.CURSOR_SIZES: lpCursorName = OS.IDC_SIZENS; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
212 case DWT.CURSOR_SIZEE: lpCursorName = OS.IDC_SIZEWE; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
213 case DWT.CURSOR_SIZEW: lpCursorName = OS.IDC_SIZEWE; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
214 case DWT.CURSOR_SIZENE: lpCursorName = OS.IDC_SIZENESW; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
215 case DWT.CURSOR_SIZESE: lpCursorName = OS.IDC_SIZENWSE; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
216 case DWT.CURSOR_SIZESW: lpCursorName = OS.IDC_SIZENESW; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
217 case DWT.CURSOR_SIZENW: lpCursorName = OS.IDC_SIZENWSE; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
218 case DWT.CURSOR_UPARROW: lpCursorName = OS.IDC_UPARROW; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
219 case DWT.CURSOR_IBEAM: lpCursorName = OS.IDC_IBEAM; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
220 case DWT.CURSOR_NO: lpCursorName = OS.IDC_NO; break;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
221 default:
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
222 DWT.error(DWT.ERROR_INVALID_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
223 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
224 handle = OS.LoadCursor(null, cast(wchar*)lpCursorName);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
225 /*
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
226 * IDC_HAND is supported only on Windows 2000 and Windows 98.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
227 * Create a hand cursor if running in other Windows platforms.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
228 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
229 if (handle is null && style is DWT.CURSOR_HAND) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
230 int width = OS.GetSystemMetrics(OS.SM_CXCURSOR);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
231 int height = OS.GetSystemMetrics(OS.SM_CYCURSOR);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
232 if (width is 32 && height is 32) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
233 auto hInst = OS.GetModuleHandle(null);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
234 if (OS.IsWinCE) DWT.error(DWT.ERROR_NOT_IMPLEMENTED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
235 handle = OS.CreateCursor(hInst, 5, 0, 32, 32, HAND_SOURCE.ptr, HAND_MASK.ptr);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
236
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
237 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
238 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
239 if (handle is null) DWT.error(DWT.ERROR_NO_HANDLES);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
240 if (device.tracking) device.new_Object(this);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
241 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
242
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
243 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
244 * Constructs a new cursor given a device, image and mask
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
245 * data describing the desired cursor appearance, and the x
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
246 * and y coordinates of the <em>hotspot</em> (that is, the point
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
247 * within the area covered by the cursor which is considered
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
248 * to be where the on-screen pointer is "pointing").
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
249 * <p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
250 * The mask data is allowed to be null, but in this case the source
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
251 * must be an ImageData representing an icon that specifies both
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
252 * color data and mask data.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
253 * <p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
254 * You must dispose the cursor when it is no longer required.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
255 * </p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
256 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
257 * @param device the device on which to allocate the cursor
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
258 * @param source the color data for the cursor
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
259 * @param mask the mask data for the cursor (or null)
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
260 * @param hotspotX the x coordinate of the cursor's hotspot
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
261 * @param hotspotY the y coordinate of the cursor's hotspot
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
262 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
263 * @exception IllegalArgumentException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
264 * <li>ERROR_NULL_ARGUMENT - if device is null and there is no current device</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
265 * <li>ERROR_NULL_ARGUMENT - if the source is null</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
266 * <li>ERROR_NULL_ARGUMENT - if the mask is null and the source does not have a mask</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
267 * <li>ERROR_INVALID_ARGUMENT - if the source and the mask are not the same
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
268 * size, or if the hotspot is outside the bounds of the image</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
269 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
270 * @exception DWTError <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
271 * <li>ERROR_NO_HANDLES - if a handle could not be obtained for cursor creation</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
272 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
273 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
274 public this(Device device, ImageData source, ImageData mask, int hotspotX, int hotspotY) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
275 if (device is null) device = Device.getDevice();
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
276 if (device is null) DWT.error(DWT.ERROR_NULL_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
277 this.device = device;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
278 if (source is null) DWT.error(DWT.ERROR_NULL_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
279 if (mask is null) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
280 if (source.getTransparencyType() !is DWT.TRANSPARENCY_MASK) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
281 DWT.error(DWT.ERROR_NULL_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
282 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
283 mask = source.getTransparencyMask();
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
284 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
285 /* Check the bounds. Mask must be the same size as source */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
286 if (mask.width !is source.width || mask.height !is source.height) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
287 DWT.error(DWT.ERROR_INVALID_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
288 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
289 /* Check the hotspots */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
290 if (hotspotX >= source.width || hotspotX < 0 ||
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
291 hotspotY >= source.height || hotspotY < 0) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
292 DWT.error(DWT.ERROR_INVALID_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
293 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
294 /* Convert depth to 1 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
295 mask = ImageData.convertMask(mask);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
296 source = ImageData.convertMask(source);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
297
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
298 /* Make sure source and mask scanline pad is 2 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
299 byte[] sourceData = ImageData.convertPad(source.data, source.width, source.height, source.depth, source.scanlinePad, 2);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
300 byte[] maskData = ImageData.convertPad(mask.data, mask.width, mask.height, mask.depth, mask.scanlinePad, 2);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
301
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
302 /* Create the cursor */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
303 auto hInst = OS.GetModuleHandle(null);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
304 if (OS.IsWinCE) DWT.error (DWT.ERROR_NOT_IMPLEMENTED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
305 handle = OS.CreateCursor(hInst, hotspotX, hotspotY, source.width, source.height, sourceData.ptr, maskData.ptr);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
306 if (handle is null) DWT.error(DWT.ERROR_NO_HANDLES);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
307 if (device.tracking) device.new_Object(this);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
308 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
309
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
310 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
311 * Constructs a new cursor given a device, image data describing
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
312 * the desired cursor appearance, and the x and y coordinates of
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
313 * the <em>hotspot</em> (that is, the point within the area
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
314 * covered by the cursor which is considered to be where the
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
315 * on-screen pointer is "pointing").
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
316 * <p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
317 * You must dispose the cursor when it is no longer required.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
318 * </p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
319 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
320 * @param device the device on which to allocate the cursor
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
321 * @param source the image data for the cursor
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
322 * @param hotspotX the x coordinate of the cursor's hotspot
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
323 * @param hotspotY the y coordinate of the cursor's hotspot
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
324 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
325 * @exception IllegalArgumentException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
326 * <li>ERROR_NULL_ARGUMENT - if device is null and there is no current device</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
327 * <li>ERROR_NULL_ARGUMENT - if the image is null</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
328 * <li>ERROR_INVALID_ARGUMENT - if the hotspot is outside the bounds of the
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
329 * image</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
330 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
331 * @exception DWTError <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
332 * <li>ERROR_NO_HANDLES - if a handle could not be obtained for cursor creation</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
333 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
334 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
335 * @since 3.0
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
336 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
337 public this(Device device, ImageData source, int hotspotX, int hotspotY) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
338 if (device is null) device = Device.getDevice();
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
339 if (device is null) DWT.error(DWT.ERROR_NULL_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
340 this.device = device;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
341 if (source is null) DWT.error(DWT.ERROR_NULL_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
342 /* Check the hotspots */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
343 if (hotspotX >= source.width || hotspotX < 0 ||
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
344 hotspotY >= source.height || hotspotY < 0) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
345 DWT.error(DWT.ERROR_INVALID_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
346 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
347 ImageData mask = source.getTransparencyMask();
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
348 int[] result = Image.init(device, null, source, mask);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
349 auto hBitmap = cast(HBITMAP)result[0];
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
350 auto hMask = cast(HBITMAP)result[1];
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
351 /* Create the icon */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
352 ICONINFO info;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
353 info.fIcon = false;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
354 info.hbmColor = hBitmap;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
355 info.hbmMask = hMask;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
356 info.xHotspot = hotspotX;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
357 info.yHotspot = hotspotY;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
358 handle = OS.CreateIconIndirect(&info);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
359 if (handle is null) DWT.error(DWT.ERROR_NO_HANDLES);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
360 OS.DeleteObject(hBitmap);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
361 OS.DeleteObject(hMask);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
362 isIcon = true;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
363 if (device.tracking) device.new_Object(this);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
364 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
365
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
366 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
367 * Disposes of the operating system resources associated with
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
368 * the cursor. Applications must dispose of all cursors which
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
369 * they allocate.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
370 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
371 public void dispose () {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
372 if (handle is null) return;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
373 if (device.isDisposed()) return;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
374
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
375 /*
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
376 * It is an error in Windows to destroy the current
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
377 * cursor. Check that the cursor that is about to
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
378 * be destroyed is the current cursor. If so, set
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
379 * the current cursor to be IDC_ARROW. Note that
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
380 * Windows shares predefined cursors so the call to
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
381 * LoadCursor() does not leak.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
382 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
383 // TEMPORARY CODE
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
384 // if (OS.GetCursor() is handle) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
385 // OS.SetCursor(OS.LoadCursor(0, OS.IDC_ARROW));
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
386 // }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
387
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
388 if (isIcon) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
389 OS.DestroyIcon(handle);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
390 } else {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
391 /*
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
392 * The MSDN states that one should not destroy a shared
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
393 * cursor, that is, one obtained from LoadCursor.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
394 * However, it does not appear to do any harm, so rather
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
395 * than keep track of how a cursor was created, we just
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
396 * destroy them all. If this causes problems in the future,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
397 * put the flag back in.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
398 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
399 if (!OS.IsWinCE) OS.DestroyCursor(handle);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
400 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
401 handle = null;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
402 if (device.tracking) device.dispose_Object(this);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
403 device = null;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
404 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
405
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
406 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
407 * Compares the argument to the receiver, and returns true
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
408 * if they represent the <em>same</em> object using a class
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
409 * specific comparison.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
410 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
411 * @param object the object to compare with this object
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
412 * @return <code>true</code> if the object is the same as this object and <code>false</code> otherwise
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
413 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
414 * @see #hashCode
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
415 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
416 public override int opEquals (Object object) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
417 if (object is this) return true;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
418 if (!(cast(Cursor)object)) return false;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
419 Cursor cursor = cast(Cursor) object;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
420 return device is cursor.device && handle is cursor.handle;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
421 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
422
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
423 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
424 * Returns an integer hash code for the receiver. Any two
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
425 * objects that return <code>true</code> when passed to
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
426 * <code>equals</code> must return the same value for this
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
427 * method.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
428 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
429 * @return the receiver's hash
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
430 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
431 * @see #equals
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
432 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
433 public override hash_t toHash () {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
434 return cast(hash_t)handle;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
435 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
436
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
437 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
438 * Returns <code>true</code> if the cursor has been disposed,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
439 * and <code>false</code> otherwise.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
440 * <p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
441 * This method gets the dispose state for the cursor.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
442 * When a cursor has been disposed, it is an error to
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
443 * invoke any other method using the cursor.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
444 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
445 * @return <code>true</code> when the cursor is disposed and <code>false</code> otherwise
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
446 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
447 public bool isDisposed() {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
448 return handle is null;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
449 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
450
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
451 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
452 * Returns a string containing a concise, human-readable
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
453 * description of the receiver.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
454 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
455 * @return a string representation of the receiver
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
456 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
457 public char[] toString () {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
458 if (isDisposed()) return "Cursor {*DISPOSED*}";
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
459 return Format( "Cursor {{{}}", handle );
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
460 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
461
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
462 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
463 * Invokes platform specific functionality to allocate a new cursor.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
464 * <p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
465 * <b>IMPORTANT:</b> This method is <em>not</em> part of the public
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
466 * API for <code>Cursor</code>. It is marked public only so that it
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
467 * can be shared within the packages provided by DWT. It is not
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
468 * available on all platforms, and should never be called from
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
469 * application code.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
470 * </p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
471 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
472 * @param device the device on which to allocate the color
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
473 * @param handle the handle for the cursor
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
474 * @return a new cursor object containing the specified device and handle
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
475 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
476 public static Cursor win32_new(Device device, HCURSOR handle) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
477 if (device is null) device = Device.getDevice();
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
478 Cursor cursor = new Cursor();
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
479 cursor.handle = handle;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
480 cursor.device = device;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
481 return cursor;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
482 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
483
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
484 }