1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
|
/*
SPDX-FileCopyrightText: 2012 Dominik Haumann <dhaumann@kde.org>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#include "messagewidget.h"
// lib
#include "message.h"
// KF
#include <KMessageWidget>
// Qt
#include <QTimer>
#include <QToolTip>
#include <QVBoxLayout>
namespace Sublime {
constexpr int s_defaultAutoHideTime = 6 * 1000;
// the enums values do not necessarily match, hence translate case-by-case
KMessageWidget::MessageType kMessageWidgetMessageType(Message::MessageType messageType)
{
return
messageType == Message::Positive ? KMessageWidget::Positive :
messageType == Message::Information ? KMessageWidget::Information :
messageType == Message::Warning ? KMessageWidget::Warning :
messageType == Message::Error ? KMessageWidget::Error :
/* else */ KMessageWidget::Information;
}
MessageWidget::MessageWidget(QWidget* parent)
: QWidget(parent)
, m_autoHideTimer(new QTimer(this))
{
auto* l = new QVBoxLayout();
l->setContentsMargins(0, 0, 0, 0);
m_messageWidget = new KMessageWidget(this);
m_messageWidget->setCloseButtonVisible(false);
l->addWidget(m_messageWidget);
setLayout(l);
// tell the widget to always use the minimum size.
setSizePolicy(QSizePolicy::Preferred, QSizePolicy::Minimum);
// by default, hide widgets
m_messageWidget->hide();
hide();
// setup autoHide timer details
m_autoHideTimer->setSingleShot(true);
connect(m_messageWidget, &KMessageWidget::hideAnimationFinished,
this, &MessageWidget::showNextMessage);
connect(m_messageWidget, &KMessageWidget::linkHovered,
this, &MessageWidget::linkHovered);
}
void MessageWidget::showNextMessage()
{
// at this point, we should not have a currently shown message
Q_ASSERT(!m_currentMessage);
// if not message to show, just stop
if (m_messageQueue.isEmpty()) {
hide();
return;
}
// track current message
m_currentMessage = m_messageQueue[0];
// set text etc.
m_messageWidget->setText(m_currentMessage->text());
m_messageWidget->setIcon(m_currentMessage->icon());
// connect textChanged() and iconChanged(), so it's possible to change this on the fly
connect(m_currentMessage, &Message::textChanged,
m_messageWidget, &KMessageWidget::setText, Qt::UniqueConnection);
connect(m_currentMessage, &Message::iconChanged,
m_messageWidget, &KMessageWidget::setIcon, Qt::UniqueConnection);
const KMessageWidget::MessageType widgetMessageType =
kMessageWidgetMessageType(m_currentMessage->messageType());
m_messageWidget->setMessageType(widgetMessageType);
// remove all actions from the message widget
const auto messageWidgetActions = m_messageWidget->actions();
for (QAction* action : messageWidgetActions) {
m_messageWidget->removeAction(action);
}
// add new actions to the message widget
const auto m_currentMessageActions = m_currentMessage->actions();
for (QAction* action : m_currentMessageActions) {
m_messageWidget->addAction(action);
}
// set word wrap of the message
setWordWrap(m_currentMessage);
// setup auto-hide timer, and start if requested
m_autoHideTime = m_currentMessage->autoHide();
m_autoHideTimer->stop();
if (m_autoHideTime >= 0) {
connect(m_autoHideTimer, &QTimer::timeout,
m_currentMessage, &Message::deleteLater, Qt::UniqueConnection);
m_autoHideTimer->start(m_autoHideTime == 0 ? s_defaultAutoHideTime : m_autoHideTime);
}
// finally show
show();
// NOTE: use a singleShot timer to avoid resizing issues when showing the message widget the first time (bug #316666)
QTimer::singleShot(0, m_messageWidget, &KMessageWidget::animatedShow);
}
void MessageWidget::setWordWrap(Message* message)
{
// want word wrap anyway? -> ok
if (message->wordWrap()) {
m_messageWidget->setWordWrap(message->wordWrap());
return;
}
// word wrap not wanted, that's ok if a parent widget does not exist
if (!parentWidget()) {
m_messageWidget->setWordWrap(false);
return;
}
// word wrap not wanted -> enable word wrap if it breaks the layout otherwise
int margin = 0;
if (parentWidget()->layout()) {
// get left/right margin of the layout, since we need to subtract these
int leftMargin = 0, rightMargin = 0;
parentWidget()->layout()->getContentsMargins(&leftMargin, nullptr, &rightMargin, nullptr);
margin = leftMargin + rightMargin;
}
// if word wrap enabled, first disable it
if (m_messageWidget->wordWrap()) {
m_messageWidget->setWordWrap(false);
}
// make sure the widget's size is up-to-date in its hidden state
m_messageWidget->ensurePolished();
m_messageWidget->adjustSize();
// finally enable word wrap, if there is not enough free horizontal space
const int freeSpace = (parentWidget()->width() - margin) - m_messageWidget->width();
if (freeSpace < 0) {
// qCDebug(LOG_KTE) << "force word wrap to avoid breaking the layout" << freeSpace;
m_messageWidget->setWordWrap(true);
}
}
void MessageWidget::postMessage(Message* message, const QVector<QSharedPointer<QAction>>& actions)
{
Q_ASSERT(!m_messageHash.contains(message));
m_messageHash.insert(message, actions);
// insert message sorted after priority
int i = 0;
for (; i < m_messageQueue.count(); ++i) {
if (message->priority() > m_messageQueue[i]->priority()) {
break;
}
}
// queue message
m_messageQueue.insert(i, message);
// catch if the message gets deleted
connect(message, &Message::closed,
this, &MessageWidget::messageDestroyed);
if (i == 0 && !m_messageWidget->isHideAnimationRunning()) {
// if message has higher priority than the one currently shown,
// then hide the current one and then show the new one.
if (m_currentMessage) {
// autoHide timer may be running for currently shown message, therefore
// simply disconnect autoHide timer to all timeout() receivers
disconnect(m_autoHideTimer, SIGNAL(timeout()), nullptr, nullptr);
m_autoHideTimer->stop();
// if there is a current message, the message queue must contain 2 messages
Q_ASSERT(m_messageQueue.size() > 1);
Q_ASSERT(m_currentMessage == m_messageQueue[1]);
// a bit unnice: disconnect textChanged() and iconChanged() signals of previously visible message
disconnect(m_currentMessage, &Message::textChanged,
m_messageWidget, &KMessageWidget::setText);
disconnect(m_currentMessage, &Message::iconChanged,
m_messageWidget, &KMessageWidget::setIcon);
m_currentMessage = nullptr;
m_messageWidget->animatedHide();
} else {
showNextMessage();
}
}
}
void MessageWidget::messageDestroyed(Message* message)
{
// last moment when message is valid, since KTE::Message is already in
// destructor we have to do the following:
// 1. remove message from m_messageQueue, so we don't care about it anymore
// 2. activate hide animation or show a new message()
// remove widget from m_messageQueue
int i = 0;
for (; i < m_messageQueue.count(); ++i) {
if (m_messageQueue[i] == message) {
break;
}
}
// the message must be in the list
Q_ASSERT(i < m_messageQueue.count());
// remove message
m_messageQueue.removeAt(i);
// remove message from hash -> release QActions
Q_ASSERT(m_messageHash.contains(message));
m_messageHash.remove(message);
// if deleted message is the current message, launch hide animation
if (message == m_currentMessage) {
m_currentMessage = nullptr;
m_messageWidget->animatedHide();
}
}
void MessageWidget::startAutoHideTimer()
{
// message does not want autohide, or timer already running
if (!m_currentMessage // no message, nothing to do
|| m_autoHideTime < 0 // message does not want auto-hide
|| m_autoHideTimer->isActive() // auto-hide timer is already active
|| m_messageWidget->isHideAnimationRunning() // widget is in hide animation phase
|| m_messageWidget->isShowAnimationRunning() // widget is in show animation phase
) {
return;
}
// safety checks: the message must still be valid
Q_ASSERT(m_messageQueue.size());
Q_ASSERT(m_currentMessage->autoHide() == m_autoHideTime);
// start autoHide timer as requested
m_autoHideTimer->start(m_autoHideTime == 0 ? s_defaultAutoHideTime : m_autoHideTime);
}
void MessageWidget::linkHovered(const QString &link)
{
QToolTip::showText(QCursor::pos(), link, m_messageWidget);
}
QString MessageWidget::text() const
{
return m_messageWidget->text();
}
}
|