plasma-framework/private/nativetabbar.cpp

/*
    Copyright 2007 Robert Knight <robertknight@gmail.com>
    Copyright 2008 Marco Martin <notmart@gmail.com>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

// Own
#include "nativetabbar_p.h"

// Qt
#include <QIcon>
#include <QMouseEvent>
#include <QPainter>
#include <QApplication>
#include <QStyleOption>
#include <QToolButton>
#include <QPropertyAnimation>
#include <QWeakPointer>

#include <QGradient>
#include <QLinearGradient>

// KDE
#include <kdebug.h>
#include <kcolorutils.h>
#include <kicon.h>
#include <kiconeffect.h>
#include <kiconloader.h>

#include "plasma/plasma.h"
#include "plasma/theme.h"
#include "plasma/animator.h"
#include "plasma/framesvg.h"
#include "plasma/paintutils.h"

namespace Plasma
{

static const int buttonHMargin = 4;
static const int buttonVMargin = 3;
static const int iconSpacing = 4;

class NativeTabBarPrivate
{
public:
    NativeTabBarPrivate(NativeTabBar *parent)
        : q(parent),
          shape(NativeTabBar::RoundedNorth),
          backgroundSvg(0),
          buttonSvg(0),
          m_highlightSvg(0)
    {
        backgroundSvg = new FrameSvg(q);
        backgroundSvg->setImagePath("widgets/frame");
        backgroundSvg->setElementPrefix("sunken");

        buttonSvg = new FrameSvg(q);
        buttonSvg->setImagePath("widgets/button");
        buttonSvg->setElementPrefix("normal");

        syncBorders();

        lastIndex[0] = -1;
        lastIndex[1] = -1;
    }

    ~NativeTabBarPrivate()
    {
        delete backgroundSvg;
        delete buttonSvg;
    }

    void syncBorders();
    void storeLastIndex();

    FrameSvg *highlightSvg()
    {
        if (!m_highlightSvg) {
            m_highlightSvg = new FrameSvg(q);
            m_highlightSvg->setImagePath("widgets/button");
            m_highlightSvg->setElementPrefix("pressed");
        }

        return m_highlightSvg;
    }

    NativeTabBar *q;
    QTabBar::Shape shape; //used to keep track of shape() changes
    FrameSvg *backgroundSvg;
    qreal left, top, right, bottom;
    FrameSvg *buttonSvg;
    qreal buttonLeft, buttonTop, buttonRight, buttonBottom;

    QList<bool> highlightedTabs;

    QWeakPointer<QPropertyAnimation> anim;

    QRect currentAnimRect;
    QRect startAnimRect;
    QPoint mousePressOffset;
    int lastIndex[2];
    qreal animProgress;

    FrameSvg *m_highlightSvg;
};

void NativeTabBarPrivate::syncBorders()
{
    backgroundSvg->getMargins(left, top, right, bottom);
    buttonSvg->getMargins(buttonLeft, buttonTop, buttonRight, buttonBottom);
}

void NativeTabBarPrivate::storeLastIndex()
{
    // if first run, or invalid previous index
    if (lastIndex[1] < 0 || lastIndex[1] >= q->count()) {
        lastIndex[0] = q->currentIndex();
    } else {
        lastIndex[0] = lastIndex[1];
    }

    lastIndex[1] = q->currentIndex();
}

NativeTabBar::NativeTabBar(QWidget *parent)
        : KTabBar(parent),
          d(new NativeTabBarPrivate(this))
{
    connect(this, SIGNAL(currentChanged(int)), this, SLOT(startAnimation()));
    setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
}

NativeTabBar::~NativeTabBar()
{
    d->anim.clear();
    delete d;
}

QRect NativeTabBar::tabRect(int index) const
{
    QRect rect = KTabBar::tabRect(index).translated(d->left, d->top);

    if (isVertical()) {
        rect.setWidth(width() - d->left - d->right);

        if (index == count() - 1) {
            rect.adjust(0, 0, 0, -d->bottom);
        }
    } else {
        rect.setHeight(height() - d->top- d->bottom);

        if (index == count() - 1) {
            rect.adjust(0, 0, -d->right, 0);
        }
    }

    return rect;
}

int NativeTabBar::lastIndex() const
{
    return d->lastIndex[0];
}

QSize NativeTabBar::tabSizeHint(int index) const
{
    //return KTabBar::tabSizeHint(index);
    QSize hint = tabSize(index);
    int minwidth = 0;
    int minheight = 0;
    int maxwidth = 0;

    Shape s = shape();
    switch (s) {
        case RoundedSouth:
        case TriangularSouth:
        case RoundedNorth:
        case TriangularNorth:
            if (count() > 0) {
                for (int i = count() - 1; i >= 0; i--) {
                    minwidth += tabSize(i).width();
                }

                if (minwidth < width() - d->left - d->right) {
                    hint.rwidth() += (width() - d->left - d->right - minwidth) / count();
                }
            }
            break;
        case RoundedWest:
        case TriangularWest:
        case RoundedEast:
        case TriangularEast:
            if (count() > 0) {
                for (int i = count() - 1; i >= 0; i--) {
                    minheight += tabSize(i).height();
                    if (tabSize(i).width() > maxwidth) {
                        maxwidth = tabSize(i).width();
                    }
                }

                if (minheight < height()) {
                    hint.rheight() += (height() - minheight) / count();
                }
            }
            break;
    }
    return hint;
}


QSize NativeTabBar::sizeHint() const
{
    return KTabBar::sizeHint();
}

void NativeTabBar::setTabHighlighted(int index, bool highlight)
{
    if (index < 0 || index >= count()) {
        return;
    }

    if (highlight != d->highlightedTabs[index]) {
        d->highlightedTabs[index] = highlight;
        update();
    }
}

bool NativeTabBar::isTabHighlighted(int index) const
{
    if (index < 0 || index >= count() ) {
        return false;
    }

    return d->highlightedTabs[index];
}
void NativeTabBar::paintEvent(QPaintEvent *event)
{
    if (!styleSheet().isNull()) {
        KTabBar::paintEvent(event);
        return;
    }

    QPainter painter(this);
    //int numTabs = count();
    //bool ltr = painter.layoutDirection() == Qt::LeftToRight; // Not yet used

    if (drawBase()) {
        d->backgroundSvg->paintFrame(&painter);
    }

    // Drawing Tabborders
    QRect movingRect;

    if (d->currentAnimRect.isNull() || !d->anim || d->anim.data()->state() != QAbstractAnimation::Running) {
        movingRect = tabRect(currentIndex());
    } else {
        movingRect = d->currentAnimRect;
    }

    //resizing here because in resizeevent the first time is invalid (still no tabs)
    d->buttonSvg->resizeFrame(movingRect.size());
    d->buttonSvg->paintFrame(&painter, movingRect.topLeft());

    QFontMetrics metrics(painter.font());


    QRect scrollButtonsRect;
    foreach (QObject *child, children()) {
        QToolButton *childWidget = qobject_cast<QToolButton *>(child);
        if (childWidget) {
            if (!childWidget->isVisible()) {
                continue;
            }

            if (scrollButtonsRect.isValid()) {
                scrollButtonsRect = scrollButtonsRect.united(childWidget->geometry());
            } else {
                scrollButtonsRect = childWidget->geometry();
            }
        }
    }

    const QColor buttonText = Plasma::Theme::defaultTheme()->color(Theme::ButtonTextColor);
    const QColor textColor = Plasma::Theme::defaultTheme()->color(Theme::TextColor);
    const QColor highlightColor = Plasma::Theme::defaultTheme()->color(Theme::HighlightColor);

    for (int i = 0; i < count(); ++i) {
        const bool isHighlighted = d->highlightedTabs[i];
        QRect rect = tabRect(i).adjusted(d->buttonLeft + buttonHMargin, d->buttonTop + buttonVMargin,
                                         -(d->buttonRight + buttonHMargin), -(d->buttonBottom + buttonVMargin));

        // draw tab icon
        QRect iconRect = QRect(rect.x(), rect.y(), iconSize().width(), iconSize().height());
        iconRect.moveCenter(QPoint(iconRect.center().x(), rect.center().y()));

        if (!tabIcon(i).isNull()) {
            if (isHighlighted) {
                QRect iconRectAdjusted = iconRect.adjusted(-buttonHMargin, -buttonVMargin, buttonHMargin, buttonVMargin);
                d->highlightSvg()->resizeFrame(iconRectAdjusted.size());
                d->highlightSvg()->paintFrame(&painter, iconRectAdjusted.topLeft());
                QPixmap iconPix = tabIcon(i).pixmap(iconRect.size());
                KIconEffect *effect = KIconLoader::global()->iconEffect();
                iconPix = effect->apply(iconPix, KIconLoader::Panel, KIconLoader::ActiveState);
                painter.drawPixmap(iconRect.topLeft(), iconPix);
            } else {
                tabIcon(i).paint(&painter, iconRect);
                painter.setOpacity(1.0);
            }
        }

        // draw tab text
        if (i == currentIndex() && d->animProgress == 1) {
            painter.setPen(isHighlighted ? highlightColor : buttonText);
        } else {
            QColor color = (isHighlighted ? highlightColor : textColor);
            if (!isTabEnabled(i)) {
                color.setAlpha(140);
            }

            painter.setPen(color);
        }
        QRect textRect = rect;

        if (!tabIcon(i).isNull()) {
            textRect.setLeft(iconRect.right() + iconSpacing);
        }


        painter.setFont(Plasma::Theme::defaultTheme()->font(Plasma::Theme::DefaultFont));

        int endTabSpace = contentsRect().right() - scrollButtonsRect.width();
        if (textRect.left() < endTabSpace) {
            if (textRect.left() < contentsRect().left() || textRect.right() > endTabSpace) {
                QPixmap buffer(textRect.size());
                buffer.fill(Qt::transparent);

                QPainter buffPainter(&buffer);
                buffPainter.drawText(buffer.rect(), Qt::AlignCenter | Qt::TextHideMnemonic, tabText(i));
                buffPainter.setCompositionMode(QPainter::CompositionMode_DestinationIn);
                QLinearGradient gradient(buffer.rect().topLeft(), buffer.rect().topRight());

                if (textRect.left() < contentsRect().left()) {
                    gradient.setColorAt(0, Qt::transparent);
                    gradient.setColorAt(qBound(qreal(0), (-(qreal)textRect.left())/(qreal)textRect.width(), qreal(1)), Qt::transparent);
                    gradient.setColorAt(1, Qt::black);
                } else {
                    gradient.setColorAt(0, Qt::black);
                    gradient.setColorAt(qBound(qreal(0), 1 - (qreal)(textRect.right() - endTabSpace)/(qreal)textRect.width(), qreal(1)), Qt::transparent);
                    gradient.setColorAt(1, Qt::transparent);
                }

                buffPainter.setBrush(gradient);
                buffPainter.setPen(Qt::NoPen);
                buffPainter.drawRect(buffer.rect());
                buffPainter.end();

                painter.drawPixmap(textRect, buffer, buffer.rect());
            } else {
                painter.drawText(textRect, Qt::AlignCenter | Qt::TextHideMnemonic, tabText(i));
            }
        }
    }

    if (scrollButtonsRect.isValid()) {
        scrollButtonsRect.adjust(2, 4, -2, -4);
        painter.save();

        QColor background(Plasma::Theme::defaultTheme()->color(Theme::BackgroundColor));
        background.setAlphaF(0.75);

        painter.setRenderHint(QPainter::Antialiasing);
        painter.fillPath(PaintUtils::roundedRectangle(scrollButtonsRect, 5), background);
        painter.restore();

        QStyleOption so;
        so.initFrom(this);
        so.palette.setColor(QPalette::ButtonText,
                            Plasma::Theme::defaultTheme()->color(Theme::TextColor));

        so.rect = scrollButtonsRect.adjusted(0, 0, -scrollButtonsRect.width() / 2, 0);
        style()->drawPrimitive(QStyle::PE_IndicatorArrowLeft, &so, &painter, this);

        so.rect = scrollButtonsRect.adjusted(scrollButtonsRect.width() / 2, 0, 0, 0);
        style()->drawPrimitive(QStyle::PE_IndicatorArrowRight, &so, &painter, this);
    }
}

void NativeTabBar::resizeEvent(QResizeEvent *event)
{
    KTabBar::resizeEvent(event);
    d->currentAnimRect = tabRect(currentIndex());
    d->backgroundSvg->resizeFrame(size());
    d->syncBorders();

    update();
}

void NativeTabBar::tabInserted(int index)
{
    d->highlightedTabs.insert(index, false);
    KTabBar::tabInserted(index);
    emit sizeHintChanged();

    d->currentAnimRect = tabRect(currentIndex());
    d->backgroundSvg->resizeFrame(size());
    d->syncBorders();

    update();
}

void NativeTabBar::tabRemoved(int index)
{
    d->highlightedTabs.removeAt(index);
    KTabBar::tabRemoved(index);
    emit sizeHintChanged();

    d->currentAnimRect = tabRect(currentIndex());
    d->backgroundSvg->resizeFrame(size());
    d->syncBorders();

    update();
}

void NativeTabBar::tabLayoutChange()
{
    KTabBar::tabLayoutChange();

    if (shape() != d->shape) {
        d->shape = shape();
        emit shapeChanged(d->shape);
    }
}

void NativeTabBar::startAnimation()
{
    d->storeLastIndex();

    QPropertyAnimation *anim = d->anim.data();
    if (anim) {
        anim->stop();
        d->anim.clear();
    }

    anim = new QPropertyAnimation(this,  "onValueChanged",  this);
    d->anim = anim;
    anim->setDuration(150);

    QRect rect = tabRect(currentIndex());
    QRect lastRect = d->startAnimRect.isNull() ? tabRect(lastIndex())
                                               : d->startAnimRect;
    int x = isHorizontal() ? (int)(lastRect.x() -  (lastRect.x() - rect.x())) : rect.x();
    int y = isHorizontal() ? rect.y() : (int)(lastRect.y() -  (lastRect.y() - rect.y()));
    QSizeF sz = lastRect.size() - (lastRect.size() - rect.size());
    d->currentAnimRect = QRect(x, y, (int)(sz.width()), (int)(sz.height()));

    anim->setStartValue(lastRect);
    anim->setEndValue(d->currentAnimRect);
    anim->start(QAbstractAnimation::DeleteWhenStopped);
}

void NativeTabBar::setOnValueChanged(QRectF value)
{
    if (value == d->anim.data()->endValue()) {
        d->animProgress = 1;
        animationFinished();
        return;
    }

    d->currentAnimRect = value.toRect();
    update();
}

QRectF NativeTabBar::onValueChanged() const
{
    return d->currentAnimRect;
}

void NativeTabBar::animationFinished()
{
    d->startAnimRect = QRect();
    d->currentAnimRect = QRect();
    update();
}

bool NativeTabBar::isVertical() const
{
    switch (shape()) {
        case RoundedWest:
        case RoundedEast:
        case TriangularWest:
        case TriangularEast:
            return true;
            break;
        default:
            break;
    }

    return false;
}

bool NativeTabBar::isHorizontal() const
{
    return !isVertical();
}

QSize NativeTabBar::tabSize(int index) const
{
    QSize hint;
    const QFontMetrics metrics(QApplication::font());
    const QSize textSize = metrics.size(Qt::TextHideMnemonic, tabText(index));
    hint.rwidth() = textSize.width() + iconSpacing + iconSize().width() + buttonHMargin * 2;
    hint.rheight() = qMax(iconSize().height(), textSize.height()) + buttonVMargin * 2;
    hint.rwidth() += d->buttonLeft + d->buttonRight;
    hint.rheight() += d->buttonTop + d->buttonBottom;

    if (isVertical()) {
        hint.rwidth() = qMax(hint.width(), int(minimumWidth() - d->left - d->right));
    } else {
        hint.rheight() = qMax(hint.height(), int(minimumHeight() - d->top - d->bottom));
    }

    return hint;
}

void NativeTabBar::mousePressEvent(QMouseEvent *event)
{
    if (d->currentAnimRect.isNull()) {
        QRect rect = tabRect(currentIndex());

        if (rect.contains(event->pos())) {
            d->mousePressOffset = event->pos();
            event->accept();
            return;
        }
    }

    KTabBar::mousePressEvent(event);
}

void NativeTabBar::mouseMoveEvent(QMouseEvent *event)
{
    if (d->mousePressOffset != QPoint()) {
        d->currentAnimRect = tabRect(currentIndex());

        if (isVertical()) {
            int pos = qBound(0, d->currentAnimRect.top() + (event->pos().y() - d->mousePressOffset.y()),
                            height() - d->currentAnimRect.height());
            d->currentAnimRect.moveTop(pos);
        } else {
            int pos = qBound(0, d->currentAnimRect.left() + (event->pos().x() - d->mousePressOffset.x()),
                            width() - d->currentAnimRect.width());
            d->currentAnimRect.moveLeft(pos);
        }
        update();
    } else {
        KTabBar::mouseMoveEvent(event);
    }
}

void NativeTabBar::mouseReleaseEvent(QMouseEvent *event)
{
    if (d->mousePressOffset != QPoint()) {
        int index = -1;

        if (isVertical()) {
            bool top = event->pos().y() - d->mousePressOffset.y() < 0;
            index = tabAt(QPoint(1, top ? d->currentAnimRect.top() : d->currentAnimRect.bottom()));
        } else {
            bool left = event->pos().x() - d->mousePressOffset.x() < 0;
            index = tabAt(QPoint(left ? d->currentAnimRect.left() : d->currentAnimRect.right(), 1));
        }

        d->mousePressOffset = QPoint();

        if (index != currentIndex() && isTabEnabled(index)) {
            d->startAnimRect = d->currentAnimRect;
            setCurrentIndex(index);
        } else {
            d->currentAnimRect = QRect();
        }

        update();
    } else {
        KTabBar::mouseReleaseEvent(event);
    }
}

void NativeTabBar::wheelEvent(QWheelEvent *event)
{
    if (underMouse()) {
        //Cycle tabs with the circular array tecnique
        if (event->delta() < 0) {
            int index = currentIndex();
            //search for an enabled tab
            for (int i = 0; i < count()-1; ++i) {
                index = (index + 1) % count();
                if (isTabEnabled(index)) {
                    break;
                }
            }

            setCurrentIndex(index);
        } else {
            int index = currentIndex();
            for (int i = 0; i < count()-1; ++i) {
                index = (count() + index -1) % count();
                if (isTabEnabled(index)) {
                    break;
                }
            }

            setCurrentIndex(index);
        }
    } else {
        QTabBar::wheelEvent(event);
    }
}

} // namespace Plasma

#include "moc_nativetabbar_p.cpp"