/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtGui module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#include "qdialog.h"

#include "qevent.h"

#include "qdesktopwidget.h"

#include "qpushbutton.h"

#include "qapplication.h"

#include "qlayout.h"

#include "qsizegrip.h"

#include "qwhatsthis.h"

#include "qmenu.h"

#include "qcursor.h"

#include "private/qdialog_p.h"

#ifndef QT_NO_ACCESSIBILITY

#include "qaccessible.h"

#endif

#if defined(Q_WS_WINCE)

#include "qt_windows.h"

#include "qmenubar.h"

#include "qpointer.h"

#include "qguifunctions_wince.h"

extern bool qt_wince_is_mobile();     //defined in qguifunctions_wce.cpp

extern bool qt_wince_is_smartphone(); //is defined in qguifunctions_wce.cpp

#elif defined(Q_WS_X11)

#  include "../kernel/qt_x11_p.h"

#elif defined(Q_OS_SYMBIAN)

#   include "qfiledialog.h"

#   include "qfontdialog.h"

#   include "qcolordialog.h"

#   include "qwizard.h"

#endif

#if defined(Q_WS_S60)

#include "private/qt_s60_p.h"

#endif

#ifndef SPI_GETSNAPTODEFBUTTON

#   define SPI_GETSNAPTODEFBUTTON  95

#endif

QT_BEGIN_NAMESPACE

/*!

    \class QDialog

    \brief The QDialog class is the base class of dialog windows.

    \ingroup dialog-classes

    \ingroup abstractwidgets

    A dialog window is a top-level window mostly used for short-term

    tasks and brief communications with the user. QDialogs may be

    modal or modeless. QDialogs can

    provide a \link #return return

    value\endlink, and they can have \link #default default

    buttons\endlink. QDialogs can also have a QSizeGrip in their

    lower-right corner, using setSizeGripEnabled().

    Note that QDialog (an any other widget that has type Qt::Dialog) uses

    the parent widget slightly differently from other classes in Qt. A

    dialog is always a top-level widget, but if it has a parent, its

    default location is centered on top of the parent's top-level widget

    (if it is not top-level itself). It will also share the parent's

    taskbar entry.

    Use the overload of the QWidget::setParent() function to change

    the ownership of a QDialog widget. This function allows you to

    explicitly set the window flags of the reparented widget; using

    the overloaded function will clear the window flags specifying the

    window-system properties for the widget (in particular it will

    reset the Qt::Dialog flag).

    \section1 Modal Dialogs

    A \bold{modal} dialog is a dialog that blocks input to other

    visible windows in the same application. Dialogs that are used to

    request a file name from the user or that are used to set

    application preferences are usually modal. Dialogs can be

    \l{Qt::ApplicationModal}{application modal} (the default) or

    \l{Qt::WindowModal}{window modal}.

    When an application modal dialog is opened, the user must finish

    interacting with the dialog and close it before they can access

    any other window in the application. Window modal dialogs only

    block access to the window associated with the dialog, allowing

    the user to continue to use other windows in an application.

    The most common way to display a modal dialog is to call its

    exec() function. When the user closes the dialog, exec() will

    provide a useful \link #return return value\endlink. Typically,

    to get the dialog to close and return the appropriate value, we

    connect a default button, e.g. \gui OK, to the accept() slot and a

    \gui Cancel button to the reject() slot.

    Alternatively you can call the done() slot with \c Accepted or

    \c Rejected.

    An alternative is to call setModal(true) or setWindowModality(),

    then show(). Unlike exec(), show() returns control to the caller

    immediately. Calling setModal(true) is especially useful for

    progress dialogs, where the user must have the ability to interact

    with the dialog, e.g.  to cancel a long running operation. If you

    use show() and setModal(true) together to perform a long operation,

    you must call QApplication::processEvents() periodically during

    processing to enable the user to interact with the dialog. (See

    QProgressDialog.)

    \section1 Modeless Dialogs

    A \bold{modeless} dialog is a dialog that operates

    independently of other windows in the same application. Find and

    replace dialogs in word-processors are often modeless to allow the

    user to interact with both the application's main window and with

    the dialog.

    Modeless dialogs are displayed using show(), which returns control

    to the caller immediately.

    If you invoke the \l{QWidget::show()}{show()} function after hiding

    a dialog, the dialog will be displayed in its original position. This is

    because the window manager decides the position for windows that

    have not been explicitly placed by the programmer. To preserve the

    position of a dialog that has been moved by the user, save its position

    in your \l{QWidget::closeEvent()}{closeEvent()}  handler and then

    move the dialog to that position, before showing it again.

    \target default

    \section1 Default Button

    A dialog's \e default button is the button that's pressed when the

    user presses Enter (Return). This button is used to signify that

    the user accepts the dialog's settings and wants to close the

    dialog. Use QPushButton::setDefault(), QPushButton::isDefault()

    and QPushButton::autoDefault() to set and control the dialog's

    default button.

    \target escapekey

    \section1 Escape Key

    If the user presses the Esc key in a dialog, QDialog::reject()

    will be called. This will cause the window to close: The \link

    QCloseEvent close event \endlink cannot be \link

    QCloseEvent::ignore() ignored \endlink.

    \section1 Extensibility

    Extensibility is the ability to show the dialog in two ways: a

    partial dialog that shows the most commonly used options, and a

    full dialog that shows all the options. Typically an extensible

    dialog will initially appear as a partial dialog, but with a

    \gui More toggle button. If the user presses the \gui More button down,

    the dialog is expanded. The \l{Extension Example} shows how to achieve

    extensible dialogs using Qt.

    \target return

    \section1 Return Value (Modal Dialogs)

    Modal dialogs are often used in situations where a return value is

    required, e.g. to indicate whether the user pressed \gui OK or

    \gui Cancel. A dialog can be closed by calling the accept() or the

    reject() slots, and exec() will return \c Accepted or \c Rejected

    as appropriate. The exec() call returns the result of the dialog.

    The result is also available from result() if the dialog has not

    been destroyed.

    In order to modify your dialog's close behavior, you can reimplement

    the functions accept(), reject() or done(). The

    \l{QWidget::closeEvent()}{closeEvent()} function should only be

    reimplemented to preserve the dialog's position or to override the

    standard close or reject behavior.

    \target examples

    \section1 Code Examples

    A modal dialog:

    \snippet doc/src/snippets/dialogs/dialogs.cpp 1

    A modeless dialog:

    \snippet doc/src/snippets/dialogs/dialogs.cpp 0

    \sa QDialogButtonBox, QTabWidget, QWidget, QProgressDialog,

        {fowler}{GUI Design Handbook: Dialogs, Standard}, {Extension Example},

        {Standard Dialogs Example}

*/

/*! \enum QDialog::DialogCode

    The value returned by a modal dialog.

    \value Accepted

    \value Rejected

*/

/*!

  \property QDialog::sizeGripEnabled

  \brief whether the size grip is enabled

  A QSizeGrip is placed in the bottom-right corner of the dialog when this

  property is enabled. By default, the size grip is disabled.

*/

/*!

  Constructs a dialog with parent \a parent.

  A dialog is always a top-level widget, but if it has a parent, its

  default location is centered on top of the parent. It will also

  share the parent's taskbar entry.

  The widget flags \a f are passed on to the QWidget constructor.

  If, for example, you don't want a What's This button in the title bar

  of the dialog, pass Qt::WindowTitleHint | Qt::WindowSystemMenuHint in \a f.

  \sa QWidget::setWindowFlags()

*/

QDialog::QDialog(QWidget *parent, Qt::WindowFlags f)

    : QWidget(*new QDialogPrivate, parent,

              f | QFlag((f & Qt::WindowType_Mask) == 0 ? Qt::Dialog : 0))

{

#ifdef Q_WS_WINCE

    if (!qt_wince_is_smartphone())

        setWindowFlags(windowFlags() | Qt::WindowOkButtonHint | QFlag(qt_wince_is_mobile() ? 0 : Qt::WindowCancelButtonHint));

#endif

#ifdef Q_WS_S60

    if (S60->avkonComponentsSupportTransparency) {

        bool noSystemBackground = testAttribute(Qt::WA_NoSystemBackground);

        setAttribute(Qt::WA_TranslucentBackground); // also sets WA_NoSystemBackground

        setAttribute(Qt::WA_NoSystemBackground, noSystemBackground); // restore system background attribute

    }

#endif

}

#ifdef QT3_SUPPORT

/*!

    \overload

    \obsolete

*/

QDialog::QDialog(QWidget *parent, const char *name, bool modal, Qt::WindowFlags f)

    : QWidget(*new QDialogPrivate, parent,

              f

              | QFlag(modal ? Qt::WShowModal : 0)

              | QFlag((f & Qt::WindowType_Mask) == 0 ? Qt::Dialog : 0)

        )

{

    setObjectName(QString::fromAscii(name));

}

#endif

/*!

  \overload

  \internal

*/

QDialog::QDialog(QDialogPrivate &dd, QWidget *parent, Qt::WindowFlags f)

    : QWidget(dd, parent, f | QFlag((f & Qt::WindowType_Mask) == 0 ? Qt::Dialog : 0))

{

#ifdef Q_WS_WINCE

    if (!qt_wince_is_smartphone())

        setWindowFlags(windowFlags() | Qt::WindowOkButtonHint | QFlag(qt_wince_is_mobile() ? 0 : Qt::WindowCancelButtonHint));

#endif

#ifdef Q_WS_S60

    if (S60->avkonComponentsSupportTransparency) {

        bool noSystemBackground = testAttribute(Qt::WA_NoSystemBackground);

        setAttribute(Qt::WA_TranslucentBackground); // also sets WA_NoSystemBackground

        setAttribute(Qt::WA_NoSystemBackground, noSystemBackground); // restore system background attribute

    }

#endif

}

/*!

  Destroys the QDialog, deleting all its children.

*/

QDialog::~QDialog()

{

    QT_TRY {

        // Need to hide() here, as our (to-be) overridden hide()

        // will not be called in ~QWidget.

        hide();

    } QT_CATCH(...) {

        // we're in the destructor - just swallow the exception

    }

}

/*!

  \internal

  This function is called by the push button \a pushButton when it

  becomes the default button. If \a pushButton is 0, the dialogs

  default default button becomes the default button. This is what a

  push button calls when it loses focus.

*/

void QDialogPrivate::setDefault(QPushButton *pushButton)

{

    Q_Q(QDialog);

    bool hasMain = false;

    QList<QPushButton*> list = qFindChildren<QPushButton*>(q);

    for (int i=0; i<list.size(); ++i) {

        QPushButton *pb = list.at(i);

        if (pb->window() == q) {

            if (pb == mainDef)

                hasMain = true;

            if (pb != pushButton)

                pb->setDefault(false);

        }

    }

    if (!pushButton && hasMain)

        mainDef->setDefault(true);

    if (!hasMain)

        mainDef = pushButton;

}

/*!

  \internal

  This function sets the default default push button to \a pushButton.

  This function is called by QPushButton::setDefault().

*/

void QDialogPrivate::setMainDefault(QPushButton *pushButton)

{

    mainDef = 0;

    setDefault(pushButton);

}

/*!

  \internal

  Hides the default button indicator. Called when non auto-default

  push button get focus.

 */

void QDialogPrivate::hideDefault()

{

    Q_Q(QDialog);

    QList<QPushButton*> list = qFindChildren<QPushButton*>(q);

    for (int i=0; i<list.size(); ++i) {

        list.at(i)->setDefault(false);

    }

}

void QDialogPrivate::resetModalitySetByOpen()

{

    Q_Q(QDialog);

    if (resetModalityTo != -1 && !q->testAttribute(Qt::WA_SetWindowModality)) {

        // open() changed the window modality and the user didn't touch it afterwards; restore it

        q->setWindowModality(Qt::WindowModality(resetModalityTo));

        q->setAttribute(Qt::WA_SetWindowModality, wasModalitySet);

#ifdef Q_WS_MAC

        Q_ASSERT(resetModalityTo != Qt::WindowModal);

        q->setParent(q->parentWidget(), Qt::Dialog);

#endif

    }

    resetModalityTo = -1;

}

#if defined(Q_WS_WINCE) || defined(Q_WS_S60)

#ifdef Q_WS_WINCE_WM

void QDialogPrivate::_q_doneAction()

{

    //Done...

    QApplication::postEvent(q_func(), new QEvent(QEvent::OkRequest));

}

#endif

/*!

    \reimp

*/

bool QDialog::event(QEvent *e)

{

    bool result = QWidget::event(e);

#ifdef Q_WS_WINCE

    if (e->type() == QEvent::OkRequest) {

        accept();

        result = true;

     }

#else

    if ((e->type() == QEvent::StyleChange) || (e->type() == QEvent::Resize )) {

        if (!testAttribute(Qt::WA_Moved)) {

            Qt::WindowStates state = windowState();

            adjustPosition(parentWidget());

            setAttribute(Qt::WA_Moved, false); // not really an explicit position

            if (state != windowState())

                setWindowState(state);

        }

    }

#endif

    return result;

}

#endif

/*!

  Returns the modal dialog's result code, \c Accepted or \c Rejected.

  Do not call this function if the dialog was constructed with the

  Qt::WA_DeleteOnClose attribute.

*/

int QDialog::result() const

{

    Q_D(const QDialog);

    return d->rescode;

}

/*!

  \fn void QDialog::setResult(int i)

  Sets the modal dialog's result code to \a i.

  \note We recommend that you use one of the values defined by

  QDialog::DialogCode.

*/

void QDialog::setResult(int r)

{

    Q_D(QDialog);

    d->rescode = r;

}

/*!

    \since 4.5

    Shows the dialog as a \l{QDialog#Modal Dialogs}{window modal dialog},

    returning immediately.

    \sa exec(), show(), result(), setWindowModality()

*/

void QDialog::open()

{

    Q_D(QDialog);

    Qt::WindowModality modality = windowModality();

    if (modality != Qt::WindowModal) {

        d->resetModalityTo = modality;

        d->wasModalitySet = testAttribute(Qt::WA_SetWindowModality);

        setWindowModality(Qt::WindowModal);

        setAttribute(Qt::WA_SetWindowModality, false);

#ifdef Q_WS_MAC

        setParent(parentWidget(), Qt::Sheet);

#endif

    }

    setResult(0);

    show();

}

/*!

    Shows the dialog as a \l{QDialog#Modal Dialogs}{modal dialog},

    blocking until the user closes it. The function returns a \l

    DialogCode result.

    If the dialog is \l{Qt::ApplicationModal}{application modal}, users cannot

    interact with any other window in the same application until they close

    the dialog. If the dialog is \l{Qt::ApplicationModal}{window modal}, only

    interaction with the parent window is blocked while the dialog is open.

    By default, the dialog is application modal.

    \sa open(), show(), result(), setWindowModality()

*/

int QDialog::exec()

{

    Q_D(QDialog);

    if (d->eventLoop) {

        qWarning("QDialog::exec: Recursive call detected");

        return -1;

    }

    bool deleteOnClose = testAttribute(Qt::WA_DeleteOnClose);

    setAttribute(Qt::WA_DeleteOnClose, false);

    d->resetModalitySetByOpen();

    bool wasShowModal = testAttribute(Qt::WA_ShowModal);

    setAttribute(Qt::WA_ShowModal, true);

    setResult(0);

//On Windows Mobile we create an empty menu to hide the current menu

#ifdef Q_WS_WINCE_WM

#ifndef QT_NO_MENUBAR

    QMenuBar *menuBar = 0;

    if (!findChild<QMenuBar *>())

        menuBar = new QMenuBar(this);

    if (qt_wince_is_smartphone()) {

        QAction *doneAction = new QAction(tr("Done"), this);

        menuBar->setDefaultAction(doneAction);

        connect(doneAction, SIGNAL(triggered()), this, SLOT(_q_doneAction()));

    }