ground/gcs/src/plugins/notify/notifypluginoptionspage.h

   1 /**
   2  ******************************************************************************
   3  *
   4  * @file       notifypluginoptionspage.h
   5  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
   6  * @brief      Notify Plugin options page header
   7  * @see        The GNU Public License (GPL) Version 3
   8  * @defgroup   notify
   9  * @{
  10  *
  11  *****************************************************************************/
  12 /*
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 3 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful, but
  19  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  20  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  21  * for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License along
  24  * with this program; if not, write to the Free Software Foundation, Inc.,
  25  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  26  */
  27
  28
  29 #ifndef NOTIFYPLUGINOPTIONSPAGE_H
  30 #define NOTIFYPLUGINOPTIONSPAGE_H
  31
  32 #include "coreplugin/dialogs/ioptionspage.h"
  33 #include "uavobjectmanager.h"
  34 #include "uavobject.h"
  35
  36 #include "QString"
  37 #include <QStringList>
  38 #include <QItemSelectionModel>
  39 #include <QDebug>
  40 #include <QtCore/QSettings>
  41 #include <QComboBox>
  42 #include <QSpinBox>
  43 #include <QSoundEffect>
  44 #include <QMediaPlayer>
  45
  46 class NotifyTableModel;
  47 class NotificationItem;
  48 class SoundNotifyPlugin;
  49
  50 namespace Ui {
  51 class NotifyPluginOptionsPage;
  52 };
  53
  54 using namespace Core;
  55
  56 class NotifyPluginOptionsPage : public IOptionsPage {
  57     Q_OBJECT
  58
  59 public:
  60     enum { equal, bigger, smaller, inrange };
  61     explicit NotifyPluginOptionsPage(QObject *parent = 0);
  62     ~NotifyPluginOptionsPage();
  63     QString id() const
  64     {
  65         return QLatin1String("settings");
  66     }
  67     QString trName() const
  68     {
  69         return tr("settings");
  70     }
  71     QString category() const
  72     {
  73         return QLatin1String("Notify Plugin");
  74     }
  75     QString trCategory() const
  76     {
  77         return tr("Notification");
  78     }
  79
  80     QWidget *createPage(QWidget *parent);
  81     void apply();
  82     void finish();
  83     void restoreFromSettings();
  84     static QStringList conditionValues;
  85
  86 signals:
  87     void updateNotifications(QList<NotificationItem *> list);
  88     void entryUpdated(int index);
  89
  90 private slots:
  91     void on_clicked_buttonTestSoundNotification();
  92     void on_clicked_buttonAddNotification();
  93     void on_clicked_buttonDeleteNotification();
  94     void on_clicked_buttonModifyNotification();
  95
  96     /**
  97      * We can use continuous selection, to select simultaneously
  98      * multiple rows to move them(using drag & drop) inside table ranges.
  99      */
 100     void on_changedSelection_notifyTable(const QItemSelection & selected, const QItemSelection & deselected);
 101
 102     void on_changedIndex_soundLanguage(int index);
 103     void on_clicked_buttonSoundFolder(const QString & path);
 104     void on_changedIndex_UAVObject(QString val);
 105     void on_changedIndex_UAVField(QString val);
 106     void on_changed_playButtonText(QMediaPlayer::State newstate);
 107     void on_toggled_checkEnableSound(bool state);
 108
 109     /**
 110      * Important when we change to or from "In range" value
 111      * For enums UI layout stayed the same, but for numeric values
 112      * we need to change UI to show edit line,
 113      * to have possibility assign range limits for value.
 114      */
 115     void on_changedIndex_rangeValue(QString);
 116
 117     void on_FinishedPlaying(void);
 118
 119
 120 private:
 121     Q_DISABLE_COPY(NotifyPluginOptionsPage)
 122
 123     void initButtons();
 124     void initPhononPlayer();
 125     void initRulesTable();
 126
 127     void setSelectedNotification(NotificationItem *ntf);
 128     void resetValueRange();
 129     void resetFieldType();
 130
 131     void updateConfigView(NotificationItem *notification);
 132     void getOptionsPageValues(NotificationItem *notification);
 133     UAVObjectField *getObjectFieldFromPage();
 134     UAVObjectField *getObjectFieldFromSelected();
 135
 136     void addDynamicFieldLayout();
 137     void addDynamicField(UAVObjectField *objField);
 138     void addDynamicFieldWidget(UAVObjectField *objField);
 139     void setDynamicFieldValue(NotificationItem *notification);
 140
 141 private:
 142
 143     UAVObjectManager & _objManager;
 144     SoundNotifyPlugin *_owner;
 145
 146     // ! Media object uses to test sound playing
 147     QMediaPlayer *_testSound;
 148
 149     QScopedPointer<NotifyTableModel> _notifyRulesModel;
 150     QItemSelectionModel *_notifyRulesSelection;
 151
 152     /**
 153      * Local copy of notification list, which owned by notify plugin.
 154      * Notification list readed once on application loaded, during
 155      * notify plugin startup, then on open options page.
 156      * This copy is simple assignment, but due to implicitly sharing
 157      * we don't have additional cost for that, copy will created
 158      * only after modification of private notify list.
 159      */
 160     QList<NotificationItem *> _privListNotifications;
 161
 162     QScopedPointer<Ui::NotifyPluginOptionsPage> _optionsPage;
 163
 164     // ! Widget to convinient selection of condition for field value (equal, lower, greater)
 165     QComboBox *_dynamicFieldCondition;
 166
 167     // ! Represents edit widget for dynamic UAVObjectfield,
 168     // ! can be spinbox - for numerics, combobox - enums, or
 169     // ! lineedit - for numerics with range constraints
 170     QWidget *_dynamicFieldWidget;
 171
 172     // ! Type of UAVObjectField - numeric or ENUM,
 173     // ! this variable needs to correctly set appropriate dynamic UI element (_dynamicFieldWidget)
 174     // ! NOTE: ocassionaly it should be invalidated (= -1) to reset _dynamicFieldWidget
 175     int _dynamicFieldType;
 176
 177     // ! Widget to convinient selection of position of <dynamic field value>
 178     // ! between sounds[1..3]
 179     QComboBox *_sayOrder;
 180
 181     // ! Actualy reference to optionsPageWidget,
 182     // ! we MUST hold it beyond the scope of createPage func
 183     // ! to have possibility change dynamic parts of options page layout in future
 184     QWidget *_form;
 185
 186     // ! Currently selected notification, all controls filled accroding to it.
 187     // ! On options page startup, always points to first row.
 188     NotificationItem *_selectedNotification;
 189
 190     // ! Retrieved from UAVObjectManager by name from _selectedNotification,
 191     // ! if UAVObjectManager doesn't have such object, this field will be NULL
 192     UAVDataObject *_currUAVObject;
 193     QMediaPlaylist *playlist;
 194 };
 195
 196 #endif // NOTIFYPLUGINOPTIONSPAGE_H