summaryrefslogtreecommitdiffstats
path: root/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/qt/org/eclipse/swt/dnd/TransferData.java
blob: cd59afd06a85900a7d94a648c01e2c88fa5a3a2b (plain)
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
/*******************************************************************************
 * Copyright (c) 2000, 2009 IBM Corporation and others.
 * Portion Copyright (c) 2009-2010 compeople AG (http://www.compeople.de).
 * 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
 *     Compeople AG	- QtJambi/Qt based implementation for Windows/Mac OS X/Linux
 *******************************************************************************/
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>
	 */
	public int type;

	// attributes specific to set/get
	Object data;
	String format;

	/**
	 * 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>
	 */
	//	int result;

	/*
	 * (non-Javadoc)
	 * 
	 * @see java.lang.Object#toString()
	 */
	@Override
	public String toString() {
		StringBuilder sb = new StringBuilder("TransferData {type: ");//$NON-NLS-1$
		sb.append(type);
		sb.append(", format: ");//$NON-NLS-1$
		sb.append(format);
		sb.append(", data: ");//$NON-NLS-1$
		sb.append(data);
		sb.append("}"); //$NON-NLS-1$
		return sb.toString();
	}

}