root/dwt/custom/CCombo.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.custom.CCombo;



import dwt.DWT;
import dwt.DWTException;
import dwt.accessibility.ACC;
import dwt.accessibility.AccessibleAdapter;
import dwt.accessibility.AccessibleControlAdapter;
import dwt.accessibility.AccessibleControlEvent;
import dwt.accessibility.AccessibleEvent;
import dwt.accessibility.AccessibleTextAdapter;
import dwt.accessibility.AccessibleTextEvent;
import dwt.events.ModifyListener;
import dwt.events.SelectionEvent;
import dwt.events.SelectionListener;
import dwt.events.VerifyListener;
import dwt.graphics.Color;
import dwt.graphics.Font;
import dwt.graphics.GC;
import dwt.graphics.Point;
import dwt.graphics.Rectangle;
import dwt.widgets.Button;
import dwt.widgets.Composite;
import dwt.widgets.Control;
import dwt.widgets.Display;
import dwt.widgets.Event;
import dwt.widgets.Label;
import dwt.widgets.Layout;
import dwt.widgets.List;
import dwt.widgets.Listener;
import dwt.widgets.Menu;
import dwt.widgets.Shell;
import dwt.widgets.Text;
import dwt.widgets.TypedListener;
import dwt.widgets.Widget;

static import tango.text.convert.Utf;
static import tango.text.Unicode;
static import tango.text.convert.Format;
import dwt.dwthelper.utils;
import dwt.dwthelper.Runnable;

/**
 * The CCombo class represents a selectable user interface object
 * that combines a text field and a list and issues notification
 * when an item is selected from the list.
 * <p>
 * CCombo was written to work around certain limitations in the native
 * combo box. Specifically, on win32, the height of a CCombo can be set;
 * attempts to set the height of a Combo are ignored. CCombo can be used
 * anywhere that having the increased flexibility is more important than
 * getting native L&F, but the decision should not be taken lightly.
 * There is no is no strict requirement that CCombo look or behave
 * the same as the native combo box.
 * </p>
 * <p>
 * Note that although this class is a subclass of <code>Composite</code>,
 * it does not make sense to add children to it, or set a layout on it.
 * </p>
 * <dl>
 * <dt><b>Styles:</b>
 * <dd>BORDER, READ_ONLY, FLAT</dd>
 * <dt><b>Events:</b>
 * <dd>DefaultSelection, Modify, Selection, Verify</dd>
 * </dl>
 *
 * @see <a href="http://www.eclipse.org/swt/snippets/#ccombo">CCombo snippets</a>
 * @see <a href="http://www.eclipse.org/swt/examples.php">DWT Example: CustomControlExample</a>
 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
 */
public final class CCombo : Composite {

    alias Composite.computeSize computeSize;

    Text text;
    List list;
    int visibleItemCount = 5;
    Shell popup;
    Button arrow;
    bool hasFocus;
    Listener listener, filter;
    Color foreground, background;
    Font font;

/**
 * Constructs a new instance of this class given its parent
 * 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>
 *
 * @param parent a widget which will be the parent of the new instance (cannot be null)
 * @param style the style of widget 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>
 * </ul>
 *
 * @see DWT#BORDER
 * @see DWT#READ_ONLY
 * @see DWT#FLAT
 * @see Widget#getStyle()
 */
public this (Composite parent, int style) {
    super (parent, style = checkStyle (style));

    int textStyle = DWT.SINGLE;
    if ((style & DWT.READ_ONLY) !is 0) textStyle |= DWT.READ_ONLY;
    if ((style & DWT.FLAT) !is 0) textStyle |= DWT.FLAT;
    text = new Text (this, textStyle);
    int arrowStyle = DWT.ARROW | DWT.DOWN;
    if ((style & DWT.FLAT) !is 0) arrowStyle |= DWT.FLAT;
    arrow = new Button (this, arrowStyle);

    listener = new class() Listener {
        public void handleEvent (Event event) {
            if (popup is event.widget) {
                popupEvent (event);
                return;
            }
            if (text is event.widget) {
                textEvent (event);
                return;
            }
            if (list is event.widget) {
                listEvent (event);
                return;
            }
            if (arrow is event.widget) {
                arrowEvent (event);
                return;
            }
            if (this.outer is event.widget) {
                comboEvent (event);
                return;
            }
            if (getShell () is event.widget) {
                getDisplay().asyncExec(new class() Runnable {
                    public void run() {
                        if (isDisposed()) return;
                        handleFocus (DWT.FocusOut);
                    }
                });
            }
        }
    };
    filter = new class() Listener {
        public void handleEvent(Event event) {
            Shell shell = (cast(Control)event.widget).getShell ();
            if (shell is this.outer.getShell ()) {
                handleFocus (DWT.FocusOut);
            }
        }
    };

    int [] comboEvents = [DWT.Dispose, DWT.FocusIn, DWT.Move, DWT.Resize];
    for (int i=0; i<comboEvents.length; i++) this.addListener (comboEvents [i], listener);

    int [] textEvents = [DWT.DefaultSelection, DWT.KeyDown, DWT.KeyUp, DWT.MenuDetect, DWT.Modify, DWT.MouseDown, DWT.MouseUp, DWT.MouseDoubleClick, DWT.MouseWheel, DWT.Traverse, DWT.FocusIn, DWT.Verify];
    for (int i=0; i<textEvents.length; i++) text.addListener (textEvents [i], listener);

    int [] arrowEvents = [DWT.MouseDown, DWT.MouseUp, DWT.Selection, DWT.FocusIn];
    for (int i=0; i<arrowEvents.length; i++) arrow.addListener (arrowEvents [i], listener);

    createPopup(null, -1);
    initAccessible();
}
static int checkStyle (int style) {
    int mask = DWT.BORDER | DWT.READ_ONLY | DWT.FLAT | DWT.LEFT_TO_RIGHT | DWT.RIGHT_TO_LEFT;
    return DWT.NO_FOCUS | (style & mask);
}
/**
 * Adds the argument to the end of the receiver's list.
 *
 * @param string the new item
 *
 * @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 #add(String,int)
 */
public void add (String string) {
    checkWidget();
    // DWT extension: allow null for zero length string
    //if (string is null) DWT.error (DWT.ERROR_NULL_ARGUMENT);
    list.add (string);
}
/**
 * Adds the argument to the receiver's list at the given
 * zero-relative index.
 * <p>
 * Note: To add an item at the end of the list, use the
 * result of calling <code>getItemCount()</code> as the
 * index or use <code>add(String)</code>.
 * </p>
 *
 * @param string the new item
 * @param index the index for the item
 *
 * @exception IllegalArgumentException <ul>
 *    <li>ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list (inclusive)</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 #add(String)
 */
public void add (String string, int index) {
    checkWidget();
    // DWT extension: allow null for zero length string
    //if (string is null) DWT.error (DWT.ERROR_NULL_ARGUMENT);
    list.add (string, index);
}
/**
 * Adds the listener to the collection of listeners who will
 * be notified when the receiver's text is modified, by sending
 * it one of the messages defined in the <code>ModifyListener</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 ModifyListener
 * @see #removeModifyListener
 */
public void addModifyListener (ModifyListener listener) {
    checkWidget();
    if (listener is null) DWT.error (DWT.ERROR_NULL_ARGUMENT);
    TypedListener typedListener = new TypedListener (listener);
    addListener (DWT.Modify, typedListener);
}
/**
 * Adds the listener to the collection of listeners who will
 * be notified when the user changes the receiver's selection, by sending
 * it one of the messages defined in the <code>SelectionListener</code>
 * interface.
 * <p>
 * <code>widgetSelected</code> is called when the combo's list selection changes.
 * <code>widgetDefaultSelected</code> is typically called when ENTER is pressed the combo's text area.
 * </p>
 *
 * @param listener the listener which should be notified when the user changes the receiver's selection
 *
 * @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 SelectionListener
 * @see #removeSelectionListener
 * @see SelectionEvent
 */
public void addSelectionListener(SelectionListener listener) {
    checkWidget();
    if (listener is null) DWT.error (DWT.ERROR_NULL_ARGUMENT);
    TypedListener typedListener = new TypedListener (listener);
    addListener (DWT.Selection,typedListener);
    addListener (DWT.DefaultSelection,typedListener);
}
/**
 * Adds the listener to the collection of listeners who will
 * be notified when the receiver's text is verified, by sending
 * it one of the messages defined in the <code>VerifyListener</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 VerifyListener
 * @see #removeVerifyListener
 *
 * @since 3.3
 */
public void addVerifyListener (VerifyListener listener) {
    checkWidget();
    if (listener is null) DWT.error (DWT.ERROR_NULL_ARGUMENT);
    TypedListener typedListener = new TypedListener (listener);
    addListener (DWT.Verify,typedListener);
}
void arrowEvent (Event event) {
    switch (event.type) {
        case DWT.FocusIn: {
            handleFocus (DWT.FocusIn);
            break;
        }
        case DWT.MouseDown: {
            Event mouseEvent = new Event ();
            mouseEvent.button = event.button;
            mouseEvent.count = event.count;
            mouseEvent.stateMask = event.stateMask;
            mouseEvent.time = event.time;
            mouseEvent.x = event.x; mouseEvent.y = event.y;
            notifyListeners (DWT.MouseDown, mouseEvent);
            event.doit = mouseEvent.doit;
            break;
        }
        case DWT.MouseUp: {
            Event mouseEvent = new Event ();
            mouseEvent.button = event.button;
            mouseEvent.count = event.count;
            mouseEvent.stateMask = event.stateMask;
            mouseEvent.time = event.time;
            mouseEvent.x = event.x; mouseEvent.y = event.y;
            notifyListeners (DWT.MouseUp, mouseEvent);
            event.doit = mouseEvent.doit;
            break;
        }
        case DWT.Selection: {
            text.setFocus();
            dropDown (!isDropped ());
            break;
        }
        default:
    }
}
/**
 * Sets the selection in the receiver's text field to an empty
 * selection starting just before the first character. If the
 * text field is editable, this has the effect of placing the
 * i-beam at the start of the text.
 * <p>
 * Note: To clear the selected items in the receiver's list,
 * use <code>deselectAll()</code>.
 * </p>
 *
 * @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 #deselectAll
 */
public void clearSelection () {
    checkWidget ();
    text.clearSelection ();
    list.deselectAll ();
}
void comboEvent (Event event) {
    switch (event.type) {
        case DWT.Dispose:
            if (popup !is null && !popup.isDisposed ()) {
                list.removeListener (DWT.Dispose, listener);
                popup.dispose ();
            }
            Shell shell = getShell ();
            shell.removeListener (DWT.Deactivate, listener);
            Display display = getDisplay ();
            display.removeFilter (DWT.FocusIn, filter);
            popup = null;
            text = null;
            list = null;
            arrow = null;
            break;
        case DWT.FocusIn:
            Control focusControl = getDisplay ().getFocusControl ();
            if (focusControl is arrow || focusControl is list) return;
            if (isDropped()) {
                list.setFocus();
            } else {
                text.setFocus();
            }
            break;
        case DWT.Move:
            dropDown (false);
            break;
        case DWT.Resize:
            internalLayout (false);
            break;
        default:
    }
}

public override Point computeSize (int wHint, int hHint, bool changed) {
    checkWidget ();
    int width = 0, height = 0;
    String[] items = list.getItems ();
    GC gc = new GC (text);
    int spacer = gc.stringExtent (" ").x; //$NON-NLS-1$
    int textWidth = gc.stringExtent (text.getText ()).x;
    for (int i = 0; i < items.length; i++) {
        textWidth = Math.max (gc.stringExtent (items[i]).x, textWidth);
    }
    gc.dispose ();
    Point textSize = text.computeSize (DWT.DEFAULT, DWT.DEFAULT, changed);
    Point arrowSize = arrow.computeSize (DWT.DEFAULT, DWT.DEFAULT, changed);
    Point listSize = list.computeSize (DWT.DEFAULT, DWT.DEFAULT, changed);
    int borderWidth = getBorderWidth ();

    height = Math.max (textSize.y, arrowSize.y);
    width = Math.max (textWidth + 2*spacer + arrowSize.x + 2*borderWidth, listSize.x);
    if (wHint !is DWT.DEFAULT) width = wHint;
    if (hHint !is DWT.DEFAULT) height = hHint;
    return new Point (width + 2*borderWidth, height + 2*borderWidth);
}
/**
 * Copies the selected text.
 * <p>
 * The current selection is copied to the clipboard.
 * </p>
 *
 * @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>
 *
 * @since 3.3
 */
public void copy () {
    checkWidget ();
    text.copy ();
}
void createPopup(String[] items, int selectionIndex) {
    // create shell and list
    popup = new Shell (getShell (), DWT.NO_TRIM | DWT.ON_TOP);
    int style = getStyle ();
    int listStyle = DWT.SINGLE | DWT.V_SCROLL;
    if ((style & DWT.FLAT) !is 0) listStyle |= DWT.FLAT;
    if ((style & DWT.RIGHT_TO_LEFT) !is 0) listStyle |= DWT.RIGHT_TO_LEFT;
    if ((style & DWT.LEFT_TO_RIGHT) !is 0) listStyle |= DWT.LEFT_TO_RIGHT;
    list = new List (popup, listStyle);
    if (font !is null) list.setFont (font);
    if (foreground !is null) list.setForeground (foreground);
    if (background !is null) list.setBackground (background);

    int [] popupEvents = [DWT.Close, DWT.Paint, DWT.Deactivate];
    for (int i=0; i<popupEvents.length; i++) popup.addListener (popupEvents [i], listener);
    int [] listEvents = [DWT.MouseUp, DWT.Selection, DWT.Traverse, DWT.KeyDown, DWT.KeyUp, DWT.FocusIn, DWT.Dispose];
    for (int i=0; i<listEvents.length; i++) list.addListener (listEvents [i], listener);

    if (items !is null) list.setItems (items);
    if (selectionIndex !is -1) list.setSelection (selectionIndex);
}
/**
 * Cuts the selected text.
 * <p>
 * The current selection is first copied to the
 * clipboard and then deleted from the widget.
 * </p>
 *
 * @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>
 *
 * @since 3.3
 */
public void cut () {
    checkWidget ();
    text.cut ();
}
/**
 * Deselects the item at the given zero-relative index in the receiver's
 * list.  If the item at the index was already deselected, it remains
 * deselected. Indices that are out of range are ignored.
 *
 * @param index the index of the item to deselect
 *
 * @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>
 */
public void deselect (int index) {
    checkWidget ();
    if (0 <= index && index < list.getItemCount () &&
            index is list.getSelectionIndex() &&
            text.getText().equals(list.getItem(index))) {
        text.setText("");  //$NON-NLS-1$
        list.deselect (index);
    }
}
/**
 * Deselects all selected items in the receiver's list.
 * <p>
 * Note: To clear the selection in the receiver's text field,
 * use <code>clearSelection()</code>.
 * </p>
 *
 * @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 #clearSelection
 */
public void deselectAll () {
    checkWidget ();
    text.setText("");  //$NON-NLS-1$
    list.deselectAll ();
}
void dropDown (bool drop) {
    if (drop is isDropped ()) return;
    if (!drop) {
        popup.setVisible (false);
        if (!isDisposed () && isFocusControl()) {
            text.setFocus();
        }
        return;
    }
    if (!isVisible()) return;
    if (getShell() !is popup.getParent ()) {
        String[] items = list.getItems ();
        int selectionIndex = list.getSelectionIndex ();
        list.removeListener (DWT.Dispose, listener);
        popup.dispose();
        popup = null;
        list = null;
        createPopup (items, selectionIndex);
    }

    Point size = getSize ();
    int itemCount = list.getItemCount ();
    itemCount = (itemCount is 0) ? visibleItemCount : Math.min(visibleItemCount, itemCount);
    int itemHeight = list.getItemHeight () * itemCount;
    Point listSize = list.computeSize (DWT.DEFAULT, itemHeight, false);
    list.setBounds (1, 1, Math.max (size.x - 2, listSize.x), listSize.y);

    int index = list.getSelectionIndex ();
    if (index !is -1) list.setTopIndex (index);
    Display display = getDisplay ();
    Rectangle listRect = list.getBounds ();
    Rectangle parentRect = display.map (getParent (), null, getBounds ());
    Point comboSize = getSize ();
    Rectangle displayRect = getMonitor ().getClientArea ();
    int width = Math.max (comboSize.x, listRect.width + 2);
    int height = listRect.height + 2;
    int x = parentRect.x;
    int y = parentRect.y + comboSize.y;
    if (y + height > displayRect.y + displayRect.height) y = parentRect.y - height;
    if (x + width > displayRect.x + displayRect.width) x = displayRect.x + displayRect.width - listRect.width;
    popup.setBounds (x, y, width, height);
    popup.setVisible (true);
    if (isFocusControl()) list.setFocus ();
}
/*
 * Return the lowercase of the first non-'&' character following
 * an '&' character in the given string. If there are no '&'
 * characters in the given string, return '\0'.
 */
dchar _findMnemonic (String string) {
    if (string is null) return '\0';
    int index = 0;
    int length = string.length;
    do {
        while (index < length