diff options
author | Carolyn MacLeod <carolyn> | 2008-06-04 20:45:22 +0000 |
---|---|---|
committer | Carolyn MacLeod <carolyn> | 2008-06-04 20:45:22 +0000 |
commit | 45b394fe10eb1852268eed201cf431c4774b5428 (patch) | |
tree | 00ccb791c8930d127177c0034c8ee92863d9cedc /bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd | |
parent | 5ccbc836d63be99bd6e1cf9e6c2cc8027488f31c (diff) | |
download | eclipse.platform.swt-45b394fe10eb1852268eed201cf431c4774b5428.tar.gz eclipse.platform.swt-45b394fe10eb1852268eed201cf431c4774b5428.tar.xz eclipse.platform.swt-45b394fe10eb1852268eed201cf431c4774b5428.zip |
After Javadoc Bash for 3.4RC4
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd')
16 files changed, 56 insertions, 10 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/ByteArrayTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/ByteArrayTransfer.java index f8c44bc1da..f077436964 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/ByteArrayTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/ByteArrayTransfer.java @@ -115,6 +115,8 @@ import org.eclipse.swt.internal.gtk.*; * } * } * </code></pre> + * + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public abstract class ByteArrayTransfer extends Transfer { diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/Clipboard.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/Clipboard.java index 12ce73d1f0..759cd9db5e 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/Clipboard.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/Clipboard.java @@ -22,6 +22,10 @@ import org.eclipse.swt.widgets.Display; * application to another or within an application. * * <p>IMPORTANT: This class is <em>not</em> intended to be subclassed.</p> + * + * @see <a href="http://www.eclipse.org/swt/snippets/#clipboard">Clipboard snippets</a> + * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ClipboardExample</a> + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public class Clipboard { diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/DragSource.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/DragSource.java index 8a7a028ba1..ba2cf0cf9c 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/DragSource.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/DragSource.java @@ -92,6 +92,10 @@ import org.eclipse.swt.internal.gtk.*; * <dt><b>Styles</b></dt> <dd>DND.DROP_NONE, DND.DROP_COPY, DND.DROP_MOVE, DND.DROP_LINK</dd> * <dt><b>Events</b></dt> <dd>DND.DragStart, DND.DragSetData, DND.DragEnd</dd> * </dl> + * + * @see <a href="http://www.eclipse.org/swt/snippets/#dnd">Drag and Drop snippets</a> + * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: DNDExample</a> + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public class DragSource extends Widget { @@ -257,6 +261,7 @@ static DragSource FindDragSource(int /*long*/ handle) { * </ul> * * @see DragSourceListener + * @see #getDragListeners * @see #removeDragListener * @see DragSourceEvent */ @@ -388,6 +393,9 @@ public Control getControl () { * operation is in progress, by sending it one of the messages defined in * the <code>DragSourceListener</code> interface. * + * @return the listeners who will be notified when a drag and drop + * operation is in progress + * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> @@ -485,7 +493,7 @@ int osOpToOp(int osOperation){ * Removes the listener from the collection of listeners who will * be notified when a drag and drop operation is in progress. * - * @param listener the listener which should be notified + * @param listener the listener which should no longer be notified * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the listener is null</li> @@ -497,6 +505,7 @@ int osOpToOp(int osOperation){ * * @see DragSourceListener * @see #addDragListener + * @see #getDragListeners */ public void removeDragListener(DragSourceListener listener) { if (listener == null) DND.error (SWT.ERROR_NULL_ARGUMENT); diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/DropTarget.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/DropTarget.java index 1778506094..ea1192e98f 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/DropTarget.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/DropTarget.java @@ -67,6 +67,10 @@ import org.eclipse.swt.internal.gtk.*; * <dt><b>Events</b></dt> <dd>DND.DragEnter, DND.DragLeave, DND.DragOver, DND.DragOperationChanged, * DND.DropAccept, DND.Drop </dd> * </dl> + * + * @see <a href="http://www.eclipse.org/swt/snippets/#dnd">Drag and Drop snippets</a> + * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: DNDExample</a> + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public class DropTarget extends Widget { @@ -302,6 +306,7 @@ static DropTarget FindDropTarget(int /*long*/ handle) { * </ul> * * @see DropTargetListener + * @see #getDropListeners * @see #removeDropListener * @see DropTargetEvent */ @@ -509,6 +514,9 @@ public Control getControl () { * operation is in progress, by sending it one of the messages defined in * the <code>DropTargetListener</code> interface. * + * @return the listeners who will be notified when a drag and drop + * operation is in progress + * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> @@ -614,7 +622,7 @@ int osOpToOp(int osOperation){ * Removes the listener from the collection of listeners who will * be notified when a drag and drop operation is in progress. * - * @param listener the listener which should be notified + * @param listener the listener which should no longer be notified * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the listener is null</li> @@ -626,6 +634,7 @@ int osOpToOp(int osOperation){ * * @see DropTargetListener * @see #addDropListener + * @see #getDropListeners */ public void removeDropListener(DropTargetListener listener) { if (listener == null) DND.error (SWT.ERROR_NULL_ARGUMENT); diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/FileTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/FileTransfer.java index 737c00277c..7106f12d0a 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/FileTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/FileTransfer.java @@ -30,6 +30,8 @@ import org.eclipse.swt.internal.gtk.*; * fileData[0] = file1.getAbsolutePath(); * fileData[1] = file2.getAbsolutePath(); * </code></pre> + * + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public class FileTransfer extends ByteArrayTransfer { diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/HTMLTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/HTMLTransfer.java index 1d53ab5dff..65a149334e 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/HTMLTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/HTMLTransfer.java @@ -24,6 +24,8 @@ import org.eclipse.swt.internal.gtk.*; * <code><pre> * String htmlData = "<p>This is a paragraph of text.</p>"; * </code></pre> + * + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public class HTMLTransfer extends ByteArrayTransfer { diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/ImageTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/ImageTransfer.java index 992ec29e5d..360244a3e0 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/ImageTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/ImageTransfer.java @@ -29,6 +29,10 @@ import org.eclipse.swt.widgets.*; * Image image = new Image("C:\temp\img1.gif"); * ImageData imgData = image.getImageData(); * </code></pre> + * + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * + * @since 3.4 */ public class ImageTransfer extends ByteArrayTransfer { @@ -122,12 +126,12 @@ public void javaToNative(Object object, TransferData transferData) { /** * This implementation of <code>nativeToJava</code> converts a platform specific - * representation of an <code>ImageData</code> to java. + * representation of an image to java <code>ImageData</code>. * For additional information see <code>Transfer#nativeToJava</code>. * * @param transferData the platform specific representation of the data to be * been converted - * @return a java <code>ImageData</code> the imageData of the image if + * @return a java <code>ImageData</code> of the image if * conversion was successful; otherwise null */ public Object nativeToJava(TransferData transferData) { diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/RTFTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/RTFTransfer.java index 4e7caf2c67..f3de70bcbd 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/RTFTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/RTFTransfer.java @@ -25,6 +25,8 @@ import org.eclipse.swt.internal.gtk.*; * <code><pre> * String rtfData = "{\\rtf1{\\colortbl;\\red255\\green0\\blue0;}\\uc1\\b\\i Hello World}"; * </code></pre> + * + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public class RTFTransfer extends ByteArrayTransfer { diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TableDragSourceEffect.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TableDragSourceEffect.java index 24092f0eab..c681157bba 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TableDragSourceEffect.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TableDragSourceEffect.java @@ -29,6 +29,7 @@ import org.eclipse.swt.widgets.*; * * @see DragSourceEffect * @see DragSourceEvent + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.3 */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TableDropTargetEffect.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TableDropTargetEffect.java index ff9852adad..72d9f7a6a3 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TableDropTargetEffect.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TableDropTargetEffect.java @@ -40,6 +40,7 @@ import org.eclipse.swt.widgets.*; * * @see DropTargetAdapter * @see DropTargetEvent + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.3 */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TextTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TextTransfer.java index 70b394ed19..988351b5ed 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TextTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TextTransfer.java @@ -26,6 +26,7 @@ import org.eclipse.swt.internal.gtk.*; * </code></pre> * * @see Transfer + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public class TextTransfer extends ByteArrayTransfer { diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/Transfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/Transfer.java index 5e1fdee9c0..ed8d4958fa 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/Transfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/Transfer.java @@ -25,6 +25,9 @@ import org.eclipse.swt.internal.gtk.OS; * ByteArrayTransfer class.</p> * * @see ByteArrayTransfer + * @see <a href="http://www.eclipse.org/swt/snippets/#dnd">Drag and Drop snippets</a> + * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: DNDExample</a> + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public abstract class Transfer { diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TransferData.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TransferData.java index 3e2d976514..ca4c01afde 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TransferData.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TransferData.java @@ -24,6 +24,8 @@ package org.eclipse.swt.dnd; * <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 { /** diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TreeDragSourceEffect.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TreeDragSourceEffect.java index 750214182c..0a4890ec6a 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TreeDragSourceEffect.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TreeDragSourceEffect.java @@ -28,6 +28,7 @@ import org.eclipse.swt.widgets.*; * * @see DragSourceEffect * @see DragSourceEvent + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.3 */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TreeDropTargetEffect.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TreeDropTargetEffect.java index eaee2569b8..ea5af1b1f3 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TreeDropTargetEffect.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/TreeDropTargetEffect.java @@ -43,6 +43,7 @@ import org.eclipse.swt.widgets.*; * * @see DropTargetAdapter * @see DropTargetEvent + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.3 */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/URLTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/URLTransfer.java index b6821ec788..6dedda0e7d 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/URLTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/gtk/org/eclipse/swt/dnd/URLTransfer.java @@ -16,15 +16,17 @@ import org.eclipse.swt.internal.gtk.*; * The class <code>URLTransfer</code> provides a platform specific mechanism * for converting text in URL format represented as a java <code>String</code> * to a platform specific representation of the data and vice versa. See - * <code>Transfer</code> for additional information. The string - * must be a fully specified url. + * <code>Transfer</code> for additional information. The string + * must contain a fully specified url. * - * <p>An example of a java <code>String[]</code> containing a URL is shown + * <p>An example of a java <code>String</code> containing a URL is shown * below:</p> * * <code><pre> - * String urlData = "http://www.eclipse.org"; + * String url = "http://www.eclipse.org"; * </code></pre> + * + * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public class URLTransfer extends ByteArrayTransfer { @@ -46,7 +48,7 @@ public static URLTransfer getInstance () { } /** - * This implementation of <code>javaToNative</code> converts a URL + * This implementation of <code>javaToNative</code> converts a URL * represented by a java <code>String</code> to a platform specific representation. * For additional information see <code>Transfer#javaToNative</code>. * @@ -75,7 +77,7 @@ public void javaToNative (Object object, TransferData transferData){ /** * This implementation of <code>nativeToJava</code> converts a platform specific - * representation of a URL <code>String</code>. + * representation of a URL to a java <code>String</code>. * For additional information see <code>Transfer#nativeToJava</code>. * * @param transferData the platform specific representation of the data to be |