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