view dwt/widgets/TabFolder.d @ 212:ab60f3309436

reverted the char[] to String and use the an alias.
author Frank Benoit <benoit@tionex.de>
date Mon, 05 May 2008 00:12:38 +0200
parents 6f75fdfa1bcd
children 36f5cb12e1a2
line wrap: on
line source

/*******************************************************************************
 * Copyright (c) 2000, 2007 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.TabFolder;


import dwt.DWT;
import dwt.DWTException;
import dwt.events.SelectionEvent;
import dwt.events.SelectionListener;
import dwt.graphics.Font;
import dwt.graphics.Image;
import dwt.graphics.Point;
import dwt.graphics.Rectangle;
import dwt.internal.ImageList;
import dwt.internal.win32.OS;

import dwt.widgets.Composite;
import dwt.widgets.TabItem;
import dwt.widgets.TypedListener;
import dwt.widgets.Event;
import dwt.widgets.Control;

import dwt.dwthelper.utils;

/**
 * Instances of this class implement the notebook user interface
 * metaphor.  It allows the user to select a notebook page from
 * set of pages.
 * <p>
 * The item children that may be added to instances of this class
 * must be of type <code>TabItem</code>.
 * <code>Control</code> children are created and then set into a
 * tab item using <code>TabItem#setControl</code>.
 * </p><p>
 * Note that although this class is a subclass of <code>Composite</code>,
 * it does not make sense to set a layout on it.
 * </p><p>
 * <dl>
 * <dt><b>Styles:</b></dt>
 * <dd>TOP, BOTTOM</dd>
 * <dt><b>Events:</b></dt>
 * <dd>Selection</dd>
 * </dl>
 * <p>
 * Note: Only one of the styles TOP and BOTTOM may be specified.
 * </p><p>
 * IMPORTANT: This class is <em>not</em> intended to be subclassed.
 * </p>
 */
public class TabFolder : Composite {

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

    TabItem [] items;
    ImageList imageList;
    private static /+const+/ WNDPROC TabFolderProc;
    static const TCHAR[] TabFolderClass = OS.WC_TABCONTROL;

    /*
    * These are the undocumented control id's for the children of
    * a tab control.  Since there are no constants for these values,
    * they may change with different versions of Windows.
    */
    static const int ID_UPDOWN = 1;

    private static bool static_this_completed = false;
    private static void static_this() {
        if( static_this_completed ){
            return;
        }
        synchronized {
            if( static_this_completed ){
                return;
            }
            WNDCLASS lpWndClass;
            OS.GetClassInfo (null, TabFolderClass.ptr, &lpWndClass);
            TabFolderProc = lpWndClass.lpfnWndProc;
            /*
            * Feature in Windows.  The tab control window class
            * uses the CS_HREDRAW and CS_VREDRAW style bits to
            * force a full redraw of the control and all children
            * when resized.  This causes flashing.  The fix is to
            * register a new window class without these bits and
            * implement special code that damages only the exposed
            * area.
            *
            * NOTE:  Screen readers look for the exact class name
            * of the control in order to provide the correct kind
            * of assistance.  Therefore, it is critical that the
            * new window class have the same name.  It is possible
            * to register a local window class with the same name
            * as a global class.  Since bits that affect the class
            * are being changed, it is possible that other native
            * code, other than DWT, could create a control with
            * this class name, and fail unexpectedly.
            */
            auto hInstance = OS.GetModuleHandle (null);
            auto hHeap = OS.GetProcessHeap ();
            lpWndClass.hInstance = hInstance;
            lpWndClass.style &= ~(OS.CS_HREDRAW | OS.CS_VREDRAW | OS.CS_GLOBALCLASS);
            int byteCount = (TabFolderClass.length+1) * TCHAR.sizeof;
            auto lpszClassName = cast(TCHAR*) OS.HeapAlloc (hHeap, OS.HEAP_ZERO_MEMORY, byteCount);
            OS.MoveMemory (lpszClassName, TabFolderClass.ptr, byteCount);
            lpWndClass.lpszClassName = lpszClassName;
            OS.RegisterClass (&lpWndClass);
            OS.HeapFree (hHeap, 0, lpszClassName);
            static_this_completed = true;
        }
    }

/**
 * 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));
}

/**
 * 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>
 * When <code>widgetSelected</code> is called, the item field of the event object is valid.
 * <code>widgetDefaultSelected</code> is not called.
 * </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) error (DWT.ERROR_NULL_ARGUMENT);
    TypedListener typedListener = new TypedListener(listener);
    addListener(DWT.Selection,typedListener);
    addListener(DWT.DefaultSelection,typedListener);
}

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

static int checkStyle (int style) {
    /*
    * When the DWT.TOP style has not been set, force the
    * tabs to be on the bottom for tab folders on PPC.
    */
    if (OS.IsPPC) {
        if ((style & DWT.TOP) is 0) style |= DWT.BOTTOM;
    }
    style = checkBits (style, DWT.TOP, DWT.BOTTOM, 0, 0, 0, 0);

    /*
    * 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 ();
    Point size = super.computeSize (wHint, hHint, changed);
    RECT insetRect, itemRect;
    OS.SendMessage (handle, OS.TCM_ADJUSTRECT, 0, &insetRect);
    int width = insetRect.left - insetRect.right;
    int count = OS.SendMessage (handle, OS.TCM_GETITEMCOUNT, 0, 0);
    if (count !is 0) {
        OS.SendMessage (handle, OS.TCM_GETITEMRECT, count - 1, &itemRect);
        width = Math.max (width, itemRect.right - insetRect.right);
    }
    RECT rect;
    OS.SetRect (&rect, 0, 0, width, size.y);
    OS.SendMessage (handle, OS.TCM_ADJUSTRECT, 1, &rect);
    int border = getBorderWidth ();
    rect.left -= border;  rect.right += border;
    width = rect.right - rect.left;
    size.x = Math.max (width, size.x);
    return size;
}

override public Rectangle computeTrim (int x, int y, int width, int height) {
    checkWidget ();
    RECT rect;
    OS.SetRect (&rect, x, y, x + width, y + height);
    OS.SendMessage (handle, OS.TCM_ADJUSTRECT, 1, &rect);
    int border = getBorderWidth ();
    rect.left -= border;  rect.right += border;
    rect.top -= border;  rect.bottom += border;
    int newWidth = rect.right - rect.left;
    int newHeight = rect.bottom - rect.top;
    return new Rectangle (rect.left, rect.top, newWidth, newHeight);
}

void createItem (TabItem item, int index) {
    int count = OS.SendMessage (handle, OS.TCM_GETITEMCOUNT, 0, 0);
    if (!(0 <= index && index <= count)) error (DWT.ERROR_INVALID_RANGE);
    if (count is items.length) {
        TabItem [] newItems = new TabItem [items.length + 4];
        System.arraycopy (items, 0, newItems, 0, items.length);
        items = newItems;
    }
    TCITEM tcItem;
    if (OS.SendMessage (handle, OS.TCM_INSERTITEM, index, &tcItem) is -1) {
        error (DWT.ERROR_ITEM_NOT_ADDED);
    }
    System.arraycopy (items, index, items, index + 1, count - index);
    items [index] = item;

    /*
    * Send a selection event when the item that is added becomes
    * the new selection.  This only happens when the first item
    * is added.
    */
    if (count is 0) {
        Event event = new Event ();
        event.item = items [0];
        sendEvent (DWT.Selection, event);
        // the widget could be destroyed at this point
    }
}

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

    /* Enable the flat look for tab folders on PPC */
    if (OS.IsPPC) {
        OS.SendMessage (handle, OS.CCM_SETVERSION, 0x020c /*COMCTL32_VERSION*/, 0);
    }

    /*
    * Feature in Windows.  Despite the fact that the
    * tool tip text contains \r\n, the tooltip will
    * not honour the new line unless TTM_SETMAXTIPWIDTH
    * is set.  The fix is to set TTM_SETMAXTIPWIDTH to
    * a large value.
    */
    auto hwndToolTip = cast(HWND) OS.SendMessage (handle, OS.TCM_GETTOOLTIPS, 0, 0);
    OS.SendMessage (hwndToolTip, OS.TTM_SETMAXTIPWIDTH, 0, 0x7FFF);
}

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

void destroyItem (TabItem item) {
    int count = OS.SendMessage (handle, OS.TCM_GETITEMCOUNT, 0, 0);
    int index = 0;
    while (index < count) {
        if (items [index] is item) break;
        index++;
    }
    if (index is count) return;
    int selectionIndex = OS.SendMessage (handle, OS.TCM_GETCURSEL, 0, 0);
    if (OS.SendMessage (handle, OS.TCM_DELETEITEM, index, 0) is 0) {
        error (DWT.ERROR_ITEM_NOT_REMOVED);
    }
    System.arraycopy (items, index + 1, items, index, --count - index);
    items [count] = null;
    if (count is 0) {
        if (imageList !is null) {
            OS.SendMessage (handle, OS.TCM_SETIMAGELIST, 0, 0);
            display.releaseImageList (imageList);
        }
        imageList = null;
        items = new TabItem [4];
    }
    if (count > 0 && index is selectionIndex) {
        setSelection (Math.max (0, selectionIndex - 1), true);
    }
}

override void drawThemeBackground (HDC hDC, HWND hwnd, RECT* rect) {
    RECT rect2;
    OS.GetClientRect (handle, &rect2);
    OS.MapWindowPoints (handle, hwnd, cast(POINT*) &rect2, 2);
    RECT dummy;
    if (OS.IntersectRect (&dummy, &rect2, rect)) {
        OS.DrawThemeBackground (display.hTabTheme (), hDC, OS.TABP_BODY, 0, &rect2, null);
    }
}

override Control findThemeControl () {
    /* It is not possible to change the background of this control */
    return this;
}

override public Rectangle getClientArea () {
    checkWidget ();
    forceResize ();
    RECT rect;
    OS.GetClientRect (handle, &rect);
    OS.SendMessage (handle, OS.TCM_ADJUSTRECT, 0, &rect);
    int width = rect.right - rect.left;
    int height = rect.bottom - rect.top;
    return new Rectangle (rect.left, rect.top, width, height);
}

/**
 * Returns the item at the given, zero-relative index in the
 * receiver. Throws an exception if the index is out of range.
 *
 * @param index the index of the item to return
 * @return the item at the given 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 TabItem getItem (int index) {
    checkWidget ();
    int count = OS.SendMessage (handle, OS.TCM_GETITEMCOUNT, 0, 0);
    if (!(0 <= index && index < count)) error (DWT.ERROR_INVALID_RANGE);
    return items [index];
}

/**
 * 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.TCM_GETITEMCOUNT, 0, 0);
}

/**
 * Returns an array of <code>TabItem</code>s which are the items
 * in the receiver.
 * <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 items in the receiver
 *
 * @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 TabItem [] getItems () {
    checkWidget ();
    int count = OS.SendMessage (handle, OS.TCM_GETITEMCOUNT, 0, 0);
    TabItem [] result = new TabItem [count];
    System.arraycopy (items, 0, result, 0, count);
    return result;
}

/**
 * Returns an array of <code>TabItem</code>s that are currently
 * selected in the receiver. An empty array indicates that no
 * items are selected.
 * <p>
 * Note: This is not the actual structure used by the receiver
 * to maintain its selection, so modifying the array will
 * not affect the receiver.
 * </p>
 * @return an array representing the selection
 *
 * @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 TabItem [] getSelection () {
    checkWidget ();
    int index = OS.SendMessage (handle, OS.TCM_GETCURSEL, 0, 0);
    if (index is -1) return new TabItem [0];
    return [ items [index] ];
}

/**
 * Returns the zero-relative index of the item which is currently
 * selected in the receiver, or -1 if no item is selected.
 *
 * @return the index of the selected 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>
 */
public int getSelectionIndex () {
    checkWidget ();
    return OS.SendMessage (handle, OS.TCM_GETCURSEL, 0, 0);
}

int imageIndex (Image image) {
    if (image is null) return OS.I_IMAGENONE;
    if (imageList is null) {
        Rectangle bounds = image.getBounds ();
        imageList = display.getImageList (style & DWT.RIGHT_TO_LEFT, bounds.width, bounds.height);
        int index = imageList.add (image);
        auto hImageList = imageList.getHandle ();
        OS.SendMessage (handle, OS.TCM_SETIMAGELIST, 0, hImageList);
        return index;
    }
    int index = imageList.indexOf (image);
    if (index is -1) {
        index = imageList.add (image);
    } else {
        imageList.put (index, image);
    }
    return index;
}

/**
 * Searches the receiver's list starting at the first item
 * (index 0) until an item is found that is equal to the
 * argument, and returns the index of that item. If no item
 * is found, returns -1.
 *
 * @param item the search item
 * @return the index of the item
 *
 * @exception IllegalArgumentException <ul>
 *    <li>ERROR_NULL_ARGUMENT - if the item 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>
 */
public int indexOf (TabItem item) {
    checkWidget ();
    if (item is null) error (DWT.ERROR_NULL_ARGUMENT);
    int count = OS.SendMessage (handle, OS.TCM_GETITEMCOUNT, 0, 0);
    for (int i=0; i<count; i++) {
        if (items [i] is item) return i;
    }
    return -1;
}

override Point minimumSize (int wHint, int hHint, bool flushCache) {
    Control [] children = _getChildren ();
    int width = 0, height = 0;
    for (int i=0; i<children.length; i++) {
        Control child = children [i];
        int index = 0;
        int count = OS.SendMessage (handle, OS.TCM_GETITEMCOUNT, 0, 0);
        while (index < count) {
            if (items [index].control is child) break;
            index++;
        }
        if (index is count) {
            Rectangle rect = child.getBounds ();
            width = Math.max (width, rect.x + rect.width);
            height = Math.max (height, rect.y + rect.height);
        } else {
            Point size = child.computeSize (wHint, hHint, flushCache);
            width = Math.max (width, size.x);
            height = Math.max (height, size.y);
        }
    }
    return new Point (width, height);
}

override bool mnemonicHit (wchar key) {
    for (int i=0; i<items.length; i++) {
        TabItem item = items [i];
        if (item !is null) {
            wchar ch = findMnemonic (item.getText ());
            if (CharacterToUpper (key) is CharacterToUpper (ch)) {
                if (forceFocus ()) {
                    if (i !is getSelectionIndex ()) setSelection (i, true);
                    return true;
                }
            }
        }
    }
    return false;
}

override bool mnemonicMatch (wchar key) {
    for (int i=0; i<items.length; i++) {
        TabItem item = items [i];
        if (item !is null) {
            wchar ch = findMnemonic (item.getText ());
            if (CharacterToUpper (key) is CharacterToUpper (ch)) {
                return true;
            }
        }
    }
    return false;
}

override void releaseChildren (bool destroy) {
    if (items !is null) {
        int count = OS.SendMessage (handle, OS.TCM_GETITEMCOUNT, 0, 0);
        for (int i=0; i<count; i++) {
            TabItem item = items [i];
            if (item !is null && !item.isDisposed ()) {
                item.release (false);
            }
        }
        items = null;
    }
    super.releaseChildren (destroy);
}

override void releaseWidget () {
    super.releaseWidget ();
    if (imageList !is null) {
        OS.SendMessage (handle, OS.TCM_SETIMAGELIST, 0, 0);
        display.releaseImageList (imageList);
    }
    imageList = null;
}

override void removeControl (Control control) {
    super.removeControl (control);
    int count = OS.SendMessage (handle, OS.TCM_GETITEMCOUNT, 0, 0);
    for (int i=0; i<count; i++) {
        TabItem item = items [i];
        if (item.control is control) item.setControl (null);
    }
}

/**
 * Removes the listener from the collection of listeners who will
 * be notified when the user changes the receiver's selection.
 *
 * @param listener the listener which should no longer 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 SelectionListener
 * @see #addSelectionListener
 */
public void removeSelectionListener (SelectionListener listener) {
    checkWidget ();
    if (listener is null) error (DWT.ERROR_NULL_ARGUMENT);
    if (eventTable is null) return;
    eventTable.unhook (DWT.Selection, listener);
    eventTable.unhook (DWT.DefaultSelection,listener);
}

/**
 * Sets the receiver's selection to the given item.
 * The current selected is first cleared, then the new item is
 * selected.
 *
 * @param item the item to select
 *
 * @exception IllegalArgumentException <ul>
 *    <li>ERROR_NULL_ARGUMENT - if the item 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>
 *
 * @since 3.2
 */
public void setSelection (TabItem item) {
    checkWidget ();
    if (item is null) error (DWT.ERROR_NULL_ARGUMENT);
    setSelection ( [item] );
}

/**
 * Sets the receiver's selection to be the given array of items.
 * The current selected is first cleared, then the new items are
 * selected.
 *
 * @param items the array of items
 *
 * @exception IllegalArgumentException <ul>
 *    <li>ERROR_NULL_ARGUMENT - if the items array 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>
 */
public void setSelection (TabItem [] items) {
    checkWidget ();
    if (items is null) error (DWT.ERROR_NULL_ARGUMENT);
    if (items.length is 0) {
        setSelection (-1, false);
    } else {
        for (int i=items.length-1; i>=0; --i) {
            int index = indexOf (items [i]);
            if (index !is -1) setSelection (index, false);
        }
    }
}

override public void setFont (Font font) {
    checkWidget ();
    Rectangle oldRect = getClientArea ();
    super.setFont (font);
    Rectangle newRect = getClientArea ();
    if (oldRect !=/*eq*/ newRect) {
        sendResize ();
        int index = OS.SendMessage (handle, OS.TCM_GETCURSEL, 0, 0);
        if (index !is -1) {
            TabItem item = items [index];
            Control control = item.control;
            if (control !is null && !control.isDisposed ()) {
                control.setBounds (getClientArea ());
            }
        }
    }
}

/**
 * Selects the item at the given zero-relative index in the receiver.
 * If the item at the index was already selected, it remains selected.
 * The current selection is first cleared, then the new items are
 * selected. Indices that are out of range are ignored.
 *
 * @param index the index of the item to select
 *
 * @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 setSelection (int index) {
    checkWidget ();
    int count = OS.SendMessage (handle, OS.TCM_GETITEMCOUNT, 0, 0);
    if (!(0 <= index && index < count)) return;
    setSelection (index, false);
}

void setSelection (int index, bool notify) {
    int oldIndex = OS.SendMessage (handle, OS.TCM_GETCURSEL, 0, 0);
    if (oldIndex is index) return;
    if (oldIndex !is -1) {
        TabItem item = items [oldIndex];
        Control control = item.control;
        if (control !is null && !control.isDisposed ()) {
            control.setVisible (false);
        }
    }
    OS.SendMessage (handle, OS.TCM_SETCURSEL, index, 0);
    int newIndex = OS.SendMessage (handle, OS.TCM_GETCURSEL, 0, 0);
    if (newIndex !is -1) {
        TabItem item = items [newIndex];
        Control control = item.control;
        if (control !is null && !control.isDisposed ()) {
            control.setBounds (getClientArea ());
            control.setVisible (true);
        }
        if (notify) {
            Event event = new Event ();
            event.item = item;
            sendEvent (DWT.Selection, event);
        }
    }
}

override String toolTipText (NMTTDISPINFO* hdr) {
    if ((hdr.uFlags & OS.TTF_IDISHWND) !is 0) {
        return null;
    }
    int index = hdr.hdr.idFrom;
    auto hwndToolTip = cast(HWND) OS.SendMessage (handle, OS.TCM_GETTOOLTIPS, 0, 0);
    if (hwndToolTip is hdr.hdr.hwndFrom) {
        if (toolTipText_ !is null) return "";
        if (0 <= index && index < items.length) {
            TabItem item = items [index];
            if (item !is null) return item.toolTipText;
        }
    }
    return super.toolTipText (hdr);
}

override bool traversePage (bool next) {
    int count = getItemCount ();
    if (count <= 1) return false;
    int index = getSelectionIndex ();
    if (index is -1) {
        index = 0;
    } else {
        int offset = (next) ? 1 : -1;
        index = (index + offset + count) % count;
    }
    setSelection (index, true);
    if (index is getSelectionIndex ()) {
        OS.SendMessage (handle, OS.WM_CHANGEUISTATE, OS.UIS_INITIALIZE, 0);
        return true;
    }
    return false;
}

override int widgetStyle () {
    /*
    * Bug in Windows.  Under certain circumstances,
    * when TCM_SETITEM is used to change the text
    * in a tab item, the tab folder draws on top
    * of the client area.  The fix is ensure that
    * this cannot happen by setting WS_CLIPCHILDREN.
    */
    int bits = super.widgetStyle () | OS.WS_CLIPCHILDREN;
    if ((style & DWT.NO_FOCUS) !is 0) bits |= OS.TCS_FOCUSNEVER;
    if ((style & DWT.BOTTOM) !is 0) bits |= OS.TCS_BOTTOM;
    return bits | OS.TCS_TABS | OS.TCS_TOOLTIPS;
}

override String windowClass () {
    return TCHARsToStr( TabFolderClass );
}

override int windowProc () {
    return cast(int) TabFolderProc;
}

override LRESULT WM_GETDLGCODE (int wParam, int lParam) {
    LRESULT result = super.WM_GETDLGCODE (wParam, lParam);
    /*
    * Return DLGC_BUTTON so that mnemonics will be
    * processed without needing to press the ALT key
    * when the widget has focus.
    */
    if (result !is null) return result;
    return new LRESULT (OS.DLGC_BUTTON);
}

override LRESULT WM_MOUSELEAVE (int wParam, int lParam) {
    LRESULT result = super.WM_MOUSELEAVE (wParam, lParam);
    if (result !is null) return result;
    /*
    * Bug in Windows.  On XP, when a tooltip is
    * hidden due to a time out or mouse press,
    * the tooltip remains active although no
    * longer visible and won't show again until
    * another tooltip becomes active.  If there
    * is only one tooltip in the window,  it will
    * never show again.  The fix is to remove the
    * current tooltip and add it again every time
    * the mouse leaves the control.
    */
    if (OS.COMCTL32_MAJOR >= 6) {
        TOOLINFO lpti;
        lpti.cbSize = TOOLINFO.sizeof;
        auto hwndToolTip = cast(HWND) OS.SendMessage (handle, OS.TCM_GETTOOLTIPS, 0, 0);
        if (OS.SendMessage (hwndToolTip, OS.TTM_GETCURRENTTOOL, 0, &lpti) !is 0) {
            if ((lpti.uFlags & OS.TTF_IDISHWND) is 0) {
                OS.SendMessage (hwndToolTip, OS.TTM_DELTOOL, 0, &lpti);
                OS.SendMessage (hwndToolTip, OS.TTM_ADDTOOL, 0, &lpti);
            }
        }
    }
    return result;
}

override LRESULT WM_NCHITTEST (int wParam, int lParam) {
    LRESULT result = super.WM_NCHITTEST (wParam, lParam);
    if (result !is null) return result;
    /*
    * Feature in Windows.  The tab control implements
    * WM_NCHITTEST to return HTCLIENT when the cursor
    * is inside the tab buttons.  This causes mouse
    * events like WM_MOUSEMOVE to be delivered to the
    * parent.  Also, tool tips for the tab control are
    * never invoked because tool tips rely on mouse
    * events to be delivered to the window that wants
    * to display the tool tip.  The fix is to call the
    * default window proc that returns HTCLIENT when
    * the mouse is in the client area.
    */
    int hittest = OS.DefWindowProc (handle, OS.WM_NCHITTEST, wParam, lParam);
    return new LRESULT (hittest);
}

override LRESULT WM_NOTIFY (int wParam, int lParam) {
    /*
    * Feature in Windows.  When the tab folder window
    * proc processes WM_NOTIFY, it forwards this
    * message to its parent.  This is done so that
    * children of this control that send this message
    * type to their parent will notify not only
    * this control but also the parent of this control,
    * which is typically the application window and
    * the window that is looking for the message.
    * If the control did not forward the message,
    * applications would have to subclass the control
    * window to see the message. Because the control
    * window is subclassed by DWT, the message
    * is delivered twice, once by DWT and once when
    * the message is forwarded by the window proc.
    * The fix is to avoid calling the window proc
    * for this control.
    */
    LRESULT result = super.WM_NOTIFY (wParam, lParam);
    if (result !is null) return result;
    return LRESULT.ZERO;
}

override LRESULT WM_PARENTNOTIFY (int wParam, int lParam) {
    LRESULT result = super.WM_PARENTNOTIFY (wParam, lParam);
    if (result !is null) return result;
    /*
    * Feature in Windows.  Windows does not explicitly set the orientation of
    * the buddy control.  Instead, the orientation is inherited when WS_EX_LAYOUTRTL
    * is specified for the tab folder.  This means that when both WS_EX_LAYOUTRTL
    * and WS_EX_NOINHERITLAYOUT are specified for the tab folder, the buddy control
    * will not be oriented correctly.  The fix is to explicitly set the orientation
    * for the buddy control.
    *
    * NOTE: WS_EX_LAYOUTRTL is not supported on Windows NT.
    */
    if (OS.WIN32_VERSION < OS.VERSION (4, 10)) return result;
    if ((style & DWT.RIGHT_TO_LEFT) !is 0) {
        int code = wParam & 0xFFFF;
        switch (code) {
            case OS.WM_CREATE: {
                int id = (wParam >> 16);
                HWND hwnd = cast(HWND) lParam;
                if (id is ID_UPDOWN) {
                    auto bits = OS.GetWindowLong (hwnd, OS.GWL_EXSTYLE);
                    OS.SetWindowLong (hwnd, OS.GWL_EXSTYLE, bits | OS.WS_EX_LAYOUTRTL);
                }
                break;
            }
            default:
        }
    }
    return result;
}

override LRESULT WM_SIZE (int wParam, int lParam) {
    LRESULT result = super.WM_SIZE (wParam, lParam);
    /*
    * It is possible (but unlikely), that application
    * code could have disposed the widget in the resize
    * event.  If this happens, end the processing of the
    * Windows message by returning the result of the
    * WM_SIZE message.
    */
    if (isDisposed ()) return result;
    int index = OS.SendMessage (handle, OS.TCM_GETCURSEL, 0, 0);
    if (index !is -1) {
        TabItem item = items [index];
        Control control = item.control;
        if (control !is null && !control.isDisposed ()) {
            control.setBounds (getClientArea ());
        }
    }
    return result;
}

override LRESULT WM_WINDOWPOSCHANGING (int wParam, int lParam) {
    LRESULT result = super.WM_WINDOWPOSCHANGING (wParam, lParam);
    if (result !is null) return result;
    if (!OS.IsWindowVisible (handle)) return result;
    WINDOWPOS* lpwp = cast(WINDOWPOS*)lParam;
    //OS.MoveMemory (lpwp, lParam, WINDOWPOS.sizeof);
    if ((lpwp.flags & (OS.SWP_NOSIZE | OS.SWP_NOREDRAW)) !is 0) {
        return result;
    }
    // TEMPORARY CODE
//  if (OS.COMCTL32_MAJOR >= 6 && OS.IsAppThemed ()) {
//      OS.InvalidateRect (handle, null, true);
//      return result;
//  }
    int bits = OS.GetWindowLong (handle, OS.GWL_STYLE);
    if ((bits & OS.TCS_MULTILINE) !is 0) {
        OS.InvalidateRect (handle, null, true);
        return result;
    }
    RECT rect;
    OS.SetRect (&rect, 0, 0, lpwp.cx, lpwp.cy);
    OS.SendMessage (handle, OS.WM_NCCALCSIZE, 0, &rect);
    int newWidth = rect.right - rect.left;
    int newHeight = rect.bottom - rect.top;
    OS.GetClientRect (handle, &rect);
    int oldWidth = rect.right - rect.left;
    int oldHeight = rect.bottom - rect.top;
    if (newWidth is oldWidth && newHeight is oldHeight) {
        return result;
    }
    RECT inset;
    OS.SendMessage (handle, OS.TCM_ADJUSTRECT, 0, &inset);
    int marginX = -inset.right, marginY = -inset.bottom;
    if (newWidth !is oldWidth) {
        int left = oldWidth;
        if (newWidth < oldWidth) left = newWidth;
        OS.SetRect (&rect, left - marginX, 0, newWidth, newHeight);
        OS.InvalidateRect (handle, &rect, true);
    }
    if (newHeight !is oldHeight) {
        int bottom = oldHeight;
        if (newHeight < oldHeight) bottom = newHeight;
        if (newWidth < oldWidth) oldWidth -= marginX;
        OS.SetRect (&rect, 0, bottom - marginY, oldWidth, newHeight);
        OS.InvalidateRect (handle, &rect, true);
    }
    return result;
}

override LRESULT wmNotifyChild (NMHDR* hdr, int wParam, int lParam) {
    int code = hdr.code;
    switch (code) {
        case OS.TCN_SELCHANGE:
        case OS.TCN_SELCHANGING:
            TabItem item = null;
            int index = OS.SendMessage (handle, OS.TCM_GETCURSEL, 0, 0);
            if (index !is -1) item = items [index];
            if (item !is null) {
                Control control = item.control;
                if (control !is null && !control.isDisposed ()) {
                    if (code is OS.TCN_SELCHANGE) {
                        control.setBounds (getClientArea ());
                    }
                    control.setVisible (code is OS.TCN_SELCHANGE);
                }
            }
            if (code is OS.TCN_SELCHANGE) {
                Event event = new Event ();
                event.item = item;
                postEvent (DWT.Selection, event);
            }
        default:
    }
    return super.wmNotifyChild (hdr, wParam, lParam);
}

}