blob: 60d6bef3532a4e5b470abff8ab8e45392cf94f71 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
/*******************************************************************************
* Copyright (c) 2000, 2010 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.swt.dnd;
/**
* The <code>TransferData</code> class is a platform specific data structure for
* describing the type and the contents of data being converted by a transfer agent.
*
* <p>As an application writer, you do not need to know the specifics of
* TransferData. TransferData instances are passed to a subclass of Transfer
* and the Transfer object manages the platform specific issues.
* You can ask a Transfer subclass if it can handle this data by calling
* Transfer.isSupportedType(transferData).</p>
*
* <p>You should only need to become familiar with the fields in this class if you
* are implementing a Transfer subclass and you are unable to subclass the
* ByteArrayTransfer class.</p>
*
* @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
*/
public class TransferData {
/**
* The type is a unique identifier of a system format or user defined format.
* (Warning: This field is platform dependent)
* <p>
* <b>IMPORTANT:</b> This field is <em>not</em> part of the SWT
* public API. It is marked public only so that it can be shared
* within the packages provided by SWT. It is not available on all
* platforms and should never be accessed from application code.
* </p>
*
* @noreference This field is not intended to be referenced by clients.
*/
public int type;
/**
* Specifies the number of units in pValue.
* (Warning: This field is platform dependent)
* <p>
* <b>IMPORTANT:</b> This field is <em>not</em> part of the SWT
* public API. It is marked public only so that it can be shared
* within the packages provided by SWT. It is not available on all
* platforms and should never be accessed from application code.
* </p>
*
* @see TransferData#format for the size of one unit
*
* @noreference This field is not intended to be referenced by clients.
*/
public int length;
/**
* Specifies the size in bits of a single unit in pValue.
* (Warning: This field is platform dependent)
* <p>
* <b>IMPORTANT:</b> This field is <em>not</em> part of the SWT
* public API. It is marked public only so that it can be shared
* within the packages provided by SWT. It is not available on all
* platforms and should never be accessed from application code.
* </p>
*
* This is most commonly 8 bits.
*
* @noreference This field is not intended to be referenced by clients.
*/
public int format;
/**
* Pointer to the data being transferred.
* (Warning: This field is platform dependent)
* <p>
* <b>IMPORTANT:</b> This field is <em>not</em> part of the SWT
* public API. It is marked public only so that it can be shared
* within the packages provided by SWT. It is not available on all
* platforms and should never be accessed from application code.
* </p>
*
* @noreference This field is not intended to be referenced by clients.
*/
public int pValue;
/**
* The result field contains the result of converting a
* java data type into a platform specific value.
* (Warning: This field is platform dependent)
* <p>
* <b>IMPORTANT:</b> This field is <em>not</em> part of the SWT
* public API. It is marked public only so that it can be shared
* within the packages provided by SWT. It is not available on all
* platforms and should never be accessed from application code.
* </p>
* <p>The value of result is 1 if the conversion was successful.
* The value of result is 0 if the conversion failed.</p>
*
* @noreference This field is not intended to be referenced by clients.
*/
public int result;
}
|
