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

import dwt.DWT;
import dwt.DWTException;
import dwt.internal.win32.OS;

import dwt.widgets.Dialog;
import dwt.widgets.Shell;
import dwt.widgets.Display;
import dwt.dwthelper.utils;

/**
 * Instances of this class are used to inform or warn the user.
 * <dl>
 * <dt><b>Styles:</b></dt>
 * <dd>ICON_ERROR, ICON_INFORMATION, ICON_QUESTION, ICON_WARNING, ICON_WORKING</dd>
 * <dd>OK, OK | CANCEL</dd>
 * <dd>YES | NO, YES | NO | CANCEL</dd>
 * <dd>RETRY | CANCEL</dd>
 * <dd>ABORT | RETRY | IGNORE</dd>
 * <dt><b>Events:</b></dt>
 * <dd>(none)</dd>
 * </dl>
 * <p>
 * Note: Only one of the styles ICON_ERROR, ICON_INFORMATION, ICON_QUESTION,
 * ICON_WARNING and ICON_WORKING may be specified.
 * </p><p>
 * IMPORTANT: This class is intended to be subclassed <em>only</em>
 * within the DWT implementation.
 * </p>
 *
 * @see <a href="http://www.eclipse.org/swt/examples.php">DWT Example: ControlExample, Dialog tab</a>
 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
 */
public  class MessageBox : Dialog {

    alias Dialog.checkStyle checkStyle;

    String message = "";
    private bool allowNullParent = false;

/**
 * Constructs a new instance of this class given only its parent.
 *
 * @param parent a shell which will be the parent of the new instance
 *
 * @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>
 */
public this (Shell parent) {
    this (parent, DWT.OK | DWT.ICON_INFORMATION | DWT.APPLICATION_MODAL);
}

/**
 * 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.
 *
 * @param parent a shell which will be the parent of the new instance
 * @param style the style of dialog 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>
 */
public this (Shell parent, int style) {
    super (parent, checkStyle (parent, checkStyle (style)));
    checkSubclass ();
}

/++
 + DWT extension, a MessageBox with no parent
 +/
public this (int style) {
    allowNullParent = true;
    this( null, style );
}
// PORT
// actually, the parent can be null
override void checkParent (Shell parent){
    if( !allowNullParent ){
        super.checkParent( parent );
    }
}

static int checkStyle (int style) {
    int mask = (DWT.YES | DWT.NO | DWT.OK | DWT.CANCEL | DWT.ABORT | DWT.RETRY | DWT.IGNORE);
    int bits = style & mask;
    if (bits is DWT.OK || bits is DWT.CANCEL || bits is (DWT.OK | DWT.CANCEL)) return style;
    if (bits is DWT.YES || bits is DWT.NO || bits is (DWT.YES | DWT.NO) || bits is (DWT.YES | DWT.NO | DWT.CANCEL)) return style;
    if (bits is (DWT.RETRY | DWT.CANCEL) || bits is (DWT.ABORT | DWT.RETRY | DWT.IGNORE)) return style;
    style = (style & ~mask) | DWT.OK;
    return style;
}

/**
 * Returns the dialog's message, or an empty string if it does not have one.
 * The message is a description of the purpose for which the dialog was opened.
 * This message will be visible in the dialog while it is open.
 *
 * @return the message
 */
public String getMessage () {
    return message;
}

/**
 * Makes the dialog visible and brings it to the front
 * of the display.
 *
 * @return the ID of the button that was selected to dismiss the
 *         message box (e.g. DWT.OK, DWT.CANCEL, etc.)
 *
 * @exception DWTException <ul>
 *    <li>ERROR_WIDGET_DISPOSED - if the dialog has been disposed</li>
 *    <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the dialog</li>
 * </ul>
 */
public int open () {

    /* Compute the MessageBox style */
    int buttonBits = 0;
    if ((style & DWT.OK) is DWT.OK) buttonBits = OS.MB_OK;
    if ((style & (DWT.OK | DWT.CANCEL)) is (DWT.OK | DWT.CANCEL)) buttonBits = OS.MB_OKCANCEL;
    if ((style & (DWT.YES | DWT.NO)) is (DWT.YES | DWT.NO)) buttonBits = OS.MB_YESNO;
    if ((style & (DWT.YES | DWT.NO | DWT.CANCEL)) is (DWT.YES | DWT.NO | DWT.CANCEL)) buttonBits = OS.MB_YESNOCANCEL;
    if ((style & (DWT.RETRY | DWT.CANCEL)) is (DWT.RETRY | DWT.CANCEL)) buttonBits = OS.MB_RETRYCANCEL;
    if ((style & (DWT.ABORT | DWT.RETRY | DWT.IGNORE)) is (DWT.ABORT | DWT.RETRY | DWT.IGNORE)) buttonBits = OS.MB_ABORTRETRYIGNORE;
    if (buttonBits is 0) buttonBits = OS.MB_OK;

    int iconBits = 0;
    if ((style & DWT.ICON_ERROR) !is 0) iconBits = OS.MB_ICONERROR;
    if ((style & DWT.ICON_INFORMATION) !is 0) iconBits = OS.MB_ICONINFORMATION;
    if ((style & DWT.ICON_QUESTION) !is 0) iconBits = OS.MB_ICONQUESTION;
    if ((style & DWT.ICON_WARNING) !is 0) iconBits = OS.MB_ICONWARNING;
    if ((style & DWT.ICON_WORKING) !is 0) iconBits = OS.MB_ICONINFORMATION;

    /* Only MB_APPLMODAL is supported on WinCE */
    int modalBits = 0;
    static if (OS.IsWinCE) {
        if ((style & (DWT.PRIMARY_MODAL | DWT.APPLICATION_MODAL | DWT.SYSTEM_MODAL)) !is 0) {
            modalBits = OS.MB_APPLMODAL;
        }
    } else {
        if ((style & DWT.PRIMARY_MODAL) !is 0) modalBits = OS.MB_APPLMODAL;
        if ((style & DWT.APPLICATION_MODAL) !is 0) modalBits = OS.MB_TASKMODAL;
        if ((style & DWT.SYSTEM_MODAL) !is 0) modalBits = OS.MB_SYSTEMMODAL;
    }

    int bits = buttonBits | iconBits | modalBits;
    if ((style & DWT.RIGHT_TO_LEFT) !is 0) bits |= OS.MB_RTLREADING | OS.MB_RIGHT;
    if ((style & (DWT.LEFT_TO_RIGHT | DWT.RIGHT_TO_LEFT)) is 0) {
        if (parent !is null && (parent.style & DWT.MIRRORED) !is 0) {
            bits |= OS.MB_RTLREADING | OS.MB_RIGHT;
        }
    }

    /*
    * Feature in Windows.  System modal is not supported
    * on Windows 95 and NT.  The fix is to convert system
    * modal to task modal.
    */
    if ((bits & OS.MB_SYSTEMMODAL) !is 0) {
        bits |= OS.MB_TASKMODAL;
        bits &= ~OS.MB_SYSTEMMODAL;
        /* Force a system modal message box to the front */
        bits |= OS.MB_TOPMOST;
    }

    /*
    * Feature in Windows.  In order for MB_TASKMODAL to work,
    * the parent HWND of the MessageBox () call must be NULL.
    * If the parent is not NULL, MB_TASKMODAL behaves the
    * same as MB_APPLMODAL.  The fix to set the parent HWND
    * anyway and not rely on MB_MODAL to work by making the
    * parent be temporarily modal.
    */
    HWND hwndOwner = parent !is null ? parent.handle : null;
    Dialog oldModal = null;
    Display display = null;
    if ((bits & OS.MB_TASKMODAL) !is 0) {
        display = ( allowNullParent && parent is null ) ? Display.getCurrent() : parent.getDisplay ();
        oldModal = display.getModalDialog ();
        display.setModalDialog (this);
    }

    /* Open the message box */
    /* Use the character encoding for the default locale */
    TCHAR[] buffer1 = StrToTCHARs (0, message, true);
    TCHAR[] buffer2 = StrToTCHARs (0, title, true);
    int code = OS.MessageBox (hwndOwner, buffer1.ptr, buffer2.ptr, bits);

    /* Clear the temporarily dialog modal parent */
    if ((bits & OS.MB_TASKMODAL) !is 0) {
        display.setModalDialog (oldModal);
    }

    /*
    * This code is intentionally commented.  On some
    * platforms, the owner window is repainted right
    * away when a dialog window exits.  This behavior
    * is currently unspecified.
    */
//  if (hwndOwner !is 0) OS.UpdateWindow (hwndOwner);

    /* Compute and return the result */
    if (code !is 0) {
        int type = bits & 0x0F;
        if (type is OS.MB_OK) return DWT.OK;
        if (type is OS.MB_OKCANCEL) {
            return (code is OS.IDOK) ? DWT.OK : DWT.CANCEL;
        }
        if (type is OS.MB_YESNO) {
            return (code is OS.IDYES) ? DWT.YES : DWT.NO;
        }
        if (type is OS.MB_YESNOCANCEL) {
            if (code is OS.IDYES) return DWT.YES;
            if (code is OS.IDNO) return DWT.NO;
            return DWT.CANCEL;
        }
        if (type is OS.MB_RETRYCANCEL) {
            return (code is OS.IDRETRY) ? DWT.RETRY : DWT.CANCEL;
        }
        if (type is OS.MB_ABORTRETRYIGNORE) {
            if (code is OS.IDRETRY) return DWT.RETRY;
            if (code is OS.IDABORT) return DWT.ABORT;
            return DWT.IGNORE;
        }
    }
    return DWT.CANCEL;
}

/**
 * Sets the dialog's message, which is a description of
 * the purpose for which it was opened. This message will be
 * visible on the dialog while it is open.
 *
 * @param string the message
 *
 * @exception IllegalArgumentException <ul>
 *    <li>ERROR_NULL_ARGUMENT - if the string is null</li>
 * </ul>
 */
public void setMessage (String string) {
    if (string is null) error (DWT.ERROR_NULL_ARGUMENT);
    message = string;
}

/++
 + DWT extension
 +/
public static int showMessageBox(String str, String title, Shell shell, int style) {
    MessageBox msgBox = (shell is null ) ? new MessageBox( style ) : new MessageBox(shell, style);
    msgBox.setMessage(str);
    if(title !is null){
        msgBox.setText(title);
    }
    return msgBox.open();
}

/// DWT extension
public static int showInfo(String str, String title = null, Shell shell = null) {
    return showMessageBox( str, title, shell, DWT.OK | DWT.ICON_INFORMATION );
}
/// DWT extension
alias showInfo showInformation;

/// DWT extension
public static int showWarning(String str, String title = null, Shell shell = null) {
    return showMessageBox( str, title, shell, DWT.OK | DWT.ICON_WARNING );
}
/// DWT extension
public static int showError(String str, String title = null, Shell shell = null) {
    return showMessageBox( str, title, shell, DWT.OK | DWT.ICON_ERROR );
}

}