kde-extraapps/kdeplasma-addons/applets/icontasks/tooltips/tooltip.cpp

/*
 *   Copyright 2007 by Dan Meltzer <hydrogen@notyetimplemented.com>
 *   Copyright (C) 2008 by Alexis Ménard <darktears31@gmail.com>
 *
 *   This program 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, or
 *   (at your option) any later version.
 *
 *   This program 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 General Public License for more details
 *
 *   You should have received a copy of the GNU Library General Public
 *   License along with this program; if not, write to the
 *   Free Software Foundation, Inc.,
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#include "tooltip_p.h"
#include "tooltipmanager.h"
#include "windowpreview_p.h"

#include <QAbstractTextDocumentLayout>
#include <QBitmap>
#include <QGridLayout>
#include <QLabel>
#include <QtGui/qevent.h>
#include <QPainter>
#include <QPalette>
#include <QTextDocument>
#include <QPropertyAnimation>
#include <QtGui/qtextobject.h>
#include <QToolButton>
#ifdef Q_WS_X11
#include <QX11Info>
#include <netwm.h>
#endif

#include <kdebug.h>
#include <kglobal.h>
#include <kglobalsettings.h>
#include <kwindowsystem.h>
#include <KIcon>
#include <KIconLoader>
#include <KIconEffect>

#include <plasma/plasma.h>
#include <plasma/paintutils.h>
#include <plasma/theme.h>
#include <plasma/framesvg.h>
#include <plasma/windoweffects.h>

using namespace Plasma;

namespace IconTasks
{

class TipTextWidget : public QWidget
{
public:
    TipTextWidget(ToolTip *parent)
        : QWidget(parent),
          m_toolTip(parent),
          m_document(new QTextDocument(this)) {
    }

    void setStyleSheet(const QString &css) {
        m_document->setDefaultStyleSheet(css);
    }

    void setContent(const ToolTipContent &data) {
        QString html;
        if (!data.mainText().isEmpty()) {
            html.append("<b>" + data.mainText() + "</b><br/>");
        }
        html.append(data.subText());

        m_anchor.clear();
        m_document->clear();
        data.registerResources(m_document);
        if (!html.isEmpty()) {
            m_document->setHtml("<p>" + html + "</p>");
        }
        m_document->adjustSize();

        update();
    }

    QSize minimumSizeHint() const {
        const int margin = 6;
        return m_document->size().toSize() + QSize(margin, margin)*2;
    }

    QSize maximumSizeHint() const {
        return minimumSizeHint();
    }

    void paintEvent(QPaintEvent *event) {
        QPainter p(this);
        m_document->drawContents(&p, event->rect());
    }

    void mousePressEvent(QMouseEvent *event) {
        QAbstractTextDocumentLayout *layout = m_document->documentLayout();
        if (layout) {
            m_anchor = layout->anchorAt(event->pos());
        }
    }

    void mouseReleaseEvent(QMouseEvent *event) {
        QAbstractTextDocumentLayout *layout = m_document->documentLayout();
        if (layout) {
            QString anchor = layout->anchorAt(event->pos());
            if (anchor == m_anchor) {
                m_toolTip->linkActivated(m_anchor, event);
            }

            m_anchor.clear();
        }
    }


private:
    ToolTip *m_toolTip;
    QTextDocument *m_document;
    QString m_anchor;
};

class MediaButton : public QWidget
{
public:

    MediaButton(ToolTip *parent, const char *i1, const char *i2 = 0)
        : QWidget(parent)
        , m_toolTip(parent)
        , m_state(0)
        , m_hover(0) {
        int iconSize = 32;
        resize(iconSize, iconSize);
        setSizePolicy(QSizePolicy::Fixed, QSizePolicy::Fixed);
        setMouseTracking(true);

        m_icon[0][0] = KIcon(i1).pixmap(iconSize, iconSize);
        KIconEffect *effect = KIconLoader::global()->iconEffect();

        if (effect->hasEffect(KIconLoader::Desktop, KIconLoader::ActiveState)) {
            m_icon[0][1] = effect->apply(m_icon[0][0], KIconLoader::Desktop, KIconLoader::ActiveState);
        } else {
            m_icon[0][1] = m_icon[0][0];
        }

        if (i2) {
            m_icon[1][0] = KIcon(i2).pixmap(iconSize, iconSize);

            if (effect->hasEffect(KIconLoader::Desktop, KIconLoader::ActiveState)) {
                m_icon[1][1] = effect->apply(m_icon[1][0], KIconLoader::Desktop, KIconLoader::ActiveState);
            } else {
                m_icon[1][1] = m_icon[1][0];
            }
        }

    }

    QSize sizeHint() const {
        return m_icon[0][0].size();
    }

    void paintEvent(QPaintEvent *e) {
        Q_UNUSED(e)

        QPainter painter(this);
        painter.drawPixmap(rect().x(), rect().y(), m_icon[m_state][m_hover]);
        painter.end();
    }

    void enterEvent(QEvent *e) {
        Q_UNUSED(e)
        m_hover = 1;
        repaint();
    }

    void leaveEvent(QEvent *e) {
        Q_UNUSED(e)
        m_hover = 0;
        repaint();
    }

    void mouseReleaseEvent(QMouseEvent *e) {
        Q_UNUSED(e)
        m_toolTip->buttonPressed(this);
    }

    void setChecked(bool c) {
        if ((c && 0 == m_state) || (!c && 1 == m_state)) {
            m_state = c && !m_icon[1][0].isNull() ? 1 : 0;
            if (isVisible()) {
                repaint();
            }
        }
    }

private:
    ToolTip *m_toolTip;
    int m_state;
    int m_hover;
    QPixmap m_icon[2][2];
};

class ToolTipPrivate
{
public:
    ToolTipPrivate()
        : text(0),
          imageLabel(0),
          preview(0),
          direction(Plasma::Up),
          autohide(true),
          hovered(false)
    { }

    TipTextWidget *text;
    QLabel *imageLabel;
    WindowPreview *preview;
    FrameSvg *background;
    QWeakPointer<QObject> source;
    QPropertyAnimation *animation;
    Plasma::Direction direction;
    MediaButton *prev;
    MediaButton *playPause;
    MediaButton *next;
    bool autohide;
    bool hovered;
};

/*
 * media-skip-forward
 * media-skip-backward
*/
ToolTip::ToolTip(QWidget *parent)
    : QWidget(parent),
      d(new ToolTipPrivate())
{
    setAttribute(Qt::WA_TranslucentBackground);
    setWindowFlags(Qt::ToolTip);
    d->preview = new WindowPreview(this);
    d->text = new TipTextWidget(this);
    d->imageLabel = new QLabel(this);
    d->imageLabel->setAlignment(Qt::AlignTop | Qt::AlignLeft);

    d->animation = new QPropertyAnimation(this, "pos", this);
    d->animation->setEasingCurve(QEasingCurve::InOutQuad);
    d->animation->setDuration(250);

    d->background = new FrameSvg(this);
    d->background->setImagePath("widgets/tooltip");
    d->background->setEnabledBorders(FrameSvg::AllBorders);
    updateTheme();
    connect(d->background, SIGNAL(repaintNeeded()), this, SLOT(updateTheme()));
    connect(d->preview, SIGNAL(windowPreviewClicked(WId, Qt::MouseButtons, Qt::KeyboardModifiers, QPoint)),
            this, SIGNAL(activateWindowByWId(WId, Qt::MouseButtons, Qt::KeyboardModifiers, QPoint)));
    connect(d->preview, SIGNAL(windowButtonClicked(WId, Qt::MouseButtons, Qt::KeyboardModifiers, QPoint)),
            this, SIGNAL(closeWindowByWId(WId, Qt::MouseButtons, Qt::KeyboardModifiers, QPoint)));
    QHBoxLayout *previewHBoxLayout = new QHBoxLayout;
    previewHBoxLayout->addWidget(d->preview);

    QHBoxLayout *iconTextHBoxLayout = new QHBoxLayout;
    iconTextHBoxLayout->addWidget(d->imageLabel);
    iconTextHBoxLayout->setAlignment(d->imageLabel, Qt::AlignCenter);
    iconTextHBoxLayout->addWidget(d->text);
    iconTextHBoxLayout->setAlignment(d->text, Qt::AlignLeft | Qt::AlignVCenter);
    iconTextHBoxLayout->setStretchFactor(d->text, 1);

    QHBoxLayout *mediaHBoxLayout = new QHBoxLayout;
    d->prev = new MediaButton(this, "media-skip-backward");
    d->playPause = new MediaButton(this, "media-playback-start", "media-playback-pause");
    d->next = new MediaButton(this, "media-skip-forward");
    mediaHBoxLayout->addItem(new QSpacerItem(0, 0, QSizePolicy::MinimumExpanding, QSizePolicy::Fixed));
    mediaHBoxLayout->addWidget(d->prev);
    mediaHBoxLayout->addWidget(d->playPause);
    mediaHBoxLayout->addWidget(d->next);
    mediaHBoxLayout->addItem(new QSpacerItem(0, 0, QSizePolicy::MinimumExpanding, QSizePolicy::Fixed));

    QVBoxLayout *mainLayout = new QVBoxLayout;
    mainLayout->addLayout(previewHBoxLayout);
    mainLayout->addLayout(iconTextHBoxLayout);
    mainLayout->addLayout(mediaHBoxLayout);

    setLayout(mainLayout);
    setProperty("_KDE_NET_WM_SKIP_SHADOW", true); // Prevent oxygen shadows - we're not really a Plasma::ToolTip so need to do this :-(
}

ToolTip::~ToolTip()
{
    delete d;
}

void ToolTip::showEvent(QShowEvent *e)
{
    checkSize();
    QWidget::showEvent(e);
    d->preview->setInfo();
}

void ToolTip::hideEvent(QHideEvent *e)
{
    QWidget::hideEvent(e);
    d->animation->stop();

    QObject *source = d->source.data();
    if (source && source->metaObject()->indexOfMethod("toolTipHidden()") != -1) {
        QMetaObject::invokeMethod(source, "toolTipHidden");
    }

    WindowEffects::highlightWindows(winId(), QList<WId>());
    d->hovered = false;
}

void ToolTip::mouseReleaseEvent(QMouseEvent *event)
{
    if (rect().contains(event->pos()) &&
            (!d->preview || !d->preview->geometry().contains(event->pos()))) {
        hide();
    }
}

void ToolTip::enterEvent(QEvent *)
{
    d->hovered = true;
    emit hovered(true);
}

void ToolTip::leaveEvent(QEvent *)
{
    d->hovered = false;
    emit hovered(false);
}

void ToolTip::checkSize()
{
    //FIXME: layout bugs even on qlayouts? oh, please, no.
    d->text->setMinimumSize(0, 0);
    d->text->setMaximumSize(QWIDGETSIZE_MAX, QWIDGETSIZE_MAX);
    d->text->setMinimumSize(d->text->minimumSizeHint());
    d->text->setMaximumSize(d->text->maximumSizeHint());

    adjustSize();
}

void ToolTip::adjustPosition(const QSize &previous, const QSize &current)
{
    if (previous != current) {
        //offsets to stop tooltips from jumping when they resize
        int deltaX = 0;
        int deltaY = 0;
        if (d->direction == Plasma::Up) {
            /*
            kDebug() << "resizing from" << current << "to" << hint
                     << "and moving from" << pos() << "to"
                     << x() << y() + (current.height() - hint.height())
                     << current.height() - hint.height();
                     */
            deltaY = previous.height() - current.height();
        } else if (d->direction == Plasma::Left) {
            /*
            kDebug() << "vertical resizing from" << current << "to" << hint
                     << "and moving from" << pos() << "to"
                     << x() + (current.width() - hint.width()) << y()
                     << current.width() - hint.width(); */
            deltaX = previous.width() - current.width();
        }

        // resize then move if we're getting smaller, vice versa when getting bigger
        // this prevents overlap with the item in the smaller case, and a repaint of
        // the tipped item when getting bigger

        move(x() + deltaX, y() + deltaY);
    }
}

void ToolTip::setContent(QObject *tipper, const ToolTipContent &data)
{
    QObject *source = d->source.data();
    if (source && source!=tipper && source->metaObject()->indexOfMethod("toolTipHidden()") != -1) {
        QMetaObject::invokeMethod(source, "toolTipHidden");
    }

    //reset our size
    if (data.mediaUpdate()) {
        d->playPause->setChecked("Playing" == data.playState());
        return;
    }

    if (data.windowsToPreview().size()) {
        d->text->setVisible(false);
        d->imageLabel->setVisible(false);
    } else {
        d->text->setVisible(true);
        d->imageLabel->setVisible(true);
        d->text->setContent(data);
        d->imageLabel->setPixmap(data.image());
    }

    if (!data.playState().isEmpty()) {
        d->prev->setVisible(true);
        d->playPause->setVisible(true);
        d->playPause->setChecked("Playing" == data.playState());
        d->next->setVisible(true);
    } else {
        d->prev->setVisible(false);
        d->playPause->setVisible(false);
        d->next->setVisible(false);
    }

    if (data.highlightWindows() && (data.windowsToPreview().size() > 1 || data.windowToPreview() != 0)) {
        WindowEffects::highlightWindows(winId(), QList<WId>() << winId() << data.windowsToPreview());
    }

    d->preview->setVertical(data.vertical());

    if (data.windowsToPreview().size() > 0) {
        d->preview->setWindows(data.windowDetailsToPreview());
    } else {
        d->preview->setWindows(QList<ToolTipContent::Window>());
    }

    d->preview->setHighlightWindows(data.highlightWindows());

    d->autohide = data.autohide();
    d->source = tipper;

    if (isVisible()) {
        d->preview->setInfo();
        //kDebug() << "about to check size";
        checkSize();
        if (d->hovered) {
            // Updating tooltip content causes ToolTipManager to restart its hide timer. But if we are visible, and hovered, then re-emit this...
            emit hovered(true);
        }
    }
}

void ToolTip::prepareShowing()
{
    if (!d->preview->isEmpty()) {
        // show/hide the preview area
        d->preview->show();
    } else {
        d->preview->hide();
    }

    layout()->activate();
    d->preview->setInfo();
    //kDebug() << "about to check size";
    checkSize();
}

void ToolTip::moveTo(const QPoint &to)
{
    if (!isVisible() ||
            !(KGlobalSettings::graphicEffectsLevel() & KGlobalSettings::SimpleAnimationEffects)) {
        move(to);
        return;
    }

    d->animation->stop();
    d->animation->setEndValue(to);
    d->animation->start();
}

void ToolTip::resizeEvent(QResizeEvent *e)
{
    QWidget::resizeEvent(e);
    d->background->resizeFrame(size());
    setMask(d->background->mask());
    d->preview->setInfo();

    if (isVisible()) {
        adjustPosition(e->oldSize(), e->size());
    }
}

void ToolTip::paintEvent(QPaintEvent *e)
{
    QPainter painter(this);
    painter.setRenderHint(QPainter::Antialiasing);
    painter.setClipRect(e->rect());
    painter.setCompositionMode(QPainter::CompositionMode_Source);
    painter.fillRect(rect(), Qt::transparent);

    d->background->paintFrame(&painter);
}

bool ToolTip::autohide() const
{
    return d->autohide;
}

void ToolTip::setDirection(Plasma::Direction direction)
{
    d->direction = direction;
}

void ToolTip::linkActivated(const QString &anchor, QMouseEvent *event)
{
    emit linkActivated(anchor, event->buttons(), event->modifiers(), event->globalPos());
}

void ToolTip::buttonPressed(MediaButton *btn)
{
    if (btn == d->prev) {
        emit mediaButtonPressed(ToolTipManager::MB_PREV);
    } else if (btn == d->playPause) {
        emit mediaButtonPressed(ToolTipManager::MB_PLAY_PAUSE);
    } else if (btn == d->next) {
        emit mediaButtonPressed(ToolTipManager::MB_NEXT);
    }
}

void ToolTip::updateTheme()
{
    const int topHeight = d->background->marginSize(Plasma::TopMargin);
    const int leftWidth = d->background->marginSize(Plasma::LeftMargin);
    const int rightWidth = d->background->marginSize(Plasma::RightMargin);
    const int bottomHeight = d->background->marginSize(Plasma::BottomMargin);
    setContentsMargins(leftWidth, topHeight, rightWidth, bottomHeight);

    // Make the tooltip use Plasma's colorscheme
    QColor textColor = Plasma::Theme::defaultTheme()->color(Plasma::Theme::TextColor);
    QPalette plasmaPalette = QPalette();
    plasmaPalette.setColor(QPalette::Window,
                           Plasma::Theme::defaultTheme()->color(Plasma::Theme::BackgroundColor));
    plasmaPalette.setColor(QPalette::WindowText, textColor);
    setAutoFillBackground(true);
    setPalette(plasmaPalette);
    update();
}

} // namespace Plasma

#include "moc_tooltip_p.cpp"