annotate dwt/graphics/Resource.d @ 259:c0d810de7093

Update SWT 3.4M7 to 3.4
author Frank Benoit <benoit@tionex.de>
date Sun, 29 Jun 2008 14:33:38 +0200
parents ce446666f5a2
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
72
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 71
diff changeset
1 /*******************************************************************************
259
c0d810de7093 Update SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 240
diff changeset
2 * Copyright (c) 2000, 2008 IBM Corporation and others.
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
72
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 71
diff changeset
10 * Port to the D programming language:
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 71
diff changeset
11 * Frank Benoit <benoit@tionex.de>
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
13 module dwt.graphics.Resource;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
15 import dwt.DWT;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16
18
92223a4ecca7 start of image port
Frank Benoit <benoit@tionex.de>
parents: 17
diff changeset
17 import dwt.graphics.Device;
33
27324bbbac70 changed to regenerated BCD bindings
Frank Benoit <benoit@tionex.de>
parents: 18
diff changeset
18 import dwt.internal.c.gdk;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * This class is the abstract superclass of all graphics resource objects.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * Resources created by the application must be disposed.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * <p>
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * IMPORTANT: This class is intended to be subclassed <em>only</em>
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
25 * within the DWT implementation. However, it has not been marked
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
26 * final to allow those outside of the DWT development team to implement
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * patched versions of the class in order to get around specific
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * limitations in advance of when those limitations can be addressed
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * by the team. Any class built using subclassing to access the internals
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * of this class will likely fail to compile or run between releases and
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 * may be strongly platform specific. Subclassing should not be attempted
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * without an intimate and detailed understanding of the workings of the
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * hierarchy. No support is provided for user-written classes which are
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * implemented as subclasses of this class.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * </p>
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * @see #dispose
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * @see #isDisposed
259
c0d810de7093 Update SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 240
diff changeset
39 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 * @since 3.1
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 public abstract class Resource {
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 33
diff changeset
45 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 33
diff changeset
46 * the device where this resource was created
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 33
diff changeset
47 */
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 33
diff changeset
48 Device device;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49
259
c0d810de7093 Update SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 240
diff changeset
50 public this() {
240
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
51 }
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
52
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
53 this(Device device) {
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
54 if (device is null) device = Device.getDevice();
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
55 if (device is null) DWT.error(DWT.ERROR_NULL_ARGUMENT);
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
56 this.device = device;
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
57 }
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
58
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
59 void destroy() {
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
60 }
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
61
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 * Disposes of the operating system resources associated with
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 * this resource. Applications must dispose of all resources
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 * which they allocate.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 */
240
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
67 public void dispose() {
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
68 if (device is null) return;
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
69 if (device.isDisposed()) return;
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
70 destroy();
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
71 if (device.tracking) device.dispose_Object(this);
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
72 device = null;
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
73 }
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 * Returns the <code>Device</code> where this resource was
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 * created.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 * @return <code>Device</code> the device of the receiver
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 * @since 3.2
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 public Device getDevice() {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 33
diff changeset
84 Device device = this.device;
71
295b29fc7d13 Renamed SWT to DWT
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
85 if (device is null || isDisposed ()) DWT.error (DWT.ERROR_GRAPHIC_DISPOSED);
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 33
diff changeset
86 return device;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88
240
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
89 void init_() {
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
90 if (device.tracking) device.new_Object(this);
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
91 }
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
92
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 * Returns <code>true</code> if the resource has been disposed,
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 * and <code>false</code> otherwise.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 * <p>
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 * This method gets the dispose state for the resource.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 * When a resource has been disposed, it is an error to
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 * invoke any other method using the resource.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 * @return <code>true</code> when the resource is disposed and <code>false</code> otherwise
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 public abstract bool isDisposed();
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 }