client: Use sentence case for Core Info details
[quassel.git] / src / qtui / qtuiapplication.h
1 /***************************************************************************
2  *   Copyright (C) 2005-2018 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 #pragma once
22
23 #ifdef HAVE_KDE4
24 #  include <KApplication>
25 #else
26 #  include <QApplication>
27 #endif
28
29 #include <QSessionManager>
30
31 #include "quassel.h"
32 #include "uisettings.h"
33 #include "qtuisettings.h"
34
35 class QtUi;
36
37 #ifdef HAVE_KDE4
38 class QtUiApplication : public KApplication
39 {
40 #else
41 class QtUiApplication : public QApplication
42 {
43 #endif
44
45     Q_OBJECT
46
47 public:
48     QtUiApplication(int &, char **);
49     ~QtUiApplication();
50     virtual bool init();
51
52     void resumeSessionIfPossible();
53     inline bool isAboutToQuit() const { return _aboutToQuit; }
54
55 #if (QT_VERSION < QT_VERSION_CHECK(5, 0, 0))
56     void commitData(QSessionManager &manager) override;
57     void saveState(QSessionManager &manager) override;
58 #else
59     void commitData(QSessionManager &manager);
60     void saveState(QSessionManager &manager);
61 #endif
62
63 private:
64     /**
65      * Migrate settings if neccessary and possible
66      *
67      * If unsuccessful (major version changed, minor version upgrade failed), returning false, the
68      * settings are in an unknown state and the client should quit.
69      *
70      * @return True if settings successfully migrated, otherwise false
71      */
72     bool migrateSettings();
73
74     /**
75      * Migrate from one minor settings version to the next
76      *
77      * Settings can only be migrated one version at a time.  Start from the current version, calling
78      * this function for each intermediate version up until the latest version.
79      *
80      * @param[in] settings    Current settings instance
81      * @param[in] newVersion  Next target version for migration, at most 1 from the current version
82      * @return True if minor revision of settings successfully migrated, otherwise false
83      */
84     bool applySettingsMigration(QtUiSettings settings, const uint newVersion);
85
86 private slots:
87     void initUi();
88
89 private:
90     bool _aboutToQuit{false};
91
92     Quassel _quasselInstance;
93 };