Implement core-side highlights
[quassel.git] / src / qtui / qtuistyle.h
1 /***************************************************************************
2  *   Copyright (C) 2005-2016 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  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
19  ***************************************************************************/
20
21 #ifndef QTUISTYLE_H_
22 #define QTUISTYLE_H_
23
24 #include "uistyle.h"
25 #include "qtuisettings.h"
26
27 class QtUiStyle : public UiStyle
28 {
29     Q_OBJECT
30
31 public:
32     QtUiStyle(QObject *parent = 0);
33     virtual ~QtUiStyle();
34
35     virtual inline qreal firstColumnSeparator() const { return 6; }
36     virtual inline qreal secondColumnSeparator() const { return 6; }
37
38 public slots:
39     /**
40      * Generates initial settingsQss if it doesn't exist
41      *
42      * This allows for default fonts, colors, etc to specified.
43      */
44
45     void initializeSettingsQss();
46
47     /**
48      * Generates UI stylesheet based on selected fonts, colors, etc
49      */
50     void generateSettingsQss() const;
51
52 private slots:
53     /**
54      * Updates knowledge of whether or not to use the custom timestamp format
55      */
56     void updateUseCustomTimestampFormat();
57
58     /**
59      * Updates knowledge of the current timestamp format
60      */
61     void updateTimestampFormatString();
62
63     /**
64      * Updates knowledge of whether or not to show sender brackets
65      */
66     void updateShowSenderBrackets();
67
68 private:
69     QString fontDescription(const QFont &font) const;
70
71     /**
72      * Generate a Qt stylesheet color string from a given setting
73      *
74      * @param[in] key          Reference to settings key containing a QColor
75      * @param[in] settings     UiSettings manager to search
76      * @param[in] defaultColor Fallback color if not found; when unspecified default is black
77      */
78     QString color(const QString &key, UiSettings &settings, const QColor &defaultColor = QColor()) const;
79
80     QString msgTypeQss(const QString &msgType, const QString &key, UiSettings &settings) const;
81
82     /**
83      * Generates the Qss color palette stylesheet for sender colors
84      *
85      * This must be called before generating any Qss dependent on these colors.
86      *
87      * @see QtUiStyle::senderQss()
88      * @param[in] settings     Reference to current UI settings, used for loading color values
89      * @return Quassel-theme-compatible Qss color palette
90      */
91     QString senderPaletteQss(UiSettings &settings) const;
92
93     /**
94      * Generate a snippet of Qss stylesheet for a given sender-hash index
95      *
96      * This depends on the color palette generated by QtUiStyle::senderPaletteQss()
97      *
98      * @param[in] i            Sender hash index from 0 - 15
99      * @param[in] messageType  Type of message to filter, e.g. 'plain' or 'action'
100      * @param[in] includeNick  Also apply foreground color to Nick
101      * @return Snippet of Quassel-theme-compatible Qss stylesheet
102      */
103     QString senderQss(int i, const QString &messageType, bool includeNick = false) const;
104
105     /**
106      * Generate a snippet of Qss stylesheet for a given IRC nickname sender-hash index
107      *
108      * This depends on the color palette generated by QtUiStyle::senderPaletteQss()
109      *
110      * @param[in] i            Sender hash index from 0 - 15
111      * @return Snippet of Quassel-theme-compatible Qss stylesheet
112      */
113     QString nickQss(int i) const;
114
115     QString chatListItemQss(const QString &state, const QString &key, UiSettings &settings) const;
116 };
117
118
119 #endif