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 #include <memory>
  24
  25 #include <QApplication>
  26 #include <QSessionManager>
  27
  28 #include "client.h"
  29 #include "quassel.h"
  30 #include "uisettings.h"
  31 #include "qtuisettings.h"
  32
  33 class QtUi;
  34
  35 class QtUiApplication : public QApplication
  36 {
  37     Q_OBJECT
  38
  39 public:
  40     QtUiApplication(int &, char **);
  41
  42     virtual void init();
  43
  44     void resumeSessionIfPossible();
  45     inline bool isAboutToQuit() const { return _aboutToQuit; }
  46
  47     void commitData(QSessionManager &manager);
  48     void saveState(QSessionManager &manager);
  49
  50 protected:
  51     virtual Quassel::QuitHandler quitHandler();
  52
  53 private:
  54     /**
  55      * Migrate settings if neccessary and possible
  56      *
  57      * If unsuccessful (major version changed, minor version upgrade failed), returning false, the
  58      * settings are in an unknown state and the client should quit.
  59      *
  60      * @return True if settings successfully migrated, otherwise false
  61      */
  62     bool migrateSettings();
  63
  64     /**
  65      * Migrate from one minor settings version to the next
  66      *
  67      * Settings can only be migrated one version at a time.  Start from the current version, calling
  68      * this function for each intermediate version up until the latest version.
  69      *
  70      * @param[in] settings    Current settings instance
  71      * @param[in] newVersion  Next target version for migration, at most 1 from the current version
  72      * @return True if minor revision of settings successfully migrated, otherwise false
  73      */
  74     bool applySettingsMigration(QtUiSettings settings, const uint newVersion);
  75
  76 private slots:
  77     void initUi();
  78
  79 protected:
  80     std::unique_ptr<Client> _client;
  81
  82 private:
  83     bool _aboutToQuit{false};
  84 };