1 /***************************************************************************
2 * Copyright (C) 2005-09 by the Quassel Project *
3 * devel@quassel-irc.org *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) version 3. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
24 #include <QDataStream>
25 #include <QFontMetricsF>
27 #include <QTextCharFormat>
28 #include <QTextLayout>
36 Q_DECLARE_TR_FUNCTIONS(UiStyle)
42 typedef QList<QPair<quint16, quint32> > FormatList;
44 //! This enumerates the possible formats a text element may have. */
45 /** These formats are ordered on increasing importance, in cases where a given property is specified
46 * by multiple active formats.
47 * \NOTE: Do not change/add values here without also adapting the relevant
48 * methods in this class (in particular mergedFormat())!
49 * Also, we _do_ rely on certain properties of these values in styleString() and friends!
55 // Message Formats (mutually exclusive!)
56 PlainMsg = 0x00000001,
57 NoticeMsg = 0x00000002,
58 ActionMsg = 0x00000003,
66 ServerMsg = 0x0000000b,
68 ErrorMsg = 0x0000000d,
69 DayChangeMsg = 0x0000000e,
74 Underline = 0x00000040,
77 // Individual parts of a message
78 Timestamp = 0x00000100,
81 Hostmask = 0x00000800,
82 ChannelName = 0x00001000,
83 ModeFlags = 0x00002000,
85 // URL is special, we want that to take precedence over the rest...
88 // mIRC Colors - we assume those to be present only in plain contents
89 // foreground: 0x0.400000
90 // background: 0x.0800000
95 Highlight = 0x00000002
100 FormatList formatList; // starting pos, ftypes
105 StyledString styleString(const QString &string, quint32 baseFormat = None);
106 QString mircToInternal(const QString &) const;
108 FormatType formatType(Message::Type msgType) const;
110 QTextCharFormat format(quint32 formatType, quint32 messageLabel = 0);
111 QFontMetricsF *fontMetrics(quint32 formatType, quint32 messageLabel = 0);
113 inline QFont defaultFont() const { return _defaultFont; }
115 QList<QTextLayout::FormatRange> toTextLayoutList(const FormatList &, int textLength);
118 void loadStyleSheet();
120 //! Determines the format set to be used for the given hostmask
121 //int formatSetIndex(const QString &hostmask) const;
122 //int formatSetIndexForSelf() const;
124 QTextCharFormat cachedFormat(quint64 key) const;
125 QTextCharFormat cachedFormat(quint32 formatType, quint32 messageLabel = 0) const;
126 void setCachedFormat(const QTextCharFormat &format, quint32 formatType, quint32 messageLabel = 0);
127 void mergeSubElementFormat(QTextCharFormat &format, quint32 formatType, quint32 messageLabel = 0);
129 FormatType formatType(const QString &code) const;
130 QString formatCode(FormatType) const;
134 QHash<quint64, QTextCharFormat> _formatCache;
135 QHash<quint64, QFontMetricsF *> _metricsCache;
136 QHash<QString, FormatType> _formatCodes;
139 class UiStyle::StyledMessage : public Message {
141 explicit StyledMessage(const Message &message);
143 //! Styling is only needed for calls to plainContents() and contentsFormatList()
144 // StyledMessage can't style lazily by itself, as it doesn't know the used style
145 bool inline needsStyling() const { return _contents.plainText.isNull(); }
146 void style(UiStyle *style) const;
149 QString decoratedTimestamp() const;
150 QString plainSender() const; //!< Nickname (no decorations) for Plain and Notice, empty else
151 QString decoratedSender() const;
152 inline const QString &plainContents() const { return _contents.plainText; }
154 inline FormatType timestampFormat() const { return UiStyle::Timestamp; }
155 FormatType senderFormat() const;
156 inline const FormatList &contentsFormatList() const { return _contents.formatList; }
159 mutable StyledString _contents;
162 QDataStream &operator<<(QDataStream &out, const UiStyle::FormatList &formatList);
163 QDataStream &operator>>(QDataStream &in, UiStyle::FormatList &formatList);
165 Q_DECLARE_METATYPE(UiStyle::FormatList)