root/dwt/widgets/Menu.d

/*******************************************************************************
 * Copyright (c) 2000, 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 * Port to the D programming language:
 *     Frank Benoit <benoit@tionex.de>
 *******************************************************************************/
module dwt.widgets.Menu;

import dwt.DWT;
import dwt.DWTException;
import dwt.events.HelpListener;
import dwt.events.MenuListener;
import dwt.graphics.Color;
import dwt.graphics.Image;
import dwt.graphics.Point;
import dwt.graphics.Rectangle;
import dwt.internal.ImageList;
import dwt.internal.win32.OS;

import dwt.widgets.Widget;
import dwt.widgets.Decorations;
import dwt.widgets.MenuItem;
import dwt.widgets.Control;
import dwt.widgets.Shell;
import dwt.widgets.TypedListener;

import dwt.dwthelper.utils;

/**
 * Instances of this class are user interface objects that contain
 * menu items.
 * <dl>
 * <dt><b>Styles:</b></dt>
 * <dd>BAR, DROP_DOWN, POP_UP, NO_RADIO_GROUP</dd>
 * <dd>LEFT_TO_RIGHT, RIGHT_TO_LEFT</dd>
 * <dt><b>Events:</b></dt>
 * <dd>Help, Hide, Show </dd>
 * </dl>
 * <p>
 * Note: Only one of BAR, DROP_DOWN and POP_UP may be specified.
 * Only one of LEFT_TO_RIGHT or RIGHT_TO_LEFT may be specified.
 * </p><p>
 * IMPORTANT: This class is <em>not</em> intended to be subclassed.
 * </p>
 *
 * @see <a href="http://www.eclipse.org/swt/snippets/#menu">Menu snippets</a>
 * @see <a href="http://www.eclipse.org/swt/examples.php">DWT Example: ControlExample</a>
 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
 */

public class Menu : Widget {
    /**
     * the handle to the OS resource
     * (Warning: This field is platform dependent)
     * <p>
     * <b>IMPORTANT:</b> This field is <em>not</em> part of the DWT
     * public API. It is marked public only so that it can be shared
     * within the packages provided by DWT. It is not available on all
     * platforms and should never be accessed from application code.
     * </p>
     */
    public HMENU handle;

    int x, y;
    HBRUSH hBrush;
    HWND hwndCB;
    int id0, id1;
    int foreground = -1, background = -1;
    Image backgroundImage;
    bool hasLocation;
    MenuItem cascade;
    Decorations parent;
    ImageList imageList;

    /* Resource ID for SHMENUBARINFO */
    static const int ID_PPC = 100;

    /* SmartPhone SoftKeyBar resource ids */
    static const int ID_SPMM = 102;
    static const int ID_SPBM = 103;
    static const int ID_SPMB = 104;
    static const int ID_SPBB = 105;
    static const int ID_SPSOFTKEY0 = 106;
    static const int ID_SPSOFTKEY1 = 107;

/**
 * Constructs a new instance of this class given its parent,
 * and sets the style for the instance so that the instance
 * will be a popup menu on the given parent's shell.
 * <p>
 * After constructing a menu, it can be set into its parent
 * using <code>parent.setMenu(menu)</code>.  In this case, the parent may
 * be any control in the same widget tree as the parent.
 * </p>
 *
 * @param parent a control which will be the parent of the new instance (cannot be null)
 *
 * @exception IllegalArgumentException <ul>
 *    <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
 * </ul>
 * @exception DWTException <ul>
 *    <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 DWT#POP_UP
 * @see Widget#checkSubclass
 * @see Widget#getStyle
 */
public this (Control parent) {
    this (checkNull (parent).menuShell (), DWT.POP_UP);
}

/**
 * Constructs a new instance of this class given its parent
 * (which must be a <code>Decorations</code>) and a style value
 * describing its behavior and appearance.
 * <p>
 * The style value is either one of the style constants defined in
 * class <code>DWT</code> which is applicable to instances of this
 * class, or must be built by <em>bitwise OR</em>'ing together
 * (that is, using the <code>int</code> "|" operator) two or more
 * of those <code>DWT</code> style constants. The class description
 * lists the style constants that are applicable to the class.
 * Style bits are also inherited from superclasses.
 * </p><p>
 * After constructing a menu or menuBar, it can be set into its parent
 * using <code>parent.setMenu(menu)</code> or <code>parent.setMenuBar(menuBar)</code>.
 * </p>
 *
 * @param parent a decorations control which will be the parent of the new instance (cannot be null)
 * @param style the style of menu to construct
 *
 * @exception IllegalArgumentException <ul>
 *    <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
 * </ul>
 * @exception DWTException <ul>
 *    <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 DWT#BAR
 * @see DWT#DROP_DOWN
 * @see DWT#POP_UP
 * @see Widget#checkSubclass
 * @see Widget#getStyle
 */
public this (Decorations parent, int style) {
    this (parent, checkStyle (style), null);
}

/**
 * Constructs a new instance of this class given its parent
 * (which must be a <code>Menu</code>) and sets the style
 * for the instance so that the instance will be a drop-down
 * menu on the given parent's parent.
 * <p>
 * After constructing a drop-down menu, it can be set into its parentMenu
 * using <code>parentMenu.setMenu(menu)</code>.
 * </p>
 *
 * @param parentMenu a menu which will be the parent of the new instance (cannot be null)
 *
 * @exception IllegalArgumentException <ul>
 *    <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
 * </ul>
 * @exception DWTException <ul>
 *    <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 DWT#DROP_DOWN
 * @see Widget#checkSubclass
 * @see Widget#getStyle
 */
public this (Menu parentMenu) {
    this (checkNull (parentMenu).parent, DWT.DROP_DOWN);
}

/**
 * Constructs a new instance of this class given its parent
 * (which must be a <code>MenuItem</code>) and sets the style
 * for the instance so that the instance will be a drop-down
 * menu on the given parent's parent menu.
 * <p>
 * After constructing a drop-down menu, it can be set into its parentItem
 * using <code>parentItem.setMenu(menu)</code>.
 * </p>
 *
 * @param parentItem a menu item which will be the parent of the new instance (cannot be null)
 *
 * @exception IllegalArgumentException <ul>
 *    <li>ERROR_NULL_ARGUMENT - if the parent is null</li>
 * </ul>
 * @exception DWTException <ul>
 *    <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 DWT#DROP_DOWN
 * @see Widget#checkSubclass
 * @see Widget#getStyle
 */
public this (MenuItem parentItem) {
    this (checkNull (parentItem).parent);
}

this (Decorations parent, int style, HWND handle) {
    super (parent, checkStyle (style));
    this.parent = parent;
    this.handle = handle;
    /*
    * Bug in IBM JVM 1.3.1.  For some reason, when the checkOrientation() is
    * called from createWidget(), the JVM issues this error:
    *
    * JVM Exception 0x2 (subcode 0x0) occurred in thread "main" (TID:0x9F19D8)
    *
    * In addition, on Windows XP, a dialog appears with following error message,
    * indicating that the problem may be in the JIT:
    *
    * AppName: java.exe  AppVer: 0.0.0.0     ModName: jitc.dll
    * ModVer: 0.0.0.0    Offset: 000b6912
    *
    * The fix is to call checkOrientation() from here.
    */
    checkOrientation (parent);
    createWidget ();
}

void _setVisible (bool visible) {
    if ((style & (DWT.BAR | DWT.DROP_DOWN)) !is 0) return;
    auto hwndParent = parent.handle;
    if (visible) {
        int flags = OS.TPM_LEFTBUTTON;
        if (OS.GetKeyState (OS.VK_LBUTTON) >= 0) flags |= OS.TPM_RIGHTBUTTON;
        if ((style & DWT.RIGHT_TO_LEFT) !is 0) flags |= OS.TPM_RIGHTALIGN;
        if ((parent.style & DWT.MIRRORED) !is 0) {
            flags &= ~OS.TPM_RIGHTALIGN;
            if ((style & DWT.LEFT_TO_RIGHT) !is 0) flags |= OS.TPM_RIGHTALIGN;
        }
        int nX = x, nY = y;
        if (!hasLocation) {
            int pos = OS.GetMessagePos ();
            nX = OS.GET_X_LPARAM (pos);
            nY = OS.GET_Y_LPARAM (pos);
        }
        /*
        * Feature in Windows.  It is legal use TrackPopupMenu()
        * to display an empty menu as long as menu items are added
        * inside of WM_INITPOPUPMENU.  If no items are added, then
        * TrackPopupMenu() fails and does not send an indication
        * that the menu has been closed.  This is not strictly a
        * bug but leads to unwanted behavior when application code
        * assumes that every WM_INITPOPUPMENU will eventually result
        * in a WM_MENUSELECT, wParam=MAKEWPARAM (0, 0xFFFF), lParam=0 to
        * indicate that the menu has been closed.  The fix is to detect
        * the case when TrackPopupMenu() fails and the number of items in
        * the menu is zero and issue a fake WM_MENUSELECT.
        */
        bool success = cast(bool) OS.TrackPopupMenu (handle, flags, nX, nY, 0, hwndParent, null);
        if (!success && GetMenuItemCount (handle) is 0) {
            OS.SendMessage (hwndParent, OS.WM_MENUSELECT, OS.MAKEWPARAM (0, 0xFFFF), 0);
        }
    } else {
        OS.SendMessage (hwndParent, OS.WM_CANCELMODE, 0, 0);
    }
}

/**
 * Adds the listener to the collection of listeners who will
 * be notified when 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 DWTException <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 is null) error (DWT.ERROR_NULL_ARGUMENT);
    TypedListener typedListener = new TypedListener (listener);
    addListener (DWT.Help, typedListener);
}

/**
 * Adds the listener to the collection of listeners who will
 * be notified when menus are hidden or shown, by sending it
 * one of the messages defined in the <code>MenuListener</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 DWTException <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 MenuListener
 * @see #removeMenuListener
 */
public void addMenuListener (MenuListener listener) {
    checkWidget ();
    if (listener is null) error (DWT.ERROR_NULL_ARGUMENT);
    TypedListener typedListener = new TypedListener (listener);
    addListener (DWT.Hide,typedListener);
    addListener (DWT.Show,typedListener);
}

static Control checkNull (Control control) {
    if (control is null) DWT.error (DWT.ERROR_NULL_ARGUMENT);
    return control;
}

static Menu checkNull (Menu menu) {
    if (menu is null) DWT.error (DWT.ERROR_NULL_ARGUMENT);
    return menu;
}

static MenuItem checkNull (MenuItem item) {
    if (item is null) DWT.error (DWT.ERROR_NULL_ARGUMENT);
    return item;
}

static int checkStyle (int style) {
    return checkBits (style, DWT.POP_UP, DWT.BAR, DWT.DROP_DOWN, 0, 0, 0);
}

void createHandle () {
    if (handle !is null) return;
    if ((style & DWT.BAR) !is 0) {
        static if( OS.IsWinCE ) if (OS.IsPPC) {
            auto hwndShell = parent.handle;
            SHMENUBARINFO mbi;
            mbi.cbSize = SHMENUBARINFO.sizeof;
            mbi.hwndParent = hwndShell;
            mbi.dwFlags = OS.SHCMBF_HIDDEN;
            mbi.nToolBarId = ID_PPC;
            mbi.hInstRes = OS.GetLibraryHandle ();
            bool success = cast(bool) OS.SHCreateMenuBar (&mbi);
            hwndCB = mbi.hwndMB;
            if (!success) error (DWT.ERROR_NO_HANDLES);
            /* Remove the item from the resource file */
            OS.SendMessage (hwndCB, OS.TB_DELETEBUTTON, 0, 0);
            return;
        }
        /*
        * Note in WinCE SmartPhone.  The SoftBar contains only 2 items.
        * An item can either be a menu or a button.
        * DWT.BAR: creates a SoftBar with 2 menus
        * DWT.BAR | DWT.BUTTON1: creates a SoftBar with 1 button
        *    for button1, and a menu for button2
        * DWT.BAR | DWT.BUTTON1 | DWT.BUTTON2: creates a SoftBar with
        *    2 buttons
        */
        static if (OS.IsSP) {
            /* Determine type of menubar */
            int nToolBarId;
            if ((style & DWT.BUTTON1) !is 0) {
                nToolBarId = ((style & DWT.BUTTON2) !is 0) ? ID_SPBB : ID_SPBM;
            } else {
                nToolBarId = ((style & DWT.BUTTON2) !is 0) ? ID_SPMB : ID_SPMM;
            }

            /* Create SHMENUBAR */
            SHMENUBARINFO mbi;
            mbi.cbSize = SHMENUBARINFO.sizeof;
            mbi.hwndParent = parent.handle;
            mbi.dwFlags = OS.SHCMBF_HIDDEN;
            mbi.nToolBarId = nToolBarId; /* as defined in .rc file */
            mbi.hInstRes = OS.GetLibraryHandle ();
            if (!OS.SHCreateMenuBar (&mbi)) error (DWT.ERROR_NO_HANDLES);
            hwndCB = mbi.hwndMB;

            /*
            * Feature on WinCE SmartPhone.  The SHCMBF_HIDDEN flag causes the
            * SHMENUBAR to not be drawn. However the keyboard events still go
            * through it.  The workaround is to also hide the SHMENUBAR with
            * ShowWindow ().
            */
            OS.ShowWindow (hwndCB, OS.SW_HIDE);

            TBBUTTONINFO info = new TBBUTTONINFO ();
            info.cbSize = TBBUTTONINFO.sizeof;
            info.dwMask = OS.TBIF_COMMAND;
            MenuItem item;

            /* Set first item */
            if (nToolBarId is ID_SPMM || nToolBarId is ID_SPMB) {
                int /*long*/ hMenu = OS.SendMessage (hwndCB, OS.SHCMBM_GETSUBMENU, 0, ID_SPSOFTKEY0);
                /* Remove the item from the resource file */
                OS.RemoveMenu (hMenu, 0, OS.MF_BYPOSITION);
                Menu menu = new Menu (parent, DWT.DROP_DOWN, hMenu);
                item = new MenuItem (this, menu, DWT.CASCADE, 0);
            } else {
                item = new MenuItem (this, null, DWT.PUSH, 0);
            }
            info.idCommand = id0 = item.id;
            OS.SendMessage (hwndCB, OS.TB_SETBUTTONINFO, ID_SPSOFTKEY0, info);

            /* Set second item */
            if (nToolBarId is ID_SPMM || nToolBarId is ID_SPBM) {
                int /*long*/ hMenu = OS.SendMessage (hwndCB, OS.SHCMBM_GETSUBMENU, 0, ID_SPSOFTKEY1);
                OS.RemoveMenu (hMenu, 0, OS.MF_BYPOSITION);
                Menu menu = new Menu (parent, DWT.DROP_DOWN, hMenu);
                item = new MenuItem (this, menu, DWT.CASCADE, 1);
            } else {
                item = new MenuItem (this, null, DWT.PUSH, 1);
            }
            info.idCommand = id1 = item.id;
            OS.SendMessage (hwndCB, OS.TB_SETBUTTONINFO, ID_SPSOFTKEY1, info);

            /*
            * Override the Back key.  For some reason, the owner of the menubar
            * must be a Dialog or it won't receive the WM_HOTKEY message.  As
            * a result, Shell on WinCE SP must use the class Dialog.
            */
            int dwMask = OS.SHMBOF_NODEFAULT | OS.SHMBOF_NOTIFY;
            int /*long*/ lParam = OS.MAKELPARAM (dwMask, dwMask);
            OS.SendMessage (hwndCB, OS.SHCMBM_OVERRIDEKEY, OS.VK_ESCAPE, lParam);
            return;
        }
        handle = OS.CreateMenu ();
        if (handle is null) error (DWT.ERROR_NO_HANDLES);
        static if (OS.IsHPC) {
            auto hwndShell = parent.handle;
            hwndCB = OS.CommandBar_Create (OS.GetModuleHandle (null), hwndShell, 1);
            if (hwndCB is null) error (DWT.ERROR_NO_HANDLES);
            OS.CommandBar_Show (hwndCB, false);
            OS.CommandBar_InsertMenubarEx (hwndCB, 0, handle, 0);
            /*
            * The command bar hosts the 'close' button when the window does not
            * have a caption.
            */
            if ((parent.style & DWT.CLOSE) !is 0 && (parent.style & DWT.TITLE) is 0) {
                OS.CommandBar_AddAdornments (hwndCB, 0, 0);
            }
        }
    } else {
        handle = OS.CreatePopupMenu ();
        if (handle is null) error (DWT.ERROR_NO_HANDLES);
    }
}

void createItem (MenuItem item, int index) {
    int count = GetMenuItemCount (handle);
    if (!(0 <= index && index <= count)) error (DWT.ERROR_INVALID_RANGE);
    display.addMenuItem (item);
    bool success = false;
    if ((OS.IsPPC || OS.IsSP) && hwndCB !is null) {
        if (OS.IsSP) return;
        TBBUTTON lpButton;
        lpButton.idCommand = item.id;
        lpButton.fsStyle = cast(byte) OS.TBSTYLE_AUTOSIZE;
        if ((item.style & DWT.CASCADE) !is 0) lpButton.fsStyle |= OS.TBSTYLE_DROPDOWN | 0x80;
        if ((item.style & DWT.SEPARATOR) !is 0) lpButton.fsStyle = cast(byte) OS.BTNS_SEP;
        lpButton.fsState = cast(byte) OS.TBSTATE_ENABLED;
        lpButton.iBitmap = OS.I_IMAGENONE;
        success = OS.SendMessage (hwndCB, OS.TB_INSERTBUTTON, index, &lpButton) !is 0;
    } else {
        static if (OS.IsWinCE) {
            int uFlags = OS.MF_BYPOSITION;
            TCHAR lpNewItem = null;
            if ((item.style & DWT.SEPARATOR) !is 0) {
                uFlags |= OS.MF_SEPARATOR;
            } else {
                lpNewItem = new TCHAR (0, " ", true);
            }
            success = OS.InsertMenu (handle, index, uFlags, item.id, lpNewItem);
            if (success) {
                MENUITEMINFO info = new MENUITEMINFO ();
                info.cbSize = OS.MENUITEMINFO_sizeof;
                info.fMask = OS.MIIM_DATA;
                info.dwItemData = item.id;
                success = OS.SetMenuItemInfo (handle, index, true, info);
            }
        } else {
            /*
            * Bug in Windows.  For some reason, when InsertMenuItem()
            * is used to insert an item without text, it is not possible
            * to use SetMenuItemInfo() to set the text at a later time.
            * The fix is to insert the item with some text.
            *
            * Feature in Windows.  When an empty string is used instead
            * of a space and InsertMenuItem() is used to set a submenu
            * before setting text to a non-empty string, the menu item
            * becomes unexpectedly disabled.  The fix is to insert a
            * space.
            */
            auto hHeap = OS.GetProcessHeap ();
            TCHAR[] buffer = StrToTCHARs (0, " \0");
            int byteCount = (buffer.length-1) * TCHAR.sizeof;
            auto pszText = cast(TCHAR*) OS.HeapAlloc (hHeap, OS.HEAP_ZERO_MEMORY, byteCount);
            OS.MoveMemory (pszText, buffer.ptr, byteCount);
            MENUITEMINFO info;
            info.cbSize = OS.MENUITEMINFO_sizeof;
            info.fMask = OS.MIIM_ID | OS.MIIM_TYPE | OS.MIIM_DATA;
            info.wID = item.id;
            info.dwItemData = item.id;
            info.fType = item.widgetStyle ();
            info.dwTypeData = pszText;
            success = cast(bool) OS.InsertMenuItem (handle, index, true, &info);
            if (pszText !is null) OS.HeapFree (hHeap, 0, pszText);
        }
    }
    if (!success) {
        display.removeMenuItem (item);
        error (DWT.ERROR_ITEM_NOT_ADDED);
    }
    redraw ();
}

void createWidget () {
    /*
    * Bug in IBM JVM 1.3.1.  For some reason, when the following code is called
    * from this method, the JVM issues this error:
    *
    * JVM Exception 0x2 (subcode 0x0) occurred in thread "main" (TID:0x9F19D8)
    *
    * In addition, on Windows XP, a dialog appears with following error message,
    * indicating that the problem may be in the JIT:
    *
    * AppName: java.exe  AppVer: 0.0.0.0     ModName: jitc.dll
    * ModVer: 0.0.0.0    Offset: 000b6912
    *
    * The fix is to move the code to the caller of this method.
    */
//  checkOrientation (parent);
    createHandle ();
    parent.addMenu (this);
}

int defaultBackground () {
    return OS.GetSysColor (OS.COLOR_MENU);
}

int defaultForeground () {
    return OS.GetSysColor (OS.COLOR_MENUTEXT);
}

void destroyAccelerators () {
    parent.destroyAccelerators ();
}

void destroyItem (MenuItem item) {
    static if (OS.IsWinCE) {
        if ((OS.IsPPC || OS.IsSP) && hwndCB !is null) {
            if (OS.IsSP) {
                redraw();
                return;
            }
            int index = OS.SendMessage (hwndCB, OS.TB_COMMANDTOINDEX, item.id, 0);
            if (OS.SendMessage (hwndCB, OS.TB_DELETEBUTTON, index, 0) is 0) {
                error (DWT.ERROR_ITEM_NOT_REMOVED);
            }
            int count = OS.SendMessage (hwndCB, OS.TB_BUTTONCOUNT, 0, 0);
            if (count is 0) {
                if (imageList !is null) {
                    OS.SendMessage (handle, OS.TB_SETIMAGELIST, 0, 0);
                    display.releaseImageList (imageList);
                    imageList = null;
                }
            }
        } else {
            int index = 0;
            MENUITEMINFO info;
            info.cbSize = OS.MENUITEMINFO_sizeof;
            info.fMask = OS.MIIM_DATA;
            while (OS.GetMenuItemInfo (handle, index, true, &info)) {
                if (info.dw