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

**

** Copyright (C) 2009 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 "qwizard.h"

#ifndef QT_NO_WIZARD

#include "qabstractspinbox.h"

#include "qalgorithms.h"

#include "qapplication.h"

#include "qboxlayout.h"

#include "qlayoutitem.h"

#include "qdesktopwidget.h"

#include "qevent.h"

#include "qframe.h"

#include "qlabel.h"

#include "qlineedit.h"

#include "qpainter.h"

#include "qpushbutton.h"

#include "qset.h"

#include "qstyle.h"

#include "qvarlengtharray.h"

#if defined(Q_WS_MAC)

#include "private/qt_mac_p.h"

#include "qlibrary.h"

#elif !defined(QT_NO_STYLE_WINDOWSVISTA)

#include "qwizard_win_p.h"

#include "qtimer.h"

#endif

#include "private/qdialog_p.h"

#include <qdebug.h>

#ifdef Q_WS_WINCE

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

#endif

#include <string.h>     // for memset()

#ifdef QT_SOFTKEYS_ENABLED

#include "qaction.h"

#endif

QT_BEGIN_NAMESPACE

// These fudge terms were needed a few places to obtain pixel-perfect results

const int GapBetweenLogoAndRightEdge = 5;

const int ModernHeaderTopMargin = 2;

const int ClassicHMargin = 4;

const int MacButtonTopMargin = 13;

const int MacLayoutLeftMargin = 20;

//const int MacLayoutTopMargin = 14; // Unused. Save some space and avoid warning.

const int MacLayoutRightMargin = 20;

const int MacLayoutBottomMargin = 17;

static void changeSpacerSize(QLayout *layout, int index, int width, int height)

{

    QSpacerItem *spacer = layout->itemAt(index)->spacerItem();

    if (!spacer)

        return;

    spacer->changeSize(width, height);

}

static QWidget *iWantTheFocus(QWidget *ancestor)

{

    const int MaxIterations = 100;

    QWidget *candidate = ancestor;

    for (int i = 0; i < MaxIterations; ++i) {

        candidate = candidate->nextInFocusChain();

        if (!candidate)

            break;

        if (candidate->focusPolicy() & Qt::TabFocus) {

            if (candidate != ancestor && ancestor->isAncestorOf(candidate))

                return candidate;

        }

    }

    return 0;

}

static bool objectInheritsXAndXIsCloserThanY(const QObject *object, const QByteArray &classX,

                                             const QByteArray &classY)

{

    const QMetaObject *metaObject = object->metaObject();

    while (metaObject) {

        if (metaObject->className() == classX)

            return true;

        if (metaObject->className() == classY)

            return false;

        metaObject = metaObject->superClass();

    }

    return false;

}

const int NFallbackDefaultProperties = 7;

const struct {

    const char *className;

    const char *property;

    const char *changedSignal;

} fallbackProperties[NFallbackDefaultProperties] = {

    // If you modify this list, make sure to update the documentation (and the auto test)

    { "QAbstractButton", "checked", SIGNAL(toggled(bool)) },

    { "QAbstractSlider", "value", SIGNAL(valueChanged(int)) },

    { "QComboBox", "currentIndex", SIGNAL(currentIndexChanged(int)) },

    { "QDateTimeEdit", "dateTime", SIGNAL(dateTimeChanged(QDateTime)) },

    { "QLineEdit", "text", SIGNAL(textChanged(QString)) },

    { "QListWidget", "currentRow", SIGNAL(currentRowChanged(int)) },

    { "QSpinBox", "value", SIGNAL(valueChanged(int)) }

};

class QWizardDefaultProperty

{

public:

    QByteArray className;

    QByteArray property;

    QByteArray changedSignal;

    inline QWizardDefaultProperty() {}

    inline QWizardDefaultProperty(const char *className, const char *property,

                                   const char *changedSignal)

        : className(className), property(property), changedSignal(changedSignal) {}

};

class QWizardField

{

public:

    inline QWizardField() {}

    QWizardField(QWizardPage *page, const QString &spec, QObject *object, const char *property,

                  const char *changedSignal);

    void resolve(const QVector<QWizardDefaultProperty> &defaultPropertyTable);

    void findProperty(const QWizardDefaultProperty *properties, int propertyCount);

    QWizardPage *page;

    QString name;

    bool mandatory;

    QObject *object;

    QByteArray property;

    QByteArray changedSignal;

    QVariant initialValue;

};

QWizardField::QWizardField(QWizardPage *page, const QString &spec, QObject *object,

                           const char *property, const char *changedSignal)

    : page(page), name(spec), mandatory(false), object(object), property(property),

      changedSignal(changedSignal)

{

    if (name.endsWith(QLatin1Char('*'))) {

        name.chop(1);

        mandatory = true;

    }

}

void QWizardField::resolve(const QVector<QWizardDefaultProperty> &defaultPropertyTable)

{

    if (property.isEmpty())

        findProperty(defaultPropertyTable.constData(), defaultPropertyTable.count());

    initialValue = object->property(property);

}

void QWizardField::findProperty(const QWizardDefaultProperty *properties, int propertyCount)

{

    QByteArray className;

    for (int i = 0; i < propertyCount; ++i) {

        if (objectInheritsXAndXIsCloserThanY(object, properties[i].className, className)) {

            className = properties[i].className;

            property = properties[i].property;

            changedSignal = properties[i].changedSignal;

        }

    }

}

class QWizardLayoutInfo

{

public:

    inline QWizardLayoutInfo()

    : topLevelMarginLeft(-1), topLevelMarginRight(-1), topLevelMarginTop(-1),

      topLevelMarginBottom(-1), childMarginLeft(-1), childMarginRight(-1),

      childMarginTop(-1), childMarginBottom(-1), hspacing(-1), vspacing(-1),

          wizStyle(QWizard::ClassicStyle), header(false), watermark(false), title(false),

          subTitle(false), extension(false) {}

    int topLevelMarginLeft;

    int topLevelMarginRight;

    int topLevelMarginTop;

    int topLevelMarginBottom;

    int childMarginLeft;

    int childMarginRight;

    int childMarginTop;

    int childMarginBottom;

    int hspacing;

    int vspacing;

    int buttonSpacing;

    QWizard::WizardStyle wizStyle;

    bool header;

    bool watermark;

    bool title;

    bool subTitle;

    bool extension;

    bool operator==(const QWizardLayoutInfo &other);

    inline bool operator!=(const QWizardLayoutInfo &other) { return !operator==(other); }

};

bool QWizardLayoutInfo::operator==(const QWizardLayoutInfo &other)

{

    return topLevelMarginLeft == other.topLevelMarginLeft

           && topLevelMarginRight == other.topLevelMarginRight

           && topLevelMarginTop == other.topLevelMarginTop

           && topLevelMarginBottom == other.topLevelMarginBottom

           && childMarginLeft == other.childMarginLeft

           && childMarginRight == other.childMarginRight

           && childMarginTop == other.childMarginTop

           && childMarginBottom == other.childMarginBottom

           && hspacing == other.hspacing

           && vspacing == other.vspacing

           && buttonSpacing == other.buttonSpacing

           && wizStyle == other.wizStyle

           && header == other.header

           && watermark == other.watermark

           && title == other.title

           && subTitle == other.subTitle

           && extension == other.extension;

}

class QWizardHeader : public QWidget

{

public:

    enum RulerType { Ruler };

    inline QWizardHeader(RulerType /* ruler */, QWidget *parent = 0)

        : QWidget(parent) { setFixedHeight(2); }

    QWizardHeader(QWidget *parent = 0);

    void setup(const QWizardLayoutInfo &info, const QString &title,

               const QString &subTitle, const QPixmap &logo, const QPixmap &banner,

               Qt::TextFormat titleFormat, Qt::TextFormat subTitleFormat);

protected:

    void paintEvent(QPaintEvent *event);

#if !defined(QT_NO_STYLE_WINDOWSVISTA)

private:

    bool vistaDisabled() const;

#endif

private:

    QLabel *titleLabel;

    QLabel *subTitleLabel;

    QLabel *logoLabel;

    QGridLayout *layout;

    QPixmap bannerPixmap;

};

QWizardHeader::QWizardHeader(QWidget *parent)

    : QWidget(parent)

{

    setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Fixed);

    setBackgroundRole(QPalette::Base);

    titleLabel = new QLabel(this);

    titleLabel->setBackgroundRole(QPalette::Base);

    subTitleLabel = new QLabel(this);

    subTitleLabel->setAlignment(Qt::AlignTop | Qt::AlignLeft);

    subTitleLabel->setWordWrap(true);

    logoLabel = new QLabel(this);

    QFont font = titleLabel->font();

    font.setBold(true);

    titleLabel->setFont(font);

    layout = new QGridLayout(this);

    layout->setMargin(0);

    layout->setSpacing(0);

    layout->setRowMinimumHeight(3, 1);

    layout->setRowStretch(4, 1);

    layout->setColumnStretch(2, 1);

    layout->setColumnMinimumWidth(4, 2 * GapBetweenLogoAndRightEdge);

    layout->setColumnMinimumWidth(6, GapBetweenLogoAndRightEdge);

    layout->addWidget(titleLabel, 2, 1, 1, 2);

    layout->addWidget(subTitleLabel, 4, 2);

    layout->addWidget(logoLabel, 1, 5, 5, 1);

}

#if !defined(QT_NO_STYLE_WINDOWSVISTA)

bool QWizardHeader::vistaDisabled() const

{

    bool styleDisabled = false;

    QWizard *wiz = parentWidget() ? qobject_cast <QWizard *>(parentWidget()->parentWidget()) : 0;

    if (wiz) {

        // Designer dosen't support the Vista style for Wizards. This property is used to turn

        // off the Vista style.

        const QVariant v = wiz->property("_q_wizard_vista_off");

        styleDisabled = v.isValid() && v.toBool();

    }

    return styleDisabled;

}

#endif

void QWizardHeader::setup(const QWizardLayoutInfo &info, const QString &title,

                          const QString &subTitle, const QPixmap &logo, const QPixmap &banner,

                          Qt::TextFormat titleFormat, Qt::TextFormat subTitleFormat)

{

    bool modern = ((info.wizStyle == QWizard::ModernStyle)

#if !defined(QT_NO_STYLE_WINDOWSVISTA)

        || ((info.wizStyle == QWizard::AeroStyle

            && QVistaHelper::vistaState() == QVistaHelper::Classic) || vistaDisabled())

#endif

    );

    layout->setRowMinimumHeight(0, modern ? ModernHeaderTopMargin : 0);

    layout->setRowMinimumHeight(1, modern ? info.topLevelMarginTop - ModernHeaderTopMargin - 1 : 0);

    layout->setRowMinimumHeight(6, (modern ? 3 : GapBetweenLogoAndRightEdge) + 2);

    int minColumnWidth0 = modern ? info.topLevelMarginLeft + info.topLevelMarginRight : 0;

    int minColumnWidth1 = modern ? info.topLevelMarginLeft + info.topLevelMarginRight + 1

                                 : info.topLevelMarginLeft + ClassicHMargin;

    layout->setColumnMinimumWidth(0, minColumnWidth0);

    layout->setColumnMinimumWidth(1, minColumnWidth1);

    titleLabel->setTextFormat(titleFormat);

    titleLabel->setText(title);

    logoLabel->setPixmap(logo);

    subTitleLabel->setTextFormat(subTitleFormat);

    subTitleLabel->setText(QLatin1String("Pq\nPq"));

    int desiredSubTitleHeight = subTitleLabel->sizeHint().height();

    subTitleLabel->setText(subTitle);

    if (modern) {

        bannerPixmap = banner;

    } else {

        bannerPixmap = QPixmap();

    }

    if (bannerPixmap.isNull()) {

        /*

            There is no widthForHeight() function, so we simulate it with a loop.

        */

        int candidateSubTitleWidth = qMin(512, 2 * QApplication::desktop()->width() / 3);

        int delta = candidateSubTitleWidth >> 1;

        while (delta > 0) {

            if (subTitleLabel->heightForWidth(candidateSubTitleWidth - delta)

                        <= desiredSubTitleHeight)

                candidateSubTitleWidth -= delta;

            delta >>= 1;

        }

        subTitleLabel->setMinimumSize(candidateSubTitleWidth, desiredSubTitleHeight);

        QSize size = layout->totalMinimumSize();

        setMinimumSize(size);

        setMaximumSize(QWIDGETSIZE_MAX, size.height());

    } else {

        subTitleLabel->setMinimumSize(0, 0);

        setFixedSize(banner.size() + QSize(0, 2));

    }

    updateGeometry();

}

void QWizardHeader::paintEvent(QPaintEvent * /* event */)

{

    QPainter painter(this);

    painter.drawPixmap(0, 0, bannerPixmap);

    int x = width() - 2;

    int y = height() - 2;

    const QPalette &pal = palette();

    painter.setPen(pal.mid().color());

    painter.drawLine(0, y, x, y);

    painter.setPen(pal.base().color());

    painter.drawPoint(x + 1, y);

    painter.drawLine(0, y + 1, x + 1, y + 1);

}

// We save one vtable by basing QWizardRuler on QWizardHeader

class QWizardRuler : public QWizardHeader

{

public:

    inline QWizardRuler(QWidget *parent = 0)

        : QWizardHeader(Ruler, parent) {}

};

class QWizardPagePrivate : public QWidgetPrivate

{

    Q_DECLARE_PUBLIC(QWizardPage)

public:

    enum TriState { Tri_Unknown = -1, Tri_False, Tri_True };

    inline QWizardPagePrivate()

        : wizard(0), completeState(Tri_Unknown), explicitlyFinal(false), commit(false) {}

    bool cachedIsComplete() const;

    void _q_maybeEmitCompleteChanged();

    void _q_updateCachedCompleteState();

    QWizard *wizard;

    QString title;

    QString subTitle;

    QPixmap pixmaps[QWizard::NPixmaps];

    QVector<QWizardField> pendingFields;

    mutable TriState completeState;

    bool explicitlyFinal;

    bool commit;

    QMap<int, QString> buttonCustomTexts;

};

bool QWizardPagePrivate::cachedIsComplete() const

{

    Q_Q(const QWizardPage);

    if (completeState == Tri_Unknown)

        completeState = q->isComplete() ? Tri_True : Tri_False;

    return completeState == Tri_True;

}

void QWizardPagePrivate::_q_maybeEmitCompleteChanged()

{

    Q_Q(QWizardPage);

    TriState newState = q->isComplete() ? Tri_True : Tri_False;

    if (newState != completeState)

        emit q->completeChanged();

}

void QWizardPagePrivate::_q_updateCachedCompleteState()

{

    Q_Q(QWizardPage);

    completeState = q->isComplete() ? Tri_True : Tri_False;

}

class QWizardAntiFlickerWidget : public QWidget

{

    QWizard *wizard;

    QWizardPrivate *wizardPrivate;

public:

    QWizardAntiFlickerWidget(QWizard *wizard, QWizardPrivate *wizardPrivate)

        : QWidget(wizard)

        , wizard(wizard)

        , wizardPrivate(wizardPrivate) {}

#if !defined(QT_NO_STYLE_WINDOWSVISTA)

protected:

    void paintEvent(QPaintEvent *);

#endif

};

class QWizardPrivate : public QDialogPrivate

{

    Q_DECLARE_PUBLIC(QWizard)

public:

    typedef QMap<int, QWizardPage *> PageMap;

    enum Direction {

        Backward,

        Forward

    };

    inline QWizardPrivate()

        : start(-1)

        , current(-1)

        , canContinue(false)

        , canFinish(false)

        , disableUpdatesCount(0)

        , opts(0)

        , buttonsHaveCustomLayout(false)

        , titleFmt(Qt::AutoText)

        , subTitleFmt(Qt::AutoText)

        , placeholderWidget1(0)

        , placeholderWidget2(0)

        , headerWidget(0)

        , watermarkLabel(0)

        , titleLabel(0)

        , subTitleLabel(0)

        , bottomRuler(0)

#if !defined(QT_NO_STYLE_WINDOWSVISTA)

        , vistaInitPending(false)

        , vistaState(QVistaHelper::Dirty)

        , vistaStateChanged(false)

        , inHandleAeroStyleChange(false)

#endif

        , minimumWidth(0)

        , minimumHeight(0)

        , maximumWidth(QWIDGETSIZE_MAX)

        , maximumHeight(QWIDGETSIZE_MAX)