src/uisupport/uistyle.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 by the Quassel Project                          *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   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.                                           *
   9  *                                                                         *
  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.                          *
  14  *                                                                         *
  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  ***************************************************************************/
  20
  21 #ifndef UISTYLE_H_
  22 #define UISTYLE_H_
  23
  24 #include <QDataStream>
  25 #include <QFontMetricsF>
  26 #include <QHash>
  27 #include <QTextCharFormat>
  28 #include <QTextLayout>
  29 #include <QPalette>
  30 #include <QVector>
  31
  32 #include "bufferinfo.h"
  33 #include "message.h"
  34 #include "networkmodel.h"
  35 #include "settings.h"
  36
  37 class UiStyle : public QObject{
  38   Q_OBJECT
  39
  40 public:
  41   UiStyle(QObject *parent = 0);
  42   virtual ~UiStyle();
  43
  44   typedef QList<QPair<quint16, quint32> > FormatList;
  45
  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!
  52    */
  53   enum FormatType {
  54     Base            = 0x00000000,
  55     Invalid         = 0xffffffff,
  56
  57     // Message Formats (mutually exclusive!)
  58     PlainMsg        = 0x00000001,
  59     NoticeMsg       = 0x00000002,
  60     ActionMsg       = 0x00000003,
  61     NickMsg         = 0x00000004,
  62     ModeMsg         = 0x00000005,
  63     JoinMsg         = 0x00000006,
  64     PartMsg         = 0x00000007,
  65     QuitMsg         = 0x00000008,
  66     KickMsg         = 0x00000009,
  67     KillMsg         = 0x0000000a,
  68     ServerMsg       = 0x0000000b,
  69     InfoMsg         = 0x0000000c,
  70     ErrorMsg        = 0x0000000d,
  71     DayChangeMsg    = 0x0000000e,
  72     TopicMsg        = 0x0000000f,
  73     NetsplitJoinMsg = 0x00000010,
  74     NetsplitQuitMsg = 0x00000020,
  75
  76     // Standard Formats
  77     Bold            = 0x00000100,
  78     Italic          = 0x00000200,
  79     Underline       = 0x00000400,
  80     Reverse         = 0x00000800,
  81
  82     // Individual parts of a message
  83     Timestamp       = 0x00001000,
  84     Sender          = 0x00002000,
  85     Contents        = 0x00004000,
  86     Nick            = 0x00008000,
  87     Hostmask        = 0x00010000,
  88     ChannelName     = 0x00020000,
  89     ModeFlags       = 0x00040000,
  90
  91     // URL is special, we want that to take precedence over the rest...
  92     Url             = 0x00080000
  93
  94     // mIRC Colors - we assume those to be present only in plain contents
  95     // foreground: 0x0.400000
  96     // background: 0x.0800000
  97   };
  98
  99   enum MessageLabel {
 100     OwnMsg          = 0x00000001,
 101     Highlight       = 0x00000002,
 102     Selected        = 0x00000004  // must be last!
 103   };
 104
 105   enum ItemFormatType {
 106     BufferViewItem    = 0x00000001,
 107     NickViewItem      = 0x00000002,
 108
 109     NetworkItem       = 0x00000010,
 110     ChannelBufferItem = 0x00000020,
 111     QueryBufferItem   = 0x00000040,
 112     IrcUserItem       = 0x00000080,
 113     UserCategoryItem  = 0x00000100,
 114
 115     InactiveBuffer    = 0x00001000,
 116     ActiveBuffer      = 0x00002000,
 117     UnreadBuffer      = 0x00004000,
 118     HighlightedBuffer = 0x00008000,
 119     UserAway          = 0x00010000
 120   };
 121
 122   enum ColorRole {
 123     MarkerLine,
 124     NumRoles  // must be last!
 125   };
 126
 127   struct StyledString {
 128     QString plainText;
 129     FormatList formatList;  // starting pos, ftypes
 130   };
 131
 132   class StyledMessage;
 133
 134   static FormatType formatType(Message::Type msgType);
 135   static StyledString styleString(const QString &string, quint32 baseFormat = Base);
 136   static QString mircToInternal(const QString &);
 137   static inline QString timestampFormatString() { return _timestampFormatString; }
 138
 139   QTextCharFormat format(quint32 formatType, quint32 messageLabel) const;
 140   QFontMetricsF *fontMetrics(quint32 formatType, quint32 messageLabel) const;
 141
 142   QList<QTextLayout::FormatRange> toTextLayoutList(const FormatList &, int textLength, quint32 messageLabel) const;
 143
 144   inline const QBrush &brush(ColorRole role) const { return _uiStylePalette.at((int) role); }
 145   inline void setBrush(ColorRole role, const QBrush &brush) { _uiStylePalette[(int) role] = brush; }
 146
 147   QVariant bufferViewItemData(const QModelIndex &networkModelIndex, int role) const;
 148   QVariant nickViewItemData(const QModelIndex &networkModelIndex, int role) const;
 149
 150 public slots:
 151   void reload();
 152
 153 signals:
 154   void changed();
 155
 156 protected:
 157   void loadStyleSheet();
 158   QString loadStyleSheet(const QString &name, bool shouldExist = false);
 159
 160   QTextCharFormat format(quint64 key) const;
 161   QTextCharFormat cachedFormat(quint32 formatType, quint32 messageLabel) const;
 162   void setCachedFormat(const QTextCharFormat &format, quint32 formatType, quint32 messageLabel) const;
 163   void mergeFormat(QTextCharFormat &format, quint32 formatType, quint64 messageLabel) const;
 164   void mergeSubElementFormat(QTextCharFormat &format, quint32 formatType, quint64 messageLabel) const;
 165
 166   static FormatType formatType(const QString &code);
 167   static QString formatCode(FormatType);
 168   static void setTimestampFormatString(const QString &format);
 169
 170   QVariant itemData(int role, const QTextCharFormat &format) const;
 171
 172 private slots:
 173   void allowMircColorsChanged(const QVariant &);
 174   void showItemViewIconsChanged(const QVariant &);
 175
 176 private:
 177   QVector<QBrush> _uiStylePalette;
 178   QBrush _markerLineBrush;
 179   QHash<quint64, QTextCharFormat> _formats;
 180   mutable QHash<quint64, QTextCharFormat> _formatCache;
 181   mutable QHash<quint64, QFontMetricsF *> _metricsCache;
 182   QHash<quint32, QTextCharFormat> _listItemFormats;
 183   static QHash<QString, FormatType> _formatCodes;
 184   static QString _timestampFormatString;
 185
 186   QPixmap _channelJoinedIcon;
 187   QPixmap _channelPartedIcon;
 188   QPixmap _userOfflineIcon;
 189   QPixmap _userOnlineIcon;
 190   QPixmap _userAwayIcon;
 191   QPixmap _categoryOpIcon;
 192   QPixmap _categoryVoiceIcon;
 193   int _opIconLimit;
 194   int _voiceIconLimit;
 195   bool _showNickViewIcons;
 196   bool _showBufferViewIcons;
 197   bool _allowMircColors;
 198 };
 199
 200 class UiStyle::StyledMessage : public Message {
 201   Q_DECLARE_TR_FUNCTIONS(UiStyle::StyledMessage)
 202
 203 public:
 204   explicit StyledMessage(const Message &message);
 205
 206   QString decoratedTimestamp() const;
 207   QString plainSender() const;             //!< Nickname (no decorations) for Plain and Notice, empty else
 208   QString decoratedSender() const;
 209   const QString &plainContents() const;
 210
 211   const FormatList &contentsFormatList() const;
 212
 213   quint8 senderHash() const;
 214
 215 protected:
 216   void style() const;
 217
 218 private:
 219   mutable StyledString _contents;
 220   mutable quint8 _senderHash;
 221 };
 222
 223 QDataStream &operator<<(QDataStream &out, const UiStyle::FormatList &formatList);
 224 QDataStream &operator>>(QDataStream &in, UiStyle::FormatList &formatList);
 225
 226 Q_DECLARE_METATYPE(UiStyle::FormatList)
 227
 228 #endif