summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCarolyn MacLeod <carolyn>2005-06-22 19:35:24 +0000
committerCarolyn MacLeod <carolyn>2005-06-22 19:35:24 +0000
commitc80b6bbb7632776bb73138b7bb43edbba7510d67 (patch)
tree6986b4604c2a6f51cf45c0561b5821a396be0c7a
parent3d46a5db0398dddaf37b5b88b44ca853285ffc69 (diff)
downloadeclipse.platform.swt-c80b6bbb7632776bb73138b7bb43edbba7510d67.tar.gz
eclipse.platform.swt-c80b6bbb7632776bb73138b7bb43edbba7510d67.tar.xz
eclipse.platform.swt-c80b6bbb7632776bb73138b7bb43edbba7510d67.zip
doc: bug 84985
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Decorations.java6
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Display.java9
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/FileDialog.java2
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/MenuItem.java4
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Table.java2
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Text.java23
6 files changed, 31 insertions, 15 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Decorations.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Decorations.java
index 26c9a68a42..46067b9bb1 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Decorations.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Decorations.java
@@ -863,7 +863,11 @@ void setBounds (int x, int y, int width, int height, int flags, boolean defer) {
* <em>saved default button</em>). If no default button had
* previously been set, or the saved default button was
* disposed, the receiver's default button will be set to
- * null.
+ * null.
+ * <p>
+ * The default button is the button that is selected when
+ * the receiver is active and the user presses ENTER.
+ * </p>
*
* @param button the new default button
*
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 c36ec4dccb..79c70291d9 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
@@ -366,7 +366,7 @@ static void setDevice (Device device) {
* </p>
*
* @exception SWTException <ul>
- * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li>
+ * <li>ERROR_THREAD_INVALID_ACCESS - if called from a thread that already created an existing display</li>
* <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li>
* </ul>
*
@@ -1350,9 +1350,8 @@ public boolean getHighContrast () {
}
/**
- * Returns the maximum allowed depth of icons on this display.
- * On some platforms, this may be different than the actual
- * depth of the display.
+ * Returns the maximum allowed depth of icons on this display, in bits per pixel.
+ * On some platforms, this may be different than the actual depth of the display.
*
* @return the maximum icon depth
*
@@ -1360,6 +1359,8 @@ public boolean getHighContrast () {
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li>
* </ul>
+ *
+ * @see Device#getDepth
*/
public int getIconDepth () {
checkDevice ();
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 91c6d92f81..5cd438d813 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
@@ -24,6 +24,8 @@ import org.eclipse.swt.*;
* <dd>(none)</dd>
* </dl>
* <p>
+ * Note: Only one of the styles SAVE and OPEN may be specified.
+ * </p><p>
* IMPORTANT: This class is intended to be subclassed <em>only</em>
* within the SWT implementation.
* </p>
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 bf19fbd04c..1364b6083c 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
@@ -653,8 +653,8 @@ public void setEnabled (boolean enabled) {
/**
* Sets the image the receiver will display to the argument.
* <p>
- * Note: This feature is not available on all window systems (for example, Windows NT),
- * in which case, calling this method will do nothing.
+ * Note: This operation is a hint and is not supported on
+ * platforms that do not have this concept (for example, Windows NT).
* </p>
*
* @param image the image to display
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 69e303ad96..6cb48daa3c 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
@@ -2787,7 +2787,7 @@ public void setSelection (TableItem [] items) {
/**
* Selects the item at the given zero-relative index in the receiver.
- * The current selected is first cleared, then the new item is selected.
+ * The current selection is first cleared, then the new item is selected.
*
* @param index the index of the item to select
*
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 a05146654e..47f75ce01b 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
@@ -633,6 +633,8 @@ public boolean getDoubleClickEnabled () {
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
+ *
+ * @see #setEchoChar
*/
public char getEchoChar () {
checkWidget ();
@@ -681,6 +683,8 @@ public int getLineCount () {
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
* </ul>
+ *
+ * @see #DELIMITER
*/
public String getLineDelimiter () {
checkWidget ();
@@ -711,7 +715,8 @@ public int getLineHeight () {
}
/**
- * Returns the orientation of the receiver.
+ * Returns the orientation of the receiver, which will be one of the
+ * constants <code>SWT.LEFT_TO_RIGHT</code> or <code>SWT.RIGHT_TO_LEFT</code>.
*
* @return the orientation style
*
@@ -1296,8 +1301,8 @@ void setBounds (int x, int y, int width, int height, int flags) {
* default action of the text widget when the user
* double clicks.
* </p><p>
- * Note: This feature is not available on all window systems,
- * in which case, calling this method will do nothing.
+ * Note: This operation is a hint and is not supported on
+ * platforms that do not have this concept.
* </p>
*
* @param doubleClick the new double click flag
@@ -1375,8 +1380,8 @@ public void setFont (Font font) {
* Sets the orientation of the receiver, which must be one
* of the constants <code>SWT.LEFT_TO_RIGHT</code> or <code>SWT.RIGHT_TO_LEFT</code>.
* <p>
- * Note: This feature is not available on all window systems,
- * in which case, calling this method will do nothing.
+ * Note: This operation is a hint and is not supported on
+ * platforms that do not have this concept.
* </p>
*
* @param orientation new orientation style
@@ -1437,7 +1442,8 @@ public void setSelection (int start) {
}
/**
- * Sets the selection.
+ * Sets the selection to the range specified
+ * by the given start and end indices.
* <p>
* Indexing is zero based. The range of
* a selection is from 0..N where N is
@@ -1492,7 +1498,10 @@ public void setRedraw (boolean redraw) {
}
/**
- * Sets the selection.
+ * Sets the selection to the range specified
+ * by the given point, where the x coordinate
+ * represents the start index and the y coordinate
+ * represents the end index.
* <p>
* Indexing is zero based. The range of
* a selection is from 0..N where N is