ground/gcs/src/plugins/config/calibration/wizardmodel.h

   1 /**
   2  ******************************************************************************
   3  *
   4  * @file       wizardmodel.c
   5  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2013.
   6  *
   7  * @brief      A fsm state machine model used in wizard like UIs
   8  * @see        The GNU Public License (GPL) Version 3
   9  * @defgroup
  10  * @{
  11  *
  12  *****************************************************************************/
  13 /*
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful, but
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  21  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  22  * for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License along
  25  * with this program; if not, write to the Free Software Foundation, Inc.,
  26  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  27  */
  28 #ifndef WIZARDMODEL_H
  29 #define WIZARDMODEL_H
  30
  31 #include "wizardstate.h"
  32 #include <accelsensor.h>
  33
  34 #include <QStateMachine>
  35 #include <QQmlListProperty>
  36
  37 class WizardModel : public QStateMachine {
  38     Q_OBJECT Q_PROPERTY(QQmlListProperty<QObject> steps READ steps CONSTANT)
  39     // Q_PROPERTY(QString instructions READ instructions NOTIFY instructionsChanged)
  40     Q_PROPERTY(WizardState * currentState READ currentState NOTIFY currentStateChanged)
  41
  42 public:
  43     enum MessageType { Debug, Info, Prompt, Warn, Success, Failure };
  44
  45     explicit WizardModel(QObject *parent = 0);
  46
  47     QQmlListProperty<QObject> steps()
  48     {
  49         return QQmlListProperty<QObject>(this, m_steps);
  50     }
  51
  52     QString &instructions()
  53     {
  54         return m_instructions;
  55     }
  56
  57     WizardState *currentState();
  58
  59 public slots:
  60     void addInstructions(QString text, WizardModel::MessageType type = WizardModel::Info)
  61     {
  62         m_instructions = text;
  63         emit instructionsAdded(text, type);
  64     }
  65
  66 protected:
  67     QList<QObject *> m_steps;
  68
  69 private:
  70     QString m_instructions;
  71
  72 signals:
  73     void instructionsAdded(QString text, WizardModel::MessageType type = WizardModel::Info);
  74     void currentStateChanged(WizardState *status);
  75 };
  76
  77 #endif // WIZARDMODEL_H