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

**

** 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 "qstatusbar.h"

#ifndef QT_NO_STATUSBAR

#include "qlist.h"

#include "qdebug.h"

#include "qevent.h"

#include "qlayout.h"

#include "qpainter.h"

#include "qtimer.h"

#include "qstyle.h"

#include "qstyleoption.h"

#include "qsizegrip.h"

#include "qmainwindow.h"

#include <private/qlayoutengine_p.h>

#include <private/qwidget_p.h>

QT_BEGIN_NAMESPACE

class QStatusBarPrivate : public QWidgetPrivate

{

    Q_DECLARE_PUBLIC(QStatusBar)

public:

    QStatusBarPrivate() {}

    struct SBItem {

        SBItem(QWidget* widget, int stretch, bool permanent)

            : s(stretch), w(widget), p(permanent) {}

        int s;

        QWidget * w;

        bool p;

    };

    QList<SBItem *> items;

    QString tempItem;

    QBoxLayout * box;

    QTimer * timer;

#ifndef QT_NO_SIZEGRIP

    QSizeGrip * resizer;

    bool showSizeGrip;

#endif

    int savedStrut;

#ifdef Q_WS_MAC

    QPoint dragStart;

#endif

    int indexToLastNonPermanentWidget() const

    {

        int i = items.size() - 1;

        for (; i >= 0; --i) {

            SBItem *item = items.at(i);

            if (!(item && item->p))

                break;

        }

        return i;

    }

#ifndef QT_NO_SIZEGRIP

    void tryToShowSizeGrip()

    {

        if (!showSizeGrip)

            return;

        showSizeGrip = false;

        if (!resizer || resizer->isVisible())

            return;

        resizer->setAttribute(Qt::WA_WState_ExplicitShowHide, false);

        QMetaObject::invokeMethod(resizer, "_q_showIfNotHidden", Qt::DirectConnection);

        resizer->setAttribute(Qt::WA_WState_ExplicitShowHide, false);

    }

#endif

    QRect messageRect() const;

};

QRect QStatusBarPrivate::messageRect() const

{

    Q_Q(const QStatusBar);

    bool rtl = q->layoutDirection() == Qt::RightToLeft;

    int left = 6;

    int right = q->width() - 12;

#ifndef QT_NO_SIZEGRIP

    if (resizer && resizer->isVisible()) {

        if (rtl)

            left = resizer->x() + resizer->width();

        else

            right = resizer->x();

    }

#endif

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

        QStatusBarPrivate::SBItem* item = items.at(i);

        if (!item)

            break;

        if (item->p && item->w->isVisible()) {

                if (item->p) {

                    if (rtl)

                        left = qMax(left, item->w->x() + item->w->width() + 2);

                    else

                        right = qMin(right, item->w->x() - 2);

                }

                break;

        }

    }

    return QRect(left, 0, right-left, q->height());

}

/*!

    \class QStatusBar

    \brief The QStatusBar class provides a horizontal bar suitable for

    presenting status information.

    \ingroup mainwindow-classes

    \ingroup helpsystem

    Each status indicator falls into one of three categories:

    \list

    \o \e Temporary - briefly occupies most of the status bar. Used

        to explain tool tip texts or menu entries, for example.

    \o \e Normal - occupies part of the status bar and may be hidden

        by temporary messages. Used to display the page and line

        number in a word processor, for example.

    \o \e Permanent - is never hidden. Used for important mode

        indications, for example, some applications put a Caps Lock

        indicator in the status bar.

    \endlist

    QStatusBar lets you display all three types of indicators.

    Typically, a request for the status bar functionality occurs in

    relation to a QMainWindow object. QMainWindow provides a main

    application window, with a menu bar, tool bars, dock widgets \e

    and a status bar around a large central widget. The status bar can

    be retrieved using the QMainWindow::statusBar() function, and

    replaced using the QMainWindow::setStatusBar() function.

    Use the showMessage() slot to display a \e temporary message:

    \snippet examples/mainwindows/dockwidgets/mainwindow.cpp 8

    To remove a temporary message, use the clearMessage() slot, or set

    a time limit when calling showMessage(). For example:

    \snippet examples/mainwindows/dockwidgets/mainwindow.cpp 3

    Use the currentMessage() function to retrieve the temporary

    message currently shown. The QStatusBar class also provide the

    messageChanged() signal which is emitted whenever the temporary

    status message changes.

    \target permanent message

    \e Normal and \e Permanent messages are displayed by creating a

    small widget (QLabel, QProgressBar or even QToolButton) and then

    adding it to the status bar using the addWidget() or the

    addPermanentWidget() function. Use the removeWidget() function to

    remove such messages from the status bar.

    \snippet doc/src/snippets/code/src_gui_widgets_qstatusbar.cpp 0

    By default QStatusBar provides a QSizeGrip in the lower-right

    corner. You can disable it using the setSizeGripEnabled()

    function. Use the isSizeGripEnabled() function to determine the

    current status of the size grip.

    \image plastique-statusbar.png A status bar shown in the Plastique widget style

    \sa QMainWindow, QStatusTipEvent, {fowler}{GUI Design Handbook:

    Status Bar}, {Application Example}

*/

#ifdef QT3_SUPPORT

/*!

    Constructs a status bar with a size grip and the given \a parent

    and object \a name.

    Use the QStatusBar() constructor and the QObject::setObjectName()

    function instead.

    \oldcode

        QStatusBar *myStatusBar = new QStatusBar(parent, name);

    \newcode

        QStatusBar *myStatusBar = new QStatusBar(parent);

        myStatusBar->setObjectName(name);

    \endcode

*/

QStatusBar::QStatusBar(QWidget * parent, const char *name)

    : QWidget(*new QStatusBarPrivate, parent, 0)

{

    Q_D(QStatusBar);

    setObjectName(QString::fromAscii(name));

    d->box = 0;

    d->timer = 0;

#ifndef QT_NO_SIZEGRIP

    d->resizer = 0;

    d->showSizeGrip = false;

    setSizeGripEnabled(true); // causes reformat()

#else

    reformat();

#endif

}

/*!

    \fn void QStatusBar::addWidget(QWidget * widget, int stretch, bool permanent)

   Use addWidget() or addPermanentWidget() instead, depending on the

   value of the \a permanent parameter.

    \oldcode

        QStatusBar *myStatusBar;

        myStatusBar->addWidget(widget, stretch, permanent);  // permanent == true

    \newcode

        QStatusBar *myStatusBar;

        myStatusBar->addPermanentWidget(widget, stretch);

    \endcode

 */

#endif

/*!

    Constructs a status bar with a size grip and the given \a parent.

    \sa setSizeGripEnabled()

*/

QStatusBar::QStatusBar(QWidget * parent)

    : QWidget(*new QStatusBarPrivate, parent, 0)

{

    Q_D(QStatusBar);

    d->box = 0;

    d->timer = 0;

#ifndef QT_NO_SIZEGRIP

    d->resizer = 0;

    setSizeGripEnabled(true); // causes reformat()

#else

    reformat();

#endif

}

/*!

    Destroys this status bar and frees any allocated resources and

    child widgets.

*/

QStatusBar::~QStatusBar()

{

    Q_D(QStatusBar);

    while (!d->items.isEmpty())

        delete d->items.takeFirst();

}

/*!

    Adds the given \a widget to this status bar, reparenting the

    widget if it isn't already a child of this QStatusBar object. The

    \a stretch parameter is used to compute a suitable size for the

    given \a widget as the status bar grows and shrinks. The default

    stretch factor is 0, i.e giving the widget a minimum of space.

    The widget is located to the far left of the first permanent

    widget (see addPermanentWidget()) and may be obscured by temporary

    messages.

    \sa insertWidget(), removeWidget(), addPermanentWidget()

*/

void QStatusBar::addWidget(QWidget * widget, int stretch)

{

    if (!widget)

        return;

    insertWidget(d_func()->indexToLastNonPermanentWidget() + 1, widget, stretch);

}

/*!

    \since 4.2

    Inserts the given \a widget at the given \a index to this status bar,

    reparenting the widget if it isn't already a child of this

    QStatusBar object. If \a index is out of range, the widget is appended

    (in which case it is the actual index of the widget that is returned).

    The \a stretch parameter is used to compute a suitable size for

    the given \a widget as the status bar grows and shrinks. The

    default stretch factor is 0, i.e giving the widget a minimum of

    space.

    The widget is located to the far left of the first permanent

    widget (see addPermanentWidget()) and may be obscured by temporary

    messages.

    \sa addWidget(), removeWidget(), addPermanentWidget()

*/

int QStatusBar::insertWidget(int index, QWidget *widget, int stretch)

{

    if (!widget)

        return -1;

    Q_D(QStatusBar);

    QStatusBarPrivate::SBItem* item = new QStatusBarPrivate::SBItem(widget, stretch, false);

    int idx = d->indexToLastNonPermanentWidget();

    if (index < 0 || index > d->items.size() || (idx >= 0 && index > idx + 1)) {

        qWarning("QStatusBar::insertWidget: Index out of range (%d), appending widget", index);

        index = idx + 1;

    }

    d->items.insert(index, item);

    if (!d->tempItem.isEmpty())

        widget->hide();

    reformat();

    if (!widget->isHidden() || !widget->testAttribute(Qt::WA_WState_ExplicitShowHide))

        widget->show();

    return index;

}

/*!

    Adds the given \a widget permanently to this status bar,

    reparenting the widget if it isn't already a child of this

    QStatusBar object. The \a stretch parameter is used to compute a

    suitable size for the given \a widget as the status bar grows and

    shrinks. The default stretch factor is 0, i.e giving the widget a

    minimum of space.

    Permanently means that the widget may not be obscured by temporary

    messages. It is is located at the far right of the status bar.

    \sa insertPermanentWidget(), removeWidget(), addWidget()

*/

void QStatusBar::addPermanentWidget(QWidget * widget, int stretch)

{

    if (!widget)

        return;

    insertPermanentWidget(d_func()->items.size(), widget, stretch);

}

/*!

    \since 4.2

    Inserts the given \a widget at the given \a index permanently to this status bar,

    reparenting the widget if it isn't already a child of this

    QStatusBar object. If \a index is out of range, the widget is appended

    (in which case it is the actual index of the widget that is returned).

    The \a stretch parameter is used to compute a

    suitable size for the given \a widget as the status bar grows and

    shrinks. The default stretch factor is 0, i.e giving the widget a

    minimum of space.

    Permanently means that the widget may not be obscured by temporary

    messages. It is is located at the far right of the status bar.

    \sa addPermanentWidget(), removeWidget(), addWidget()

*/

int QStatusBar::insertPermanentWidget(int index, QWidget *widget, int stretch)

{

    if (!widget)

        return -1;

    Q_D(QStatusBar);

    QStatusBarPrivate::SBItem* item = new QStatusBarPrivate::SBItem(widget, stretch, true);

    int idx = d->indexToLastNonPermanentWidget();

    if (index < 0 || index > d->items.size() || (idx >= 0 && index <= idx)) {

        qWarning("QStatusBar::insertPermanentWidget: Index out of range (%d), appending widget", index);

        index = d->items.size();

    }

    d->items.insert(index, item);

    reformat();

    if (!widget->isHidden() || !widget->testAttribute(Qt::WA_WState_ExplicitShowHide))

        widget->show();

    return index;

}

/*!

    Removes the specified \a widget from the status bar.

    \note This function does not delete the widget but \e hides it.

    To add the widget again, you must call both the addWidget() and

    show() functions.

    \sa addWidget(), addPermanentWidget(), clearMessage()

*/

void QStatusBar::removeWidget(QWidget *widget)

{

    if (!widget)

        return;

    Q_D(QStatusBar);

    bool found = false;

    QStatusBarPrivate::SBItem* item;

    for (int i=0; i<d->items.size(); ++i) {

        item = d->items.at(i);

        if (!item)

            break;

        if (item->w == widget) {

            d->items.removeAt(i);

            item->w->hide();

            delete item;

            found = true;

            break;

        }

    }

    if (found)

        reformat();

#if defined(QT_DEBUG)

    else

        qDebug("QStatusBar::removeWidget(): Widget not found.");

#endif

}

/*!

    \property QStatusBar::sizeGripEnabled

    \brief whether the QSizeGrip in the bottom-right corner of the

    status bar is enabled

    The size grip is enabled by default.

*/

bool QStatusBar::isSizeGripEnabled() const

{

#ifdef QT_NO_SIZEGRIP

    return false;

#else

    Q_D(const QStatusBar);

    return !!d->resizer;

#endif

}

void QStatusBar::setSizeGripEnabled(bool enabled)

{

#ifdef QT_NO_SIZEGRIP

    Q_UNUSED(enabled);

#else

    Q_D(QStatusBar);

    if (!enabled != !d->resizer) {

        if (enabled) {

            d->resizer = new QSizeGrip(this);

            d->resizer->hide();

            d->resizer->installEventFilter(this);

            d->showSizeGrip = true;

        } else {

            delete d->resizer;

            d->resizer = 0;

            d->showSizeGrip = false;

        }

        reformat();

        if (d->resizer && isVisible())

            d->tryToShowSizeGrip();

    }

#endif

}

/*!

    Changes the status bar's appearance to account for item changes.

    Special subclasses may need this function, but geometry management

    will usually take care of any necessary rearrangements.

*/

void QStatusBar::reformat()

{

    Q_D(QStatusBar);

    if (d->box)

        delete d->box;

    QBoxLayout *vbox;

#ifndef QT_NO_SIZEGRIP

    if (d->resizer) {

        d->box = new QHBoxLayout(this);