summaryrefslogtreecommitdiffstats
path: root/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/MenuItem.java
diff options
context:
space:
mode:
authorCarolyn MacLeod <carolyn>2006-05-03 20:02:09 +0000
committerCarolyn MacLeod <carolyn>2006-05-03 20:02:09 +0000
commite880a6e84e2c212aad35915a8e501a30b543c4fe (patch)
tree33caaa46660a67b93663d6f950933dbf725b03f3 /bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/MenuItem.java
parentdd2daaefe7b01d6308af5987fb9008de6a622b64 (diff)
downloadeclipse.platform.swt-e880a6e84e2c212aad35915a8e501a30b543c4fe.tar.gz
eclipse.platform.swt-e880a6e84e2c212aad35915a8e501a30b543c4fe.tar.xz
eclipse.platform.swt-e880a6e84e2c212aad35915a8e501a30b543c4fe.zip
Javadoc basher output for 3.2RC3
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/MenuItem.java')
-rw-r--r--bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/MenuItem.java14
1 files changed, 10 insertions, 4 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/MenuItem.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/MenuItem.java
index dc07b150ac..1da00ef764 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/MenuItem.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/MenuItem.java
@@ -95,10 +95,11 @@ public MenuItem (Menu parent, int style) {
*
* @param parent a menu control which will be the parent of the new instance (cannot be null)
* @param style the style of control to construct
- * @param index the index to store the receiver in its parent
+ * @param index the zero-relative index to store the receiver in its parent
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
+ * <li>ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the parent (inclusive)</li>
* </ul>
* @exception SWTException <ul>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent</li>
@@ -684,6 +685,11 @@ public void setImage (Image image) {
* pull down menu. The sequence of key strokes, button presses
* and/or button releases that are used to request a pull down
* menu is platform specific.
+ * <p>
+ * Note: Disposing of a menu item that has a pull down menu
+ * will dispose of the menu. To avoid this behavior, set the
+ * menu to null before the menu item is disposed.
+ * </p>
*
* @param menu the new pull down menu
*
@@ -779,14 +785,14 @@ public void setSelection (boolean selected) {
* Sets the receiver's text. The string may include
* the mnemonic character and accelerator text.
* <p>
- * Mnemonics are indicated by an '&amp' that causes the next
+ * Mnemonics are indicated by an '&amp;' that causes the next
* character to be the mnemonic. When the user presses a
* key sequence that matches the mnemonic, a selection
* event occurs. On most platforms, the mnemonic appears
* underlined but may be emphasised in a platform specific
- * manner. The mnemonic indicator character '&amp' can be
+ * manner. The mnemonic indicator character '&amp;' can be
* escaped by doubling it in the string, causing a single
- *'&amp' to be displayed.
+ * '&amp;' to be displayed.
* </p>
* <p>
* Accelerator text is indicated by the '\t' character.