X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fuisupport%2Fuistyle.h;h=0f8d834be5584bbcce110380edf4f20a5bd379a4;hp=7d1a8bcd285414d4b2565e12b431f943aa233749;hb=HEAD;hpb=ac7a58dd970833da2336f6ce035ec55515bac0f1 diff --git a/src/uisupport/uistyle.h b/src/uisupport/uistyle.h index 7d1a8bcd..0f8d834b 100644 --- a/src/uisupport/uistyle.h +++ b/src/uisupport/uistyle.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2016 by the Quassel Project * + * Copyright (C) 2005-2022 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -20,16 +20,19 @@ #pragma once +#include "uisupport-export.h" + #include #include +#include #include #include #include #include +#include #include #include -#include #include #include "bufferinfo.h" @@ -37,13 +40,36 @@ #include "networkmodel.h" #include "settings.h" -class UiStyle : public QObject +class UISUPPORT_EXPORT UiStyle : public QObject { Q_OBJECT + Q_ENUMS(SenderPrefixModes) public: - UiStyle(QObject *parent = 0); - virtual ~UiStyle(); + UiStyle(QObject* parent = nullptr); + ~UiStyle() override; + +// For backwards compatibility with Qt 5.5, the setFormats method was introduced +// in Qt 5.6, but the old setAdditionalFormats was deprecated in 5.6 as well. +// +// So we use the old one on Qt 5.5, and the new one everywhere else. +#if QT_VERSION >= QT_VERSION_CHECK(5, 6, 0) + using FormatContainer = QVector; + static inline void setTextLayoutFormats(QTextLayout& layout, const FormatContainer& formats) { + layout.setFormats(formats); + } + static inline QVector containerToVector(const FormatContainer& container) { + return container; + } +#else + using FormatContainer = QList; + static inline void setTextLayoutFormats(QTextLayout& layout, const FormatContainer& formats) { + layout.setAdditionalFormats(formats); + } + static inline QVector containerToVector(const FormatContainer& container) { + return container.toVector(); + } +#endif //! This enumerates the possible formats a text element may have. */ /** These formats are ordered on increasing importance, in cases where a given property is specified @@ -52,7 +78,8 @@ public: * methods in this class (in particular mergedFormat())! * Also, we _do_ rely on certain properties of these values in styleString() and friends! */ - enum class FormatType : quint32 { + enum class FormatType : quint32 + { Base = 0x00000000, Invalid = 0xffffffff, @@ -80,7 +107,7 @@ public: Bold = 0x00000100, Italic = 0x00000200, Underline = 0x00000400, - Reverse = 0x00000800, + Strikethrough = 0x00000800, // Individual parts of a message Timestamp = 0x00001000, @@ -94,20 +121,24 @@ public: // URL is special, we want that to take precedence over the rest... Url = 0x00080000 - // mIRC Colors - we assume those to be present only in plain contents - // foreground: 0x0.400000 - // background: 0x.0800000 + // mIRC Colors - we assume those to be present only in plain contents + // foreground: 0x0.400000 + // background: 0x.0800000 }; - enum class MessageLabel : quint32 { - None = 0x00000000, - OwnMsg = 0x00000001, - Highlight = 0x00000002, - Selected = 0x00000004 // must be last! + enum class MessageLabel : quint32 + { + None = 0x00000000, + OwnMsg = 0x00000001, + Highlight = 0x00000002, + Selected = 0x00000004, + Hovered = 0x00000008, + Last = Hovered }; - enum class ItemFormatType : quint32 { - None = 0x00000000, + enum class ItemFormatType : quint32 + { + None = 0x00000000, BufferViewItem = 0x00000001, NickViewItem = 0x00000002, @@ -127,7 +158,14 @@ public: Invalid = 0xffffffff }; - enum class ColorRole { + enum class FormatProperty + { + AllowForegroundOverride = QTextFormat::UserProperty, + AllowBackgroundOverride + }; + + enum class ColorRole + { MarkerLine, // Sender colors (16 + self) // These aren't used directly to avoid having storing all of the sender color options in the @@ -153,18 +191,32 @@ public: SenderColor0d, SenderColor0e, SenderColor0f, - NumRoles // must be last! + NumRoles // must be last! + }; + + /// Display of sender prefix modes + enum class SenderPrefixMode + { + NoModes = 0, ///< Hide sender modes + HighestMode = 1, ///< Show the highest active sender mode + AllModes = 2 ///< Show all active sender modes }; + // Do not change SenderPrefixMode numbering without also adjusting + // ChatViewSettingsPage::initSenderPrefixComboBox() and chatviewsettingspage.ui "defaultValue" - struct Format { + struct Format + { FormatType type; + QColor foreground; + QColor background; }; using FormatList = std::vector>; - struct StyledString { + struct StyledString + { QString plainText; - FormatList formatList; // starting pos, ftypes + FormatList formatList; // starting pos, ftypes }; class StyledMessage; @@ -178,23 +230,23 @@ public: * @see ../qtui/settingspages/chatviewsettingspage.ui * @see UiStyle::ColorRole */ - const QList defaultSenderColors = QList { - QColor(204, 0, 0), /// Sender00 - QColor( 0, 108, 173), /// Sender01 - QColor( 77, 153, 0), /// Sender02 - QColor(102, 0, 204), /// Sender03 - QColor(166, 125, 0), /// Sender04 - QColor( 0, 153, 39), /// Sender05 - QColor( 0, 48, 192), /// Sender06 - QColor(204, 0, 154), /// Sender07 - QColor(185, 70, 0), /// Sender08 - QColor(134, 153, 0), /// Sender09 - QColor( 20, 153, 0), /// Sender10 - QColor( 0, 153, 96), /// Sender11 - QColor( 0, 108, 173), /// Sender12 - QColor( 0, 153, 204), /// Sender13 - QColor(179, 0, 204), /// Sender14 - QColor(204, 0, 77), /// Sender15 + const QList defaultSenderColors = QList{ + QColor(204, 0 , 0 ), ///< Sender00 + QColor(0 , 108, 173), ///< Sender01 + QColor(77 , 153, 0 ), ///< Sender02 + QColor(102, 0 , 204), ///< Sender03 + QColor(166, 125, 0 ), ///< Sender04 + QColor(0 , 153, 39 ), ///< Sender05 + QColor(0 , 48 , 192), ///< Sender06 + QColor(204, 0 , 154), ///< Sender07 + QColor(185, 70 , 0 ), ///< Sender08 + QColor(134, 153, 0), ///< Sender09 + QColor(20 , 153, 0), ///< Sender10 + QColor(0 , 153, 96), ///< Sender11 + QColor(0 , 108, 173), ///< Sender12 + QColor(0 , 153, 204), ///< Sender13 + QColor(179, 0 , 204), ///< Sender14 + QColor(204, 0 , 77 ), ///< Sender15 }; // Explicitly declare QList type for defaultSenderColors, otherwise error C2797 // "list initialization inside member initializer list" will occur in Windows builds with Visual @@ -212,8 +264,8 @@ public: const QColor defaultSenderColorSelf = QColor(0, 0, 0); static FormatType formatType(Message::Type msgType); - static StyledString styleString(const QString &string, FormatType baseFormat = FormatType::Base); - static QString mircToInternal(const QString &); + static StyledString styleString(const QString& string, FormatType baseFormat = FormatType::Base); + static QString mircToInternal(const QString&); /** * Gets if a custom timestamp format is used. @@ -242,16 +294,16 @@ public: */ static QString timestampFormatString(); - QTextCharFormat format(FormatType formatType, MessageLabel messageLabel) const; - QFontMetricsF *fontMetrics(FormatType formatType, MessageLabel messageLabel) const; + QTextCharFormat format(const Format& format, MessageLabel messageLabel) const; + QFontMetricsF* fontMetrics(FormatType formatType, MessageLabel messageLabel) const; - QList toTextLayoutList(const FormatList &, int textLength, MessageLabel messageLabel) const; + FormatContainer toTextLayoutList(const FormatList&, int textLength, MessageLabel messageLabel) const; - inline const QBrush &brush(ColorRole role) const { return _uiStylePalette.at((int)role); } - inline void setBrush(ColorRole role, const QBrush &brush) { _uiStylePalette[(int)role] = brush; } + inline const QBrush& brush(ColorRole role) const { return _uiStylePalette.at((int)role); } + inline void setBrush(ColorRole role, const QBrush& brush) { _uiStylePalette[(int)role] = brush; } - QVariant bufferViewItemData(const QModelIndex &networkModelIndex, int role) const; - QVariant nickViewItemData(const QModelIndex &networkModelIndex, int role) const; + QVariant bufferViewItemData(const QModelIndex& networkModelIndex, int role) const; + QVariant nickViewItemData(const QModelIndex& networkModelIndex, int role) const; public slots: void reload(); @@ -261,22 +313,23 @@ signals: protected: void loadStyleSheet(); - QString loadStyleSheet(const QString &name, bool shouldExist = false); + QString loadStyleSheet(const QString& name, bool shouldExist = false); - QTextCharFormat format(quint64 key) const; - QTextCharFormat cachedFormat(FormatType formatType, MessageLabel messageLabel) const; - void setCachedFormat(const QTextCharFormat &format, FormatType formatType, MessageLabel messageLabel) const; - void mergeFormat(QTextCharFormat &format, FormatType formatType, MessageLabel messageLabel) const; - void mergeSubElementFormat(QTextCharFormat &format, FormatType formatType, MessageLabel messageLabel) const; + QTextCharFormat parsedFormat(quint64 key) const; + QTextCharFormat cachedFormat(const Format& format, MessageLabel messageLabel) const; + void setCachedFormat(const QTextCharFormat& charFormat, const Format& format, MessageLabel messageLabel) const; + void mergeFormat(QTextCharFormat& charFormat, const Format& format, MessageLabel messageLabel) const; + void mergeSubElementFormat(QTextCharFormat& charFormat, FormatType formatType, MessageLabel messageLabel) const; + void mergeColors(QTextCharFormat& charFormat, const Format& format, MessageLabel messageLabel) const; - static FormatType formatType(const QString &code); + static FormatType formatType(const QString& code); static QString formatCode(FormatType); /** * Cache the system locale timestamp format string * - * Based on whether or not AM/PM designators are used in the QLocale::system().timeFormat(), - * this extends the system locale timestamp format string to include seconds. + * Based on whether or not AM/PM designators are used in the QLocale.timeFormat(), this extends + * the application locale timestamp format string to include seconds. * * @see UiStyle::systemTimestampFormatString() */ @@ -294,13 +347,13 @@ protected: * * @param[in] format Timestamp format string */ - static void setTimestampFormatString(const QString &format); + static void setTimestampFormatString(const QString& format); /** - * Updates the local setting cache of whether or not to show sender prefixmodes + * Updates the local setting cache of how to display sender prefix modes * - * @param[in] enabled If true, sender prefixmodes are enabled, otherwise false. + * @param[in] mode Display format for sender prefix modes */ - static void enableSenderPrefixes(bool enabled); + static void setSenderPrefixDisplay(UiStyle::SenderPrefixMode mode); /** * Updates the local setting cache of whether or not to show sender brackets @@ -309,25 +362,25 @@ protected: */ static void enableSenderBrackets(bool enabled); - QVariant itemData(int role, const QTextCharFormat &format) const; + QVariant itemData(int role, const QTextCharFormat& format) const; private slots: - void allowMircColorsChanged(const QVariant &); - void showItemViewIconsChanged(const QVariant &); + void allowMircColorsChanged(const QVariant&); + void showItemViewIconsChanged(const QVariant&); private: QVector _uiStylePalette; QBrush _markerLineBrush; QHash _formats; - mutable QHash _formatCache; - mutable QHash _metricsCache; + mutable QHash _formatCache; + mutable QHash _metricsCache; QHash _listItemFormats; static QHash _formatCodes; - static bool _useCustomTimestampFormat; /// If true, use the custom timestamp format - static QString _systemTimestampFormatString; /// Cached copy of system locale timestamp format - static QString _timestampFormatString; /// Timestamp format string - static bool _showSenderPrefixes; /// If true, show prefixmodes before sender names - static bool _showSenderBrackets; /// If true, show brackets around sender names + static bool _useCustomTimestampFormat; ///< If true, use the custom timestamp format + static QString _systemTimestampFormatString; ///< Cached copy of system locale timestamp format + static QString _timestampFormatString; ///< Timestamp format string + static UiStyle::SenderPrefixMode _senderPrefixDisplay; ///< Prefix mode display before sender + static bool _showSenderBrackets; ///< If true, show brackets around sender names QIcon _channelJoinedIcon; QIcon _channelPartedIcon; @@ -343,20 +396,19 @@ private: bool _allowMircColors; }; - -class UiStyle::StyledMessage : public Message +class UISUPPORT_EXPORT UiStyle::StyledMessage : public Message { Q_DECLARE_TR_FUNCTIONS(UiStyle::StyledMessage) public: - explicit StyledMessage(const Message &message); + explicit StyledMessage(const Message& message); QString decoratedTimestamp() const; - QString plainSender() const; //!< Nickname (no decorations) for Plain and Notice, empty else + QString plainSender() const; //!< Nickname (no decorations) for Plain and Notice, empty else QString decoratedSender() const; - const QString &plainContents() const; + const QString& plainContents() const; - const FormatList &contentsFormatList() const; + const FormatList& contentsFormatList() const; quint8 senderHash() const; @@ -368,39 +420,36 @@ private: mutable quint8 _senderHash; }; -#if QT_VERSION < 0x050000 -uint qHash(UiStyle::ItemFormatType key); -#else uint qHash(UiStyle::ItemFormatType key, uint seed); -#endif // ---- Operators for dealing with enums ---------------------------------------------------------- -UiStyle::FormatType operator|(UiStyle::FormatType lhs, UiStyle::FormatType rhs); -UiStyle::FormatType& operator|=(UiStyle::FormatType &lhs, UiStyle::FormatType rhs); -UiStyle::FormatType operator|(UiStyle::FormatType lhs, quint32 rhs); -UiStyle::FormatType& operator|=(UiStyle::FormatType &lhs, quint32 rhs); -UiStyle::FormatType operator&(UiStyle::FormatType lhs, UiStyle::FormatType rhs); -UiStyle::FormatType& operator&=(UiStyle::FormatType &lhs, UiStyle::FormatType rhs); -UiStyle::FormatType operator&(UiStyle::FormatType lhs, quint32 rhs); -UiStyle::FormatType& operator&=(UiStyle::FormatType &lhs, quint32 rhs); -UiStyle::FormatType& operator^=(UiStyle::FormatType &lhs, UiStyle::FormatType rhs); - -UiStyle::MessageLabel operator|(UiStyle::MessageLabel lhs, UiStyle::MessageLabel rhs); -UiStyle::MessageLabel& operator|=(UiStyle::MessageLabel &lhs, UiStyle::MessageLabel rhs); -UiStyle::MessageLabel operator&(UiStyle::MessageLabel lhs, quint32 rhs); -UiStyle::MessageLabel& operator&=(UiStyle::MessageLabel &lhs, UiStyle::MessageLabel rhs); +UISUPPORT_EXPORT UiStyle::FormatType operator|(UiStyle::FormatType lhs, UiStyle::FormatType rhs); +UISUPPORT_EXPORT UiStyle::FormatType& operator|=(UiStyle::FormatType& lhs, UiStyle::FormatType rhs); +UISUPPORT_EXPORT UiStyle::FormatType operator|(UiStyle::FormatType lhs, quint32 rhs); +UISUPPORT_EXPORT UiStyle::FormatType& operator|=(UiStyle::FormatType& lhs, quint32 rhs); +UISUPPORT_EXPORT UiStyle::FormatType operator&(UiStyle::FormatType lhs, UiStyle::FormatType rhs); +UISUPPORT_EXPORT UiStyle::FormatType& operator&=(UiStyle::FormatType& lhs, UiStyle::FormatType rhs); +UISUPPORT_EXPORT UiStyle::FormatType operator&(UiStyle::FormatType lhs, quint32 rhs); +UISUPPORT_EXPORT UiStyle::FormatType& operator&=(UiStyle::FormatType& lhs, quint32 rhs); +UISUPPORT_EXPORT UiStyle::FormatType& operator^=(UiStyle::FormatType& lhs, UiStyle::FormatType rhs); + +UISUPPORT_EXPORT UiStyle::MessageLabel operator|(UiStyle::MessageLabel lhs, UiStyle::MessageLabel rhs); +UISUPPORT_EXPORT UiStyle::MessageLabel& operator|=(UiStyle::MessageLabel& lhs, UiStyle::MessageLabel rhs); +UISUPPORT_EXPORT UiStyle::MessageLabel operator&(UiStyle::MessageLabel lhs, quint32 rhs); +UISUPPORT_EXPORT UiStyle::MessageLabel& operator&=(UiStyle::MessageLabel& lhs, UiStyle::MessageLabel rhs); // Shifts the label into the upper half of the return value -quint64 operator|(UiStyle::FormatType lhs, UiStyle::MessageLabel rhs); +UISUPPORT_EXPORT quint64 operator|(UiStyle::FormatType lhs, UiStyle::MessageLabel rhs); -UiStyle::ItemFormatType operator|(UiStyle::ItemFormatType lhs, UiStyle::ItemFormatType rhs); -UiStyle::ItemFormatType& operator|=(UiStyle::ItemFormatType &lhs, UiStyle::ItemFormatType rhs); +UISUPPORT_EXPORT UiStyle::ItemFormatType operator|(UiStyle::ItemFormatType lhs, UiStyle::ItemFormatType rhs); +UISUPPORT_EXPORT UiStyle::ItemFormatType& operator|=(UiStyle::ItemFormatType& lhs, UiStyle::ItemFormatType rhs); // ---- Allow for FormatList in QVariant ---------------------------------------------------------- -QDataStream &operator<<(QDataStream &out, const UiStyle::FormatList &formatList); -QDataStream &operator>>(QDataStream &in, UiStyle::FormatList &formatList); +QDataStream& operator<<(QDataStream& out, const UiStyle::FormatList& formatList); +QDataStream& operator>>(QDataStream& in, UiStyle::FormatList& formatList); Q_DECLARE_METATYPE(UiStyle::FormatList) Q_DECLARE_METATYPE(UiStyle::MessageLabel) +Q_DECLARE_METATYPE(UiStyle::SenderPrefixMode)