KisFloatingMessage Class Reference

The KisFloatingMessage class shows the given message in a semi-transparent bubble that doesn't take focus and slowly fades away. More...

#include <kis_floating_message.h>

Inheritance diagram for KisFloatingMessage:

Public Types
enum	Priority { High = 0 , Medium , Low }

Public Slots
void	removeMessage ()
void	showMessage ()

Public Member Functions
	KisFloatingMessage (const QString &message, QWidget *parent, bool showOverParent, int timeout, Priority priority, int alignment=Qt::AlignCenter|Qt::TextWordWrap)
void	setIcon (const QIcon &icon)
void	setShowOverParent (bool show)
	Show message above parent widget instead of screen.
void	tryOverrideMessage (const QString message, const QIcon &icon, int timeout, KisFloatingMessage::Priority priority, int alignment=Qt::AlignCenter|Qt::TextWordWrap)

Private Slots
void	startFade ()
void	updateOpacity (int value)
void	widgetDeleted ()

Private Member Functions
QRect	determineMetrics (const int M)

Private Attributes
int	m_alignment {0}
QTimeLine	m_fadeTimeLine
QImage	m_icon
QLabel *	m_iconLabel {nullptr}
int	m_m {0}
QString	m_message
QLabel *	m_messageLabel {nullptr}
Priority	m_priority
QPixmap	m_scaledIcon
bool	m_showOverParent {false}
int	m_timeout {0}
QTimer	m_timer
bool	widgetQueuedForDeletion {false}

Detailed Description

The KisFloatingMessage class shows the given message in a semi-transparent bubble that doesn't take focus and slowly fades away.

Heavily based on Amarok's Osd.cpp

Definition at line 33 of file kis_floating_message.h.

Member Enumeration Documentation

Priority

enum KisFloatingMessage::Priority

Enumerator
High
Medium
Low

Definition at line 38 of file kis_floating_message.h.

                  {
        High = 0,
        Medium,
        Low
    };

Constructor & Destructor Documentation

KisFloatingMessage()

KisFloatingMessage::KisFloatingMessage ( const QString & message, QWidget * parent, bool showOverParent, int timeout, Priority priority, int alignment = Qt::AlignCenter | Qt::TextWordWrap )

explicit

Definition at line 53 of file kis_floating_message.cpp.

    : QWidget(parent)
    , m_message(message)
    , m_showOverParent(showOverParent)
    , m_timeout(timeout)
    , m_priority(priority)
    , m_alignment(alignment)
{
    m_icon = KisIconUtils::loadIcon("krita-branding").pixmap(256, 256).toImage();
 
    setWindowFlags(Qt::FramelessWindowHint | Qt::ToolTip | Qt::WindowTransparentForInput);
    setFocusPolicy(Qt::NoFocus);
    setAttribute(Qt::WA_ShowWithoutActivating);
 
    m_messageLabel = new QLabel(message, this);
    m_messageLabel->setAttribute(Qt::WA_TranslucentBackground);
    m_iconLabel = new QLabel(this);
    m_iconLabel->setAttribute(Qt::WA_TranslucentBackground);
    {
        int h, s, v;
        palette().color( QPalette::Normal, QPalette::WindowText ).getHsv( &h, &s, &v );
        const QColor shadowColor = v > 128 ? Qt::black : Qt::white;
        addDropShadow(m_messageLabel, shadowColor);
        addDropShadow(m_iconLabel, shadowColor);
    }
 
    m_timer.setSingleShot( true );
    connect(&m_timer, SIGNAL(timeout()), SLOT(startFade()));
    connect(this, SIGNAL(destroyed()), SLOT(widgetDeleted()));
}

References addDropShadow(), connect(), KisIconUtils::loadIcon(), m_icon, m_iconLabel, m_messageLabel, m_timer, palette, startFade(), v, and widgetDeleted().

Member Function Documentation

determineMetrics()

QRect KisFloatingMessage::determineMetrics ( const int M )

private

Definition at line 150 of file kis_floating_message.cpp.

{
    m_m = M;
 
    const QSize minImageSize = m_icon.size().boundedTo(QSize(100, 100));
 
    // determine a sensible maximum size, don't cover the whole desktop or cross the screen
    const QSize margin( (M + MARGIN) * 2, (M + MARGIN) * 2); //margins
    const QSize image = m_icon.isNull() ? QSize(0, 0) : minImageSize;
    QRect geom = parentWidget()->geometry();
    QPoint p(geom.width() / 2 + geom.left(), geom.height() / 2 + geom.top());
    QScreen *s = qApp->screenAt(p);
    QSize max;
    if (s) {
        max = QSize(s->availableGeometry().size() - margin);
    }
    else {
        max = QSize(1024, 768);
    }
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
    // If we don't do that, the boundingRect() might not be suitable for drawText() (Qt issue N67674)
    m_message.replace(QRegExp( " +\n"), "\n");
    // remove consecutive line breaks
    m_message.replace(QRegExp( "\n+"), "\n");
#else
    // If we don't do that, the boundingRect() might not be suitable for drawText() (Qt issue N67674)
    QRegExp r(" +\n");
    r.replaceIn(m_message, "\n");
 
     // remove consecutive line breaks
    QRegExp r2(( "\n+"));
    r2.replaceIn(m_message, "\n");
#endif
 
    // The osd cannot be larger than the screen
    QRect rect = fontMetrics().boundingRect(0, 0, max.width() - image.width(), max.height(),
           m_alignment, m_message);
 
    if (!m_icon.isNull()) {
        const int availableWidth = max.width() - rect.width() - M; //WILL be >= (minImageSize.width() - M)
 
        m_scaledIcon = QPixmap::fromImage(m_icon.scaled(qMin(availableWidth, m_icon.width()),
                                                        qMin( rect.height(), m_icon.height()),
                                                        Qt::KeepAspectRatio, Qt::SmoothTransformation));
 
        const int widthIncludingImage = rect.width() + m_scaledIcon.width() + M; //margin between text + image
        rect.setWidth( widthIncludingImage );
    }
 
    // expand in all directions by 2*M
    //
    // take care with this rect, because it must be *bigger*
    // than the rect we paint the message in
    rect = kisGrowRect(rect, 2 * M);
 
 
 
    const QSize newSize = rect.size();
    QRect screen;
    if (s) {
        screen = s->availableGeometry();
    }
    else {
        screen = QRect(0, 0, 1024, 768);
    }
 
    QPoint newPos(MARGIN, MARGIN);
 
    if (parentWidget() && m_showOverParent) {
        screen = parentWidget()->geometry();
        screen.setTopLeft(parentWidget()->mapToGlobal(QPoint(MARGIN, MARGIN + 50)));
        newPos = screen.topLeft();
    }
    else {
        // move to the right
        newPos.rx() = screen.width() - MARGIN - newSize.width();
 
        //ensure we don't dip below the screen
        if (newPos.y() + newSize.height() > screen.height() - MARGIN) {
            newPos.ry() = screen.height() - MARGIN - newSize.height();
        }
        // correct for screen position
        newPos += screen.topLeft();
 
        if (parentWidget()) {
            // Move a bit to the left as there could be a scrollbar
            newPos.setX(newPos.x() - MARGIN);
        }
    }
 
    QRect rc(newPos, rect.size());
 
    return rc;
}

References kisGrowRect(), m_alignment, m_icon, m_m, m_message, m_scaledIcon, m_showOverParent, MARGIN, p, and r2.

removeMessage

void KisFloatingMessage::removeMessage ( )

slot

Definition at line 256 of file kis_floating_message.cpp.

{
    m_timer.stop();
    m_fadeTimeLine.stop();
    widgetQueuedForDeletion = true;
 
    hide();
    deleteLater();
}

References m_fadeTimeLine, m_timer, and widgetQueuedForDeletion.

setIcon()

void KisFloatingMessage::setIcon

(

const QIcon &

icon

)

Definition at line 143 of file kis_floating_message.cpp.

{
    m_icon = icon.pixmap(256, 256).toImage();
}

References m_icon.

setShowOverParent()

void KisFloatingMessage::setShowOverParent

(

bool

show

)

Show message above parent widget instead of screen.

Definition at line 138 of file kis_floating_message.cpp.

{
    m_showOverParent = show;
}

References m_showOverParent.

showMessage

void KisFloatingMessage::showMessage ( )

slot

Definition at line 104 of file kis_floating_message.cpp.

{
    if (widgetQueuedForDeletion) return;
 
    m_messageLabel->setAlignment(flagsToAlignmentFlags(m_alignment));
    m_messageLabel->setWordWrap(m_alignment & Qt::TextWordWrap);
    m_messageLabel->adjustSize();
 
    QRect geom = determineMetrics(fontMetrics().horizontalAdvance('x'));
    setGeometry(geom);
    setWindowOpacity(OSD_WINDOW_OPACITY);
 
    QRect rect(QPoint(), geom.size());
    rect.adjust(m_m, m_m, -m_m, -m_m);
    if (!m_icon.isNull()) {
        QRect r(rect);
        r.setTop((size().height() - m_scaledIcon.height() ) / 2);
        r.setSize(m_scaledIcon.size());
        m_iconLabel->setPixmap(m_scaledIcon);
        m_iconLabel->setFixedSize(r.size());
        m_iconLabel->move(r.topLeft());
        m_iconLabel->show();
        rect.setLeft(rect.left() + m_scaledIcon.width() + m_m);
    } else {
        m_iconLabel->hide();
    }
    m_messageLabel->setFixedSize(rect.size());
    m_messageLabel->move(rect.topLeft());
 
    QWidget::setVisible(true);
    m_fadeTimeLine.stop();
    m_timer.start(m_timeout);
}

References determineMetrics(), flagsToAlignmentFlags(), m_alignment, m_fadeTimeLine, m_icon, m_iconLabel, m_m, m_messageLabel, m_scaledIcon, m_timeout, m_timer, OSD_WINDOW_OPACITY, and widgetQueuedForDeletion.

startFade

void KisFloatingMessage::startFade ( )

privateslot

Definition at line 245 of file kis_floating_message.cpp.

{
    m_fadeTimeLine.setDuration(500);
    m_fadeTimeLine.setEasingCurve(QEasingCurve::InCurve);
    m_fadeTimeLine.setLoopCount(1);
    m_fadeTimeLine.setFrameRange(0, 10);
    connect(&m_fadeTimeLine, SIGNAL(finished()), SLOT(removeMessage()));
    connect(&m_fadeTimeLine, SIGNAL(frameChanged(int)), SLOT(updateOpacity(int)));
    m_fadeTimeLine.start();
}

References connect(), m_fadeTimeLine, removeMessage(), and updateOpacity().

tryOverrideMessage()

void KisFloatingMessage::tryOverrideMessage	(	const QString	message,
		const QIcon &	icon,
		int	timeout,
		KisFloatingMessage::Priority	priority,
		int	alignment = Qt::AlignCenter | Qt::TextWordWrap )

Definition at line 84 of file kis_floating_message.cpp.

{
#ifndef Q_OS_HAIKU
    if ((int)priority > (int)m_priority) return;
 
    m_message = message;
    m_messageLabel->setText(message);
    setIcon(icon);
    m_timeout = timeout;
    m_priority = priority;
    m_alignment = alignment;
    showMessage();
    update();
#endif
}

References m_alignment, m_message, m_messageLabel, m_priority, m_timeout, setIcon(), and showMessage().

updateOpacity

void KisFloatingMessage::updateOpacity ( int value )

privateslot

Definition at line 266 of file kis_floating_message.cpp.

{
    setWindowOpacity(OSD_WINDOW_OPACITY / 10.0 * (10 - value));
}

References OSD_WINDOW_OPACITY, and value().

widgetDeleted

void KisFloatingMessage::widgetDeleted ( )

privateslot

Definition at line 271 of file kis_floating_message.cpp.

{
    widgetQueuedForDeletion = false;
}

References widgetQueuedForDeletion.

Member Data Documentation

m_alignment

int KisFloatingMessage::m_alignment {0}

private

Definition at line 79 of file kis_floating_message.h.

{0};

m_fadeTimeLine

QTimeLine KisFloatingMessage::m_fadeTimeLine

private

Definition at line 75 of file kis_floating_message.h.

m_icon

QImage KisFloatingMessage::m_icon

private

Definition at line 71 of file kis_floating_message.h.

m_iconLabel

QLabel* KisFloatingMessage::m_iconLabel {nullptr}

private

Definition at line 82 of file kis_floating_message.h.

{nullptr};

m_m

int KisFloatingMessage::m_m {0}

private

Definition at line 74 of file kis_floating_message.h.

{0};

m_message

QString KisFloatingMessage::m_message

private

Definition at line 70 of file kis_floating_message.h.

m_messageLabel

QLabel* KisFloatingMessage::m_messageLabel {nullptr}

private

Definition at line 81 of file kis_floating_message.h.

{nullptr};

m_priority

Priority KisFloatingMessage::m_priority

private

Definition at line 78 of file kis_floating_message.h.

m_scaledIcon

QPixmap KisFloatingMessage::m_scaledIcon

private

Definition at line 72 of file kis_floating_message.h.

m_showOverParent

bool KisFloatingMessage::m_showOverParent {false}

private

Definition at line 76 of file kis_floating_message.h.

{false};

m_timeout

int KisFloatingMessage::m_timeout {0}

private

Definition at line 77 of file kis_floating_message.h.

{0};

m_timer

QTimer KisFloatingMessage::m_timer

private

Definition at line 73 of file kis_floating_message.h.

widgetQueuedForDeletion

bool KisFloatingMessage::widgetQueuedForDeletion {false}

private

Definition at line 80 of file kis_floating_message.h.

{false};

---

The documentation for this class was generated from the following files:

• libs/ui/widgets/kis_floating_message.h
• libs/ui/widgets/kis_floating_message.cpp