annotate dwt/graphics/Resource.d @ 10:63c023465156

moved from org.eclipse.swt to dwt
author Frank Benoit <benoit@tionex.de>
date Sat, 05 Jan 2008 17:58:37 +0100
parents ad2b69216039
children 4db14dc0bc45
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2005 IBM Corporation and others.
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
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 *******************************************************************************/
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
11 module dwt.graphics.Resource;
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 import dwt.SWT;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 //PORTING_TYPE
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 class Device{}
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 * This class is the abstract superclass of all graphics resource objects.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 * Resources created by the application must be disposed.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * <p>
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * IMPORTANT: This class is intended to be subclassed <em>only</em>
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * within the SWT implementation. However, it has not been marked
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * final to allow those outside of the SWT development team to implement
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * patched versions of the class in order to get around specific
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * limitations in advance of when those limitations can be addressed
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * by the team. Any class built using subclassing to access the internals
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * 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
29 * may be strongly platform specific. Subclassing should not be attempted
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * without an intimate and detailed understanding of the workings of the
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 * hierarchy. No support is provided for user-written classes which are
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * implemented as subclasses of this class.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * </p>
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * @see #dispose
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * @see #isDisposed
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * @since 3.1
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 public abstract class Resource {
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41
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 * the device where this resource was created
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 Device device;
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 * Disposes of the operating system resources associated with
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 * this resource. Applications must dispose of all resources
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * which they allocate.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 public abstract void dispose();
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 * Returns the <code>Device</code> where this resource was
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 * created.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 * @return <code>Device</code> the device of the receiver
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 * @since 3.2
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 public Device getDevice() {
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 Device device = this.device;
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 if (device is null || isDisposed ()) SWT.error (SWT.ERROR_GRAPHIC_DISPOSED);
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 return device;
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 * Returns <code>true</code> if the resource has been disposed,
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 * and <code>false</code> otherwise.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 * <p>
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 * This method gets the dispose state for the resource.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 * When a resource has been disposed, it is an error to
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 * invoke any other method using the resource.
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 * @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
77 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 public abstract bool isDisposed();
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 }