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>
32 #include "bufferinfo.h"
34 #include "networkmodel.h"
37 class UiStyle : public QObject{
41 UiStyle(QObject *parent = 0);
44 typedef QList<QPair<quint16, quint32> > FormatList;
46 //! This enumerates the possible formats a text element may have. */
47 /** These formats are ordered on increasing importance, in cases where a given property is specified
48 * by multiple active formats.
49 * \NOTE: Do not change/add values here without also adapting the relevant
50 * methods in this class (in particular mergedFormat())!
51 * Also, we _do_ rely on certain properties of these values in styleString() and friends!
57 // Message Formats (mutually exclusive!)
58 PlainMsg = 0x00000001,
59 NoticeMsg = 0x00000002,
60 ActionMsg = 0x00000003,
68 ServerMsg = 0x0000000b,
70 ErrorMsg = 0x0000000d,
71 DayChangeMsg = 0x0000000e,
72 TopicMsg = 0x0000000f,
73 NetsplitJoinMsg = 0x00000010,
74 NetsplitQuitMsg = 0x00000020,
75 InviteMsg = 0x00000030,
80 Underline = 0x00000400,
83 // Individual parts of a message
84 Timestamp = 0x00001000,
86 Contents = 0x00004000,
88 Hostmask = 0x00010000,
89 ChannelName = 0x00020000,
90 ModeFlags = 0x00040000,
92 // URL is special, we want that to take precedence over the rest...
95 // mIRC Colors - we assume those to be present only in plain contents
96 // foreground: 0x0.400000
97 // background: 0x.0800000
102 Highlight = 0x00000002,
103 Selected = 0x00000004 // must be last!
106 enum ItemFormatType {
107 BufferViewItem = 0x00000001,
108 NickViewItem = 0x00000002,
110 NetworkItem = 0x00000010,
111 ChannelBufferItem = 0x00000020,
112 QueryBufferItem = 0x00000040,
113 IrcUserItem = 0x00000080,
114 UserCategoryItem = 0x00000100,
116 InactiveBuffer = 0x00001000,
117 ActiveBuffer = 0x00002000,
118 UnreadBuffer = 0x00004000,
119 HighlightedBuffer = 0x00008000,
120 UserAway = 0x00010000
125 NumRoles // must be last!
128 struct StyledString {
130 FormatList formatList; // starting pos, ftypes
135 static FormatType formatType(Message::Type msgType);
136 static StyledString styleString(const QString &string, quint32 baseFormat = Base);
137 static QString mircToInternal(const QString &);
138 static inline QString timestampFormatString() { return _timestampFormatString; }
140 QTextCharFormat format(quint32 formatType, quint32 messageLabel) const;
141 QFontMetricsF *fontMetrics(quint32 formatType, quint32 messageLabel) const;
143 QList<QTextLayout::FormatRange> toTextLayoutList(const FormatList &, int textLength, quint32 messageLabel) const;
145 inline const QBrush &brush(ColorRole role) const { return _uiStylePalette.at((int) role); }
146 inline void setBrush(ColorRole role, const QBrush &brush) { _uiStylePalette[(int) role] = brush; }
148 QVariant bufferViewItemData(const QModelIndex &networkModelIndex, int role) const;
149 QVariant nickViewItemData(const QModelIndex &networkModelIndex, int role) const;
158 void loadStyleSheet();
159 QString loadStyleSheet(const QString &name, bool shouldExist = false);
161 QTextCharFormat format(quint64 key) const;
162 QTextCharFormat cachedFormat(quint32 formatType, quint32 messageLabel) const;
163 void setCachedFormat(const QTextCharFormat &format, quint32 formatType, quint32 messageLabel) const;
164 void mergeFormat(QTextCharFormat &format, quint32 formatType, quint64 messageLabel) const;
165 void mergeSubElementFormat(QTextCharFormat &format, quint32 formatType, quint64 messageLabel) const;
167 static FormatType formatType(const QString &code);
168 static QString formatCode(FormatType);
169 static void setTimestampFormatString(const QString &format);
171 QVariant itemData(int role, const QTextCharFormat &format) const;
174 void allowMircColorsChanged(const QVariant &);
175 void showItemViewIconsChanged(const QVariant &);
178 QVector<QBrush> _uiStylePalette;
179 QBrush _markerLineBrush;
180 QHash<quint64, QTextCharFormat> _formats;
181 mutable QHash<quint64, QTextCharFormat> _formatCache;
182 mutable QHash<quint64, QFontMetricsF *> _metricsCache;
183 QHash<quint32, QTextCharFormat> _listItemFormats;
184 static QHash<QString, FormatType> _formatCodes;
185 static QString _timestampFormatString;
187 QPixmap _channelJoinedIcon;
188 QPixmap _channelPartedIcon;
189 QPixmap _userOfflineIcon;
190 QPixmap _userOnlineIcon;
191 QPixmap _userAwayIcon;
192 QPixmap _categoryOpIcon;
193 QPixmap _categoryVoiceIcon;
196 bool _showNickViewIcons;
197 bool _showBufferViewIcons;
198 bool _allowMircColors;
201 class UiStyle::StyledMessage : public Message {
202 Q_DECLARE_TR_FUNCTIONS(UiStyle::StyledMessage)
205 explicit StyledMessage(const Message &message);
207 QString decoratedTimestamp() const;
208 QString plainSender() const; //!< Nickname (no decorations) for Plain and Notice, empty else
209 QString decoratedSender() const;
210 const QString &plainContents() const;
212 const FormatList &contentsFormatList() const;
214 quint8 senderHash() const;
220 mutable StyledString _contents;
221 mutable quint8 _senderHash;
224 QDataStream &operator<<(QDataStream &out, const UiStyle::FormatList &formatList);
225 QDataStream &operator>>(QDataStream &in, UiStyle::FormatList &formatList);
227 Q_DECLARE_METATYPE(UiStyle::FormatList)