blob: c5a20e530da136a345ce0f7c80dfff232764274a [file] [log] [blame]
package org.eclipse.swt.widgets;
/*
* (c) Copyright IBM Corp. 2000, 2001.
* All Rights Reserved
*/
import org.eclipse.swt.internal.*;
import org.eclipse.swt.internal.win32.*;
import org.eclipse.swt.*;
import org.eclipse.swt.graphics.*;
import org.eclipse.swt.events.*;
/**
* Instances of this class represent a selectable user interface object
* that issues notification when pressed and released.
* <dl>
* <dt><b>Styles:</b></dt>
* <dd>CHECK, CASCADE, PUSH, RADIO, SEPARATOR</dd>
* <dt><b>Events:</b></dt>
* <dd>Arm, Help, Selection</dd>
* </dl>
*<p>
* IMPORTANT: This class is <em>not</em> intended to be subclassed.
* </p>
*/
public class MenuItem extends Item {
Menu parent, menu;
int id, accelerator;
public MenuItem (Menu parent, int style) {
super (parent, checkStyle (style));
this.parent = parent;
parent.createItem (this, parent.getItemCount ());
}
public MenuItem (Menu parent, int style, int index) {
super (parent, checkStyle (style));
this.parent = parent;
parent.createItem (this, index);
}
/**
* Adds the listener to the collection of listeners who will
* be notified when the arm events are generated for the control, by sending
* it one of the messages defined in the <code>ArmListener</code>
* interface.
*
* @param listener the listener which should be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
* </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>
*
* @see ArmListener
* @see #removeArmListener
*/
public void addArmListener (ArmListener listener) {
checkWidget ();
if (listener == null) error (SWT.ERROR_NULL_ARGUMENT);
TypedListener typedListener = new TypedListener (listener);
addListener (SWT.Arm, typedListener);
}
/**
* Adds the listener to the collection of listeners who will
* be notified when the help events are generated for the control, by sending
* it one of the messages defined in the <code>HelpListener</code>
* interface.
*
* @param listener the listener which should be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
* </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>
*
* @see HelpListener
* @see #removeHelpListener
*/
public void addHelpListener (HelpListener listener) {
checkWidget ();
if (listener == null) error (SWT.ERROR_NULL_ARGUMENT);
TypedListener typedListener = new TypedListener (listener);
addListener (SWT.Help, typedListener);
}
/**
* Adds the listener to the collection of listeners who will
* be notified when the control is selected, by sending
* it one of the messages defined in the <code>SelectionListener</code>
* interface.
* <p>
* When <code>widgetSelected</code> is called, the stateMask field of the event object is valid.
* <code>widgetDefaultSelected</code> is not called.
* </p>
*
* @param listener the listener which should be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
* </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>
*
* @see SelectionListener
* @see #removeSelectionListener
* @see SelectionEvent
*/
public void addSelectionListener (SelectionListener listener) {
checkWidget ();
if (listener == null) error (SWT.ERROR_NULL_ARGUMENT);
TypedListener typedListener = new TypedListener(listener);
addListener (SWT.Selection,typedListener);
addListener (SWT.DefaultSelection,typedListener);
}
protected void checkSubclass () {
if (!isValidSubclass ()) error (SWT.ERROR_INVALID_SUBCLASS);
}
static int checkStyle (int style) {
return checkBits (style, SWT.PUSH, SWT.CHECK, SWT.RADIO, SWT.SEPARATOR, SWT.CASCADE, 0);
}
void fillAccel (ACCEL accel) {
accel.fVirt = 0;
accel.cmd = accel.key = 0;
if (accelerator == 0) return;
int key = accelerator & ~(SWT.ALT | SWT.CTRL | SWT.SHIFT);
int newKey = Display.untranslateKey (key);
if (newKey != 0) {
key = newKey;
} else {
if (key == 0x7F) {
key = OS.VK_DELETE;
} else {
char ch = wcsToMbcs ((char) key);
key = OS.CharUpper ((short) ch);
}
}
accel.key = (short) key;
accel.cmd = (short) id;
accel.fVirt = (byte) OS.FVIRTKEY;
if ((accelerator & SWT.ALT) != 0) accel.fVirt |= OS.FALT;
if ((accelerator & SWT.CTRL) != 0) accel.fVirt |= OS.FCONTROL;
if ((accelerator & SWT.SHIFT) != 0) accel.fVirt |= OS.FSHIFT;
}
/**
* Return 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>.
*
* @return the accelerator
*
* </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>
*/
public int getAccelerator () {
checkWidget ();
return accelerator;
}
public Display getDisplay () {
Menu parent = this.parent;
if (parent == null) error (SWT.ERROR_WIDGET_DISPOSED);
return parent.getDisplay ();
}
/**
* Returns <code>true</code> if the receiver is enabled, and
* <code>false</code> otherwise. A disabled control is typically
* not selectable from the user interface and draws with an
* inactive or "grayed" look.
*
* @return the receiver's enabled state
*
* @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>
*/
public boolean getEnabled () {
checkWidget ();
int hMenu = parent.handle;
MENUITEMINFO info = new MENUITEMINFO ();
info.cbSize = MENUITEMINFO.sizeof;
info.fMask = OS.MIIM_STATE;
boolean success = OS.GetMenuItemInfo (hMenu, id, false, info);
if (!success) error (SWT.ERROR_CANNOT_GET_ENABLED);
return (info.fState & (OS.MFS_DISABLED | OS.MFS_GRAYED)) == 0;
}
/**
* Returns the receiver's cascade menu if it has one or null
* if it does not. Only <code>CASCADE</code> menu items can have
* a 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.
*
* @return the receiver's menu
*
* @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>
*/
public Menu getMenu () {
checkWidget ();
return menu;
}
String getNameText () {
if ((style & SWT.SEPARATOR) != 0) return "|";
return super.getNameText ();
}
/**
* Returns the receiver's parent, which must be a <code>Menu</code>.
*
* @return the receiver's parent
*
* @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>
*/
public Menu getParent () {
checkWidget ();
return parent;
}
/**
* Returns <code>true</code> if the receiver is selected,
* and false otherwise.
* <p>
* When the receiver is of type <code>CHECK</code> or <code>RADIO</code>,
* it is selected when it is checked.
*
* @return the selection state
*
* @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>
*/
public boolean getSelection () {
checkWidget ();
if ((style & (SWT.CHECK | SWT.RADIO)) == 0) return false;
int hMenu = parent.handle;
MENUITEMINFO info = new MENUITEMINFO ();
info.cbSize = MENUITEMINFO.sizeof;
info.fMask = OS.MIIM_STATE;
boolean success = OS.GetMenuItemInfo (hMenu, id, false, info);
if (!success) error (SWT.ERROR_CANNOT_GET_SELECTION);
return (info.fState & OS.MFS_CHECKED) !=0;
}
/**
* Returns <code>true</code> if the receiver is enabled, and
* <code>false</code> otherwise. A disabled control is typically
* not selectable from the user interface and draws with an
* inactive or "grayed" look.
*
* @return the receiver's enabled state
*
* @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>
*/
public boolean isEnabled () {
return getEnabled () && parent.isEnabled ();
}
void releaseChild () {
super.releaseChild ();
if (menu != null) menu.dispose ();
menu = null;
parent.destroyItem (this);
}
void releaseWidget () {
if (menu != null) {
menu.releaseWidget ();
menu.releaseHandle ();
}
menu = null;
super.releaseWidget ();
if (accelerator != 0) {
parent.destroyAcceleratorTable ();
}
accelerator = 0;
Decorations shell = parent.parent;
shell.remove (this);
parent = null;
}
/**
* Removes the listener from the collection of listeners who will
* be notified when the arm events are generated for the control.
*
* @param listener the listener which should be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
* </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>
*
* @see ArmListener
* @see #addArmListener
*/
public void removeArmListener (ArmListener listener) {
checkWidget ();
if (listener == null) error (SWT.ERROR_NULL_ARGUMENT);
if (eventTable == null) return;
eventTable.unhook (SWT.Arm, listener);
}
/**
* Removes the listener from the collection of listeners who will
* be notified when the help events are generated for the control.
*
* @param listener the listener which should be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
* </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>
*
* @see HelpListener
* @see #addHelpListener
*/
public void removeHelpListener (HelpListener listener) {
checkWidget ();
if (listener == null) error (SWT.ERROR_NULL_ARGUMENT);
if (eventTable == null) return;
eventTable.unhook (SWT.Help, listener);
}
/**
* Removes the listener from the collection of listeners who will
* be notified when the control is selected.
*
* @param listener the listener which should be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
* </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>
*
* @see SelectionListener
* @see #addSelectionListener
*/
public void removeSelectionListener (SelectionListener listener) {
checkWidget ();
if (listener == null) error (SWT.ERROR_NULL_ARGUMENT);
if (eventTable == null) return;
eventTable.unhook (SWT.Selection, listener);
eventTable.unhook (SWT.DefaultSelection,listener);
}
/**
* Sets 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>.
*
* @param accelerator an integer that is the bit-wise OR of masks and a key
*
* </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>
*/
public void setAccelerator (int accelerator) {
checkWidget ();
this.accelerator = accelerator;
parent.destroyAcceleratorTable ();
}
/**
* Enables the receiver if the argument is <code>true</code>,
* and disables it otherwise. A disabled control is typically
* not selectable from the user interface and draws with an
* inactive or "grayed" look.
*
* @param enabled the new enabled state
*
* @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>
*/
public void setEnabled (boolean enabled) {
checkWidget ();
int hMenu = parent.handle;
MENUITEMINFO info = new MENUITEMINFO ();
info.cbSize = MENUITEMINFO.sizeof;
info.fMask = OS.MIIM_STATE;
boolean success = OS.GetMenuItemInfo (hMenu, id, false, info);
if (!success) error (SWT.ERROR_CANNOT_SET_ENABLED);
info.fState &= ~(OS.MFS_DISABLED | OS.MFS_GRAYED);
if (!enabled) info.fState |= (OS.MFS_DISABLED | OS.MFS_GRAYED);
success = OS.SetMenuItemInfo (hMenu, id, false, info);
if (!success) error (SWT.ERROR_CANNOT_SET_ENABLED);
parent.redraw ();
}
public void setImage (Image image) {
checkWidget ();
if ((style & SWT.SEPARATOR) != 0) return;
super.setImage (image);
if ((WIN32_MAJOR << 16 | WIN32_MINOR) < (4 << 16 | 10)) {
return;
}
int hMenu = parent.handle;
int hHeap = OS.GetProcessHeap ();
MENUITEMINFO info = new MENUITEMINFO ();
info.cbSize = MENUITEMINFO.sizeof;
info.fMask = OS.MIIM_BITMAP;
if (image != null) info.hbmpItem = OS.HBMMENU_CALLBACK;
boolean success = OS.SetMenuItemInfo (hMenu, id, false, info);
/*
* This code is intentionally commented.
*/
// if (!success) error (SWT.ERROR_CANNOT_SET_TEXT);
parent.redraw ();
}
/**
* Sets the receiver's cascade menu to the argument.
* Only <code>CASCADE</code> menu items can have a
* 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.
*
* @param menu the new pop up menu
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_MENU_NOT_DROP_DOWN - the menu is not a drop down menu</li>
* <li>ERROR_MENUITEM_NOT_CASCADE - the menu item is not a <code>CASCADE</code></li>
* <li>ERROR_INVALID_PARENT - if the menu is not in the same widget tree</li>
* </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>
*/
public void setMenu (Menu menu) {
checkWidget ();
/* Check to make sure the new menu is valid */
if ((style & SWT.CASCADE) == 0) {
error (SWT.ERROR_MENUITEM_NOT_CASCADE);
}
if (menu != null) {
if ((menu.style & SWT.DROP_DOWN) == 0) {
error (SWT.ERROR_MENU_NOT_DROP_DOWN);
}
if (menu.parent != parent.parent) {
error (SWT.ERROR_INVALID_PARENT);
}
}
/* Assign the new menu */
Menu oldMenu = this.menu;
if (oldMenu == menu) return;
if (oldMenu != null) oldMenu.cascade = null;
this.menu = menu;
/* Assign the new menu in the OS */
/*
* Feature in Windows. When SetMenuItemInfo () is used to
* set a submenu and the menu item already has a submenu,
* Windows destroys the previous menu. This is undocumented
* and unexpected but not necessarily wrong. The fix is to
* remove the item with RemoveMenu () which does not destroy
* the submenu and then insert the item with InsertMenuItem ().
*/
int hMenu = parent.handle;
MENUITEMINFO info = new MENUITEMINFO ();
info.cbSize = MENUITEMINFO.sizeof;
info.fMask = OS.MIIM_ID;
int index = 0, count = OS.GetMenuItemCount (hMenu);
while (index < count) {
if (OS.GetMenuItemInfo (hMenu, index, true, info) && (info.wID == id)) {
break;
}
index++;
}
if (index == count) return;
int hHeap = OS.GetProcessHeap ();
int pszText = OS.HeapAlloc (hHeap, OS.HEAP_ZERO_MEMORY, 128);
info.fMask = OS.MIIM_STATE | OS.MIIM_ID | OS.MIIM_TYPE;
info.dwTypeData = pszText;
info.cch = 128;
boolean success = OS.GetMenuItemInfo (hMenu, index, true, info);
if (menu != null) {
menu.cascade = this;
info.fMask |= OS.MIIM_SUBMENU;
info.hSubMenu = menu.handle;
}
OS.RemoveMenu (hMenu, index, OS.MF_BYPOSITION);
success = OS.InsertMenuItem (hMenu, index, true, info);
if (pszText != 0) OS.HeapFree (hHeap, 0, pszText);
if (!success) error (SWT.ERROR_CANNOT_SET_MENU);
parent.destroyAcceleratorTable ();
}
/**
* Sets the selection state of the receiver.
* <p>
* When the receiver is of type <code>CHECK</code> or <code>RADIO</code>,
* it is selected when it is checked.
*
* @param selected the new selection state
*
* @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>
*/
public void setSelection (boolean selected) {
checkWidget ();
if ((style & (SWT.CHECK | SWT.RADIO)) == 0) return;
int hMenu = parent.handle;
MENUITEMINFO info = new MENUITEMINFO ();
info.cbSize = MENUITEMINFO.sizeof;
info.fMask = OS.MIIM_STATE;
boolean success = OS.GetMenuItemInfo (hMenu, id, false, info);
if (!success) error (SWT.ERROR_CANNOT_SET_SELECTION);
info.fState &= ~OS.MFS_CHECKED;
if (selected) info.fState |= OS.MFS_CHECKED;
success = OS.SetMenuItemInfo (hMenu, id, false, info);
if (!success) error (SWT.ERROR_CANNOT_SET_SELECTION);
parent.redraw ();
}
public void setText (String string) {
checkWidget ();
if (string == null) error (SWT.ERROR_NULL_ARGUMENT);
if ((style & SWT.SEPARATOR) != 0) return;
super.setText (string);
int hMenu = parent.handle;
int hHeap = OS.GetProcessHeap ();
byte [] buffer = Converter.wcsToMbcs (0, string, false);
int pszText = OS.HeapAlloc (hHeap, OS.HEAP_ZERO_MEMORY, buffer.length + 1);
OS.MoveMemory (pszText, buffer, buffer.length);
MENUITEMINFO info = new MENUITEMINFO ();
info.cbSize = MENUITEMINFO.sizeof;
info.fMask = OS.MIIM_TYPE;
info.fType = widgetStyle ();
info.dwTypeData = pszText;
boolean success = OS.SetMenuItemInfo (hMenu, id, false, info);
if (pszText != 0) OS.HeapFree (hHeap, 0, pszText);
if (!success) error (SWT.ERROR_CANNOT_SET_TEXT);
parent.redraw ();
}
int widgetStyle () {
if ((style & SWT.SEPARATOR) != 0) return OS.MFT_SEPARATOR;
if ((style & SWT.RADIO) != 0) return OS.MFT_RADIOCHECK;
return OS.MFT_STRING;
}
LRESULT wmCommandChild (int wParam, int lParam) {
if ((style & (SWT.CHECK | SWT.RADIO)) != 0) {
setSelection (!getSelection ());
}
Event event = new Event ();
if (OS.GetKeyState (OS.VK_MENU) < 0) event.stateMask |= SWT.ALT;
if (OS.GetKeyState (OS.VK_SHIFT) < 0) event.stateMask |= SWT.SHIFT;
if (OS.GetKeyState (OS.VK_CONTROL) < 0) event.stateMask |= SWT.CONTROL;
if (OS.GetKeyState (OS.VK_LBUTTON) < 0) event.stateMask |= SWT.BUTTON1;
if (OS.GetKeyState (OS.VK_MBUTTON) < 0) event.stateMask |= SWT.BUTTON2;
if (OS.GetKeyState (OS.VK_RBUTTON) < 0) event.stateMask |= SWT.BUTTON3;
postEvent (SWT.Selection, event);
return null;
}
/*
* Not currently used.
*/
LRESULT wmDrawChild (int wParam, int lParam) {
DRAWITEMSTRUCT struct = new DRAWITEMSTRUCT ();
OS.MoveMemory (struct, lParam, DRAWITEMSTRUCT.sizeof);
if (image != null) {
/*
* This code intentionally commented.
*/
// GC gc = GC.win32_new (struct.hDC, null);
// gc.drawImage (image, struct.left, struct.top);
int hImage = image.handle;
switch (image.type) {
case SWT.BITMAP:
BITMAP bm = new BITMAP ();
OS.GetObject (hImage, BITMAP.sizeof, bm);
int hDC = OS.CreateCompatibleDC (struct.hDC);
int oldBitmap = OS.SelectObject (hDC, hImage);
OS.BitBlt (struct.hDC, struct.left, struct.top + 2, bm.bmWidth, bm.bmHeight, hDC, 0, 0, OS.SRCCOPY);
OS.SelectObject (hDC, oldBitmap);
OS.DeleteDC (hDC);
break;
case SWT.ICON:
OS.DrawIconEx (struct.hDC, struct.left, struct.top + 2, hImage, 0, 0, 0, 0, OS.DI_NORMAL);
break;
}
}
return null;
}
/*
* Not currently used.
*/
LRESULT wmMeasureChild (int wParam, int lParam) {
MEASUREITEMSTRUCT struct = new MEASUREITEMSTRUCT ();
OS.MoveMemory (struct, lParam, MEASUREITEMSTRUCT.sizeof);
if (image != null) {
/*
* This code intentionally commented.
*/
// Rectangle rect = image.getBounds ();
// struct.itemWidth = rect.width;
// struct.itemHeight = rect.height;
int hImage = image.handle;
BITMAP bm = new BITMAP ();
switch (image.type) {
case SWT.BITMAP:
OS.GetObject (hImage, BITMAP.sizeof, bm);
break;
case SWT.ICON:
ICONINFO info = new ICONINFO ();
OS.GetIconInfo (hImage, info);
int hBitmap = info.hbmColor;
if (hBitmap == 0) hBitmap = info.hbmMask;
OS.GetObject (hBitmap, BITMAP.sizeof, bm);
if (hBitmap == info.hbmMask) bm.bmHeight /= 2;
if (info.hbmColor != 0) OS.DeleteObject (info.hbmColor);
if (info.hbmMask != 0) OS.DeleteObject (info.hbmMask);
break;
}
struct.itemWidth = bm.bmWidth + 4;
struct.itemHeight = bm.bmHeight + 4;
}
OS.MoveMemory (lParam, struct, MEASUREITEMSTRUCT.sizeof);
return null;
}
}