annotate dwt/dnd/TransferData.d @ 240:ce446666f5a2

Update to SWT 3.4M7
author Frank Benoit <benoit@tionex.de>
date Mon, 12 May 2008 19:13:01 +0200
parents 0f12f6bb9739
children c0d810de7093
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
240
ce446666f5a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 108
diff changeset
1 /*******************************************************************************
92
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2005 IBM Corporation and others.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
108
0f12f6bb9739 author notice
Frank Benoit <benoit@tionex.de>
parents: 92
diff changeset
10 * Port to the D programming language:
0f12f6bb9739 author notice
Frank Benoit <benoit@tionex.de>
parents: 92
diff changeset
11 * Frank Benoit <benoit@tionex.de>
92
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwt.dnd.TransferData;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 /**
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 * The <code>TransferData</code> class is a platform specific data structure for
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 * describing the type and the contents of data being converted by a transfer agent.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 *
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 * <p>As an application writer, you do not need to know the specifics of
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * TransferData. TransferData instances are passed to a subclass of Transfer
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * and the Transfer object manages the platform specific issues.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * You can ask a Transfer subclass if it can handle this data by calling
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * Transfer.isSupportedType(transferData).</p>
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 *
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * <p>You should only need to become familiar with the fields in this class if you
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * are implementing a Transfer subclass and you are unable to subclass the
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * ByteArrayTransfer class.</p>
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 */
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 public class TransferData {
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 /**
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * The type is a unique identifier of a system format or user defined format.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * (Warning: This field is platform dependent)
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * <p>
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * <b>IMPORTANT:</b> This field is <em>not</em> part of the DWT
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * public API. It is marked public only so that it can be shared
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * within the packages provided by DWT. It is not available on all
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * platforms and should never be accessed from application code.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * </p>
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 */
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 public void* type;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 /**
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 * Specifies the number of units in pValue.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 * (Warning: This field is platform dependent)
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 * <p>
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 * <b>IMPORTANT:</b> This field is <em>not</em> part of the DWT
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 * public API. It is marked public only so that it can be shared
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 * within the packages provided by DWT. It is not available on all
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * platforms and should never be accessed from application code.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 * </p>
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 *
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 * @see TransferData#format for the size of one unit
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 */
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 public int length;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 /**
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 * Specifies the size in bits of a single unit in pValue.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 * (Warning: This field is platform dependent)
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 * <p>
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 * <b>IMPORTANT:</b> This field is <em>not</em> part of the DWT
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 * public API. It is marked public only so that it can be shared
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 * within the packages provided by DWT. It is not available on all
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 * platforms and should never be accessed from application code.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 * </p>
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 *
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 * This is most commonly 8 bits.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 */
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 public int format;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 /**
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 * Pointer to the data being transferred.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 * (Warning: This field is platform dependent)
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 * <p>
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 * <b>IMPORTANT:</b> This field is <em>not</em> part of the DWT
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 * public API. It is marked public only so that it can be shared
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 * within the packages provided by DWT. It is not available on all
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 * platforms and should never be accessed from application code.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 * </p>
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 */
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 public char* pValue;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 /**
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 * The result field contains the result of converting a
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 * java data type into a platform specific value.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 * (Warning: This field is platform dependent)
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 * <p>
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 * <b>IMPORTANT:</b> This field is <em>not</em> part of the DWT
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 * public API. It is marked public only so that it can be shared
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 * within the packages provided by DWT. It is not available on all
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 * platforms and should never be accessed from application code.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 * </p>
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 * <p>The value of result is 1 if the conversion was successful.
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 * The value of result is 0 if the conversion failed.</p>
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 */
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 public int result;
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97
ddb19cb18d2e package dnd
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 }