root/dwt/widgets/CoolBar.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.CoolBar;

import dwt.widgets.Composite;


import dwt.DWT;
import dwt.DWTException;
import dwt.graphics.Point;
import dwt.graphics.Rectangle;
import dwt.internal.win32.OS;

import dwt.widgets.Composite;
import dwt.widgets.Control;
import dwt.widgets.CoolItem;
import dwt.widgets.Event;

import dwt.dwthelper.utils;

/**
 * Instances of this class provide an area for dynamically
 * positioning the items they contain.
 * <p>
 * The item children that may be added to instances of this class
 * must be of type <code>CoolItem</code>.
 * </p><p>
 * Note that although this class is a subclass of <code>Composite</code>,
 * it does not make sense to add <code>Control</code> children to it,
 * or set a layout on it.
 * </p><p>
 * <dl>
 * <dt><b>Styles:</b></dt>
 * <dd>FLAT, HORIZONTAL, VERTICAL</dd>
 * <dt><b>Events:</b></dt>
 * <dd>(none)</dd>
 * </dl>
 * </p><p>
 * Note: Only one of the styles HORIZONTAL and VERTICAL 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/#coolbar">CoolBar 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 CoolBar : Composite {

    alias Composite.computeSize computeSize;
    alias Composite.windowProc windowProc;

    CoolItem [] items;
    CoolItem [] originalItems;
    bool locked;
    bool ignoreResize;
    private static /+const+/ WNDPROC ReBarProc;
    static const TCHAR* ReBarClass = OS.REBARCLASSNAME.ptr;

    private static bool static_this_completed = false;
    private static void static_this() {
        if( static_this_completed ){
            return;
        }
        synchronized {
            if( static_this_completed ){
                return;
            }
            INITCOMMONCONTROLSEX icex;
            icex.dwSize = INITCOMMONCONTROLSEX.sizeof;
            icex.dwICC = OS.ICC_COOL_CLASSES;
            OS.InitCommonControlsEx (&icex);
            WNDCLASS lpWndClass;
            OS.GetClassInfo (null, ReBarClass, &lpWndClass);
            ReBarProc = lpWndClass.lpfnWndProc;
            static_this_completed = true;
        }
    }

    static const int SEPARATOR_WIDTH = 2;
    static const int MAX_WIDTH = 0x7FFF;
    static const int DEFAULT_COOLBAR_WIDTH = 0;
    static const int DEFAULT_COOLBAR_HEIGHT = 0;

/**
 * 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 composite control which will be the parent of the new instance (cannot be null)
 * @param style the style of control 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
 * @see Widget#checkSubclass
 * @see Widget#getStyle
 */
public this (Composite parent, int style) {
    static_this();
    super (parent, checkStyle (style));
    /*
    * Ensure that either of HORIZONTAL or VERTICAL is set.
    * NOTE: HORIZONTAL and VERTICAL have the same values
    * as H_SCROLL and V_SCROLL so it is necessary to first
    * clear these bits to avoid scroll bars and then reset
    * the bits using the original style supplied by the
    * programmer.
    *
    * NOTE: The CCS_VERT style cannot be applied when the
    * widget is created because of this conflict.
    */
    if ((style & DWT.VERTICAL) !is 0) {
        this.style |= DWT.VERTICAL;
        int bits = OS.GetWindowLong (handle, OS.GWL_STYLE);
        OS.SetWindowLong (handle, OS.GWL_STYLE, bits | OS.CCS_VERT);
    } else {
        this.style |= DWT.HORIZONTAL;
    }
}

override int callWindowProc (HWND hwnd, int msg, int wParam, int lParam) {
    if (handle is null) return 0;
    return OS.CallWindowProc (ReBarProc, hwnd, msg, wParam, lParam);
}

static int checkStyle (int style) {
    style |= DWT.NO_FOCUS;
    /*
    * Even though it is legal to create this widget
    * with scroll bars, they serve no useful purpose
    * because they do not automatically scroll the
    * widget's client area.  The fix is to clear
    * the DWT style.
    */
    return style & ~(DWT.H_SCROLL | DWT.V_SCROLL);
}

override protected void checkSubclass () {
    if (!isValidSubclass ()) error (DWT.ERROR_INVALID_SUBCLASS);
}

override public Point computeSize (int wHint, int hHint, bool changed) {
    checkWidget ();
    int width = 0, height = 0;
    int border = getBorderWidth ();
    int newWidth = wHint is DWT.DEFAULT ? 0x3FFF : wHint + (border * 2);
    int newHeight = hHint is DWT.DEFAULT ? 0x3FFF : hHint + (border * 2);
    int count = OS.SendMessage (handle, OS.RB_GETBANDCOUNT, 0, 0);
    if (count !is 0) {
        ignoreResize = true;
        bool redraw = false;
        if (OS.IsWindowVisible (handle)) {
            if (OS.COMCTL32_MAJOR >= 6) {
                redraw = true;
                OS.UpdateWindow (handle);
                OS.DefWindowProc (handle, OS.WM_SETREDRAW, 0, 0);
            } else {
                redraw = drawCount is 0;
                if (redraw) {
                    OS.UpdateWindow (handle);
                    OS.SendMessage (handle, OS.WM_SETREDRAW, 0, 0);
                }
            }
        }
        RECT oldRect;
        OS.GetWindowRect (handle, &oldRect);
        int oldWidth = oldRect.right - oldRect.left;
        int oldHeight = oldRect.bottom - oldRect.top;
        int flags = OS.SWP_NOACTIVATE | OS.SWP_NOMOVE | OS.SWP_NOREDRAW | OS.SWP_NOZORDER;
        SetWindowPos (handle, null, 0, 0, newWidth, newHeight, flags);
        RECT rect;
        OS.SendMessage (handle, OS.RB_GETRECT, count - 1, &rect);
        height = Math.max (height, rect.bottom);
        SetWindowPos (handle, null, 0, 0, oldWidth, oldHeight, flags);
        REBARBANDINFO rbBand;
        rbBand.cbSize = REBARBANDINFO.sizeof;
        rbBand.fMask = OS.RBBIM_IDEALSIZE | OS.RBBIM_STYLE;
        int rowWidth = 0;
        for (int i = 0; i < count; i++) {
            OS.SendMessage(handle, OS.RB_GETBANDINFO, i, &rbBand);
            if ((rbBand.fStyle & OS.RBBS_BREAK) !is 0) {
                width = Math.max(width, rowWidth);
                rowWidth = 0;
            }
            rowWidth += rbBand.cxIdeal + getMargin (i);
        }
        width = Math.max(width, rowWidth);
        if (redraw) {
            if (OS.COMCTL32_MAJOR >= 6) {
                OS.DefWindowProc (handle, OS.WM_SETREDRAW, 1, 0);
            } else {
                OS.SendMessage (handle, OS.WM_SETREDRAW, 1, 0);
            }
        }
        ignoreResize = false;
    }
    if (width is 0) width = DEFAULT_COOLBAR_WIDTH;
    if (height is 0) height = DEFAULT_COOLBAR_HEIGHT;
    if ((style & DWT.VERTICAL) !is 0) {
        int tmp = width;
        width = height;
        height = tmp;
    }
    if (wHint !is DWT.DEFAULT) width = wHint;
    if (hHint !is DWT.DEFAULT) height = hHint;
    height += border * 2;
    width += border * 2;
    return new Point (width, height);
}

override void createHandle () {
    super.createHandle ();
    state &= ~(CANVAS | THEME_BACKGROUND);

    /*
    * Feature in Windows.  When the control is created,
    * it does not use the default system font.  A new HFONT
    * is created and destroyed when the control is destroyed.
    * This means that a program that queries the font from
    * this control, uses the font in another control and then
    * destroys this control will have the font unexpectedly
    * destroyed in the other control.  The fix is to assign
    * the font ourselves each time the control is created.
    * The control will not destroy a font that it did not
    * create.
    */
    auto hFont = OS.GetStockObject (OS.SYSTEM_FONT);
    OS.SendMessage (handle, OS.WM_SETFONT, hFont, 0);
}

void createItem (CoolItem item, int index) {
    int count = OS.SendMessage (handle, OS.RB_GETBANDCOUNT, 0, 0);
    if (!(0 <= index && index <= count)) error (DWT.ERROR_INVALID_RANGE);
    int id = 0;
    while (id < items.length && items [id] !is null) id++;
    if (id is items.length) {
        CoolItem [] newItems = new CoolItem [items.length + 4];
        System.arraycopy (items, 0, newItems, 0, items.length);
        items = newItems;
    }
    auto hHeap = OS.GetProcessHeap ();
    auto lpText = cast(TCHAR*) OS.HeapAlloc (hHeap, OS.HEAP_ZERO_MEMORY, TCHAR.sizeof);
    REBARBANDINFO rbBand;
    rbBand.cbSize = REBARBANDINFO.sizeof;
    rbBand.fMask = OS.RBBIM_TEXT | OS.RBBIM_STYLE | OS.RBBIM_ID;
    rbBand.fStyle = OS.RBBS_VARIABLEHEIGHT | OS.RBBS_GRIPPERALWAYS;
    if ((item.style & DWT.DROP_DOWN) !is 0) {
        rbBand.fStyle |= OS.RBBS_USECHEVRON;
    }
    rbBand.lpText = lpText;
    rbBand.wID = id;

    /*
    * Feature in Windows.  When inserting an item at end of a row,
    * sometimes, Windows will begin to place the item on the right
    * side of the cool bar.  The fix is to resize the new items to
    * the maximum size and then resize the next to last item to the
    * ideal size.
    */
    int lastIndex = getLastIndexOfRow (index - 1);
    bool fixLast = index is lastIndex + 1;
    if (fixLast) {
        rbBand.fMask |= OS.RBBIM_SIZE;
        rbBand.cx = MAX_WIDTH;
    }

    /*
    * Feature in Windows. Is possible that the item at index zero
    * has the RBBS_BREAK flag set. When a new item is inserted at
    * position zero, the previous item at position zero moves to
    * a new line.  The fix is to detect this case and clear the
    * RBBS_BREAK flag on the previous item before inserting the
    * new item.
    */
    if (index is 0 && count > 0) {
        getItem (0).setWrap (false);
    }

    /* Insert the item */
    if (OS.SendMessage (handle, OS.RB_INSERTBAND, index, &rbBand) is 0) {
        error (DWT.ERROR_ITEM_NOT_ADDED);
    }

    /* Resize the next to last item to the ideal size */
    if (fixLast) {
        resizeToPreferredWidth (lastIndex);
    }

    OS.HeapFree (hHeap, 0, lpText);
    items [item.id = id] = item;
    int length = originalItems.length;
    CoolItem [] newOriginals = new CoolItem [length + 1];
    System.arraycopy (originalItems, 0, newOriginals, 0, index);
    System.arraycopy (originalItems, index, newOriginals, index + 1, length - index);
    newOriginals [index] = item;
    originalItems = newOriginals;
}

override void createWidget () {
    super.createWidget ();
    items = new CoolItem [4];
    originalItems = new CoolItem [0];
}

void destroyItem (CoolItem item) {
    int index = OS.SendMessage (handle, OS.RB_IDTOINDEX, item.id, 0);
    int count = OS.SendMessage (handle, OS.RB_GETBANDCOUNT, 0, 0);
    if (count !is 0) {
        int lastIndex = getLastIndexOfRow (index);
        if (index is lastIndex) {
            /*
            * Feature in Windows.  If the last item in a row is
            * given its ideal size, it will be placed at the far
            * right hand edge of the coolbar.  It is preferred
            * that the last item appear next to the second last
            * item.  The fix is to size the last item of each row
            * so that it occupies all the available space to the
            * right in the row.
            */
            resizeToMaximumWidth (lastIndex - 1);
        }
    }

    /*
    * Feature in Windows.  When Windows removed a rebar
    * band, it makes the band child invisible.  The fix
    * is to show the child.
    */
    Control control = item.control;
    bool wasVisible = control !is null && !control.isDisposed() && control.getVisible ();

    /*
    * When a wrapped item is being deleted, make the next
    * item in the row wrapped in order to preserve the row.
    * In order to avoid an unnecessary layout, temporarily
    * ignore WM_SIZE.  If the next item is wrapped then a
    * row will be deleted and the WM_SIZE is necessary.
    */
    CoolItem nextItem = null;
    if (item.getWrap ()) {
        if (index + 1 < count) {
            nextItem = getItem (index + 1);
            ignoreResize = !nextItem.getWrap ();
        }
    }
    if (OS.SendMessage (handle, OS.RB_DELETEBAND, index, 0) is 0) {
        error (DWT.ERROR_ITEM_NOT_REMOVED);
    }
    items [item.id] = null;
    item.id = -1;
    if (ignoreResize) {
        nextItem.setWrap (true);
        ignoreResize = false;
    }

    /* Restore the visible state of the control */
    if (wasVisible) control.setVisible (true);

    index = 0;
    while (index < originalItems.length) {
        if (originalItems [index] is item) break;
        index++;
    }
    int length = originalItems.length - 1;
    CoolItem [] newOriginals = new CoolItem [length];
    System.arraycopy (originalItems, 0, newOriginals, 0, index);
    System.arraycopy (originalItems, index + 1, newOriginals, index, length - index);
    originalItems = newOriginals;
}

override void drawThemeBackground (HDC hDC, HWND hwnd, RECT* rect) {
    if (OS.COMCTL32_MAJOR >= 6 && OS.IsAppThemed ()) {
        if (background is -1 && (style & DWT.FLAT) !is 0) {
            Control control = findBackgroundControl ();
            if (control !is null && control.backgroundImage !is null) {
                fillBackground (hDC, control.getBackgroundPixel (), rect);
                return;
            }
        }
    }
    RECT rect2;
    OS.GetClientRect (handle, &rect2);
    OS.MapWindowPoints (handle, hwnd, cast(POINT*) &rect2, 2);
    POINT lpPoint;
    OS.SetWindowOrgEx (hDC, -rect2.left, -rect2.top, &lpPoint);
    OS.SendMessage (handle, OS.WM_PRINT, hDC, OS.PRF_CLIENT | OS.PRF_ERASEBKGND);
    OS.SetWindowOrgEx (hDC, lpPoint.x, lpPoint.y, null);
}

override Control findThemeControl () {
    if ((style & DWT.FLAT) !is 0) return this;
    return background is -1 && backgroundImage is null ? this : super.findThemeControl ();
}

int getMargin (int index) {
    int margin = 0;
    if (OS.COMCTL32_MAJOR >= 6) {
        MARGINS margins;
        OS.SendMessage (handle, OS.RB_GETBANDMARGINS, 0, &margins);
        margin += margins.cxLeftWidth + margins.cxRightWidth;
    }
    RECT rect;
    OS.SendMessage (handle, OS.RB_GETBANDBORDERS, index, &rect);
    if ((style & DWT.FLAT) !is 0) {
        /*
        * Bug in Windows.  When the style bit  RBS_BANDBORDERS is not set
        * the rectangle returned by RBS_BANDBORDERS is four pixels too small.
        * The fix is to add four pixels to the result.
        */
        if ((style & DWT.VERTICAL) !is 0) {
            margin += rect.top + 4;
        } else {
            margin += rect.left + 4;
        }
    } else {
        if ((style & DWT.VERTICAL) !is 0) {
            margin += rect.top + rect.bottom;
        } else {
            margin += rect.left + rect.right;
        }
    }
    if ((style & DWT.FLAT) is 0) {
        if (!isLastItemOfRow (index)) {
            margin += CoolBar.SEPARATOR_WIDTH;
        }
    }
    return margin;
}

/**
 * Returns the item that is currently displayed at the given,
 * zero-relative index. Throws an exception if the index is
 * out of range.
 *
 * @param index the visual index of the item to return
 * @return the item at the given visual index
 *
 * @exception IllegalArgumentException <ul>
 *    <li>ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (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>
 */
public CoolItem getItem (int index) {
    checkWidget ();
    int count = OS.SendMessage (handle, OS.RB_GETBANDCOUNT, 0, 0);
    if (!(0 <= index && index < count)) error (DWT.ERROR_INVALID_RANGE);
    REBARBANDINFO rbBand;
    rbBand.cbSize = REBARBANDINFO.sizeof;
    rbBand.fMask = OS.RBBIM_ID;
    OS.SendMessage (handle, OS.RB_GETBANDINFO, index, &rbBand);
    return items [rbBand.wID];
}

/**
 * Returns the number of items contained in the receiver.
 *
 * @return the number of items
 *
 * @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 int getItemCount () {
    checkWidget ();
    return OS.SendMessage (handle, OS.RB_GETBANDCOUNT, 0, 0);
}

/**
 * Returns an array of zero-relative ints that map
 * the creation order of the receiver's items to the
 * order in which they are currently being displayed.
 * <p>
 * Specifically, the indices of the returned array represent
 * the current visual order of the items, and the contents
 * of the array represent the creation order of the items.
 * </p><p>
 * Note: This is not the actual structure used by the receiver
 * to maintain its list of items, so modifying the array will
 * not affect the receiver.
 * </p>
 *
 * @return the current visual order of the receiver's items
 *
 * @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 int [] getItemOrder () {
    checkWidget ();
    int count = OS.SendMessage (handle, OS.RB_GETBANDCOUNT, 0, 0);
    int [] indices = new int [count];
    REBARBANDINFO rbBand;
    rbBand.cbSize = REBARBANDINFO.sizeof;
    rbBand.fMask = OS.RBBIM_ID;
    for (int i=0; i<count; i++) {
        OS.SendMessage (handle, OS.RB_GETBANDINFO, i, &rbBand);
        CoolItem item = items [rbBand.wID];
        int index = 0;
        while (index<originalItems.length) {
            if (originalItems [index] is item) break;
            index++;
        }
        if (index is originalItems.length) error (DWT.ERROR_CANNOT_GET_ITEM);
        indices [i] = index;
    }
    return indices;
}

/**
 * Returns an array of <code>CoolItem</code>s in the order
 * in which they are currently being displayed.
 * <p>
 * Note: This is not the actual structure used by the receiver
 * to maintain its list of items, so modifying the array will
 * not affect the receiver.
 * </p>
 *
 * @return the receiver's items in their current visual order
 *
 * @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 CoolItem [] getItems () {
    checkWidget ();
    int count = OS.SendMessage (handle, OS.RB_GETBANDCOUNT, 0, 0);
    CoolItem [] result = new CoolItem [count];
    REBARBANDINFO rbBand;
    rbBand.cbSize = REBARBANDINFO.sizeof;
    rbBand.fMask = OS.RBBIM_ID;
    for (int i=0; i<count; i++) {
        OS.SendMessage (handle, OS.RB_GETBANDINFO, i, &rbBand);
        result [i] = items [rbBand.wID];
    }
    return result;
}

/**
 * Returns an array of points whose x and y coordinates describe
 * the widths and heights (respectively) of the items in the receiver
 * in the order in which they are currently being displayed.
 *
 * @return the receiver's item sizes in their current visual order
 *
 * @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>
 */