From: Shane Synan Date: Thu, 18 Feb 2016 01:44:18 +0000 (-0600) Subject: Update channel/nick/query tooltips to new-style X-Git-Tag: travis-deploy-test~481 X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=commitdiff_plain;h=b60e07cf184dc374b135489c4d5ec7db1e5f3651;hp=60d19a8ddad9f989f4fa03ba66c47e3d7bb66df1 Update channel/nick/query tooltips to new-style Modify channel, network, query and nick tooltips to use a clean, consistent style with more padding, trading efficiency for readability. This significantly helps for tooltips with lots of information. Unify HTML escaping, reducing some clutter of '#if QT_VERSION'. Fix crashes and weird formatting by escaping HTML where reasonable, such as nick ident information. In titles, spaces are replaced with non-breaking spaces to avoid line-wrapping. Expands upon a2e0951abbe2d545836fb25fd6010aa085f17d82 Thanks to https://github.com/Scheirle for the first version! --- diff --git a/src/client/networkmodel.cpp b/src/client/networkmodel.cpp index a1d8b49d..d6bd9f48 100644 --- a/src/client/networkmodel.cpp +++ b/src/client/networkmodel.cpp @@ -74,6 +74,18 @@ QVariant NetworkItem::data(int column, int role) const } } +QString NetworkItem::escapeHTML(const QString &string, bool useNonbreakingSpaces) +{ + // QString.replace() doesn't guarentee the source string will remain constant. + // Use a local variable to avoid compiler errors. +#if QT_VERSION < 0x050000 + QString formattedString = Qt::escape(string); +#else + QString formattedString = string.toHtmlEscaped(); +#endif + return (useNonbreakingSpaces ? formattedString.replace(" ", " ") : formattedString); +} + // FIXME shouldn't we check the bufferItemCache here? BufferItem *NetworkItem::findBufferItem(BufferId bufferId) @@ -210,21 +222,28 @@ void NetworkItem::setCurrentServer(const QString &serverName) QString NetworkItem::toolTip(int column) const { Q_UNUSED(column); + QString strTooltip; + QTextStream tooltip( &strTooltip, QIODevice::WriteOnly ); + tooltip << ""; -#if QT_VERSION < 0x050000 - QStringList toolTip(QString("%1").arg(Qt::escape(networkName()))); - toolTip.append(tr("Server: %1").arg(Qt::escape(currentServer()))); -#else - QStringList toolTip(QString("%1").arg(networkName().toHtmlEscaped())); - toolTip.append(tr("Server: %1").arg(currentServer().toHtmlEscaped())); -#endif - toolTip.append(tr("Users: %1").arg(nickCount())); + // Function to add a row to the tooltip table + auto addRow = [&](const QString& key, const QString& value, bool condition) { + if (condition) { + tooltip << "" << key << "" << value << ""; + } + }; - if (_network) { - toolTip.append(tr("Lag: %1 msecs").arg(_network->latency())); - } + tooltip << "

" << NetworkItem::escapeHTML(networkName(), true) << "

"; + tooltip << ""; + addRow(tr("Server"), NetworkItem::escapeHTML(currentServer(), true), true); - return QString("

%1

").arg(toolTip.join("
")); + addRow(tr("Users"), QString::number(nickCount()), true); + + if (_network) + addRow(tr("Lag"), NetworkItem::escapeHTML(tr("%1 msecs").arg(_network->latency()), true), true); + + tooltip << "
"; + return strTooltip; } @@ -498,36 +517,81 @@ QString QueryBufferItem::toolTip(int column) const { // pretty much code duplication of IrcUserItem::toolTip() but inheritance won't solve this... Q_UNUSED(column); - QStringList toolTip; + QString strTooltip; + QTextStream tooltip( &strTooltip, QIODevice::WriteOnly ); + tooltip << "" + << ""; + + // Keep track of whether or not information has been added + bool infoAdded = false; + + // Use bufferName() for QueryBufferItem, nickName() for IrcUserItem + tooltip << "

"; + tooltip << tr("Query with %1").arg(NetworkItem::escapeHTML(bufferName(), true)); + if (!_ircUser) { + // User seems to be offline, let the no information message be added below + tooltip << "

"; + } else { + // Function to add a row to the tooltip table + auto addRow = [&](const QString& key, const QString& value, bool condition) { + if (condition) { + tooltip << "" << key << "" << value << ""; + infoAdded = true; + } + }; - toolTip.append(tr("Query with %1").arg(bufferName())); + // User information is available + if (_ircUser->userModes() != "") { + //TODO Translate user Modes and add them to the table below and in IrcUserItem::toolTip + tooltip << " (" << _ircUser->userModes() << ")"; + } + tooltip << "

"; - if (_ircUser) { - if (_ircUser->userModes() != "") toolTip[0].append(QString(" (+%1)").arg(_ircUser->userModes())); + tooltip << ""; if (_ircUser->isAway()) { - toolTip[0].append(QString(" (away%1)").arg(!_ircUser->awayMessage().isEmpty() ? (QString(" ") + _ircUser->awayMessage()) : QString())); + QString awayMessage(tr("(unknown)")); + if(!_ircUser->awayMessage().isEmpty()) { + awayMessage = _ircUser->awayMessage(); + } + addRow(NetworkItem::escapeHTML(tr("Away message"), true), NetworkItem::escapeHTML(awayMessage), true); } - if (!_ircUser->realName().isEmpty()) toolTip.append(_ircUser->realName()); - if (!_ircUser->ircOperator().isEmpty()) toolTip.append(QString("%1 %2").arg(_ircUser->nick()).arg(_ircUser->ircOperator())); - if (!_ircUser->suserHost().isEmpty()) toolTip.append(_ircUser->suserHost()); - if (!_ircUser->whoisServiceReply().isEmpty()) toolTip.append(_ircUser->whoisServiceReply()); - - toolTip.append(_ircUser->hostmask().remove(0, _ircUser->hostmask().indexOf("!")+1)); + addRow(tr("Realname"), + NetworkItem::escapeHTML(_ircUser->realName()), + !_ircUser->realName().isEmpty()); + addRow(NetworkItem::escapeHTML(tr("Suser Host"), true), + NetworkItem::escapeHTML(_ircUser->suserHost()), + !_ircUser->suserHost().isEmpty()); + addRow(NetworkItem::escapeHTML(tr("Whois Service Reply"), true), + NetworkItem::escapeHTML(_ircUser->whoisServiceReply()), + !_ircUser->whoisServiceReply().isEmpty()); + addRow(tr("Hostmask"), + NetworkItem::escapeHTML(_ircUser->hostmask().remove(0, _ircUser->hostmask().indexOf("!") + 1)), + !(_ircUser->hostmask().remove(0, _ircUser->hostmask().indexOf("!") + 1) == "@")); + addRow(tr("Operator"), + NetworkItem::escapeHTML(_ircUser->ircOperator()), + !_ircUser->ircOperator().isEmpty()); if (_ircUser->idleTime().isValid()) { QDateTime now = QDateTime::currentDateTime(); QDateTime idle = _ircUser->idleTime(); int idleTime = idle.secsTo(now); - toolTip.append(tr("idling since %1").arg(secondsToString(idleTime))); + addRow(NetworkItem::escapeHTML(tr("Idling since"), true), secondsToString(idleTime), true); } + if (_ircUser->loginTime().isValid()) { - toolTip.append(tr("login time: %1").arg(_ircUser->loginTime().toString())); + addRow(NetworkItem::escapeHTML(tr("Login time"), true), _ircUser->loginTime().toString(), true); } - if (!_ircUser->server().isEmpty()) toolTip.append(tr("server: %1").arg(_ircUser->server())); + addRow(tr("Server"), NetworkItem::escapeHTML(_ircUser->server()), !_ircUser->server().isEmpty()); + tooltip << "
"; } - return QString("

%1

").arg(toolTip.join("
")); + // If no further information found, offer an explanatory message + if (!infoAdded) + tooltip << "

" << tr("No information available") << "

"; + + tooltip << ""; + return strTooltip; } @@ -583,20 +647,29 @@ QVariant ChannelBufferItem::data(int column, int role) const QString ChannelBufferItem::toolTip(int column) const { Q_UNUSED(column); - QStringList toolTip; + QString strTooltip; + QTextStream tooltip( &strTooltip, QIODevice::WriteOnly ); + tooltip << "" + << ""; + + // Function to add a row to the tooltip table + auto addRow = [&](const QString& key, const QString& value, bool condition) { + if (condition) { + tooltip << "" << key << "" << value << ""; + } + }; + + tooltip << "

"; + tooltip << NetworkItem::escapeHTML(tr("Channel %1").arg(bufferName()), true) << "

"; -#if QT_VERSION < 0x050000 - toolTip.append(tr("Channel %1").arg(Qt::escape(bufferName()))); -#else - toolTip.append(tr("Channel %1").arg(bufferName().toHtmlEscaped())); -#endif if (isActive()) { - //TODO: add channel modes - toolTip.append(tr("Users: %1").arg(nickCount())); + tooltip << ""; + addRow(tr("Users"), QString::number(nickCount()), true); + if (_ircChannel) { QString channelMode = _ircChannel->channelModeString(); // channelModeString is compiled on the fly -> thus cache the result if (!channelMode.isEmpty()) - toolTip.append(tr("Mode: %1").arg(channelMode)); + addRow(tr("Mode"), channelMode, true); } ItemViewSettings s; @@ -605,21 +678,18 @@ QString ChannelBufferItem::toolTip(int column) const QString _topic = topic(); if (_topic != "") { _topic = stripFormatCodes(_topic); -#if QT_VERSION < 0x050000 - _topic = Qt::escape(_topic); -#else - _topic = _topic.toHtmlEscaped(); -#endif - toolTip.append(QString(" ")); - toolTip.append(tr("Topic: %1").arg(_topic)); + _topic = NetworkItem::escapeHTML(_topic); + addRow(tr("Topic"), _topic, true); } } - } - else { - toolTip.append(tr("Not active
Double-click to join")); + + tooltip << "
"; + } else { + tooltip << "

" << tr("Not active, double-click to join") << "

"; } - return tr("

%1

").arg(toolTip.join("
")); + tooltip << ""; + return strTooltip; } @@ -955,11 +1025,16 @@ QString IrcUserItem::toolTip(int column) const Q_UNUSED(column); QString strTooltip; QTextStream tooltip( &strTooltip, QIODevice::WriteOnly ); - tooltip << ""; + tooltip << "" + << ""; + + // Keep track of whether or not information has been added + bool infoAdded = false; - tooltip << "

" << nickName(); + // Use bufferName() for QueryBufferItem, nickName() for IrcUserItem + tooltip << "

" << NetworkItem::escapeHTML(nickName(), true); if (_ircUser->userModes() != "") { - //TODO: Translate user Modes and add them to the table below + //TODO: Translate user Modes and add them to the table below and in QueryBufferItem::toolTip tooltip << " (" << _ircUser->userModes() << ")"; } tooltip << "

"; @@ -968,6 +1043,7 @@ QString IrcUserItem::toolTip(int column) const if (condition) { tooltip << "" << key << "" << value << ""; + infoAdded = true; } }; @@ -977,29 +1053,43 @@ QString IrcUserItem::toolTip(int column) const if(!_ircUser->awayMessage().isEmpty()) { awayMessage = _ircUser->awayMessage(); } - addRow(tr("Away Message"), awayMessage, true); - } - addRow(tr("Realname"), _ircUser->realName(), !_ircUser->realName().isEmpty()); - addRow(tr("Operator"), _ircUser->ircOperator(), !_ircUser->ircOperator().isEmpty()); - addRow(tr("Suser Host"), _ircUser->suserHost(),!_ircUser->suserHost().isEmpty()); - addRow(tr("Whois Service Reply"), _ircUser->whoisServiceReply(), !_ircUser->whoisServiceReply().isEmpty()); - addRow(tr("Hostmask"), _ircUser->hostmask().remove(0, _ircUser->hostmask().indexOf("!")+1), true); - addRow(tr("Operator"), _ircUser->ircOperator(), !_ircUser->ircOperator().isEmpty()); + addRow(NetworkItem::escapeHTML(tr("Away message"), true), NetworkItem::escapeHTML(awayMessage), true); + } + addRow(tr("Realname"), + NetworkItem::escapeHTML(_ircUser->realName()), + !_ircUser->realName().isEmpty()); + addRow(NetworkItem::escapeHTML(tr("Suser Host"), true), + NetworkItem::escapeHTML(_ircUser->suserHost()), + !_ircUser->suserHost().isEmpty()); + addRow(NetworkItem::escapeHTML(tr("Whois Service Reply"), true), + NetworkItem::escapeHTML(_ircUser->whoisServiceReply()), + !_ircUser->whoisServiceReply().isEmpty()); + addRow(tr("Hostmask"), + NetworkItem::escapeHTML(_ircUser->hostmask().remove(0, _ircUser->hostmask().indexOf("!") + 1)), + !(_ircUser->hostmask().remove(0, _ircUser->hostmask().indexOf("!") + 1) == "@")); + addRow(tr("Operator"), + NetworkItem::escapeHTML(_ircUser->ircOperator()), + !_ircUser->ircOperator().isEmpty()); if (_ircUser->idleTime().isValid()) { QDateTime now = QDateTime::currentDateTime(); QDateTime idle = _ircUser->idleTime(); int idleTime = idle.secsTo(now); - addRow(tr("Idling since"), secondsToString(idleTime), true); + addRow(NetworkItem::escapeHTML(tr("Idling since"), true), secondsToString(idleTime), true); } if (_ircUser->loginTime().isValid()) { - addRow(tr("Login time"), _ircUser->loginTime().toString(), true); + addRow(NetworkItem::escapeHTML(tr("Login time"), true), _ircUser->loginTime().toString(), true); } - addRow(tr("Server"), _ircUser->server(), !_ircUser->server().isEmpty()); + addRow(tr("Server"), NetworkItem::escapeHTML(_ircUser->server()), !_ircUser->server().isEmpty()); + tooltip << ""; - tooltip << ""; + // If no further information found, offer an explanatory message + if (!infoAdded) + tooltip << "

" << tr("No information available") << "

"; + + tooltip << ""; return strTooltip; } diff --git a/src/client/networkmodel.h b/src/client/networkmodel.h index f2342e8f..cc230d02 100644 --- a/src/client/networkmodel.h +++ b/src/client/networkmodel.h @@ -45,6 +45,19 @@ public : virtual QVariant data(int column, int row) const; + /** + * Escapes a string as HTML, ready for Qt markup. + * + * Implementation depends on Qt version - Qt4 uses Qt::escape, while Qt5 uses .toHtmlEscaped(). + * + * @param[in] string QString to escape + * @param[in] useNonbreakingSpaces + * @parblock + * If true, replace spaces with non-breaking spaces (i.e. ' '), otherwise only HTML escape. + * @endparblock + */ + static QString escapeHTML(const QString &string, bool useNonbreakingSpaces = false); + inline bool isActive() const { return (bool)_network ? _network->isConnected() : false; } inline const NetworkId &networkId() const { return _networkId; }