kdelibs/kdeui/widgets/kmessagewidget.cpp

/*
    This file is part of the KDE libraries
    Copyright (C) 2024 Ivailo Monev <xakepa10@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 version 2, as published by the Free Software Foundation.

    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.
*/

#include "kmessagewidget.h"
#include "klocale.h"
#include "kaction.h"
#include "kicon.h"
#include "kiconloader.h"
#include "kcolorscheme.h"
#include "kpixmapwidget.h"
#include "kdebug.h"

#include <QHBoxLayout>
#include <QLabel>
#include <QToolButton>
#include <QPainter>
#include <QPen>

static const qreal s_roundness = 4;
static const qreal s_bordersize = 0.6;
static const qreal s_margin = 4;

class KMessageLabel : public QLabel
{
    Q_OBJECT
public:
    KMessageLabel(QWidget *parent);

    QColor bg;
    QColor border;

protected:
    void paintEvent(QPaintEvent *event) final;
};

KMessageLabel::KMessageLabel(QWidget *parent)
    : QLabel(parent)
{
    setContentsMargins(s_margin, s_margin, s_margin, s_margin);
}

void KMessageLabel::paintEvent(QPaintEvent *event)
{
    QPainter painter(this);
    painter.setRenderHint(QPainter::Antialiasing);
    QPen borderpen(border);
    borderpen.setWidth(s_bordersize * 2);
    painter.setPen(borderpen);
    QRectF widgetrect = rect();
    painter.drawRoundedRect(widgetrect, s_roundness, s_roundness, Qt::AbsoluteSize);
    painter.setBrush(bg);
    widgetrect = widgetrect.adjusted(s_bordersize, s_bordersize, -s_bordersize, -s_bordersize);
    painter.drawRoundedRect(widgetrect, s_roundness, s_roundness, Qt::AbsoluteSize);
    QLabel::paintEvent(event);
}

//---------------------------------------------------------------------
// KMessageWidgetPrivate
//---------------------------------------------------------------------
class KMessageWidgetPrivate
{
public:
    KMessageWidgetPrivate(KMessageWidget *messagewidget);
    ~KMessageWidgetPrivate();

    void updateColors();
    void updateLayout();

    KMessageWidget* messagewidget;
    QVBoxLayout* mainlayout;
    QHBoxLayout* messagelayout;
    KPixmapWidget* iconwidget;
    KMessageLabel* textlabel;
    QToolButton* closebutton;
    QIcon icon;
    KMessageWidget::MessageType messagetype;
    QHBoxLayout* buttonslayout;
    QList<QToolButton*> buttons;
};

KMessageWidgetPrivate::KMessageWidgetPrivate(KMessageWidget *_messagewidget)
    : messagewidget(_messagewidget),
    mainlayout(nullptr),
    messagelayout(nullptr),
    iconwidget(nullptr),
    textlabel(nullptr),
    closebutton(nullptr),
    messagetype(KMessageWidget::Information),
    buttonslayout(nullptr)
{
}

KMessageWidgetPrivate::~KMessageWidgetPrivate()
{
    qDeleteAll(buttons);
    buttons.clear();
    delete buttonslayout;
    delete iconwidget;
    delete textlabel;
    delete closebutton;
    delete messagelayout;
}

void KMessageWidgetPrivate::updateColors()
{
    const KColorScheme scheme(QPalette::Active, KColorScheme::Window);
    switch (messagetype) {
        case KMessageWidget::Information: {
            // even tho the selection color may be more suitable for that there is KColorScheme
            // background type for it
            textlabel->bg = scheme.background(KColorScheme::PositiveBackground).color();
            break;
        }
        case KMessageWidget::Warning: {
            textlabel->bg = scheme.background(KColorScheme::NeutralBackground).color();
            break;
        }
        case KMessageWidget::Error: {
            textlabel->bg = scheme.background(KColorScheme::NegativeBackground).color();
            break;
        }
    }
    textlabel->border = KColorScheme::shade(textlabel->bg, KColorScheme::DarkShade);
}

void KMessageWidgetPrivate::updateLayout()
{
    qDeleteAll(buttons);
    buttons.clear();
    delete buttonslayout;
    buttonslayout = new QHBoxLayout();
    mainlayout->addLayout(buttonslayout);
    buttonslayout->addStretch();
    foreach (QAction* action, messagewidget->actions()) {
        QToolButton* button = new QToolButton(messagewidget);
        button->setDefaultAction(action);
        button->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
        buttons.append(button);
        buttonslayout->addWidget(button, 1, Qt::AlignCenter);
    }
    if (!textlabel->wordWrap()) {
        messagelayout->removeWidget(closebutton);
        buttonslayout->addWidget(closebutton, 1, Qt::AlignCenter);
    } else {
        buttonslayout->removeWidget(closebutton);
        messagelayout->addWidget(closebutton);
    }
    buttonslayout->addStretch();
}

//---------------------------------------------------------------------
// KMessageWidget
//---------------------------------------------------------------------
KMessageWidget::KMessageWidget(QWidget *parent)
    : QWidget(parent),
    d(new KMessageWidgetPrivate(this))
{
    setSizePolicy(QSizePolicy::MinimumExpanding, QSizePolicy::Minimum);

    d->mainlayout = new QVBoxLayout(this);
    setLayout(d->mainlayout);

    d->messagelayout = new QHBoxLayout();

    d->iconwidget = new KPixmapWidget(this);
    d->iconwidget->setSizePolicy(QSizePolicy::Fixed, QSizePolicy::Fixed);
    d->iconwidget->hide();
    d->messagelayout->addWidget(d->iconwidget);

    d->textlabel = new KMessageLabel(this);
    d->textlabel->setSizePolicy(QSizePolicy::MinimumExpanding, QSizePolicy::Minimum);
    d->textlabel->setOpenExternalLinks(true);
    d->textlabel->setTextInteractionFlags(Qt::LinksAccessibleByMouse);
    d->textlabel->setAlignment(Qt::AlignCenter);
    connect(d->textlabel, SIGNAL(linkActivated(QString)), this, SIGNAL(linkActivated(QString)));
    connect(d->textlabel, SIGNAL(linkHovered(QString)), this, SIGNAL(linkHovered(QString)));
    d->messagelayout->addWidget(d->textlabel);
    d->mainlayout->addLayout(d->messagelayout);

    // NOTE: the standard close action tooltip refers to document, this is not one
    d->closebutton = new QToolButton(this);
    d->closebutton->setText(i18n("&Close"));
    d->closebutton->setIcon(KIcon("window-close"));
    d->closebutton->setToolTip(i18n("Close message"));
    d->closebutton->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
    connect(d->closebutton, SIGNAL(clicked()), this, SLOT(hide()));

    d->updateColors();
    d->updateLayout();
}

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

QString KMessageWidget::text() const
{
    return d->textlabel->text();
}

void KMessageWidget::setText(const QString& text)
{
    d->textlabel->setText(text);
}

KMessageWidget::MessageType KMessageWidget::messageType() const
{
    return d->messagetype;
}

void KMessageWidget::setMessageType(KMessageWidget::MessageType type)
{
    d->messagetype = type;
    d->updateColors();
    update();
}

bool KMessageWidget::wordWrap() const
{
    return d->textlabel->wordWrap();
}

void KMessageWidget::setWordWrap(bool wordWrap)
{
    d->textlabel->setWordWrap(wordWrap);
    d->updateLayout();
}

bool KMessageWidget::isCloseButtonVisible() const
{
    return d->closebutton->isVisible();
}

void KMessageWidget::setCloseButtonVisible(bool show)
{
    d->closebutton->setVisible(show);
}

QIcon KMessageWidget::icon() const
{
    return d->icon;
}

void KMessageWidget::setIcon(const QIcon& icon)
{
    d->icon = icon;
    if (d->icon.isNull()) {
        d->iconwidget->hide();
    } else {
        const int size = KIconLoader::global()->currentSize(KIconLoader::MainToolbar);
        d->iconwidget->setPixmap(d->icon.pixmap(size));
        d->iconwidget->show();
    }
}

bool KMessageWidget::event(QEvent *event)
{
    const bool result = QWidget::event(event);
    switch (event->type()) {
        case QEvent::PaletteChange: {
            d->updateColors();
            update();
            break;
        }
        case QEvent::ActionChanged:
        case QEvent::ActionAdded:
        case QEvent::ActionRemoved: {
            d->updateLayout();
            break;
        }
        default: {
            break;
        }
    }
    return result;
}

#include "moc_kmessagewidget.cpp"
#include "kmessagewidget.moc"