# HG changeset patch
# User Frank Benoit
ST.BULLET_DOT
ST.BULLET_NUMBER
ST.BULLET_LETTER_LOWER
ST.BULLET_LETTER_UPPER
ST.BULLET_TEXT
ST.BULLET_CUSTOM
ST.BULLET_DOT
.
* The style must have a glyph metrics set.
*
* @param style the style
@@ -61,6 +82,7 @@
* Create a new bullet the specified style and type.
* The style must have a glyph metrics set.
*
+ * @param type the bullet type
* @param style the style
*
* @exception IllegalArgumentException * IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see DWT Example: CustomControlExample + * @see Sample code and further information */ public class CLabel : Canvas { diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/CTabFolder.d --- a/dwt/custom/CTabFolder.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/custom/CTabFolder.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -78,6 +78,10 @@ ** IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see CTabFolder, CTabItem snippets + * @see DWT Example: CustomControlExample + * @see Sample code and further information */ public class CTabFolder : Composite { @@ -2397,7 +2401,7 @@ /** * Removes the listener. * - * @param listener the listener + * @param listener the listener which should no longer be notified * * @exception IllegalArgumentExceptionCTabFolderListener
interface.
+ *
+ * @see CTabFolderListener
+ * @see CTabFolderEvent
+ * @see Sample code and further information
+ */
public class CTabFolderAdapter : CTabFolderListener {
public void itemClosed(CTabFolderEvent event){}
}
diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/CTabFolderEvent.d
--- a/dwt/custom/CTabFolderEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/custom/CTabFolderEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2006 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -22,7 +22,9 @@
import tango.util.Convert;
/**
+ * This event is sent when an event is generated in the CTabFolder.
*
+ * @see Sample code and further information
*/
public class CTabFolderEvent : TypedEvent {
/**
diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/CTabItem.d
--- a/dwt/custom/CTabItem.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/custom/CTabItem.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -45,6 +45,9 @@
* * IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see CTabFolder, CTabItem snippets + * @see Sample code and further information */ public class CTabItem : Item { CTabFolder parent; diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/ControlEditor.d --- a/dwt/custom/ControlEditor.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/custom/ControlEditor.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -66,6 +66,8 @@ * editor.minimumHeight = size.y; * editor.setEditor (button); * +* +* @see Sample code and further information */ public class ControlEditor { diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/DefaultContent.d --- a/dwt/custom/DefaultContent.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/custom/DefaultContent.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -733,7 +733,8 @@ * Removes the specifiedTextChangeListener
.
* * - * @param listener the listener + * @param listener the listener which should no longer be notified + * * @exception IllegalArgumentException
diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/LineBackgroundEvent.d
--- a/dwt/custom/LineBackgroundEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/custom/LineBackgroundEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2005 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -21,6 +21,8 @@
/**
* This event is sent when a line is about to be drawn.
+ *
+ * @see Sample code and further information
*/
public class LineBackgroundEvent : TypedEvent {
@@ -41,6 +43,12 @@
static final long serialVersionUID = 3978711687853324342L;
+/**
+ * Constructs a new instance of this class based on the
+ * information in the given event.
+ *
+ * @param e the event containing the information
+ */
public this(StyledTextEvent e) {
super(cast(Object)e);
lineOffset = e.detail;
diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/LineBackgroundListener.d
--- a/dwt/custom/LineBackgroundListener.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/custom/LineBackgroundListener.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2005 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -15,6 +15,14 @@
import dwt.internal.DWTEventListener;
import dwt.custom.LineBackgroundEvent;
+/**
+ * Classes which implement this interface provide a method
+ * that can provide the background color for a line that
+ * is to be drawn.
+ *
+ * @see LineBackgroundEvent
+ * @see Sample code and further information
+ */
public interface LineBackgroundListener : DWTEventListener {
/**
diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/LineStyleEvent.d
--- a/dwt/custom/LineStyleEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/custom/LineStyleEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2006 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -21,6 +21,8 @@
/**
* This event is sent when a line is about to be drawn.
+ *
+ * @see Sample code and further information
*/
public class LineStyleEvent : TypedEvent {
@@ -87,6 +89,12 @@
static final long serialVersionUID = 3906081274027192884L;
+/**
+ * Constructs a new instance of this class based on the
+ * information in the given event.
+ *
+ * @param e the event containing the information
+ */
public this(StyledTextEvent e) {
super(cast(Object)e);
styles = e.styles;
diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/LineStyleListener.d
--- a/dwt/custom/LineStyleListener.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/custom/LineStyleListener.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2005 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -15,7 +15,16 @@
import dwt.internal.DWTEventListener;
import dwt.custom.LineStyleEvent;
+/**
+ * Classes which implement this interface provide a method
+ * that can provide the style information for a line that
+ * is to be drawn.
+ *
+ * @see LineStyleEvent
+ * @see Sample code and further information
+ */
public interface LineStyleListener : DWTEventListener {
+
/**
* This method is called when a line is about to be drawn in order to get the
* line's style information.
diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/MovementEvent.d
--- a/dwt/custom/MovementEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/custom/MovementEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -21,6 +21,8 @@
* This event is sent when a new offset is required based on the current
* offset and a movement type.
*
+ * @see Sample code and further information
+ *
* @since 3.3
*/
public class MovementEvent : TypedEvent {
@@ -58,6 +60,12 @@
static final long serialVersionUID = 3978765487853324342L;
+/**
+ * Constructs a new instance of this class based on the
+ * information in the given event.
+ *
+ * @param e the event containing the information
+ */
public this(StyledTextEvent e) {
super(cast(Object)e);
lineOffset = e.detail;
diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/PaintObjectEvent.d
--- a/dwt/custom/PaintObjectEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/custom/PaintObjectEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2006 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -22,6 +22,8 @@
/**
* This event is sent when an object needs to be drawn.
*
+ * @see Sample code and further information
+ *
* @since 3.2
*/
public class PaintObjectEvent : TypedEvent {
@@ -68,6 +70,12 @@
static final long serialVersionUID = 3906081274027192855L;
+/**
+ * Constructs a new instance of this class based on the
+ * information in the given event.
+ *
+ * @param e the event containing the information
+ */
public this(StyledTextEvent e) {
super(cast(Object)e);
gc = e.gc;
diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/PopupList.d
--- a/dwt/custom/PopupList.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/custom/PopupList.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -31,6 +31,7 @@
import dwt.widgets.List;
import dwt.widgets.Listener;
import dwt.widgets.Shell;
+
/**
* A PopupList is a list of selectable items that appears in its own shell positioned above
* its parent shell. It is used for selecting items when editing a Table cell (similar to the
@@ -39,6 +40,8 @@
* The list will be positioned so that it does not run off the screen and the largest number of items
* are visible. It may appear above the current cursor location or below it depending how close you
* are to the edge of the screen.
+*
+* @see Sample code and further information
*/
public class PopupList {
Shell shell;
diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/ST.d
--- a/dwt/custom/ST.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/custom/ST.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2006 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -15,6 +15,8 @@
/**
* This class provides access to the public constants provided by StyledText
.
+ *
+ * @see Sample code and further information
*/
public class ST {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/SashForm.d
--- a/dwt/custom/SashForm.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/custom/SashForm.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -40,9 +40,16 @@
*
true
if the receiver automatically scrolls to a focused child control
* to make it visible. Otherwise, returns false
.
*
+ * @return a bool indicating whether focused child controls are automatically scrolled into the viewport
+ *
* @exception DWTException StyleRange
defines a set of styles for a specified
+ * range of text.
+ * + * The hashCode() method in this class uses the values of the public + * fields to compute the hash value. When storing instances of the + * class in hashed collections, do not modify these fields after the + * object has been inserted. + *
+ * + * @see Sample code and further information + */ public class StyleRange : TextStyle, CloneableCompatibility { /** @@ -67,9 +79,9 @@ /** * Create a new style range from an existing text style. * - *@param style the text style to copy + * @param style the text style to copy * - *@since 3.4 + * @since 3.4 */ public this(TextStyle style) { super(style); diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/StyledText.d --- a/dwt/custom/StyledText.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/custom/StyledText.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -143,6 +143,10 @@ ** IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see StyledText snippets + * @see DWT Examples: CustomControlExample, TextEditor + * @see Sample code and further information */ public class StyledText : Canvas { alias Canvas.computeSize computeSize; @@ -196,8 +200,8 @@ Point doubleClickSelection; // selection after last mouse double click bool editable = true; bool wordWrap = false; - bool doubleClickEnabled = true; // see getDoubleClickEnabled - bool overwrite = false; // insert/overwrite edit mode + bool doubleClickEnabled = true; // see getDoubleClickEnabled + bool overwrite = false; // insert/overwrite edit mode int textLimit = -1; // limits the number of characters the user can type in the widget. Unlimited by default. int[int] keyActionMap; Color background = null; // workaround for bug 4791 @@ -213,7 +217,7 @@ int lastTextChangeReplaceCharCount; int lastLineBottom; // the bottom pixel of the last line been replaced bool isMirrored_; - bool bidiColoring = false; // apply the BIDI algorithm on text segments of the same color + bool bidiColoring = false; // apply the BIDI algorithm on text segments of the same color Image leftCaretBitmap = null; Image rightCaretBitmap = null; int caretDirection = DWT.NULL; @@ -262,9 +266,9 @@ int endPage; // last page to print int startLine; // first (wrapped) line to print int endLine; // last (wrapped) line to print - bool singleLine; // widget single line mode + bool singleLine; // widget single line mode Point selection = null; // selected text - bool mirrored; // indicates the printing gc should be mirrored + bool mirrored; // indicates the printing gc should be mirrored int lineSpacing; int printMargin; @@ -3819,6 +3823,8 @@ * lineIndex is lineCount it returns the bottom pixel of the last line. * It means this function can be used to retrieve the bottom pixel of any line. * + * @return the top pixel of a given line index + * * @since 3.2 */ public int getLinePixel(int lineIndex) { @@ -3845,6 +3851,10 @@ /** * Returns the line index for a y, relative to the client area. * The line index returned is always in the range 0..lineCount - 1. + * + * @param y the y-coordinate pixel + * + * @return the line index for a given y-coordinate pixel * * @since 3.2 */ @@ -5121,13 +5131,14 @@ int length = text.length; if (length is ime.getCommitCount()) { content.replaceTextRange(start, end - start, ""); - caretOffset = start; + caretOffset = ime.getCompositionOffset(); caretWidth = 0; caretDirection = DWT.NULL; } else { content.replaceTextRange(start, end - start, text); caretOffset = ime.getCaretOffset(); if (ime.getWideCaret()) { + start = ime.getCompositionOffset(); int lineIndex = getCaretLine(); int lineOffset = content.getOffsetAtLine(lineIndex); TextLayout layout = renderer.getTextLayout(lineIndex); @@ -5511,7 +5522,6 @@ int newLastLineBottom = getLinePixel(lastLine + 1); if (lastLineBottom !is newLastLineBottom) { super.redraw(); - if (wordWrap) setCaretLocation(); } else { super.redraw(0, firstLineTop, clientAreaWidth, newLastLineBottom - firstLineTop, false); redrawLinesBullet(renderer.redrawLines); @@ -6058,6 +6068,9 @@ * * * @param printer the printer to print to + * + * @return aRunnable
for printing the receiver's text
+ *
* @exception DWTException Runnable
for printing the receiver's text
+ *
* @exception DWTException * - * @param listener the listener + * @param listener the listener which should no longer be notified + * * @exception IllegalArgumentException
TableItem
that is to be edited.
+*
+* @param item the item to be edited
+*/
public void setItem (TableItem item) {
this.item = item;
resize();
diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/TableTreeItem.d
--- a/dwt/custom/TableTreeItem.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/custom/TableTreeItem.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/TextChangedEvent.d
--- a/dwt/custom/TextChangedEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/custom/TextChangedEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2004 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -17,6 +17,8 @@
/**
* This event is sent by the StyledTextContent implementor when a change to
* the text occurs.
+ *
+ * @see Sample code and further information
*/
public class TextChangedEvent : TypedEvent {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/TextChangingEvent.d
--- a/dwt/custom/TextChangingEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/custom/TextChangingEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2004 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -22,6 +22,8 @@
/**
* This event is sent by the StyledTextContent implementor when a change
* to the text is about to occur.
+ *
+ * @see Sample code and further information
*/
public class TextChangingEvent : TypedEvent {
/**
diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/TreeEditor.d
--- a/dwt/custom/TreeEditor.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/custom/TreeEditor.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -79,6 +79,9 @@
* }
* });
*
+*
+* @see TreeEditor snippets
+* @see Sample code and further information
*/
public class TreeEditor : ControlEditor {
@@ -275,6 +278,11 @@
resize();
}
+/**
+* Specifies the TreeItem
that is to be edited.
+*
+* @param item the item to be edited
+*/
public void setItem (TreeItem item) {
this.item = item;
resize();
diff -r cc1d3de0e80b -r c0d810de7093 dwt/custom/VerifyKeyListener.d
--- a/dwt/custom/VerifyKeyListener.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/custom/VerifyKeyListener.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2005 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -16,6 +16,14 @@
import dwt.events.VerifyEvent;
import dwt.internal.DWTEventListener;
+/**
+ * Classes which implement this interface provide a method
+ * that deals with the event that is generated when a
+ * key is pressed.
+ *
+ * @see VerifyEvent
+ * @see Sample code and further information
+ */
public interface VerifyKeyListener : DWTEventListener {
/**
* The following event fields are used:* IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see Sample code and further information */ public class ViewForm : Composite { diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/ByteArrayTransfer.d --- a/dwt/dnd/ByteArrayTransfer.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/dnd/ByteArrayTransfer.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -21,8 +21,7 @@ /** * The classByteArrayTransfer
provides a platform specific
* mechanism for converting a java byte[]
to a platform
- * specific representation of the byte array and vice versa. See
- * Transfer
for additional information.
+ * specific representation of the byte array and vice versa.
*
* ByteArrayTransfer
is never used directly but is sub-classed
* by transfer agents that convert between data in a java format such as a
@@ -121,6 +120,8 @@
* }
* }
*
+ *
+ * @see Transfer
*/
public abstract class ByteArrayTransfer : Transfer {
@@ -145,14 +146,13 @@
/**
* This implementation of javaToNative
converts a java
- * byte[]
to a platform specific representation. For additional
- * information see Transfer#javaToNative
.
- *
- * @see Transfer#javaToNative
- *
+ * byte[]
to a platform specific representation.
+ *
* @param object a java byte[]
containing the data to be converted
- * @param transferData an empty TransferData
object; this
- * object will be filled in on return with the platform specific format of the data
+ * @param transferData an empty TransferData
object that will
+ * be filled in on return with the platform specific format of the data
+ *
+ * @see Transfer#nativeToJava
*/
protected override void javaToNative (Object object, TransferData transferData) {
transferData.result = 0;
@@ -173,14 +173,12 @@
/**
* This implementation of nativeToJava
converts a platform specific
* representation of a byte array to a java byte[]
.
- * For additional information see Transfer#nativeToJava
.
- *
- * @see Transfer#nativeToJava
*
- * @param transferData the platform specific representation of the data to be
- * been converted
- * @return a java byte[]
containing the converted data if the
- * conversion was successful; otherwise null
+ * @param transferData the platform specific representation of the data to be converted
+ * @return a java byte[]
containing the converted data if the conversion was
+ * successful; otherwise null
+ *
+ * @see Transfer#javaToNative
*/
protected override Object nativeToJava(TransferData transferData) {
if ( !isSupportedType(transferData) || transferData.pValue is null) return null;
diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/Clipboard.d
--- a/dwt/dnd/Clipboard.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/dnd/Clipboard.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -35,6 +35,10 @@
* application to another or within an application.
*
*
IMPORTANT: This class is not intended to be subclassed.
+ * + * @see Clipboard snippets + * @see DWT Example: ClipboardExample + * @see Sample code and further information */ public class Clipboard { diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/DND.d --- a/dwt/dnd/DND.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/dnd/DND.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -26,6 +26,7 @@ * Class DND contains all the constants used in defining a * DragSource or a DropTarget. * + * @see Sample code and further information */ public class DND { diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/DragSource.d --- a/dwt/dnd/DragSource.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/dnd/DragSource.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -115,6 +115,10 @@ *DragSourceListener
interface.
*
+ * @return the listeners who will be notified when a drag and drop
+ * operation is in progress
+ *
* @exception DWTException dragStart
permits the drag operation to start.
- * For additional information see DragSourceListener.dragStart
.
- */
- public void dragStart(DragSourceEvent event){}
- /**
- * This implementation of dragFinished
does nothing.
- * For additional information see DragSourceListener.dragFinished
.
- */
- public void dragFinished(DragSourceEvent event){}
- /**
- * This implementation of dragSetData
does nothing.
- * For additional information see DragSourceListener.dragSetData
.
- */
- public void dragSetData(DragSourceEvent event){}
+
+/**
+ * This implementation of dragStart
permits the drag operation to start.
+ * For additional information see DragSourceListener.dragStart
.
+ *
+ * @param event the information associated with the drag start event
+ */
+public void dragStart(DragSourceEvent event){}
+
+/**
+ * This implementation of dragFinished
does nothing.
+ * For additional information see DragSourceListener.dragFinished
.
+ *
+ * @param event the information associated with the drag finished event
+ */
+public void dragFinished(DragSourceEvent event){}
+
+/**
+ * This implementation of dragSetData
does nothing.
+ * For additional information see DragSourceListener.dragSetData
.
+ *
+ * @param event the information associated with the drag set data event
+ */
+public void dragSetData(DragSourceEvent event){}
+
}
diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/DragSourceEffect.d
--- a/dwt/dnd/DragSourceEffect.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/dnd/DragSourceEffect.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2007 IBM Corporation and others.
+ * Copyright (c) 2007, 2008 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
@@ -36,6 +36,7 @@
*
* @see DragSourceAdapter
* @see DragSourceEvent
+ * @see Sample code and further information
*
* @since 3.3
*/
diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/DragSourceEvent.d
--- a/dwt/dnd/DragSourceEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/dnd/DragSourceEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -23,6 +23,7 @@
* The DragSourceEvent contains the event information passed in the methods of the DragSourceListener.
*
* @see DragSourceListener
+ * @see Sample code and further information
*/
public class DragSourceEvent : TypedEvent {
/**
diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/DropTarget.d
--- a/dwt/dnd/DropTarget.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/dnd/DropTarget.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -92,6 +92,10 @@
* DropTargetListener
interface.
*
+ * @return the listeners who will be notified when a drag and drop
+ * operation is in progress
+ *
* @exception DWTException event.detail
to be performed on the current data type
* defined in event.currentDataType
.
* For additional information see DropTargetListener.dragEnter
.
+ *
+ * @param event the information associated with the drag enter event
*/
public void dragEnter(DropTargetEvent event){}
+
/**
* This implementation of dragLeave
does nothing.
* For additional information see DropTargetListener.dragOperationChanged
.
+ *
+ * @param event the information associated with the drag leave event
*/
public void dragLeave(DropTargetEvent event){}
+
/**
* This implementation of dragOperationChanged
permits the default
* operation defined in event.detail
to be performed on the current data type
* defined in event.currentDataType
.
* For additional information see DropTargetListener.dragOperationChanged
.
+ *
+ * @param event the information associated with the drag operation changed event
*/
public void dragOperationChanged(DropTargetEvent event){}
+
/**
* This implementation of dragOver
permits the default
* operation defined in event.detail
to be performed on the current data type
* defined in event.currentDataType
.
* For additional information see DropTargetListener.dragOver
.
+ *
+ * @param event the information associated with the drag over event
*/
public void dragOver(DropTargetEvent event){}
+
/**
* This implementation of drop
does nothing.
* For additional information see DropTargetListener.drop
.
+ *
+ * @param event the information associated with the drop event
*/
public void drop(DropTargetEvent event){}
+
/**
* This implementation of dropAccept
permits the default
* operation defined in event.detail
to be performed on the current data type
* defined in event.currentDataType
.
* For additional information see DropTargetListener.dropAccept
.
+ *
+ * @param event the information associated with the drop accept event
*/
public void dropAccept(DropTargetEvent event){}
diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/DropTargetEffect.d
--- a/dwt/dnd/DropTargetEffect.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/dnd/DropTargetEffect.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2007 IBM Corporation and others.
+ * Copyright (c) 2007, 2008 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
@@ -54,6 +54,7 @@
*
* @see DropTargetAdapter
* @see DropTargetEvent
+ * @see Sample code and further information
*
* @since 3.3
*/
diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/DropTargetEvent.d
--- a/dwt/dnd/DropTargetEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/dnd/DropTargetEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -21,6 +21,8 @@
/**
* The DropTargetEvent contains the event information passed in the methods of the DropTargetListener.
+ *
+ * @see Sample code and further information
*/
public class DropTargetEvent : TypedEvent {
/**
diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/FileTransfer.d
--- a/dwt/dnd/FileTransfer.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/dnd/FileTransfer.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2005 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -24,7 +24,6 @@
* platform specific representation of the data and vice versa.
* Each String
in the array contains the absolute path for a single
* file or directory.
- * See Transfer
for additional information.
*
* An example of a java String[]
containing a list of files is shown
* below:
javaToNative
converts a list of file names
* represented by a java String[]
to a platform specific representation.
* Each String
in the array contains the absolute path for a single
- * file or directory. For additional information see
- * Transfer#javaToNative
.
- *
- * @param object a java String[]
containing the file names to be
- * converted
- * @param transferData an empty TransferData
object; this
- * object will be filled in on return with the platform specific format of the data
+ * file or directory.
+ *
+ * @param object a java String[]
containing the file names to be converted
+ * @param transferData an empty TransferData
object that will
+ * be filled in on return with the platform specific format of the data
+ *
+ * @see Transfer#nativeToJava
*/
public override void javaToNative(Object object, TransferData transferData) {
transferData.result = 0;
@@ -116,12 +117,12 @@
* This implementation of nativeToJava
converts a platform specific
* representation of a list of file names to a java String[]
.
* Each String in the array contains the absolute path for a single file or directory.
- * For additional information see Transfer#nativeToJava
.
*
- * @param transferData the platform specific representation of the data to be
- * been converted
- * @return a java String[]
containing a list of file names if the
- * conversion was successful; otherwise null
+ * @param transferData the platform specific representation of the data to be converted
+ * @return a java String[]
containing a list of file names if the conversion
+ * was successful; otherwise null
+ *
+ * @see Transfer#javaToNative
*/
public override Object nativeToJava(TransferData transferData) {
if ( !isSupportedType(transferData) || transferData.pValue is null || transferData.length <= 0 ) return null;
diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/HTMLTransfer.d
--- a/dwt/dnd/HTMLTransfer.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/dnd/HTMLTransfer.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2005 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -23,8 +23,7 @@
/**
* The class HTMLTransfer
provides a platform specific mechanism
* for converting text in HTML format represented as a java String
- * to a platform specific representation of the data and vice versa. See
- * Transfer
for additional information.
+ * to a platform specific representation of the data and vice versa.
*
* An example of a java String
containing HTML text is shown
* below:
* String htmlData = "This is a paragraph of text.
";
*
+ *
+ * @see Transfer
*/
public class HTMLTransfer : ByteArrayTransfer {
@@ -61,11 +62,12 @@
/**
* This implementation of javaToNative
converts HTML-formatted text
* represented by a java String
to a platform specific representation.
- * For additional information see Transfer#javaToNative
.
*
* @param object a java String
containing HTML text
- * @param transferData an empty TransferData
object; this
- * object will be filled in on return with the platform specific format of the data
+ * @param transferData an empty TransferData
object that will
+ * be filled in on return with the platform specific format of the data
+ *
+ * @see Transfer#nativeToJava
*/
public override void javaToNative (Object object, TransferData transferData){
transferData.result = 0;
@@ -85,12 +87,12 @@
/**
* This implementation of nativeToJava
converts a platform specific
* representation of HTML text to a java String
.
- * For additional information see Transfer#nativeToJava
.
*
- * @param transferData the platform specific representation of the data to be
- * been converted
- * @return a java String
containing HTML text if the
- * conversion was successful; otherwise null
+ * @param transferData the platform specific representation of the data to be converted
+ * @return a java String
containing HTML text if the conversion was successful;
+ * otherwise null
+ *
+ * @see Transfer#javaToNative
*/
public override Object nativeToJava(TransferData transferData){
if ( !isSupportedType(transferData) || transferData.pValue is null ) return null;
diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/ImageTransfer.d
--- a/dwt/dnd/ImageTransfer.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/dnd/ImageTransfer.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2004 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -24,17 +24,19 @@
/**
* The class ImageTransfer
provides a platform specific mechanism
- * for converting a Image represented as a java ImageData
to a
+ * for converting an Image represented as a java ImageData
to a
* platform specific representation of the data and vice versa.
- * See Transfer
for additional information.
*
- * An example of a java ImageData
is shown
- * below:
An example of a java ImageData
is shown below:
- * Image image = new Image("C:\temp\img1.gif");
+ * Image image = new Image(display, "C:\temp\img1.gif");
* ImageData imgData = image.getImageData();
*
+ *
+ * @see Transfer
+ *
+ * @since 3.4
*/
public class ImageTransfer : ByteArrayTransfer {
@@ -93,12 +95,12 @@
/**
* This implementation of javaToNative
converts an ImageData object represented
* by java ImageData
to a platform specific representation.
- * For additional information see Transfer#javaToNative
.
*
- * @param object a java ImageData
containing the ImageData to be
- * converted
- * @param transferData an empty TransferData
object; this
- * object will be filled in on return with the platform specific format of the data
+ * @param object a java ImageData
containing the ImageData to be converted
+ * @param transferData an empty TransferData
object that will
+ * be filled in on return with the platform specific format of the data
+ *
+ * @see Transfer#nativeToJava
*/
public void javaToNative(Object object, TransferData transferData) {
if (!checkImage(object) || !isSupportedType(transferData)) {
@@ -144,13 +146,13 @@
/**
* This implementation of nativeToJava
converts a platform specific
- * representation of an ImageData
to java.
- * For additional information see Transfer#nativeToJava
.
- *
- * @param transferData the platform specific representation of the data to be
- * been converted
- * @return a java ImageData
the imageData of the image if
- * conversion was successful; otherwise null
+ * representation of an image to java ImageData
.
+ *
+ * @param transferData the platform specific representation of the data to be converted
+ * @return a java ImageData
of the image if the conversion was successful;
+ * otherwise null
+ *
+ * @see Transfer#javaToNative
*/
public Object nativeToJava(TransferData transferData) {
ImageData imgData = null;
diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/RTFTransfer.d
--- a/dwt/dnd/RTFTransfer.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/dnd/RTFTransfer.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2005 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -24,8 +24,7 @@
/**
* The class RTFTransfer
provides a platform specific mechanism
* for converting text in RTF format represented as a java String
- * to a platform specific representation of the data and vice versa. See
- * Transfer
for additional information.
+ * to a platform specific representation of the data and vice versa.
*
* An example of a java String
containing RTF text is shown
* below:
* String rtfData = "{\\rtf1{\\colortbl;\\red255\\green0\\blue0;}\\uc1\\b\\i Hello World}";
*
+ *
+ * @see Transfer
*/
public class RTFTransfer : ByteArrayTransfer {
@@ -65,11 +66,12 @@
/**
* This implementation of javaToNative
converts RTF-formatted text
* represented by a java String
to a platform specific representation.
- * For additional information see Transfer#javaToNative
.
*
* @param object a java String
containing RTF text
- * @param transferData an empty TransferData
object; this
- * object will be filled in on return with the platform specific format of the data
+ * @param transferData an empty TransferData
object that will
+ * be filled in on return with the platform specific format of the data
+ *
+ * @see Transfer#nativeToJava
*/
public override void javaToNative (Object object, TransferData transferData){
transferData.result = 0;
@@ -90,12 +92,12 @@
/**
* This implementation of nativeToJava
converts a platform specific
* representation of RTF text to a java String
.
- * For additional information see Transfer#nativeToJava
.
*
- * @param transferData the platform specific representation of the data to be
- * been converted
- * @return a java String
containing RTF text if the
- * conversion was successful; otherwise null
+ * @param transferData the platform specific representation of the data to be converted
+ * @return a java String
containing RTF text if the conversion was successful;
+ * otherwise null
+ *
+ * @see Transfer#javaToNative
*/
public override Object nativeToJava(TransferData transferData){
if ( !isSupportedType(transferData) || transferData.pValue is null ) return null;
diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/TableDragSourceEffect.d
--- a/dwt/dnd/TableDragSourceEffect.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/dnd/TableDragSourceEffect.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -37,6 +37,7 @@
*
* @see DragSourceEffect
* @see DragSourceEvent
+ * @see Sample code and further information
*
* @since 3.3
*/
diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/TableDropTargetEffect.d
--- a/dwt/dnd/TableDropTargetEffect.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/dnd/TableDropTargetEffect.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -48,6 +48,7 @@
*
* @see DropTargetAdapter
* @see DropTargetEvent
+ * @see Sample code and further information
*
* @since 3.3
*/
diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/TextTransfer.d
--- a/dwt/dnd/TextTransfer.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/dnd/TextTransfer.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2006 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -67,10 +67,10 @@
* represented by a java String
to a platform specific representation.
*
* @param object a java String
containing text
- * @param transferData an empty TransferData
object; this object
- * will be filled in on return with the platform specific format of the data
+ * @param transferData an empty TransferData
object that will
+ * be filled in on return with the platform specific format of the data
*
- * @see Transfer#javaToNative
+ * @see Transfer#nativeToJava
*/
override public void javaToNative (Object object, TransferData transferData) {
transferData.result = 0;
@@ -121,7 +121,7 @@
* @param transferData the platform specific representation of the data to be converted
* @return a java String
containing text if the conversion was successful; otherwise null
*
- * @see Transfer#nativeToJava
+ * @see Transfer#javaToNative
*/
override public Object nativeToJava(TransferData transferData){
if (!isSupportedType(transferData) || transferData.pValue is null) return null;
diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/Transfer.d
--- a/dwt/dnd/Transfer.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/dnd/Transfer.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -31,6 +31,9 @@
* ByteArrayTransfer class.
*
* @see ByteArrayTransfer
+ * @see Drag and Drop snippets
+ * @see DWT Example: DNDExample
+ * @see Sample code and further information
*/
public abstract class Transfer {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/TransferData.d
--- a/dwt/dnd/TransferData.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/dnd/TransferData.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2005 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -26,6 +26,8 @@
* 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.
+ * + * @see Sample code and further information */ public class TransferData { /** diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/TreeDragSourceEffect.d --- a/dwt/dnd/TreeDragSourceEffect.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/dnd/TreeDragSourceEffect.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -36,6 +36,7 @@ * * @see DragSourceEffect * @see DragSourceEvent + * @see Sample code and further information * * @since 3.3 */ diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/TreeDropTargetEffect.d --- a/dwt/dnd/TreeDropTargetEffect.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/dnd/TreeDropTargetEffect.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -50,6 +50,7 @@ * * @see DropTargetAdapter * @see DropTargetEvent + * @see Sample code and further information * * @since 3.3 */ diff -r cc1d3de0e80b -r c0d810de7093 dwt/dnd/URLTransfer.d --- a/dwt/dnd/URLTransfer.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/dnd/URLTransfer.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2007 IBM Corporation and others. + * Copyright (c) 2007, 2008 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 @@ -23,14 +23,14 @@ * for converting text in URL format represented as a javaString
* to a platform specific representation of the data and vice versa. See
* Transfer
for additional information. The string
- * must be a fully specified url.
*
- * An example of a java String[]
containing a URL is shown
- * below:
An example of a java String
containing a URL is shown below:
- * String urlData = "http://www.eclipse.org";
+ * String url = "http://www.eclipse.org";
*
+ *
+ * @see Transfer
*/
public class URLTransfer : ByteArrayTransfer {
@@ -60,11 +60,12 @@
/**
* This implementation of javaToNative
converts a URL
* represented by a java String
to a platform specific representation.
- * For additional information see Transfer#javaToNative
.
*
* @param object a java String
containing a URL
- * @param transferData an empty TransferData
object; this
- * object will be filled in on return with the platform specific format of the data
+ * @param transferData an empty TransferData
object that will
+ * be filled in on return with the platform specific format of the data
+ *
+ * @see Transfer#nativeToJava
*/
public void javaToNative (Object object, TransferData transferData){
transferData.result = 0;
@@ -83,14 +84,14 @@
}
/**
- * This implementation of nativeToJava
converts a platform specific
- * representation of a URL String
.
- * For additional information see Transfer#nativeToJava
.
- *
- * @param transferData the platform specific representation of the data to be
- * converted
- * @return a java String
containing a URL if the
- * conversion was successful; otherwise null
+ * This implementation of nativeToJava
converts a platform
+ * specific representation of a URL to a java String
.
+ *
+ * @param transferData the platform specific representation of the data to be converted
+ * @return a java String
containing a URL if the conversion was successful;
+ * otherwise null
+ *
+ * @see Transfer#javaToNative
*/
public Object nativeToJava(TransferData transferData){
if (!isSupportedType(transferData) || transferData.pValue is null) return null;
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/ArmEvent.d
--- a/dwt/events/ArmEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/ArmEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2004 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -20,6 +20,7 @@
* a widget such as a menu item being armed.
*
* @see ArmListener
+ * @see Sample code and further information
*/
public final class ArmEvent : TypedEvent {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/ControlAdapter.d
--- a/dwt/events/ControlAdapter.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/ControlAdapter.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -24,6 +24,7 @@
*
* @see ControlListener
* @see ControlEvent
+ * @see Sample code and further information
*/
public abstract class ControlAdapter : ControlListener {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/ControlEvent.d
--- a/dwt/events/ControlEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/ControlEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2004 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -21,6 +21,7 @@
* controls being moved or resized.
*
* @see ControlListener
+ * @see Sample code and further information
*/
public final class ControlEvent : TypedEvent {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/DisposeEvent.d
--- a/dwt/events/DisposeEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/DisposeEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2004 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -21,6 +21,7 @@
* widgets being disposed.
*
* @see DisposeListener
+ * @see Sample code and further information
*/
public final class DisposeEvent : TypedEvent {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/DragDetectEvent.d
--- a/dwt/events/DragDetectEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/DragDetectEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -20,6 +20,7 @@
* a drag gesture.
*
* @see DragDetectListener
+ * @see Sample code and further information
*
* @since 3.3
*/
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/ExpandAdapter.d
--- a/dwt/events/ExpandAdapter.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/ExpandAdapter.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2006 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -25,6 +25,7 @@
*
* @see ExpandListener
* @see ExpandEvent
+ * @see Sample code and further information
*
* @since 3.2
*/
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/ExpandEvent.d
--- a/dwt/events/ExpandEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/ExpandEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2006 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -21,6 +21,7 @@
* ExpandItem
s being expanded or collapsed.
*
* @see ExpandListener
+ * @see Sample code and further information
*
* @since 3.2
*/
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/FocusAdapter.d
--- a/dwt/events/FocusAdapter.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/FocusAdapter.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -25,6 +25,7 @@
*
* @see FocusListener
* @see FocusEvent
+ * @see Sample code and further information
*/
public abstract class FocusAdapter : FocusListener {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/FocusEvent.d
--- a/dwt/events/FocusEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/FocusEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2004 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -21,6 +21,7 @@
* widgets gaining and losing focus.
*
* @see FocusListener
+ * @see Sample code and further information
*/
public final class FocusEvent : TypedEvent {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/HelpEvent.d
--- a/dwt/events/HelpEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/HelpEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2004 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -21,6 +21,7 @@
* help being requested for a widget.
*
* @see HelpListener
+ * @see Sample code and further information
*/
public final class HelpEvent : TypedEvent {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/KeyAdapter.d
--- a/dwt/events/KeyAdapter.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/KeyAdapter.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -25,6 +25,7 @@
*
* @see KeyListener
* @see KeyEvent
+ * @see Sample code and further information
*/
public abstract class KeyAdapter : KeyListener {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/KeyEvent.d
--- a/dwt/events/KeyEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/KeyEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2006 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -35,8 +35,10 @@
* not necessary to add traversal listeners for these controls,
* unless you want to override the default traversal.
*
+ *
* @see KeyListener
* @see TraverseListener
+ * @see Sample code and further information
*/
public class KeyEvent : TypedEvent {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/MenuAdapter.d
--- a/dwt/events/MenuAdapter.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/MenuAdapter.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -25,6 +25,7 @@
*
* @see MenuListener
* @see MenuEvent
+ * @see Sample code and further information
*/
public abstract class MenuAdapter : MenuListener {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/MenuDetectEvent.d
--- a/dwt/events/MenuDetectEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/MenuDetectEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -24,6 +24,7 @@
* specific trigger for showing a context menu is detected.
*
* @see MenuDetectListener
+ * @see Sample code and further information
*
* @since 3.3
*/
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/MenuEvent.d
--- a/dwt/events/MenuEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/MenuEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2004 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -21,6 +21,7 @@
* menus being shown and hidden.
*
* @see MenuListener
+ * @see Sample code and further information
*/
public final class MenuEvent : TypedEvent {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/ModifyEvent.d
--- a/dwt/events/ModifyEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/ModifyEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2004 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -21,6 +21,7 @@
* text being modified.
*
* @see ModifyListener
+ * @see Sample code and further information
*/
public final class ModifyEvent : TypedEvent {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/MouseAdapter.d
--- a/dwt/events/MouseAdapter.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/MouseAdapter.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2004 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -26,6 +26,7 @@
*
* @see MouseListener
* @see MouseEvent
+ * @see Sample code and further information
*/
public abstract class MouseAdapter : MouseListener {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/MouseEvent.d
--- a/dwt/events/MouseEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/MouseEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -34,6 +34,7 @@
* @see MouseListener
* @see MouseMoveListener
* @see MouseTrackListener
+ * @see Sample code and further information
*/
public class MouseEvent : TypedEvent {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/MouseTrackAdapter.d
--- a/dwt/events/MouseTrackAdapter.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/MouseTrackAdapter.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2004 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -26,6 +26,7 @@
*
* @see MouseTrackListener
* @see MouseEvent
+ * @see Sample code and further information
*/
public abstract class MouseTrackAdapter : MouseTrackListener {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/PaintEvent.d
--- a/dwt/events/PaintEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/PaintEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2004 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -27,6 +27,7 @@
* visible areas of controls requiring re-painting.
*
* @see PaintListener
+ * @see Sample code and further information
*/
public final class PaintEvent : TypedEvent {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/SelectionAdapter.d
--- a/dwt/events/SelectionAdapter.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/SelectionAdapter.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -25,6 +25,7 @@
*
* @see SelectionListener
* @see SelectionEvent
+ * @see Sample code and further information
*/
public abstract class SelectionAdapter : SelectionListener {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/SelectionEvent.d
--- a/dwt/events/SelectionEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/SelectionEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -28,6 +28,7 @@
*
*
* @see SelectionListener
+ * @see Sample code and further information
*/
public class SelectionEvent : TypedEvent {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/ShellAdapter.d
--- a/dwt/events/ShellAdapter.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/ShellAdapter.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -25,6 +25,7 @@
*
* @see ShellListener
* @see ShellEvent
+ * @see Sample code and further information
*/
public abstract class ShellAdapter : ShellListener {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/ShellEvent.d
--- a/dwt/events/ShellEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/ShellEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2004 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -25,6 +25,7 @@
* operations being performed on shells.
*
* @see ShellListener
+ * @see Sample code and further information
*/
public final class ShellEvent : TypedEvent {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/TraverseEvent.d
--- a/dwt/events/TraverseEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/TraverseEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2006 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -81,6 +81,7 @@
*
*
* @see TraverseListener
+ * @see Sample code and further information
*/
public final class TraverseEvent : KeyEvent {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/TreeAdapter.d
--- a/dwt/events/TreeAdapter.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/TreeAdapter.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -25,6 +25,7 @@
*
* @see TreeListener
* @see TreeEvent
+ * @see Sample code and further information
*/
public abstract class TreeAdapter : TreeListener {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/TreeEvent.d
--- a/dwt/events/TreeEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/TreeEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2004 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -21,6 +21,7 @@
* trees being expanded and collapsed.
*
* @see TreeListener
+ * @see Sample code and further information
*/
public final class TreeEvent : SelectionEvent {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/TypedEvent.d
--- a/dwt/events/TypedEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/TypedEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -29,6 +29,7 @@
* applicable to the event occurrence.
*
* @see dwt.widgets.Event
+ * @see Sample code and further information
*/
public class TypedEvent : DWTEventObject {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/events/VerifyEvent.d
--- a/dwt/events/VerifyEvent.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/events/VerifyEvent.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2006 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -24,6 +24,7 @@
* widgets handling keyboard events
*
* @see VerifyListener
+ * @see Sample code and further information
*/
public final class VerifyEvent : KeyEvent {
diff -r cc1d3de0e80b -r c0d810de7093 dwt/graphics/Color.d
--- a/dwt/graphics/Color.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/graphics/Color.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2005 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -37,6 +37,9 @@
*
* @see RGB
* @see Device#getSystemColor
+ * @see Color and RGB snippets
+ * @see DWT Example: PaintExample
+ * @see Sample code and further information
*/
public final class Color : Resource {
alias Resource.init_ init_;
diff -r cc1d3de0e80b -r c0d810de7093 dwt/graphics/Cursor.d
--- a/dwt/graphics/Cursor.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/graphics/Cursor.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -50,6 +50,9 @@
* * Note: Only one of the above styles may be specified. *
+ * + * @see Cursor snippets + * @see Sample code and further information */ public final class Cursor : Resource { /** diff -r cc1d3de0e80b -r c0d810de7093 dwt/graphics/Device.d --- a/dwt/graphics/Device.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/graphics/Device.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -35,6 +35,8 @@ * such as the Display device and the Printer device. Devices * can have a graphics context (GC) created for them, and they * can be drawn on by sending messages to the associated GC. + * + * @see Sample code and further information */ public abstract class Device : Drawable { /** diff -r cc1d3de0e80b -r c0d810de7093 dwt/graphics/Font.d --- a/dwt/graphics/Font.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/graphics/Font.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -36,6 +36,9 @@ * * * @see FontData + * @see Font snippets + * @see DWT Examples: GraphicsExample, PaintExample + * @see Sample code and further information */ public final class Font : Resource { diff -r cc1d3de0e80b -r c0d810de7093 dwt/graphics/FontData.d --- a/dwt/graphics/FontData.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/graphics/FontData.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -44,6 +44,7 @@ * required, and thus nodispose()
method is provided.
*
* @see Font
+ * @see Sample code and further information
*/
public final class FontData {
/**
diff -r cc1d3de0e80b -r c0d810de7093 dwt/graphics/FontMetrics.d
--- a/dwt/graphics/FontMetrics.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/graphics/FontMetrics.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2005 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -21,6 +21,7 @@
* using the getFontMetrics()
method.
*
* @see GC#getFontMetrics
+ * @see Sample code and further information
*/
public final class FontMetrics {
int ascent, descent, averageCharWidth, leading, height;
diff -r cc1d3de0e80b -r c0d810de7093 dwt/graphics/GC.d
--- a/dwt/graphics/GC.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/graphics/GC.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2007 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -75,6 +75,9 @@
*
*
* @see dwt.events.PaintEvent
+ * @see GC snippets
+ * @see DWT Examples: GraphicsExample, PaintExample
+ * @see Sample code and further information
*/
public final class GC : Resource {
@@ -1030,7 +1033,7 @@
}
/* Merge clipping with mask if necessary */
- if (data.clipRgn !is null) {
+ if (data.clipRgn !is null) {
int newWidth = srcX + srcWidth;
int newHeight = srcY + srcHeight;
int bytesPerLine = (newWidth + 7) / 8;
@@ -2186,7 +2189,8 @@
}
/**
- * Returns the receiver's alpha value.
+ * Returns the receiver's alpha value. The alpha value
+ * is between 0 (transparent) and 255 (opaque).
*
* @return the alpha value
*
@@ -2984,7 +2988,8 @@
}
/**
- * Sets the receiver's alpha value.
+ * Sets the receiver's alpha value which must be
+ * between 0 (transparent) and 255 (opaque).
* * This operation requires the operating system's advanced * graphics subsystem which may not be available on some diff -r cc1d3de0e80b -r c0d810de7093 dwt/graphics/GCData.d --- a/dwt/graphics/GCData.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/graphics/GCData.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -30,6 +30,7 @@ * within the packages provided by DWT. It is not available on all * platforms, and should never be called from application code. *
+ * @see Sample code and further information */ public final class GCData { public Device device; diff -r cc1d3de0e80b -r c0d810de7093 dwt/graphics/GlyphMetrics.d --- a/dwt/graphics/GlyphMetrics.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/graphics/GlyphMetrics.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -32,6 +32,7 @@ * * @see TextStyle * @see TextLayout + * @see Sample code and further information * * @since 3.2 */ @@ -56,13 +57,17 @@ * Constructs an instance of this class with the given * ascent, descent and width values. * + * @param ascent the GlyphMetrics ascent + * @param descent the GlyphMetrics descent + * @param width the GlyphMetrics width + * * @exception IllegalArgumentExceptionx
in
* scanline y
in the receiver's alpha data.
+ * The alpha value is between 0 (transparent) and
+ * 255 (opaque).
*
* @param x the x coordinate of the pixel to get the alpha value of
* @param y the y coordinate of the pixel to get the alpha value of
@@ -619,7 +624,9 @@
/**
* Returns getWidth
alpha values starting at offset
* x
in scanline y
in the receiver's alpha
- * data starting at startIndex
.
+ * data starting at startIndex
. The alpha values
+ * are unsigned, between (byte)0
(transparent) and
+ * (byte)255
(opaque).
*
* @param x the x position of the pixel to begin getting alpha values
* @param y the y position of the pixel to begin getting alpha values
@@ -1173,6 +1180,8 @@
/**
* Sets the alpha value at offset x
in
* scanline y
in the receiver's alpha data.
+ * The alpha value must be between 0 (transparent)
+ * and 255 (opaque).
*
* @param x the x coordinate of the alpha value to set
* @param y the y coordinate of the alpha value to set
@@ -1194,7 +1203,8 @@
* Sets the alpha values starting at offset x
in
* scanline y
in the receiver's alpha data to the
* values from the array alphas
starting at
- * startIndex
.
+ * startIndex
. The alpha values must be between
+ * (byte)0
(transparent) and (byte)255
(opaque)
*
* @param x the x coordinate of the pixel to being setting the alpha values
* @param y the y coordinate of the pixel to being setting the alpha values
diff -r cc1d3de0e80b -r c0d810de7093 dwt/graphics/ImageLoader.d
--- a/dwt/graphics/ImageLoader.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/graphics/ImageLoader.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2006 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -48,6 +48,9 @@
* path
. If
+ * flatness
is less than or equal to zero, an unflatten
+ * copy of the path is created. Otherwise, it specifies the maximum
+ * error between the path and its flatten copy. Smaller numbers give
+ * better approximation.
+ * + * This operation requires the operating system's advanced + * graphics subsystem which may not be available on some + * platforms. + *
+ * + * @param device the device on which to allocate the path + * @param path the path to make a copy + * @param flatness the flatness value + * + * @exception IllegalArgumentException+ * This operation requires the operating system's advanced + * graphics subsystem which may not be available on some + * platforms. + *
+ * + * @param device the device on which to allocate the path + * @param data the data for the path + * + * @exception IllegalArgumentExceptionALL_PAGES
PrinterData.ALL_PAGES
PAGE_RANGE
PrinterData.PAGE_RANGE
SELECTION
PrinterData.SELECTION
ALL_PAGES
PrinterData.ALL_PAGES
PAGE_RANGE
PrinterData.PAGE_RANGE
SELECTION
PrinterData.SELECTION
* This value can be from 1 to the maximum number of pages for the platform.
- * Note that it is only valid if the scope is PAGE_RANGE
.
+ * Note that it is only valid if the scope is PrinterData.PAGE_RANGE
.
*
* This value can be from 1 to the maximum number of pages for the platform.
- * Note that it is only valid if the scope is PAGE_RANGE
.
+ * Note that it is only valid if the scope is PrinterData.PAGE_RANGE
.
*
* This value can be from 1 to the maximum number of pages for the platform.
- * Note that it is only valid if the scope is PAGE_RANGE
.
+ * Note that it is only valid if the scope is PrinterData.PAGE_RANGE
.
*
* This value can be from 1 to the maximum number of pages for the platform.
- * Note that it is only valid if the scope is PAGE_RANGE
.
+ * Note that it is only valid if the scope is PrinterData.PAGE_RANGE
.
*
+ * For a printer, this is the size of the physical page, in pixels. + *
* * @return the bounding rectangle * @@ -633,8 +637,10 @@ /** * Returns a rectangle which describes the area of the * receiver which is capable of displaying data. + ** For a printer, this is the size of the printable area - * of a page, in pixels. + * of the page, in pixels. + *
* * @return the client area * @@ -654,28 +660,32 @@ } /** - * Given a desired client area for the receiver - * (as described by the arguments), returns the bounding - * rectangle which would be required to produce that client - * area. + * Given a client area (as described by the arguments), + * returns a rectangle, relative to the client area's coordinates, + * that is the client area expanded by the printer's trim (or minimum margins). *- * In other words, it returns a rectangle such that, if the - * receiver's bounds were set to that rectangle, the area - * of the receiver which is capable of displaying data - * (that is, not covered by the "trimmings") would be the - * rectangle described by the arguments (relative to the - * receiver's parent). - *
- * Note that there is no setBounds for a printer. This method - * is usually used by passing in the client area (the 'printable - * area') of the printer. It can also be useful to pass in 0, 0, 0, 0. + * Most printers have a minimum margin on each edge of the paper where the + * printer device is unable to print. This margin is known as the "trim." + * This method can be used to calculate the printer's minimum margins + * by passing in a client area of 0, 0, 0, 0 and then using the resulting + * x and y coordinates (which will be <= 0) to determine the minimum margins + * for the top and left edges of the paper, and the resulting width and height + * (offset by the resulting x and y) to determine the minimum margins for the + * bottom and right edges of the paper, as follows: + *
Display
- * must already exist to guarantee that this method returns
- * an appropriate result.
+ * Launches the operating system executable associated with the file or
+ * URL (http:// or https://). If the file is an executable then the
+ * executable is launched. Note that a Display
must already
+ * exist to guarantee that this method returns an appropriate result.
*
- * @param fileName the file or program name
+ * @param fileName the file or program name or URL (http:// or https://)
* @return true
if the file is launched, otherwise false
*
* @exception IllegalArgumentException true
if the receiver is grayed,
+ * and false otherwise. When the widget does not have
+ * the CHECK
style, return false.
+ *
+ * @return the grayed state of the checkbox
+ *
+ * @exception DWTException true
if the receiver's list is visible,
+ * and false
otherwise.
+ * + * If one of the receiver's ancestors is not visible or some + * other condition makes the receiver not visible, this method + * may still indicate that it is considered visible even though + * it may not actually be showing. + *
+ * + * @return the receiver's list's visibility state + * + * @exception DWTExceptiontrue
,
+ * and marks it invisible otherwise.
+ * + * If one of the receiver's ancestors is not visible or some + * other condition makes the receiver not visible, marking + * it visible may not actually cause it to be displayed. + *
+ * + * @param visible the new visibility state + * + * @exception DWTExceptiontrue
if the operation was successful and false
otherwise
+ *
+ * @exception IllegalArgumentException null
+ *
* @exception DWTException true
, causes the receiver to have
* all mouse events delivered to it until the method is called with
- * false
as the argument.
+ * false
as the argument. Note that on some platforms,
+ * a mouse button must currently be down for capture to be assigned.
*
* @param capture true
to capture the mouse, and false
to release it
*
@@ -3563,18 +3616,17 @@
OS.gtk_widget_realize (handle);
auto parentHandle = parent.eventHandle ();
auto window = parent.eventWindow();
- Rectangle rect = getBounds ();
+ auto topHandle_ = topHandle ();
GdkWindowAttr attributes;
- attributes.x = rect.x;
- attributes.y = rect.y;
- attributes.width = rect.width;
- attributes.height = rect.height;
+ attributes.x = OS.GTK_WIDGET_X (topHandle_);
+ attributes.y = OS.GTK_WIDGET_Y (topHandle_);
+ attributes.width = (state & ZERO_WIDTH) !is 0 ? 0 : OS.GTK_WIDGET_WIDTH (topHandle_);
+ attributes.height = (state & ZERO_HEIGHT) !is 0 ? 0 : OS.GTK_WIDGET_HEIGHT (topHandle_);
attributes.event_mask = (0xFFFFFFFF & ~OS.ExposureMask);
attributes.wclass = OS.GDK_INPUT_ONLY;
attributes.window_type = OS.GDK_WINDOW_CHILD;
enableWindow = OS.gdk_window_new (window, &attributes, OS.GDK_WA_X | OS.GDK_WA_Y);
if (enableWindow !is null) {
- auto topHandle_ = topHandle ();
OS.gdk_window_set_user_data (enableWindow, parentHandle);
if (!OS.GDK_WINDOWING_X11 ()) {
OS.gdk_window_raise (enableWindow);
diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/CoolBar.d
--- a/dwt/widgets/CoolBar.d Tue Jun 24 22:12:18 2008 +0200
+++ b/dwt/widgets/CoolBar.d Sun Jun 29 14:33:38 2008 +0200
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2006 IBM Corporation and others.
+ * Copyright (c) 2000, 2008 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
@@ -49,6 +49,10 @@
* * IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see CoolBar snippets + * @see DWT Example: ControlExample + * @see Sample code and further information */ public class CoolBar : Composite { diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/CoolItem.d --- a/dwt/widgets/CoolItem.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/CoolItem.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -47,6 +47,8 @@ ** IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see Sample code and further information */ public class CoolItem : Item { Control control; diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/DateTime.d --- a/dwt/widgets/DateTime.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/DateTime.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -371,6 +371,10 @@ ** IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see DateTime snippets + * @see DWT Example: ControlExample + * @see Sample code and further information * * @since 3.3 */ diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/Decorations.d --- a/dwt/widgets/Decorations.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/Decorations.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -104,6 +104,7 @@ * @see #getMaximized * @see Shell * @see DWT + * @see Sample code and further information */ public class Decorations : Canvas { diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/Dialog.d --- a/dwt/widgets/Dialog.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/Dialog.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2005 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -79,6 +79,8 @@ * * * @see Shell + * @see DWT Example: ControlExample + * @see Sample code and further information */ public abstract class Dialog { diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/DirectoryDialog.d --- a/dwt/widgets/DirectoryDialog.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/DirectoryDialog.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -39,6 +39,10 @@ * IMPORTANT: This class is intended to be subclassed only * within the DWT implementation. * + * + * @see DirectoryDialog snippets + * @see DWT Example: ControlExample, Dialog tab + * @see Sample code and further information */ public class DirectoryDialog : Dialog { String message = "", filterPath = ""; diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/Display.d --- a/dwt/widgets/Display.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/Display.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -124,6 +124,8 @@ * @see #readAndDispatch * @see #sleep * @see Device#dispose + * @see Display snippets + * @see Sample code and further information */ public class Display : Device { @@ -1399,7 +1401,8 @@ } /** - * Returns a rectangle describing the receiver's size and location. + * Returns a rectangle describing the receiver's size and location. Note that + * on multi-monitor systems the origin can be negative. * * @return the bounding rectangle * @@ -1483,7 +1486,7 @@ if ((xWindow = buffer) !is 0) { xParent = xWindow; auto gdkWindow = OS.gdk_window_lookup (xWindow); - if (gdkWindow !is null) { + if (gdkWindow !is null) { OS.gdk_window_get_user_data (gdkWindow, cast(void**)&user_data); if (user_data !is null) handle = user_data; } @@ -3318,7 +3321,7 @@ * is one of the event constants defined in classDWT
.
*
* @param eventType the type of event to listen for
- * @param listener the listener which should no longer be notified when the event occurs
+ * @param listener the listener which should no longer be notified
*
* @exception IllegalArgumentException * The strings are platform specific. For example, on - * Windows, an extension filter string is typically of - * the form "*.extension", where "*.*" matches all files. + * some platforms, an extension filter string is typically + * of the form "*.extension", where "*.*" matches all files. + * For filters with multiple extensions, use semicolon as + * a separator, e.g. "*.jpg;*.png". *
* * @param extensions the file extension filter @@ -625,7 +631,7 @@ filterIndex = index; } /** - * Sets the the names that describe the filter extensions + * Sets the names that describe the filter extensions * which the dialog will use to filter the files it shows * to the argument, which may be null. *diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/FontDialog.d --- a/dwt/widgets/FontDialog.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/FontDialog.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -38,6 +38,9 @@ * IMPORTANT: This class is intended to be subclassed only * within the DWT implementation. *
+ * + * @see DWT Example: ControlExample, Dialog tab + * @see Sample code and further information */ public class FontDialog : Dialog { FontData fontData; diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/Group.d --- a/dwt/widgets/Group.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/Group.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -42,6 +42,9 @@ ** IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see DWT Example: ControlExample + * @see Sample code and further information */ public class Group : Composite { diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/IME.d --- a/dwt/widgets/IME.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/IME.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2007 IBM Corporation and others. + * Copyright (c) 2007, 2008 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 @@ -12,6 +12,7 @@ import dwt.DWT; +import dwt.DWTException; import dwt.graphics.Color; import dwt.graphics.TextStyle; import dwt.internal.Converter; @@ -21,8 +22,26 @@ import dwt.widgets.Canvas; import dwt.widgets.Event; -import dwt.dwthelper.utils; - +/** + * Instances of this class represent input method editors. + * These are typically in-line pre-edit text areas that allow + * the user to compose characters from Far Eastern languages + * such as Japanese, Chinese or Korean. + * + *+ * IMPORTANT: This class is not intended to be subclassed. + *
+ * + * @see Sample code and further information + * + * @since 3.4 + */ public class IME : Widget { Canvas parent; int caretOffset; @@ -40,8 +59,31 @@ } /** + * Constructs a new instance of this class given its parent + * and a style value describing its behavior and appearance. + *
+ * The style value is either one of the style constants defined in
+ * class DWT
which is applicable to instances of this
+ * class, or must be built by bitwise OR'ing together
+ * (that is, using the int
"|" operator) two or more
+ * of those DWT
style constants. The class description
+ * lists the style constants that are applicable to the class.
+ * Style bits are also inherited from superclasses.
+ *
+ * The ranges array contains start and end pairs. Each pair refers to
+ * the corresponding style in the styles array. For example, the pair
+ * that starts at ranges[n] and ends at ranges[n+1] uses the style
+ * at styles[n/2] returned by getStyles()
.
+ *
+ * The ranges array contains start and end pairs. Each pair refers to + * the corresponding style in the styles array. For example, the pair + * that starts at ranges[n] and ends at ranges[n+1] uses the style + * at styles[n/2]. + *
+ * + * @return the ranges for the styles + * + * @exception DWTException+ * The text for an IME is the characters in the widget that + * are in the current composition. When the commit count is + * equal to the length of the composition text, then the + * in-line edit operation is complete. + *
+ * + * @return the widget text + * + * @exception DWTExceptiontrue
if the caret should be wide, and
+ * false
otherwise. In some languages, for example
+ * Korean, the caret is typically widened to the width of the
+ * current character in the in-line edit session.
+ *
+ * @return the wide caret state
+ *
+ * @exception DWTException + * Shadow styles are hints and may not be honoured + * by the platform. To create a separator label + * with the default shadow style for the platform, + * do not specify a shadow style. + *
** IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see List snippets + * @see DWT Example: ControlExample + * @see Sample code and further information */ public class List : Scrollable { diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/Menu.d --- a/dwt/widgets/Menu.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/Menu.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -44,6 +44,10 @@ ** IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see Menu snippets + * @see DWT Example: ControlExample + * @see Sample code and further information */ public class Menu : Widget { int x, y; @@ -59,6 +63,11 @@ * Constructs a new instance of this class given its parent, * and sets the style for the instance so that the instance * will be a popup menu on the given parent's shell. + *
+ * After constructing a menu, it can be set into its parent
+ * using parent.setMenu(menu)
. In this case, the parent may
+ * be any control in the same widget tree as the parent.
+ *
DWT
style constants. The class description
* lists the style constants that are applicable to the class.
* Style bits are also inherited from superclasses.
+ *
+ * After constructing a menu or menuBar, it can be set into its parent
+ * using parent.setMenu(menu)
or parent.setMenuBar(menuBar)
.
*
Menu
) and sets the style
* for the instance so that the instance will be a drop-down
* menu on the given parent's parent.
+ *
+ * After constructing a drop-down menu, it can be set into its parentMenu
+ * using parentMenu.setMenu(menu)
.
+ *
MenuItem
) and sets the style
* for the instance so that the instance will be a drop-down
* menu on the given parent's parent menu.
+ *
+ * After constructing a drop-down menu, it can be set into its parentItem
+ * using parentItem.setMenu(menu)
.
+ *
* IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see Sample code and further information */ public class MenuItem : Item { Menu parent, menu; diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/MessageBox.d --- a/dwt/widgets/MessageBox.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/MessageBox.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -43,6 +43,9 @@ * IMPORTANT: This class is intended to be subclassed only * within the DWT implementation. * + * + * @see DWT Example: ControlExample, Dialog tab + * @see Sample code and further information */ public class MessageBox : Dialog { diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/Monitor.d --- a/dwt/widgets/Monitor.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/Monitor.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2005 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -18,6 +18,8 @@ * Instances of this class are descriptions of monitors. * * @see Display + * @see Monitor snippets + * @see Sample code and further information * * @since 3.0 */ diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/ProgressBar.d --- a/dwt/widgets/ProgressBar.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/ProgressBar.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -41,6 +41,10 @@ * IMPORTANT: This class is intended to be subclassed only * within the DWT implementation. * + * + * @see ProgressBar snippets + * @see DWT Example: ControlExample + * @see Sample code and further information */ public class ProgressBar : Control { CallbackData callbackData; @@ -146,6 +150,23 @@ return selection; } +/** + * Returns the state of the receiver. The value will be one of: + *
+ * IMPORTANT: This method is not part of the public
+ * API for Shell
. It is marked public only so that it
+ * can be shared within the packages provided by DWT. It is not
+ * available on all platforms, and should never be called from
+ * application code.
+ *
true
if the receiver is currently
+ * in fullscreen state, and false otherwise.
+ * + * + * @return the fullscreen state + * + * @exception DWTException
+ * This operation requires the operating system's advanced + * widgets subsystem which may not be available on some + * platforms. + *
+ * @param alpha the alpha value + * + * @exception DWTExceptiontrue
causes the receiver
+ * to switch to the full screen state, and if the argument is
+ * false
and the receiver was previously switched
+ * into full screen state, causes the receiver to switch back
+ * to either the maximmized or normal states.
+ *
+ * Note: The result of intermixing calls to setFullScreen(true)
,
+ * setMaximized(true)
and setMinimized(true)
will
+ * vary by platform. Typically, the behavior will match the platform user's
+ * expectations, but not always. This should be avoided if possible.
+ *
- * Note that this value is platform dependent, based upon - * the native widget implementation. - *
- */ + * the operating system limit for the number of characters + * that the text field in an instance of this class can hold + * + * @since 3.4 + */ public const static int LIMIT = 0x7FFFFFFF; /** @@ -479,12 +481,43 @@ return cast(int) (value > 0 ? value + 0.5 : value - 0.5); } +/** + * Returns a string containing a copy of the contents of the + * receiver's text field, or an empty string if there are no + * contents. + * + * @return the receiver's text + * + * @exception DWTExceptionsetTextLimit()
, it will be the constant
+ * Spinner.LIMIT
.
+ *
+ * @return the text limit
+ *
+ * @exception DWTException
+ * To reset this value to the default, use setTextLimit(Spinner.LIMIT)
.
+ * Specifying a limit value larger than Spinner.LIMIT
sets the
+ * receiver's limit to Spinner.LIMIT
.
+ *
* IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see TabFolder, TabItem snippets + * @see DWT Example: ControlExample + * @see Sample code and further information */ public class TabFolder : Composite { @@ -327,6 +331,24 @@ return items [index]; } +/** + * Returns the tab item at the given point in the receiver + * or null if no such item exists. The point is in the + * coordinate system of the receiver. + * + * @param point the point used to locate the item + * @return the tab item at the given point, or null if the point is not in a tab item + * + * @exception IllegalArgumentException* IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see TabFolder, TabItem snippets + * @see Sample code and further information */ public class TabItem : Item { @@ -144,6 +147,19 @@ releaseHandle (); } +/** + * Returns a rectangle describing the receiver's size and location + * relative to its parent. + * + * @return the receiver's bounding rectangle + * + * @exception DWTException
* Note that although this class is a subclass of Composite
,
- * it does not make sense to add Control
children to it,
- * or set a layout on it.
+ * it does not normally make sense to add Control
children to
+ * it, or set a layout on it, unless implementing something like a cell
+ * editor.
*
*
* IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see Table, TableItem, TableColumn snippets + * @see DWT Example: ControlExample + * @see Sample code and further information */ public class Table : Composite { @@ -153,6 +158,7 @@ * @see DWT#FULL_SELECTION * @see DWT#HIDE_SELECTION * @see DWT#VIRTUAL + * @see DWT#NO_SCROLL * @see Widget#checkSubclass * @see Widget#getStyle */ @@ -1488,7 +1494,7 @@ /** * Returns the height of the area which would be used to - * display one of the items in the receiver's. + * display one of the items in the receiver. * * @return the height of one item * diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/TableColumn.d --- a/dwt/widgets/TableColumn.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/TableColumn.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -45,6 +45,9 @@ ** IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see Table, TableItem, TableColumn snippets + * @see Sample code and further information */ public class TableColumn : Item { GtkWidget* labelHandle, imageHandle, buttonHandle; @@ -105,7 +108,10 @@ * lists the style constants that are applicable to the class. * Style bits are also inherited from superclasses. * - * + *+ * Note that due to a restriction on some platforms, the first column + * is always left aligned. + *
* @param parent a composite control which will be the parent of the new instance (cannot be null) * @param style the style of control to construct * @param index the zero-relative index to store the receiver in its parent @@ -512,7 +518,10 @@ * Controls how text and images will be displayed in the receiver. * The argument should be one ofLEFT
, RIGHT
* or CENTER
.
- *
+ * + * Note that due to a restriction on some platforms, the first column + * is always left aligned. + *
* @param alignment the new alignment * * @exception DWTException* IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see Table, TableItem, TableColumn snippets + * @see Sample code and further information */ public class TableItem : Item { Table parent; diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/Text.d --- a/dwt/widgets/Text.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/Text.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -33,6 +33,13 @@ /** * Instances of this class are selectable user interface * objects that allow the user to enter and modify text. + * Text controls can be either single or multi-line. + * When a text control is created with a border, the + * operating system includes a platform specific inset + * around the contents of the control. When created + * without a border, an effort is made to remove the + * inset such that the preferred size of the control + * is the same size as the contents. **
* IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see Text snippets + * @see DWT Example: ControlExample + * @see Sample code and further information */ public class Text : Scrollable { diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/ToolBar.d --- a/dwt/widgets/ToolBar.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/ToolBar.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -52,6 +52,10 @@ ** IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see ToolBar, ToolItem snippets + * @see DWT Example: ControlExample + * @see Sample code and further information */ public class ToolBar : Composite { diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/ToolItem.d --- a/dwt/widgets/ToolItem.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/ToolItem.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -46,6 +46,9 @@ ** IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see ToolBar, ToolItem snippets + * @see Sample code and further information */ public class ToolItem : Item { diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/ToolTip.d --- a/dwt/widgets/ToolTip.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/ToolTip.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -46,6 +46,10 @@ * within the DWT implementation. * * + * @see Tool Tips snippets + * @see DWT Example: ControlExample + * @see Sample code and further information + * * @since 3.2 */ public class ToolTip : Widget { diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/Tracker.d --- a/dwt/widgets/Tracker.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/Tracker.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -49,6 +49,9 @@ ** IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see Tracker snippets + * @see Sample code and further information */ public class Tracker : Widget { Composite parent; diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/Tray.d --- a/dwt/widgets/Tray.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/Tray.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2005 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -33,6 +33,8 @@ * * * @see Display#getSystemTray + * @see Tray, TrayItem snippets + * @see Sample code and further information * * @since 3.0 */ diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/TrayItem.d --- a/dwt/widgets/TrayItem.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/TrayItem.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -45,6 +45,9 @@ * IMPORTANT: This class is not intended to be subclassed. * * + * @see Tray, TrayItem snippets + * @see Sample code and further information + * * @since 3.0 */ public class TrayItem : Item { diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/Tree.d --- a/dwt/widgets/Tree.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/Tree.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -77,12 +77,13 @@ * *
* Note that although this class is a subclass of Composite
,
- * it does not make sense to add Control
children to it,
- * or set a layout on it.
+ * it does not normally make sense to add Control
children to
+ * it, or set a layout on it, unless implementing something like a cell
+ * editor.
*
*
* IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see Tree, TreeItem, TreeColumn snippets + * @see DWT Example: ControlExample + * @see Sample code and further information */ public class Tree : Composite { @@ -160,6 +165,9 @@ * @see DWT#SINGLE * @see DWT#MULTI * @see DWT#CHECK + * @see DWT#FULL_SELECTION + * @see DWT#VIRTUAL + * @see DWT#NO_SCROLL * @see Widget#checkSubclass * @see Widget#getStyle */ @@ -969,6 +977,23 @@ if (checkRenderer !is null) display.removeWidget (cast(GtkWidget*)checkRenderer); } +/** + * Deselects an item in the receiver. If the item was already + * deselected, it remains deselected. + * + * @param item the item to be deselected + * + * @exception IllegalArgumentException+ * Note that due to a restriction on some platforms, the first column + * is always left aligned. + *
* @param parent a composite control which will be the parent of the new instance (cannot be null) * @param style the style of control to construct * @param index the zero-relative index to store the receiver in its parent @@ -508,7 +514,10 @@ * Controls how text and images will be displayed in the receiver. * The argument should be one ofLEFT
, RIGHT
* or CENTER
.
- *
+ * + * Note that due to a restriction on some platforms, the first column + * is always left aligned. + *
* @param alignment the new alignment * * @exception DWTException* IMPORTANT: This class is not intended to be subclassed. *
+ * + * @see Tree, TreeItem, TreeColumn snippets + * @see Sample code and further information */ public class TreeItem : Item { Tree parent; diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/TypedListener.d --- a/dwt/widgets/TypedListener.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/TypedListener.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -71,6 +71,7 @@ * * * @see Listener + * @see Sample code and further information */ public class TypedListener : Listener { diff -r cc1d3de0e80b -r c0d810de7093 dwt/widgets/Widget.d --- a/dwt/widgets/Widget.d Tue Jun 24 22:12:18 2008 +0200 +++ b/dwt/widgets/Widget.d Sun Jun 29 14:33:38 2008 +0200 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -58,6 +58,7 @@ * * * @see #checkSubclass + * @see Sample code and further information */ public abstract class Widget { /** @@ -313,6 +314,7 @@ * * @see Listener * @see DWT + * @see #getListeners(int) * @see #removeListener(int, Listener) * @see #notifyListeners */ @@ -1087,6 +1089,7 @@ * * @see DWT * @see #addListener + * @see #getListeners(int) * @see #removeListener(int, Listener) */ public void notifyListeners (int eventType, Event event) { @@ -1154,7 +1157,7 @@ * type is one of the event constants defined in classDWT
.
*
* @param eventType the type of event to listen for
- * @param listener the listener which should no longer be notified when the event occurs
+ * @param listener the listener which should no longer be notified
*
* @exception IllegalArgumentException