diff options
author | Carolyn MacLeod <carolyn> | 2009-05-27 19:05:21 +0000 |
---|---|---|
committer | Carolyn MacLeod <carolyn> | 2009-05-27 19:05:21 +0000 |
commit | 252fa34277ec96231d89bbba1b2222a71f04f4b5 (patch) | |
tree | d1ab9d844a8f24e69ec7c33d43992143e4825371 /bundles/org.eclipse.swt/Eclipse SWT/carbon/org | |
parent | 0e9de50affb69f2c41b7aaf179af3432f3658daf (diff) | |
download | eclipse.platform.swt-252fa34277ec96231d89bbba1b2222a71f04f4b5.tar.gz eclipse.platform.swt-252fa34277ec96231d89bbba1b2222a71f04f4b5.tar.xz eclipse.platform.swt-252fa34277ec96231d89bbba1b2222a71f04f4b5.zip |
After javadoc bash for 3.5RC3v3549aBEFORE_COPYRIGHT_BASH_FOR_35RC3AFTER_JAVADOC_BASH_FOR_35RC3
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT/carbon/org')
45 files changed, 253 insertions, 59 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/graphics/GC.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/graphics/GC.java index efdb2c889d..68e5cfff0b 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/graphics/GC.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/graphics/GC.java @@ -30,6 +30,14 @@ import org.eclipse.swt.*; * </p> * * <p> + * The result of drawing on an image that was created with an indexed + * palette using a color that is not in the palette is platform specific. + * Some platforms will match to the nearest color while other will draw + * the color itself. This happens because the allocated image might use + * a direct palette on platforms that do not support indexed palette. + * </p> + * + * <p> * Application code must explicitly invoke the <code>GC.dispose()</code> * method to release the operating system resources managed by each instance * when those instances are no longer required. This is <em>particularly</em> @@ -2222,6 +2230,7 @@ public Pattern getForegroundPattern() { * @see GCData * * @since 3.2 + * @noreference This method is not intended to be referenced by clients. */ public GCData getGCData() { if (handle == 0) SWT.error(SWT.ERROR_WIDGET_DISPOSED); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/graphics/GCData.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/graphics/GCData.java index 52069e6378..074bc0ec65 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/graphics/GCData.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/graphics/GCData.java @@ -24,6 +24,7 @@ import org.eclipse.swt.internal.carbon.Rect; * platforms, and should never be called from application code. * </p> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noinstantiate This class is not intended to be instantiated by clients. */ public final class GCData { public Device device; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/graphics/TextLayout.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/graphics/TextLayout.java index 8e27d0afcd..e82a6a5fbc 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/graphics/TextLayout.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/graphics/TextLayout.java @@ -2111,7 +2111,12 @@ public void setTabs(int[] tabs) { /** * Sets the receiver's text. - * + *<p> + * Note: Setting the text also clears all the styles. This method + * returns without doing anything if the new text is the same as + * the current text. + * </p> + * * @param text the new text * * @exception IllegalArgumentException <ul> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Button.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Button.java index 1b4081a15e..bdee03b056 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Button.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Button.java @@ -44,6 +44,7 @@ import org.eclipse.swt.internal.carbon.*; * @see <a href="http://www.eclipse.org/swt/snippets/#button">Button snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Button extends Control { String text = ""; @@ -81,6 +82,8 @@ public class Button extends Control { * @see SWT#RADIO * @see SWT#TOGGLE * @see SWT#FLAT + * @see SWT#UP + * @see SWT#DOWN * @see SWT#LEFT * @see SWT#RIGHT * @see SWT#CENTER diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Caret.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Caret.java index e3c15114a7..9869a16351 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Caret.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Caret.java @@ -36,6 +36,7 @@ import org.eclipse.swt.graphics.*; * @see <a href="http://www.eclipse.org/swt/snippets/#caret">Caret snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample, Canvas tab</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Caret extends Widget { Canvas parent; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ColorDialog.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ColorDialog.java index 3ca3106023..4fea5d4d05 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ColorDialog.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ColorDialog.java @@ -31,6 +31,7 @@ import org.eclipse.swt.graphics.RGB; * * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample, Dialog tab</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class ColorDialog extends Dialog { RGB rgb; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Combo.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Combo.java index fb43a565c3..0b62e7f6ae 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Combo.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Combo.java @@ -58,6 +58,7 @@ import org.eclipse.swt.internal.carbon.Rect; * @see <a href="http://www.eclipse.org/swt/snippets/#combo">Combo snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Combo extends Composite { int menuHandle; @@ -1771,6 +1772,10 @@ public void setSelection (Point selection) { * Sets the contents of the receiver's text field to the * given string. * <p> + * This call is ignored when the receiver is read only and + * the given string is not in the receiver's list. + * </p> + * <p> * Note: The text field in a <code>Combo</code> is typically * only capable of displaying a single line of text. Thus, * setting the text to a string containing line breaks or diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Composite.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Composite.java index 986440407a..7e55e47815 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Composite.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Composite.java @@ -33,10 +33,9 @@ import org.eclipse.swt.graphics.*; * than <code>Canvas</code>. * </p><p> * Note: The <code>CENTER</code> style, although undefined for composites, has the - * same value as <code>EMBEDDED</code> (which is used to embed widgets from other - * widget toolkits into SWT). On some operating systems (GTK, Motif), this may cause - * the children of this composite to be obscured. The <code>EMBEDDED</code> style - * is for use by other widget toolkits and should normally never be used. + * same value as <code>EMBEDDED</code> which is used to embed widgets from other + * widget toolkits into SWT. On some operating systems (GTK, Motif), this may cause + * the children of this composite to be obscured. * </p><p> * This class may be subclassed by custom control implementors * who are building controls that are constructed from aggregates @@ -85,6 +84,8 @@ Composite () { * @see SWT#NO_MERGE_PAINTS * @see SWT#NO_REDRAW_RESIZE * @see SWT#NO_RADIO_GROUP + * @see SWT#EMBEDDED + * @see SWT#DOUBLE_BUFFERED * @see Widget#getStyle */ public Composite (Composite parent, int style) { diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Control.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Control.java index e6b385a2d8..4b4c6aca30 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Control.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Control.java @@ -48,6 +48,7 @@ import org.eclipse.swt.accessibility.Accessible; * @see <a href="http://www.eclipse.org/swt/snippets/#control">Control snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public abstract class Control extends Widget implements Drawable { /** @@ -106,6 +107,8 @@ Control () { * </ul> * * @see SWT#BORDER + * @see SWT#LEFT_TO_RIGHT + * @see SWT#RIGHT_TO_LEFT * @see Widget#checkSubclass * @see Widget#getStyle */ @@ -1039,7 +1042,11 @@ String [] getAxAttributes () { /** * Returns the receiver's background color. - * + * <p> + * Note: This operation is a hint and may be overridden by the platform. + * For example, on some versions of Windows the background of a TabFolder, + * is a gradient rather than a solid color. + * </p> * @return the background color * * @exception SWTException <ul> @@ -3797,8 +3804,17 @@ boolean setTabItemFocus () { /** * Sets the receiver's tool tip text to the argument, which - * may be null indicating that no tool tip text should be shown. - * + * may be null indicating that the default tool tip for the + * control will be shown. For a control that has a default + * tool tip, such as the Tree control on Windows, setting + * the tool tip text to an empty string replaces the default, + * causing no tool tip text to be shown. + * <p> + * The mnemonic indicator (character '&') is not displayed in a tool tip. + * To display a single '&' in the tool tip, the character '&' can be + * escaped by doubling it in the string. + * </p> + * * @param string the new tool tip text (or null) * * @exception SWTException <ul> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/DateTime.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/DateTime.java index 8891cc6042..62a34bba63 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/DateTime.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/DateTime.java @@ -30,13 +30,14 @@ import org.eclipse.swt.internal.carbon.Rect; * </p> * <dl> * <dt><b>Styles:</b></dt> - * <dd>DATE, TIME, CALENDAR, SHORT, MEDIUM, LONG</dd> + * <dd>DATE, TIME, CALENDAR, SHORT, MEDIUM, LONG, DROP_DOWN</dd> * <dt><b>Events:</b></dt> - * <dd>Selection</dd> + * <dd>DefaultSelection, Selection</dd> * </dl> * <p> * Note: Only one of the styles DATE, TIME, or CALENDAR may be specified, * and only one of the styles SHORT, MEDIUM, or LONG may be specified. + * The DROP_DOWN style is a <em>HINT</em>, and it is only valid with the DATE style. * </p><p> * IMPORTANT: This class is <em>not</em> intended to be subclassed. * </p> @@ -46,6 +47,7 @@ import org.eclipse.swt.internal.carbon.Rect; * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.3 + * @noextend This class is not intended to be subclassed by clients. */ public class DateTime extends Composite { LongDateRec dateRec; @@ -89,6 +91,10 @@ public class DateTime extends Composite { * @see SWT#DATE * @see SWT#TIME * @see SWT#CALENDAR + * @see SWT#SHORT + * @see SWT#MEDIUM + * @see SWT#LONG + * @see SWT#DROP_DOWN * @see Widget#checkSubclass * @see Widget#getStyle */ @@ -158,7 +164,7 @@ protected void checkSubclass () { * interface. * <p> * <code>widgetSelected</code> is called when the user changes the control's value. - * <code>widgetDefaultSelected</code> is not called. + * <code>widgetDefaultSelected</code> is typically called when ENTER is pressed. * </p> * * @param listener the listener which should be notified @@ -736,6 +742,7 @@ public void setDate (int year, int month, int day) { * Sets the receiver's date, or day of the month, to the specified day. * <p> * The first day of the month is 1, and the last day depends on the month and year. + * If the specified day is not valid for the receiver's month and year, then it is ignored. * </p> * * @param day a positive integer beginning with 1 @@ -744,6 +751,8 @@ public void setDate (int year, int month, int day) { * <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 #setDate */ public void setDay (int day) { checkWidget (); @@ -817,6 +826,7 @@ public void setMinutes (int minutes) { * Sets the receiver's month. * <p> * The first month of the year is 0, and the last month is 11. + * If the specified month is not valid for the receiver's day and year, then it is ignored. * </p> * * @param month an integer between 0 and 11 @@ -825,6 +835,8 @@ public void setMinutes (int minutes) { * <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 #setDate */ public void setMonth (int month) { checkWidget (); @@ -909,6 +921,7 @@ public void setTime (int hours, int minutes, int seconds) { * Sets the receiver's year. * <p> * The first year is 1752 and the last year is 9999. + * If the specified year is not valid for the receiver's day and month, then it is ignored. * </p> * * @param year an integer between 1752 and 9999 @@ -917,6 +930,8 @@ public void setTime (int hours, int minutes, int seconds) { * <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 #setDate */ public void setYear (int year) { checkWidget (); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Decorations.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Decorations.java index 23e6538b0b..fcac2a32b3 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Decorations.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Decorations.java @@ -93,6 +93,7 @@ import org.eclipse.swt.graphics.*; * @see Shell * @see SWT * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Decorations extends Canvas { Image image; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/DirectoryDialog.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/DirectoryDialog.java index 3ca9c726b5..2594b37a6e 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/DirectoryDialog.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/DirectoryDialog.java @@ -32,6 +32,7 @@ import org.eclipse.swt.*; * @see <a href="http://www.eclipse.org/swt/snippets/#directorydialog">DirectoryDialog snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample, Dialog tab</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class DirectoryDialog extends Dialog { String message = "", filterPath = ""; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Display.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Display.java index 22f0d73e36..beb8891e8e 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Display.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Display.java @@ -103,6 +103,7 @@ import org.eclipse.swt.graphics.*; * @see Device#dispose * @see <a href="http://www.eclipse.org/swt/snippets/#display">Display snippets</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Display extends Device { @@ -2453,6 +2454,13 @@ int pollingProc (int inTimer, int inUserData) { * <li>(in) x the x coordinate to move the mouse pointer to in screen coordinates * <li>(in) y the y coordinate to move the mouse pointer to in screen coordinates * </ul> + * <p>MouseWheel</p> + * <p>The following fields in the <code>Event</code> apply: + * <ul> + * <li>(in) type MouseWheel + * <li>(in) detail either SWT.SCROLL_LINE or SWT.SCROLL_PAGE + * <li>(in) count the number of lines or pages to scroll + * </ul> * </dl> * * @param event the event to be generated diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/FileDialog.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/FileDialog.java index ad3fdf5d9a..a3c945ca8c 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/FileDialog.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/FileDialog.java @@ -34,6 +34,7 @@ import org.eclipse.swt.internal.carbon.*; * @see <a href="http://www.eclipse.org/swt/snippets/#filedialog">FileDialog snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample, Dialog tab</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class FileDialog extends Dialog { String [] filterNames = new String [0]; @@ -84,6 +85,10 @@ public FileDialog (Shell parent) { * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li> * <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li> * </ul> + * + * @see SWT#SAVE + * @see SWT#OPEN + * @see SWT#MULTI */ public FileDialog (Shell parent, int style) { super (parent, checkStyle (parent, style)); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/FontDialog.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/FontDialog.java index 52fcd5a919..1693a52ea6 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/FontDialog.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/FontDialog.java @@ -33,6 +33,7 @@ import org.eclipse.swt.internal.carbon.RGBColor; * * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample, Dialog tab</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class FontDialog extends Dialog { FontData fontData; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Group.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Group.java index 977ad25742..1c21351711 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Group.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Group.java @@ -39,6 +39,7 @@ import org.eclipse.swt.internal.carbon.Rect; * * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Group extends Composite { String text = ""; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/IME.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/IME.java index 9d48b8f0f6..9706fbdb78 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/IME.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/IME.java @@ -36,6 +36,7 @@ import org.eclipse.swt.internal.carbon.TextRange; * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.4 + * @noextend This class is not intended to be subclassed by clients. */ public class IME extends Widget { Canvas parent; @@ -422,7 +423,7 @@ void releaseWidget () { * above the IME, then the IME must be informed that the composition * offset has changed. * - * @return the offset of the composition + * @param offset the offset of the composition * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Label.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Label.java index b679075a68..f930b5ce0a 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Label.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Label.java @@ -23,7 +23,7 @@ import org.eclipse.swt.graphics.*; * When SEPARATOR is specified, displays a single * vertical or horizontal line. * <p> - * Shadow styles are hints and may not be honoured + * Shadow styles are hints and may not be honored * by the platform. To create a separator label * with the default shadow style for the platform, * do not specify a shadow style. @@ -48,6 +48,7 @@ import org.eclipse.swt.graphics.*; * @see <a href="http://www.eclipse.org/swt/snippets/#label">Label snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Label extends Control { String text = ""; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Link.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Link.java index 429bfa83d1..f18c301ad1 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Link.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Link.java @@ -39,6 +39,7 @@ import org.eclipse.swt.graphics.*; * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.1 + * @noextend This class is not intended to be subclassed by clients. */ public class Link extends Control { String text; @@ -669,8 +670,9 @@ void setFontStyle (Font font) { * selected, the text field of the selection event contains either the * text of the hyperlink or the value of its HREF, if one was specified. * In the rare case of identical hyperlinks within the same string, the - * HREF tag can be used to distinguish between them. The string may - * include the mnemonic character and line delimiters. + * HREF attribute can be used to distinguish between them. The string may + * include the mnemonic character and line delimiters. The only delimiter + * the HREF attribute supports is the quotation mark ("). * </p> * * @param string the new text diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/List.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/List.java index 66ff6c92e0..7ad8cd6b7c 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/List.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/List.java @@ -42,6 +42,7 @@ import org.eclipse.swt.graphics.*; * @see <a href="http://www.eclipse.org/swt/snippets/#list">List snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class List extends Scrollable { String [] items; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Menu.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Menu.java index 5f57f4af6a..06ae16cf24 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Menu.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Menu.java @@ -41,6 +41,7 @@ import org.eclipse.swt.graphics.*; * @see <a href="http://www.eclipse.org/swt/snippets/#menu">Menu snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Menu extends Widget { /** @@ -121,6 +122,9 @@ public Menu (Control parent) { * @see SWT#BAR * @see SWT#DROP_DOWN * @see SWT#POP_UP + * @see SWT#NO_RADIO_GROUP + * @see SWT#LEFT_TO_RIGHT + * @see SWT#RIGHT_TO_LEFT * @see Widget#checkSubclass * @see Widget#getStyle */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/MenuItem.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/MenuItem.java index 3d680c79c8..871495fcb9 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/MenuItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/MenuItem.java @@ -33,6 +33,7 @@ import org.eclipse.swt.internal.carbon.*; * </p> * * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class MenuItem extends Item { Menu parent, menu; @@ -665,6 +666,9 @@ public void setEnabled (boolean enabled) { * <p> * Note: This operation is a hint and is not supported on * platforms that do not have this concept (for example, Windows NT). + * Furthermore, some platforms (such as GTK), cannot display both + * a check box and an image at the same time. Instead, they hide + * the image and display the check box. * </p> * * @param image the image to display diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/MessageBox.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/MessageBox.java index 1f5b08ebd2..70421f4f90 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/MessageBox.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/MessageBox.java @@ -36,6 +36,7 @@ import org.eclipse.swt.internal.carbon.*; * * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample, Dialog tab</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class MessageBox extends Dialog { String message = ""; @@ -80,6 +81,19 @@ public MessageBox (Shell parent) { * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li> * <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li> * </ul> + * + * @see SWT#ICON_ERROR + * @see SWT#ICON_INFORMATION + * @see SWT#ICON_QUESTION + * @see SWT#ICON_WARNING + * @see SWT#ICON_WORKING + * @see SWT#OK + * @see SWT#CANCEL + * @see SWT#YES + * @see SWT#NO + * @see SWT#ABORT + * @see SWT#RETRY + * @see SWT#IGNORE */ public MessageBox (Shell parent, int style) { super (parent, checkStyle (parent, checkStyle (style))); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ProgressBar.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ProgressBar.java index 4b64652d59..92f8f950ad 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ProgressBar.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ProgressBar.java @@ -36,6 +36,7 @@ import org.eclipse.swt.*; * @see <a href="http://www.eclipse.org/swt/snippets/#progressbar">ProgressBar snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class ProgressBar extends Control { @@ -66,6 +67,7 @@ public class ProgressBar extends Control { * @see SWT#SMOOTH * @see SWT#HORIZONTAL * @see SWT#VERTICAL + * @see SWT#INDETERMINATE * @see Widget#checkSubclass * @see Widget#getStyle */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Sash.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Sash.java index 38a1893b73..e4f33f3aa5 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Sash.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Sash.java @@ -39,6 +39,7 @@ import org.eclipse.swt.events.*; * @see <a href="http://www.eclipse.org/swt/snippets/#sash">Sash snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Sash extends Control { Cursor sizeCursor; @@ -79,6 +80,7 @@ public class Sash extends Control { * * @see SWT#HORIZONTAL * @see SWT#VERTICAL + * @see SWT#SMOOTH * @see Widget#checkSubclass * @see Widget#getStyle */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Scale.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Scale.java index a331aac0b0..0e3ab46a12 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Scale.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Scale.java @@ -38,6 +38,7 @@ import org.eclipse.swt.graphics.*; * @see <a href="http://www.eclipse.org/swt/snippets/#scale">Scale snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Scale extends Control { int increment = 1; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ScrollBar.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ScrollBar.java index b68ff92f82..81196f5abf 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ScrollBar.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ScrollBar.java @@ -81,6 +81,7 @@ import org.eclipse.swt.graphics.*; * @see Scrollable#getVerticalBar * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class ScrollBar extends Widget { int handle; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Scrollable.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Scrollable.java index c103cb9f86..82e60da2cd 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Scrollable.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Scrollable.java @@ -34,6 +34,7 @@ import org.eclipse.swt.graphics.*; * </p> * * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public abstract class Scrollable extends Control { int scrolledHandle; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Shell.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Shell.java index 8eb6769631..e7e2bc80c1 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Shell.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Shell.java @@ -84,7 +84,7 @@ import org.eclipse.swt.graphics.*; * downgraded to <code>APPLICATION_MODAL</code>. * <dl> * <dt><b>Styles:</b></dt> - * <dd>BORDER, CLOSE, MIN, MAX, NO_TRIM, RESIZE, TITLE, ON_TOP, TOOL</dd> + * <dd>BORDER, CLOSE, MIN, MAX, NO_TRIM, RESIZE, TITLE, ON_TOP, TOOL, SHEET</dd> * <dd>APPLICATION_MODAL, MODELESS, PRIMARY_MODAL, SYSTEM_MODAL</dd> * <dt><b>Events:</b></dt> * <dd>Activate, Close, Deactivate, Deiconify, Iconify</dd> @@ -173,13 +173,16 @@ public Shell () { * @see SWT#MAX * @see SWT#RESIZE * @see SWT#TITLE + * @see SWT#TOOL * @see SWT#NO_TRIM * @see SWT#SHELL_TRIM * @see SWT#DIALOG_TRIM + * @see SWT#ON_TOP * @see SWT#MODELESS * @see SWT#PRIMARY_MODAL * @see SWT#APPLICATION_MODAL * @see SWT#SYSTEM_MODAL + * @see SWT#SHEET */ public Shell (int style) { this ((Display) null, style); @@ -243,13 +246,16 @@ public Shell (Display display) { * @see SWT#MAX * @see SWT#RESIZE * @see SWT#TITLE + * @see SWT#TOOL * @see SWT#NO_TRIM * @see SWT#SHELL_TRIM * @see SWT#DIALOG_TRIM + * @see SWT#ON_TOP * @see SWT#MODELESS * @see SWT#PRIMARY_MODAL * @see SWT#APPLICATION_MODAL * @see SWT#SYSTEM_MODAL + * @see SWT#SHEET */ public Shell (Display display, int style) { this (display, null, style, 0, false); @@ -353,6 +359,7 @@ public Shell (Shell parent) { * @see SWT#PRIMARY_MODAL * @see SWT#APPLICATION_MODAL * @see SWT#SYSTEM_MODAL + * @see SWT#SHEET */ public Shell (Shell parent, int style) { this (parent != null ? parent.display : null, parent, style, 0, false); @@ -1588,7 +1595,7 @@ public void setEnabled (boolean enabled) { * to switch to the full screen state, and if the argument is * <code>false</code> and the receiver was previously switched * into full screen state, causes the receiver to switch back - * to either the maximmized or normal states. + * to either the maximized or normal states. * <p> * Note: The result of intermixing calls to <code>setFullScreen(true)</code>, * <code>setMaximized(true)</code> and <code>setMinimized(true)</code> will @@ -1765,19 +1772,19 @@ public void setMinimumSize (Point size) { setMinimumSize (size.x, size.y); } -/* -* Sets the receiver's modified state as specified by the argument. -* -* @param modified the new modified state for the receiver -* -* </ul> -* @exception SWTException <ul> -* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> -* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> -* </ul> -* -* @since 3.5 -*/ +/** + * Sets the receiver's modified state as specified by the argument. + * + * @param modified the new modified state for the receiver + * + * </ul> + * @exception SWTException <ul> + * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> + * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> + * </ul> + * + * @since 3.5 + */ public void setModified (boolean modified) { checkWidget (); OS.SetWindowModified (shellHandle, modified); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Slider.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Slider.java index 09931355b5..a835359804 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Slider.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Slider.java @@ -67,6 +67,7 @@ import org.eclipse.swt.graphics.*; * @see <a href="http://www.eclipse.org/swt/snippets/#slider">Slider snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Slider extends Control { boolean dragging; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Spinner.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Spinner.java index 2d62294715..6519a20133 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Spinner.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Spinner.java @@ -42,6 +42,7 @@ import org.eclipse.swt.graphics.*; * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.1 + * @noextend This class is not intended to be subclassed by clients. */ public class Spinner extends Composite { int textHandle, buttonHandle; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TabFolder.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TabFolder.java index 4d61186697..e75547db1b 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TabFolder.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TabFolder.java @@ -47,6 +47,7 @@ import org.eclipse.swt.graphics.*; * @see <a href="http://www.eclipse.org/swt/snippets/#tabfolder">TabFolder, TabItem snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class TabFolder extends Composite { TabItem [] items; @@ -77,6 +78,8 @@ public class TabFolder extends Composite { * </ul> * * @see SWT + * @see SWT#TOP + * @see SWT#BOTTOM * @see Widget#checkSubclass * @see Widget#getStyle */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TabItem.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TabItem.java index df6d838db5..ca29d05c05 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TabItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TabItem.java @@ -33,6 +33,7 @@ import org.eclipse.swt.internal.carbon.Rect; * * @see <a href="http://www.eclipse.org/swt/snippets/#tabfolder">TabFolder, TabItem snippets</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class TabItem extends Item { TabFolder parent; @@ -337,8 +338,17 @@ public void setText (String string) { /** * Sets the receiver's tool tip text to the argument, which - * may be null indicating that no tool tip text should be shown. - * + * may be null indicating that the default tool tip for the + * control will be shown. For a control that has a default + * tool tip, such as the Tree control on Windows, setting + * the tool tip text to an empty string replaces the default, + * causing no tool tip text to be shown. + * <p> + * The mnemonic indicator (character '&') is not displayed in a tool tip. + * To display a single '&' in the tool tip, the character '&' can be + * escaped by doubling it in the string. + * </p> + * * @param string the new tool tip text (or null) * * @exception SWTException <ul> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Table.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Table.java index c0c0b45bc7..454a599fe9 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Table.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Table.java @@ -74,6 +74,7 @@ import org.eclipse.swt.graphics.*; * @see <a href="http://www.eclipse.org/swt/snippets/#table">Table, TableItem, TableColumn snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Table extends Composite { TableItem [] items; @@ -1627,7 +1628,8 @@ public TableItem [] getItems () { /** * Returns <code>true</code> if the receiver's lines are visible, - * and <code>false</code> otherwise. + * and <code>false</code> otherwise. Note that some platforms draw + * grid lines while others may draw alternating row colors. * <p> * If one of the receiver's ancestors is not visible or some * other condition makes the receiver not visible, this method @@ -3009,7 +3011,8 @@ void setItemHeight (Image image) { /** * Marks the receiver's lines as visible if the argument is <code>true</code>, - * and marks it invisible otherwise. + * and marks it invisible otherwise. Note that some platforms draw grid lines + * while others may draw alternating row colors. * <p> * If one of the receiver's ancestors is not visible or some * other condition makes the receiver not visible, marking diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TableColumn.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TableColumn.java index dd4a01e11a..a8a9826c3f 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TableColumn.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TableColumn.java @@ -34,6 +34,7 @@ import org.eclipse.swt.events.*; * * @see <a href="http://www.eclipse.org/swt/snippets/#table">Table, TableItem, TableColumn snippets</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class TableColumn extends Item { Table parent; @@ -533,8 +534,17 @@ public void setText (String string) { /** * Sets the receiver's tool tip text to the argument, which - * may be null indicating that no tool tip text should be shown. - * + * may be null indicating that the default tool tip for the + * control will be shown. For a control that has a default + * tool tip, such as the Tree control on Windows, setting + * the tool tip text to an empty string replaces the default, + * causing no tool tip text to be shown. + * <p> + * The mnemonic indicator (character '&') is not displayed in a tool tip. + * To display a single '&' in the tool tip, the character '&' can be + * escaped by doubling it in the string. + * </p> + * * @param string the new tool tip text (or null) * * @exception SWTException <ul> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TableItem.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TableItem.java index 88f521861a..e804529c2b 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TableItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TableItem.java @@ -32,6 +32,7 @@ import org.eclipse.swt.graphics.*; * * @see <a href="http://www.eclipse.org/swt/snippets/#table">Table, TableItem, TableColumn snippets</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class TableItem extends Item { Table parent; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Text.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Text.java index fdb58b779f..4da6a57e1d 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Text.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Text.java @@ -40,20 +40,30 @@ import org.eclipse.swt.graphics.*; * <p> * <dl> * <dt><b>Styles:</b></dt> - * <dd>CANCEL, CENTER, LEFT, MULTI, PASSWORD, SEARCH, SINGLE, RIGHT, READ_ONLY, WRAP</dd> + * <dd>CENTER, ICON_CANCEL, ICON_SEARCH, LEFT, MULTI, PASSWORD, SEARCH, SINGLE, RIGHT, READ_ONLY, WRAP</dd> * <dt><b>Events:</b></dt> * <dd>DefaultSelection, Modify, Verify</dd> * </dl> * <p> * Note: Only one of the styles MULTI and SINGLE may be specified, * and only one of the styles LEFT, CENTER, and RIGHT may be specified. - * </p><p> + * </p> + * <p> + * Note: The styles ICON_CANCEL and ICON_SEARCH are hints used in combination with SEARCH. + * When the platform supports the hint, the text control shows these icons. When an icon + * is selected, a default selection event is sent with the detail field set to one of + * ICON_CANCEL or ICON_SEARCH. Normally, application code does not need to check the + * detail. In the case of ICON_CANCEL, the text is cleared before the default selection + * event is sent causing the application to search for an empty string. + * </p> + * <p> * IMPORTANT: This class is <em>not</em> intended to be subclassed. * </p> * * @see <a href="http://www.eclipse.org/swt/snippets/#text">Text snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Text extends Scrollable { int txnObject, frameHandle; @@ -128,6 +138,13 @@ public class Text extends Scrollable { * @see SWT#MULTI * @see SWT#READ_ONLY * @see SWT#WRAP + * @see SWT#LEFT + * @see SWT#RIGHT + * @see SWT#CENTER + * @see SWT#PASSWORD + * @see SWT#SEARCH + * @see SWT#ICON_SEARCH + * @see SWT#ICON_CANCEL * @see Widget#checkSubclass * @see Widget#getStyle */ @@ -992,13 +1009,10 @@ public int getOrientation () { } /** - * Returns the widget message. When the widget is created - * with the style <code>SWT.SEARCH</code>, the message text - * is displayed as a hint for the user, indicating the - * purpose of the field. + * Returns the widget message. The message text is displayed + * as a hint for the user, indicating the purpose of the field. * <p> - * Note: This operation is a <em>HINT</em> and is not - * supported on platforms that do not have this concept. + * Typically this is used in conjunction with <code>SWT.SEARCH</code>. * </p> * * @return the widget message @@ -2096,13 +2110,10 @@ public void setOrientation (int orientation) { } /** - * Sets the widget message. When the widget is created - * with the style <code>SWT.SEARCH</code>, the message text - * is displayed as a hint for the user, indicating the - * purpose of the field. + * Sets the widget message. The message text is displayed + * as a hint for the user, indicating the purpose of the field. * <p> - * Note: This operation is a <em>HINT</em> and is not - * supported on platforms that do not have this concept. + * Typically this is used in conjunction with <code>SWT.SEARCH</code>. * </p> * * @param message the new message diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ToolBar.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ToolBar.java index 7d29e0bb4d..756c7a9ac1 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ToolBar.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ToolBar.java @@ -43,6 +43,7 @@ import org.eclipse.swt.graphics.*; * @see <a href="http://www.eclipse.org/swt/snippets/#toolbar">ToolBar, ToolItem snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class ToolBar extends Composite { int itemCount; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ToolItem.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ToolItem.java index a4fc847dd4..f4bae10a09 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ToolItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ToolItem.java @@ -44,6 +44,7 @@ import org.eclipse.swt.graphics.*; * * @see <a href="http://www.eclipse.org/swt/snippets/#toolbar">ToolBar, ToolItem snippets</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class ToolItem extends Item { int handle, iconHandle, labelHandle; @@ -1280,8 +1281,17 @@ public void setText (String string) { /** * Sets the receiver's tool tip text to the argument, which - * may be null indicating that no tool tip text should be shown. - * + * may be null indicating that the default tool tip for the + * control will be shown. For a control that has a default + * tool tip, such as the Tree control on Windows, setting + * the tool tip text to an empty string replaces the default, + * causing no tool tip text to be shown. + * <p> + * The mnemonic indicator (character '&') is not displayed in a tool tip. + * To display a single '&' in the tool tip, the character '&' can be + * escaped by doubling it in the string. + * </p> + * * @param string the new tool tip text (or null) * * @exception SWTException <ul> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ToolTip.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ToolTip.java index 17b1945e63..04f4f50b40 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ToolTip.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/ToolTip.java @@ -40,6 +40,7 @@ import org.eclipse.swt.events.*; * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.2 + * @noextend This class is not intended to be subclassed by clients. */ public class ToolTip extends Widget { Shell parent, tip; @@ -84,6 +85,7 @@ public class ToolTip extends Widget { * <li>ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass</li> * </ul> * + * @see SWT#BALLOON * @see SWT#ICON_ERROR * @see SWT#ICON_INFORMATION * @see SWT#ICON_WARNING diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Tracker.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Tracker.java index 82cbb86bb6..1fd54809ae 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Tracker.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Tracker.java @@ -40,6 +40,7 @@ import org.eclipse.swt.internal.carbon.Rect; * * @see <a href="http://www.eclipse.org/swt/snippets/#tracker">Tracker snippets</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Tracker extends Widget { Control parent; @@ -127,6 +128,7 @@ public Tracker (Composite parent, int style) { * @see SWT#RIGHT * @see SWT#UP * @see SWT#DOWN + * @see SWT#RESIZE */ public Tracker (Display display, int style) { if (display == null) display = Display.getCurrent (); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TrayItem.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TrayItem.java index 2ac5caa8e9..1b3e444c5e 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TrayItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TrayItem.java @@ -36,6 +36,7 @@ import org.eclipse.swt.internal.cocoa.*; * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.0 + * @noextend This class is not intended to be subclassed by clients. */ public class TrayItem extends Item { Tray parent; @@ -376,9 +377,18 @@ public void setToolTip (ToolTip toolTip) { /** * Sets the receiver's tool tip text to the argument, which - * may be null indicating that no tool tip text should be shown. - * - * @param value the new tool tip text (or null) + * may be null indicating that the default tool tip for the + * control will be shown. For a control that has a default + * tool tip, such as the Tree control on Windows, setting + * the tool tip text to an empty string replaces the default, + * causing no tool tip text to be shown. + * <p> + * The mnemonic indicator (character '&') is not displayed in a tool tip. + * To display a single '&' in the tool tip, the character '&' can be + * escaped by doubling it in the string. + * </p> + * + * @param string the new tool tip text (or null) * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Tree.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Tree.java index 8a1dff6923..a7e1675a5b 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Tree.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/Tree.java @@ -81,6 +81,7 @@ import org.eclipse.swt.graphics.*; * @see <a href="http://www.eclipse.org/swt/snippets/#tree">Tree, TreeItem, TreeColumn snippets</a> * @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class Tree extends Composite { TreeItem [] items; @@ -1777,7 +1778,8 @@ TreeItem [] getItems (TreeItem parentItem) { /** * Returns <code>true</code> if the receiver's lines are visible, - * and <code>false</code> otherwise. + * and <code>false</code> otherwise. Note that some platforms draw + * grid lines while others may draw alternating row colors. * <p> * If one of the receiver's ancestors is not visible or some * other condition makes the receiver not visible, this method @@ -3233,7 +3235,8 @@ void setItemHeight (Image image) { /** * Marks the receiver's lines as visible if the argument is <code>true</code>, - * and marks it invisible otherwise. + * and marks it invisible otherwise. Note that some platforms draw + * grid lines while others may draw alternating row colors. * <p> * If one of the receiver's ancestors is not visible or some * other condition makes the receiver not visible, marking diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TreeColumn.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TreeColumn.java index da48ab62bf..2e9e843bfc 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TreeColumn.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TreeColumn.java @@ -36,6 +36,7 @@ import org.eclipse.swt.events.*; * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> * * @since 3.1 + * @noextend This class is not intended to be subclassed by clients. */ public class TreeColumn extends Item { Tree parent; @@ -544,8 +545,17 @@ public void setText (String string) { /** * Sets the receiver's tool tip text to the argument, which - * may be null indicating that no tool tip text should be shown. - * + * may be null indicating that the default tool tip for the + * control will be shown. For a control that has a default + * tool tip, such as the Tree control on Windows, setting + * the tool tip text to an empty string replaces the default, + * causing no tool tip text to be shown. + * <p> + * The mnemonic indicator (character '&') is not displayed in a tool tip. + * To display a single '&' in the tool tip, the character '&' can be + * escaped by doubling it in the string. + * </p> + * * @param string the new tool tip text (or null) * * @exception SWTException <ul> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TreeItem.java b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TreeItem.java index 0d5bc466b1..31b52aaf17 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TreeItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/carbon/org/eclipse/swt/widgets/TreeItem.java @@ -34,6 +34,7 @@ import org.eclipse.swt.graphics.*; * * @see <a href="http://www.eclipse.org/swt/snippets/#tree">Tree, TreeItem, TreeColumn snippets</a> * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @noextend This class is not intended to be subclassed by clients. */ public class TreeItem extends Item { Tree parent; |