root/branches/0.2/swt/swt.d

/*******************************************************************************
 * Copyright (c) 2000, 2004 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
module swt.swt;



public import std.math2;
public import std.thread;
public import std.string;
public import std.conv;
public import std.utf;
public import std.math;
public import std.file;
public import std.stdio;
public import std.stream;

public alias char[] String;

// for temp use, since D can't cast int to bool implicitly
public alias int BOOL;

public alias std.string.toString ITOA;


private import swt.util.util;
private import swt.internal.library;


/**
 * This class provides access to a small number of SWT system-wide
 * methods, and in addition defines the public constants provided
 * by SWT.
 * <p>
 * By defining constants like UP and DOWN in a single class, SWT
 * can share common names and concepts at the same time minimizing
 * the number of classes, names and constants for the application
 * programmer.
 * </p><p>
 * Note that some of the constants provided by this class represent
 * optional, appearance related aspects of widgets which are available
 * either only on some window systems, or for a differing set of
 * widgets on each window system. These constants are marked
 * as <em>HINT</em>s. The set of widgets which support a particular
 * <em>HINT</em> may change from release to release, although we typically
 * will not withdraw support for a <em>HINT</em> once it is made available.
 * </p>
 */
 
/* NOTE:
 *   Good javadoc coding style is to put the values of static final 
 *   constants in the comments. This reinforces the fact that
 *   consumers are allowed to rely on the value (and they must
 *   since the values are compiled inline in their code). We
 *   can <em>not</em> change the values of these constants between
 *   releases.
 */
public class SWT {
    
    /* Initialize the class */
//  static {
//      /* NOTE: the static initialization is at the end of file */
//  }
    
    /* Widget Event Constants */
    
    /**
     * The null event type (value is 0).
     * 
     * @since 3.0
     */
    public static const int None = 0;
    
    /**
     * The key down event type (value is 1).
     */
    public static const int KeyDown = 1;
    
    /**
     * The key up event type (value is 2).
     */
    public static const int KeyUp = 2;
    
    /**
     * mouse down event type (value is 3)
     */
    public static const int MouseDown = 3;
    
    /**
     * The mouse up event type (value is 4).
     */
    public static const int MouseUp = 4;
    
    /**
     * The mouse move event type (value is 5).
     */
    public static const int MouseMove = 5;
    
    /**
     * The mouse enter event type (value is 6).
     */
    public static const int MouseEnter = 6;     
    
    /**
     * The mouse exit event type (value is 7).
     */
    public static const int MouseExit = 7;
    
    /**
     * The mouse double click event type (value is 8).
     */
    public static const int MouseDoubleClick = 8;   
    
    /**
     * The paint event type (value is 9).
     */
    public static const int Paint = 9;  
    
    /**
     * The move event type (value is 10).
     */
    public static const int Move = 10;
    
    /**
     * The resize event type (value is 11).
     */
    public static const int Resize = 11;
    
    /**
     * The dispose event type (value is 12).
     */
    public static const int Dispose = 12;
    
    /**
     * The selection event type (value is 13).
     */
    public static const int Selection = 13;
    
    /**
     * The default selection event type (value is 14).
     */
    public static const int DefaultSelection = 14;
    
    /**
     * The focus in event type (value is 15).
     */
    public static const int FocusIn = 15;
    
    /**
     * The focus out event type (value is 16).
     */
    public static const int FocusOut = 16;
    
    /**
     * The expand event type (value is 17).
     */
    public static const int Expand = 17;
    
    /**
     * The collapse event type (value is 18).
     */
    public static const int Collapse = 18;
    
    /**
     * The iconify event type (value is 19).
     */
    public static const int Iconify = 19;
    
    /**
     * The de-iconify event type (value is 20).
     */
    public static const int Deiconify = 20;
    
    /**
     * The close event type (value is 21).
     */
    public static const int Close = 21;
    
    /**
     * The show event type (value is 22).
     */
    public static const int Show = 22;
    
    /**
     * The hide event type (value is 23).
     */
    public static const int Hide = 23;
    
    /**
     * The modify event type (value is 24).
     */
    public static const int Modify = 24;
    
    /**
     * The verify event type (value is 25).
     */
    public static const int Verify = 25;
    
    /**
     * The activate event type (value is 26).
     */
    public static const int Activate = 26;
    
    /**
     * The deactivate event type (value is 27).
     */
    public static const int Deactivate = 27;    
    
    /**
     * The help event type (value is 28).
     */
    public static const int Help = 28;
    
    /**
     * The drag detect event type (value is 29).
     */
    public static const int DragDetect = 29;
    
    /**
     * The arm event type (value is 30).
     */
    public static const int Arm = 30;
    
    /**
     * The traverse event type (value is 31).
     */
    public static const int Traverse = 31;
    
    /**
     * The mouse hover event type (value is 32).
     */
    public static const int MouseHover = 32;

    /**
     * The hardware key down event type (value is 33).
     */
    public static const int HardKeyDown = 33;
    
    /**
     * The hardware key up event type (value is 34).
     */
    public static const int HardKeyUp = 34;

    /**
     * The menu detect event type (value is 35).
     * 
     * @since 3.0
     */
    public static const int MenuDetect = 35;
    
    /**
     * The set data event type (value is 36).
     * 
     * @since 3.0
     */
    public static const int SetData = 36;
        
    /* Event Details */
    
    /**
     * A constant known to be zero (0), used in operations which
     * take bit flags to indicate that "no bits are set".
     */
    public static const int NONE = 0;
    
    /**
     * Indicates that a user-interface component is being dragged,
     * for example dragging the thumb of a scroll bar (value is 1).
     */
    public static const int DRAG = 1;
    
    /**
     * A constant known to be zero (0), used in operations which
     * take pointers to indicate a null argument.
     */
    public static const int NULL = 0;
    
    /**
     * Indicates that a default should be used (value is -1).
     */
    public static const int DEFAULT = -1;

    /**
     * Style constant for menu bar behavior (value is 1&lt;&lt;1).
     * <p><b>Used By:</b><ul>
     * <li><code>Menu</code></li>
     * </ul></p>
     */
    public static const int BAR = 1 << 1;

    /**
     * Style constant for drop down menu/list behavior (value is 1&lt;&lt;2).
     * <p><b>Used By:</b><ul>
     * <li><code>Menu</code></li>
     * <li><code>ToolItem</code></li>
     * <li><code>CoolItem</code></li>
     * <li><code>Combo</code></li>
     * </ul></p>
     */
    public static const int DROP_DOWN = 1 << 2;

    /**
     * Style constant for pop up menu behavior (value is 1&lt;&lt;3).
     * <p><b>Used By:</b><ul>
     * <li><code>Menu</code></li>
     * </ul></p>
     */
    public static const int POP_UP = 1 << 3;

    /**
     * Style constant for line separator behavior (value is 1&lt;&lt;1).
     * <p><b>Used By:</b><ul>
     * <li><code>Label</code></li>
     * <li><code>MenuItem</code></li>
     * <li><code>ToolItem</code></li>
     * </ul></p>
     */
    public static const int SEPARATOR = 1 << 1;

    /**
     * Style constant for toggle button behavior (value is 1&lt;&lt;1).
     * <p><b>Used By:</b><ul>
     * <li><code>Button</code></li>
     * </ul></p>
     */
    public static const int TOGGLE = 1 << 1;

    /**
     * Style constant for arrow button behavior (value is 1&lt;&lt;2).
     * <p><b>Used By:</b><ul>
     * <li><code>Button</code></li>
     * </ul></p>
     */
    public static const int ARROW = 1 << 2;

    /**
     * Style constant for push button behavior (value is 1&lt;&lt;3).
     * <p><b>Used By:</b><ul>
     * <li><code>Button</code></li>
     * <li><code>MenuItem</code></li>
     * <li><code>ToolItem</code></li>
     * </ul></p>
     */
    public static const int PUSH = 1 << 3;

    /**
     * Style constant for radio button behavior (value is 1&lt;&lt;4).
     * <p><b>Used By:</b><ul>
     * <li><code>Button</code></li>
     * <li><code>MenuItem</code></li>
     * <li><code>ToolItem</code></li>
     * </ul></p>
     */
    public static const int RADIO = 1 << 4;

    /**
     * Style constant for check box behavior (value is 1&lt;&lt;5).
     * <p><b>Used By:</b><ul>
     * <li><code>Button</code></li>
     * <li><code>MenuItem</code></li>
     * <li><code>ToolItem</code></li>
     * <li><code>Table</code></li>
     * <li><code>Tree</code></li>
     * </ul></p>
     */
    public static const int CHECK = 1 << 5;

    /**
     * Style constant for cascade behavior (value is 1&lt;&lt;6).
     * <p><b>Used By:</b><ul>
     * <li><code>MenuItem</code></li>
     * </ul></p>
     */
    public static const int CASCADE = 1 << 6;

    /**
     * Style constant for multi-selection behavior in lists
     * and multiple line support on text fields (value is 1&lt;&lt;1).
     * <p><b>Used By:</b><ul>
     * <li><code>Text</code></li>
     * <li><code>List</code></li>
     * <li><code>FileDialog</code></li>
     * </ul></p>
     */
    public static const int MULTI = 1 << 1;

    /**
     * Style constant for single selection behavior in lists
     * and single line support on text fields (value is 1&lt;&lt;2).
     * <p><b>Used By:</b><ul>
     * <li><code>Text</code></li>
     * <li><code>List</code></li>
     * <li><code>Table</code></li>
     * <li><code>Tree</code></li>
     * </ul></p>
     */
    public static const int SINGLE = 1 << 2;

    /**
     * Style constant for read-only behavior (value is 1&lt;&lt;3).
     * <p><b>Used By:</b><ul>
     * <li><code>Combo</code></li>
     * <li><code>Text</code></li>
     * </ul></p>
     */
    public static const int READ_ONLY = 1 << 3;

    /**
     * Style constant for automatic line wrap behavior (value is 1&lt;&lt;6).
     * <p><b>Used By:</b><ul>
     * <li><code>Label</code></li>
     * <li><code>Text</code></li>
     * <li><code>ToolBar</code></li>
     * </ul></p>
     */
    public static const int WRAP = 1 << 6;

    /**
     * Style constant for simple (not drop down) behavior (value is 1&lt;&lt;6).
     * <p><b>Used By:</b><ul>
     * <li><code>Combo</code></li>
     * </ul></p>
     */
    public static const int SIMPLE = 1 << 6;

    /**
     * Style constant for password behavior (value is 1&lt;&lt;22).
     * <p><b>Used By:</b><ul>
     * <li><code>Text</code></li>
     * </ul></p>
     * 
     * @since 3.0
     */
    public static const int PASSWORD = 1 << 22;
    
    /**
     * Style constant for shadow in behavior (value is 1&lt;&lt;2).
     * <br>Note that this is a <em>HINT</em>.
     * <p><b>Used By:</b><ul>
     * <li><code>Label</code></li>
     * <li><code>Group</code></li>
     * </ul></p>
     */
    public static const int SHADOW_IN = 1 << 2;

    /**
     * Style constant for shadow out behavior (value is 1&lt;&lt;3).
     * <br>Note that this is a <em>HINT</em>.
     * <p><b>Used By:</b><ul>
     * <li><code>Label</code></li>
     * <li><code>Group</code></li>
     * <li><code>ToolBar</code></li>
     * </ul></p>
     */
    public static const int SHADOW_OUT = 1 << 3;

    /**
     * Style constant for shadow etched in behavior (value is 1&lt;&lt;4).
     * <br>Note that this is a <em>HINT</em>. It is ignored on all platforms except Motif.
     * <p><b>Used By:</b><ul>
     * <li><code>Group</code></li>
     * </ul></p>
     */
    public static const int SHADOW_ETCHED_IN = 1 << 4;

    /**
     * Style constant for shadow etched out behavior (value is 1&lt;&lt;6).
     * <br>Note that this is a <em>HINT</em>. It is ignored on all platforms except Motif.
     * <p><b>Used By:</b><ul>
     * <li><code>Group</code></li>
     * </ul></p>
     */
    public static const int SHADOW_ETCHED_OUT = 1 << 6;

    /**
     * Style constant for no shadow behavior (value is 1&lt;&lt;5).
     * <br>Note that this is a <em>HINT</em>.
     * <p><b>Used By:</b><ul>
     * <li><code>Label</code></li>
     * <li><code>Group</code></li>
     * </ul></p>
     */
    public static const int SHADOW_NONE = 1 << 5;

    /**
     * Style constant for progress bar behavior (value is 1&lt;&lt;1).
     * <p><b>Used By:</b><ul>
     * <li><code>ProgressBar</code></li>
     * </ul></p>
     */
    public static const int INDETERMINATE = 1 << 1;
    
    /**
     * Style constant for tool window behavior (value is 1&lt;&lt;2).
     * <p>
     * A tool window is a window intended to be used as a floating toolbar.
     * It typically has a title bar that is shorter than a normal title bar,
     * and the window title is typically drawn using a smaller font.
     * <br>Note that this is a <em>HINT</em>.
     * </p><p><b>Used By:</b><ul>
     * <li><code>Decorations</code> and subclasses</li>
     * </ul></p>
     */
    public static const int TOOL = 1 << 2; 

    /**
     * Style constant to ensure no trimmings are used (value is 1&lt;&lt;3).
     * <br>Note that this overrides all other trim styles.
     * <p><b>Used By:</b><ul>
     * <li><code>Decorations</code> and subclasses</li>
     * </ul></p>
     */
    public static const int NO_TRIM = 1 << 3;
    
    /**
     * Style constant for resize box trim (value is 1&lt;&lt;4).
     * <p><b>Used By:</b><ul>
     * <li><code>Decorations</code> and subclasses</li>
     * <li><code>Tracker</code></li>
     * </ul></p>
     */
    public static const int RESIZE = 1 << 4;

    /**
     * Style constant for title area trim (value is 1&lt;&lt;5).
     * <p><b>Used By:</b><ul>
     * <li><code>Decorations</code> and subclasses</li>
     * </ul></p>
     */
    public static const int TITLE = 1 << 5;

    /**
     * Style constant for close box trim (value is 1&lt;&lt;6,
     * since we do not distinguish between CLOSE style and MENU style).
     * <p><b>Used By:</b><ul>
     * <li><code>Decorations</code> and subclasses</li>
     * </ul></p>
     */
    public static const int CLOSE = 1 << 6;

    /**
     * Style constant for shell menu trim (value is 1&lt;&lt;6,
     * since we do not distinguish between CLOSE style and MENU style).
     * <p><b>Used By:</b><ul>
     * <li><code>Decorations</code> and subclasses</li>
     * </ul></p>
     */
    public static const int MENU = CLOSE;

    /**
     * Style constant for minimize box trim (value is 1&lt;&lt;7).
     * <p><b>Used By:</b><ul>
     * <li><code>Decorations</code> and subclasses</li>
     * </ul></p>
     */
    public static const int MIN = 1 << 7;

    /**
     * Style constant for maximize box trim (value is 1&lt;&lt;10).
     * <p><b>Used By:</b><ul>
     * <li><code>Decorations</code> and subclasses</li>
     * </ul></p>
     */
    public static const int MAX = 1 << 10;

    /**
     * Style constant for horizontal scrollbar behavior (value is 1&lt;&lt;8).
     * <p><b>Used By:</b><ul>
     * <li><code>Scrollable</code> and subclasses</li>
     * </ul></p>
     */
    public static const int H_SCROLL = 1 << 8;

    /**
     * Style constant for vertical scrollbar behavior (value is 1&lt;&lt;9).
     * <p><b>Used By:</b><ul>
     * <li><code>Scrollable</code> and subclasses</li>
     * </ul></p>
     */
    public static const int V_SCROLL = 1 << 9;

    /**
     * Style constant for bordered behavior (value is 1&lt;&lt;11).
     * <br>Note that this is a <em>HINT</em>.
     * <p><b>Used By:</b><ul>
     * <li><code>Control</code> and subclasses</li>
     * </ul></p>
     */
    public static const int BORDER = 1 << 11;

    /**
     * Style constant indicating that the window manager should clip
     * a widget's children with respect to its viewable area. (value is 1&lt;&lt;12).
     * <br>Note that this is a <em>HINT</em>.
     * <p><b>Used By:</b><ul>
     * <li><code>Control</code> and subclasses</li>
     * </ul></p>
     */
    public static const int CLIP_CHILDREN = 1 << 12; 

    /**
     * Style constant indicating that the window manager should clip
     * a widget's siblings with respect to its viewable area. (value is 1&lt;&lt;13).
     * <br>Note that this is a <em>HINT</em>.
     * <p><b>Used By:</b><ul>
     * <li><code>Control</code> and subclasses</li>
     * </ul></p>
     */
    public static const int CLIP_SIBLINGS = 1 << 13;

    /**
     * Style constant for always on top behavior (value is 1&lt;&lt;14).
     * <br>Note that this is a <em>HINT</em>.
     * <p><b>Used By:</b><ul>
     * <li><code>Shell</code> and subclasses</li>
     * </ul></p>
     */
    public static const int ON_TOP = 1 << 14;

    /**
     * Trim style convenience constant for the most common top level shell appearance
     * (value is CLOSE|TITLE|MIN|MAX|RESIZE).
     * <p><b>Used By:</b><ul>
     * <li><code>Shell</code></li>
     * </ul></p>
     */
    public static const int SHELL_TRIM = CLOSE | TITLE | MIN | MAX | RESIZE;

    /**
     * Trim style convenience constant for the most common dialog shell appearance
     * (value is CLOSE|TITLE|BORDER).
     * <p><b>Used By:</b><ul>
     * <li><code>Shell</code></li>
     * </ul></p>
     */
    public static const int DIALOG_TRIM = TITLE | CLOSE | BORDER;

    /**
     * Style constant for modeless behavior (value is 0).
     * <br>Note that this is a <em>HINT</em>.
     * <p><b>Used By:</b><ul>
     * <li><code>Dialog</code></li>
     * <li><code>Shell</code></li>
     * </ul></p>
     */
    public static const int MODELESS = 0;

    /**
     * Style constant for primary modal behavior (value is 1&lt;&lt;15).
     * <br>Note that this is a <em>HINT</em>.
     * <p><b>Used By:</b><ul>
     * <li><code>Dialog</code></li>
     * <li><code>Shell</code></li>
     * </ul></p>
     */
    public static const int PRIMARY_MODAL = 1 << 15;

    /**
     * Style constant for application modal behavior (value is 1&lt;&lt;16).
     * <br>Note that this is a <em>HINT</em>.
     * <p><b>Used By:</b><ul>
     * <li><code>Dialog</code></li>
     * <li><code>Shell</code></li>
     * </ul></p>
     */
    public static const int APPLICATION_MODAL = 1 << 16;

    /**
     * Style constant for system modal behavior (value is 1&lt;&lt;17).
     * <br>Note that this is a <em>HINT</em>.
     * <p><b>Used By:</b><ul>
     * <li><code>Dialog</code></li>
     * <li><code>Shell</code></li>
     * </ul></p>
     */
    public static const int SYSTEM_MODAL = 1 << 17;

    /**
     * Style constant for selection hiding behavior when the widget loses focus (value is 1&lt;&lt;15).
     * <br>Note that this is a <em>HINT</em>.
     * <p><b>Used By:</b><ul>
     * <li><code>Table</code></li>
     * </ul></p>
     */
    public static const int HIDE_SELECTION = 1 << 15;

    /**
     * Style constant for full row selection behavior. (value is 1&lt;&lt;16).
     * <br>Note that this is a <em>HINT</em>.
     * <p><b>Used By:</b><ul>
     * <li><code>StyledText</code></li>
     * <li><code>Table</code></li>
     * <li><code>TableTree</code></li>
     * </ul></p>
     */
    public static const int FULL_SELECTION = 1 << 16;

    /**
     * Style constant for flat appearance. (value is 1&lt;&lt;23).
     * <br>Note that this is a <em>HINT</em>.
     * <p><b>Used By:</b><ul>
     * <li><code>Button</code></li>
     * <li><code>ToolBar</code></li>
     * </ul></p>
     */
    public static const int FLAT = 1 << 23;

    /**
     * Style constant for flat appearance. (value is 1&lt;&lt;16).
     * <br>Note that this is a <em>HINT</em>.
     * <p><b>Used By:</b><ul>
     * <li><code>ProgressBar</code></li>
     * </ul></p>
     */
    public static const int SMOOTH = 1 << 16;

    /**
     * Style constant for no background behavior (value is 1&lt;&lt;18).
     * <p>
     * By default, before a widget paints, the client area is filled with the current background color.
     * When this style is specified, the background is not filled, and the application is responsible
     * for filling every pixel of the client area.
     * This style might be used as an alternative to "double-buffering" in order to reduce flicker.
     * This style does not mean "transparent" - widgets that are obscured will not draw through.
     * </p><p><b>Used By:</b><ul>
     * <li><code>Composite</code></li>
     * </ul></p>
     */
    public static const int NO_BACKGROUND = 1 << 18;

    /**
     * Style constant for does not take focus behavior (value is 1&lt;&lt;19).
     * <br>Note that this is a <em>HINT</em>.
     * <p><b>Used By:</b><ul>
     * <li><code>Composite</code></li>
     * </ul></p>
     */
    public static const int NO_FOCUS = 1 << 19;

    /**
     * Style constant for no redraw on resize behavior (value is 1&lt;&lt;20).
     * <p>
     * This style stops the entire client area from being invalidated when the size
     * of the Canvas changes. Specifically, when the size of the Canvas gets smaller,
     * the SWT.Paint event is not sent. When it gets bigger, an SWT.Paint event is
     * sent with a GC clipped to only the new areas to be painted. Without this
     * style, the entire client area will be repainted.
     * </p><p><b>Used By:</b><ul>
     * <li><code>Composite</code></li>
     * </ul></p>
     */
    public static const int NO_REDRAW_RESIZE = 1 << 20;

    /**
     * Style constant for no paint event merging behavior (value is 1&lt;&lt;21).
     * <p><b>Used By:</b><ul>
     * <li><code>Composite</code></li>
     * </ul></p>
     */
    public static const int NO_MERGE_PAINTS = 1 << 21;

    /**
     * Style constant for preventing child radio group behavior (value is 1&lt;&lt;22).
     * <p><b>Used By:</b><ul>
     * <li><code>Composite</code></li>
     * </ul></p>
     */
    public static const int NO_RADIO_GROUP = 1 << 22;
    
    /**
     * Style constant for left to right orientation (value is 1&lt;&lt;25).
     * <p>
     * When orientation is not explicitly specified, orientation is
     * inherited.  This means that children will be assigned the
     * orientation of their parent.  To override this behavior and
     * force an orientation for a child, explicitly set the orientation
     * of the child when that child is created.
     * </p>
     * <p><b>Used By:</b><ul>
     * <li><code>Control</code></li>
     * <li><code>Menu</code></li>
     * <li><code>GC</code></li> 
     * </ul></p>
     * 
     * @since 2.1.2
     */
    public static const int LEFT_TO_RIGHT = 1 << 25;
    
    /**
     * Style constant for right to left orientation (value is 1&lt;&lt;26).
     * <p>
     * When orientation is not explicitly specified, orientation is
     * inherited.  This means that children will be assigned the
     * orientation of their parent.  To override this behavior and
     * force an orientation for a child, explicitly set the orientation
     * of the child when that child is created.
     * </p>
     * <p><b>Used By:</b><ul>
     * <li><code>Control</code></li>
     * <li><code>Menu</code></li>
     * <li><code>GC</code></li> 
     * </ul></p>
     * 
     * @since 2.1.2
     */
    public static const int RIGHT_TO_LEFT = 1 << 26;
    
    /**
     * Style constant to indicate coordinate mirroring (value is 1&lt;&lt;27).
     * <p><b>Used By:</b><ul>
     * <li><code>Control</code></li>
     * <li><code>Menu</code></li>
     * &