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,
77 Underline = 0x00000400,
80 // Individual parts of a message
81 Timestamp = 0x00001000,
83 Contents = 0x00004000,
85 Hostmask = 0x00010000,
86 ChannelName = 0x00020000,
87 ModeFlags = 0x00040000,
89 // URL is special, we want that to take precedence over the rest...
92 // mIRC Colors - we assume those to be present only in plain contents
93 // foreground: 0x0.400000
94 // background: 0x.0800000
99 Highlight = 0x00000002,
100 Selected = 0x00000004 // must be last!
103 enum ItemFormatType {
104 BufferViewItem = 0x00000001,
105 NickViewItem = 0x00000002,
107 NetworkItem = 0x00000010,
108 ChannelBufferItem = 0x00000020,
109 QueryBufferItem = 0x00000040,
110 IrcUserItem = 0x00000080,
111 UserCategoryItem = 0x00000100,
113 InactiveBuffer = 0x00001000,
114 ActiveBuffer = 0x00002000,
115 UnreadBuffer = 0x00004000,
116 HighlightedBuffer = 0x00008000,
117 UserAway = 0x00010000
122 NumRoles // must be last!
125 struct StyledString {
127 FormatList formatList; // starting pos, ftypes
132 static FormatType formatType(Message::Type msgType);
133 static StyledString styleString(const QString &string, quint32 baseFormat = Base);
134 static QString mircToInternal(const QString &);
135 static inline QString timestampFormatString() { return _timestampFormatString; }
137 QTextCharFormat format(quint32 formatType, quint32 messageLabel);
138 QFontMetricsF *fontMetrics(quint32 formatType, quint32 messageLabel);
140 QList<QTextLayout::FormatRange> toTextLayoutList(const FormatList &, int textLength, quint32 messageLabel);
142 inline const QBrush &brush(ColorRole role) const { return _uiStylePalette.at((int) role); }
143 inline void setBrush(ColorRole role, const QBrush &brush) { _uiStylePalette[(int) role] = brush; }
145 QVariant bufferViewItemData(const QModelIndex &networkModelIndex, int role) const;
146 QVariant nickViewItemData(const QModelIndex &networkModelIndex, int role) const;
155 void loadStyleSheet();
156 QString loadStyleSheet(const QString &name, bool shouldExist = false);
158 QTextCharFormat format(quint64 key) const;
159 QTextCharFormat cachedFormat(quint32 formatType, quint32 messageLabel) const;
160 void setCachedFormat(const QTextCharFormat &format, quint32 formatType, quint32 messageLabel);
161 void mergeFormat(QTextCharFormat &format, quint32 formatType, quint64 messageLabel);
162 void mergeSubElementFormat(QTextCharFormat &format, quint32 formatType, quint64 messageLabel);
164 static FormatType formatType(const QString &code);
165 static QString formatCode(FormatType);
166 static void setTimestampFormatString(const QString &format);
168 QVariant itemData(int role, const QTextCharFormat &format) const;
171 void showItemViewIconsChanged();
174 QVector<QBrush> _uiStylePalette;
175 QBrush _markerLineBrush;
176 QHash<quint64, QTextCharFormat> _formats;
177 QHash<quint64, QTextCharFormat> _formatCache;
178 QHash<quint64, QFontMetricsF *> _metricsCache;
179 QHash<quint32, QTextCharFormat> _listItemFormats;
180 static QHash<QString, FormatType> _formatCodes;
181 static QString _timestampFormatString;
183 QPixmap _channelJoinedIcon;
184 QPixmap _channelPartedIcon;
185 QPixmap _userOfflineIcon;
186 QPixmap _userOnlineIcon;
187 QPixmap _userAwayIcon;
188 QPixmap _categoryOpIcon;
189 QPixmap _categoryVoiceIcon;
192 bool _showNickViewIcons;
193 bool _showBufferViewIcons;
196 class UiStyle::StyledMessage : public Message {
198 explicit StyledMessage(const Message &message);
200 QString decoratedTimestamp() const;
201 QString plainSender() const; //!< Nickname (no decorations) for Plain and Notice, empty else
202 QString decoratedSender() const;
203 const QString &plainContents() const;
205 const FormatList &contentsFormatList() const;
207 quint8 senderHash() const;
213 mutable StyledString _contents;
214 mutable quint8 _senderHash;
217 QDataStream &operator<<(QDataStream &out, const UiStyle::FormatList &formatList);
218 QDataStream &operator>>(QDataStream &in, UiStyle::FormatList &formatList);
220 Q_DECLARE_METATYPE(UiStyle::FormatList)