diff options
author | Grant Gayed <ggayed> | 2005-06-22 14:50:11 +0000 |
---|---|---|
committer | Grant Gayed <ggayed> | 2005-06-22 14:50:11 +0000 |
commit | a35f719ac8d0c8272f6eff8156be8f6f7e72d740 (patch) | |
tree | 18636809cee891c57203e50062098b7c984f3b50 | |
parent | 5c18af56c06eac42b5c0bdd457840f7f5340884f (diff) | |
download | eclipse.platform.swt-a35f719ac8d0c8272f6eff8156be8f6f7e72d740.tar.gz eclipse.platform.swt-a35f719ac8d0c8272f6eff8156be8f6f7e72d740.tar.xz eclipse.platform.swt-a35f719ac8d0c8272f6eff8156be8f6f7e72d740.zip |
84891
13 files changed, 34 insertions, 31 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Combo.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Combo.java index fc272ddd0b..149498f5d6 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Combo.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Combo.java @@ -600,8 +600,8 @@ public int getItemHeight () { } /** - * Returns an array of <code>String</code>s which are the items - * in the receiver's list. + * Returns a (possibly empty) array of <code>String</code>s which are + * the items in the receiver's list. * <p> * Note: This is not the actual structure used by the receiver * to maintain its list of items, so modifying the array will @@ -691,7 +691,8 @@ public int getSelectionIndex () { /** * Returns a string containing a copy of the contents of the - * receiver's text field. + * receiver's text field, or an empty string if there are no + * contents. * * @return the receiver's text * diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Composite.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Composite.java index 200b486cf2..bff1ed1411 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Composite.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Composite.java @@ -277,7 +277,7 @@ void fixTabList (Control control) { } /** - * Returns an array containing the receiver's children. + * Returns a (possibly empty) array containing the receiver's children. * Children are returned in the order that they are drawn. * <p> * Note: This is not the actual structure used by the receiver @@ -331,7 +331,7 @@ public Layout getLayout () { } /** - * Gets the last specified tabbing order for the control. + * Gets the (possibly empty) tabbing order for the control. * * @return tabList the ordered list of controls representing the tab order * diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Display.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Display.java index 369b275330..c36ec4dccb 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Display.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Display.java @@ -1671,8 +1671,8 @@ public Monitor getPrimaryMonitor () { } /** - * Returns an array containing all shells which have not been - * disposed and have the receiver as their display. + * Returns a (possibly empty) array containing all shells which have + * not been disposed and have the receiver as their display. * * @return the receiver's shells * diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/FileDialog.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/FileDialog.java index c72390c363..e0eaed65c4 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/FileDialog.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/FileDialog.java @@ -84,7 +84,8 @@ public FileDialog (Shell parent, int style) { /** * Returns the path of the first file that was - * selected in the dialog relative to the filter path. + * selected in the dialog relative to the filter path, or an + * empty string if no such file has been selected. * * @return the relative path of the file */ @@ -93,8 +94,8 @@ public String getFileName () { } /** - * Returns the paths of all files that were selected - * in the dialog relative to the filter path. + * Returns a (possibly empty) array with the paths of all files + * that were selected in the dialog relative to the filter path. * * @return the relative paths of the files */ @@ -123,9 +124,9 @@ public String [] getFilterNames () { } /** - * Returns the directory path that the dialog will use. - * File names in this path will appear in the dialog, - * filtered according to the filter extensions. + * Returns the directory path that the dialog will use, or an empty + * string if this is not set. File names in this path will appear + * in the dialog, filtered according to the filter extensions. * * @return the directory path string * diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/List.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/List.java index 89356d387b..7a0005d729 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/List.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/List.java @@ -449,8 +449,8 @@ public int getItemHeight () { } /** - * Returns an array of <code>String</code>s which are the items - * in the receiver. + * Returns a (possibly empty) array of <code>String</code>s which + * are the items in the receiver. * <p> * Note: This is not the actual structure used by the receiver * to maintain its list of items, so modifying the array will @@ -524,7 +524,7 @@ public int getSelectionCount () { * Returns the zero-relative index of the item which is currently * selected in the receiver, or -1 if no item is selected. * - * @return the index of the selected item + * @return the index of the selected item or -1 * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Menu.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Menu.java index d53ce360de..6ace288382 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Menu.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Menu.java @@ -743,8 +743,8 @@ public int getItemCount () { } /** - * Returns an array of <code>MenuItem</code>s which are the items - * in the receiver. + * Returns a (possibly empty) array of <code>MenuItem</code>s which + * are the items in the receiver. * <p> * Note: This is not the actual structure used by the receiver * to maintain its list of items, so modifying the array will diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/MenuItem.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/MenuItem.java index 581c16da19..cffb42c6ad 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/MenuItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/MenuItem.java @@ -266,13 +266,13 @@ void fixMenus (Decorations newParent) { } /** - * Return the widget accelerator. An accelerator is the bit-wise + * Returns the widget accelerator. An accelerator is the bit-wise * OR of zero or more modifier masks and a key. Examples: * <code>SWT.CONTROL | SWT.SHIFT | 'T', SWT.ALT | SWT.F2</code>. * The default value is zero, indicating that the menu item does * not have an accelerator. * - * @return the accelerator + * @return the accelerator or 0 * * </ul> * @exception SWTException <ul> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/MessageBox.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/MessageBox.java index df2f644e0d..de325edd9c 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/MessageBox.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/MessageBox.java @@ -94,9 +94,9 @@ static int checkStyle (int style) { } /** - * Returns the dialog's message, which is a description of - * the purpose for which it was opened. This message will be - * visible on the dialog while it is open. + * Returns the dialog's message, or an empty string if it does not have one. + * The message is a description of the purpose for which the dialog was opened. + * This message will be visible in the dialog while it is open. * * @return the message */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Table.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Table.java index e3c2a73516..d7c691bafc 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Table.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Table.java @@ -1386,8 +1386,8 @@ public int getItemHeight () { } /** - * Returns an array of <code>TableItem</code>s which are the items - * in the receiver. + * Returns a (possibly empty) array of <code>TableItem</code>s which + * are the items in the receiver. * <p> * Note: This is not the actual structure used by the receiver * to maintain its list of items, so modifying the array will diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/TableItem.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/TableItem.java index cbe816c0e0..e0974bc15c 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/TableItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/TableItem.java @@ -449,7 +449,8 @@ public Image getImage (int index) { /** * Returns a rectangle describing the size and location * relative to its parent of an image at a column in the - * table. + * table. An empty rectangle is returned if index exceeds + * the index of the table's last column. * * @param index the index that specifies the column * @return the receiver's bounding image rectangle diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Text.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Text.java index 5623f74ebc..2db2a3a684 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Text.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Text.java @@ -769,7 +769,7 @@ public int getSelectionCount () { } /** - * Returns the selected text. + * Gets the selected text, or an empty string if there is no current selection. * * @return the selected text * diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Tree.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Tree.java index 562e69c258..e5759f3a0b 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Tree.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Tree.java @@ -1106,8 +1106,8 @@ public int getItemHeight () { } /** - * Returns the items contained in the receiver - * that are direct item children of the receiver. These + * Returns a (possibly empty) array of items contained in the + * receiver that are direct item children of the receiver. These * are the roots of the tree. * <p> * Note: This is not the actual structure used by the receiver diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/TreeItem.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/TreeItem.java index ed359bec4a..2ffc93196f 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/TreeItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/TreeItem.java @@ -571,8 +571,8 @@ public int getItemCount () { } /** - * Returns an array of <code>TreeItem</code>s which are the - * direct item children of the receiver. + * Returns a (possibly empty) array of <code>TreeItem</code>s which + * are the direct item children of the receiver. * <p> * Note: This is not the actual structure used by the receiver * to maintain its list of items, so modifying the array will |