ground/gcs/src/plugins/uavobjectwidgetutils/configtaskwidget.h

   1 /**
   2  ******************************************************************************
   3  *
   4  * @file       configtaskwidget.h
   5  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
   6  * @addtogroup GCSPlugins GCS Plugins
   7  * @{
   8  * @addtogroup UAVObjectWidgetUtils Plugin
   9  * @{
  10  * @brief Utility plugin for UAVObject to Widget relation management
  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 #ifndef CONFIGTASKWIDGET_H
  28 #define CONFIGTASKWIDGET_H
  29
  30 #include "uavobjectwidgetutils_global.h"
  31
  32 #include <QWidget>
  33 #include <QList>
  34 #include <QVariant>
  35
  36 namespace ExtensionSystem {
  37 class PluginManager;
  38 }
  39 class UAVObject;
  40 class UAVObjectField;
  41 class UAVObjectManager;
  42 class UAVObjectUtilManager;
  43 class SmartSaveButton;
  44
  45 class QComboBox;
  46 class QPushButton;
  47 class QEvent;
  48
  49 class ShadowWidgetBinding : public QObject {
  50     Q_OBJECT
  51 public:
  52     ShadowWidgetBinding(QWidget *widget, double scale, bool isLimited);
  53     ~ShadowWidgetBinding();
  54     QWidget *widget() const;
  55     double scale() const;
  56     bool isLimited() const;
  57
  58 protected:
  59     QWidget *m_widget;
  60     double m_scale;
  61     bool m_isLimited;
  62 };
  63
  64 class WidgetBinding : public ShadowWidgetBinding {
  65     Q_OBJECT
  66 public:
  67     WidgetBinding(QWidget *widget, UAVObject *object, UAVObjectField *field, int index, double scale, bool isLimited);
  68     ~WidgetBinding();
  69
  70     QString units() const;
  71     QString type() const;
  72     bool isInteger() const;
  73     UAVObject *object() const;
  74     UAVObjectField *field() const;
  75     int index() const;
  76     QList<ShadowWidgetBinding *> shadows() const;
  77
  78     void addShadow(QWidget *widget, double scale, bool isLimited);
  79     bool matches(QString objectName, QString fieldName, int index, quint32 instanceId);
  80
  81     bool isEnabled() const;
  82     void setIsEnabled(bool isEnabled);
  83
  84     QVariant value() const;
  85     void setValue(const QVariant &value);
  86
  87     void updateObjectFieldFromValue();
  88     void updateValueFromObjectField();
  89
  90 private:
  91     UAVObject *m_object;
  92     UAVObjectField *m_field;
  93     int m_index;
  94     bool m_isEnabled;
  95     QList<ShadowWidgetBinding *> m_shadows;
  96     QVariant m_value;
  97 };
  98
  99 class UAVOBJECTWIDGETUTILS_EXPORT ConfigTaskWidget : public QWidget {
 100     Q_OBJECT
 101
 102 public:
 103     enum ConfigTaskType { AutoPilot, OPLink, Child };
 104
 105     ConfigTaskWidget(QWidget *parent = 0, ConfigTaskType configType = AutoPilot);
 106     virtual ~ConfigTaskWidget();
 107
 108     void bind();
 109
 110     bool isDirty();
 111     void setDirty(bool value);
 112     void clearDirty();
 113
 114     virtual bool shouldObjectBeSaved(UAVObject *object);
 115
 116 protected:
 117     // Combobox helper functions
 118     static bool isComboboxOptionSelected(QComboBox *combo, int optionValue);
 119     static int getComboboxSelectedOption(QComboBox *combo);
 120     static void setComboboxSelectedOption(QComboBox *combo, int optionValue);
 121     static int getComboboxIndexForOption(QComboBox *combo, int optionValue);
 122     static void enableComboBoxOptionItem(QComboBox *combo, int optionValue, bool enable);
 123
 124     void disableMouseWheelEvents();
 125     bool eventFilter(QObject *obj, QEvent *evt);
 126
 127     UAVObjectManager *getObjectManager();
 128
 129     void addUAVObject(QString objectName, QList<int> *reloadGroups = NULL);
 130     void addUAVObject(UAVObject *objectName, QList<int> *reloadGroups = NULL);
 131
 132 // TODO should be protected (see VehicleConfig::registerWidgets(ConfigTaskWidget &parent)
 133 public:
 134     void addWidget(QWidget *widget);
 135
 136     void addWidgetBinding(QString objectName, QString fieldName, QWidget *widget, int index = 0, double scale = 1,
 137                           bool isLimited = false, QList<int> *reloadGroupIDs = 0, quint32 instID = 0);
 138     void addWidgetBinding(UAVObject *object, UAVObjectField *field, QWidget *widget, int index = 0, double scale = 1,
 139                           bool isLimited = false, QList<int> *reloadGroupIDs = 0, quint32 instID = 0);
 140
 141 protected:
 142     void addAutoBindings();
 143
 144     void addWidgetBinding(QString objectName, QString fieldName, QWidget *widget, QString elementName, double scale,
 145                           bool isLimited = false, QList<int> *reloadGroupIDs = 0, quint32 instID = 0);
 146     void addWidgetBinding(UAVObject *object, UAVObjectField *field, QWidget *widget, QString elementName, double scale,
 147                           bool isLimited = false, QList<int> *reloadGroupIDs = 0, quint32 instID = 0);
 148
 149     void addWidgetBinding(QString objectName, QString fieldName, QWidget *widget, QString elementName);
 150     void addWidgetBinding(UAVObject *object, UAVObjectField *field, QWidget *widget, QString elementName);
 151
 152     void addWidgetToReloadGroups(QWidget *widget, QList<int> *reloadGroupIDs);
 153
 154     bool addShadowWidgetBinding(QString objectName, QString fieldName, QWidget *widget, int index = 0, double scale = 1,
 155                                 bool isLimited = false, QList<int> *m_reloadGroups = NULL, quint32 instID = 0);
 156
 157     bool allObjectsUpdated();
 158     void setOutOfLimitsStyle(QString style)
 159     {
 160         m_outOfLimitsStyle = style;
 161     }
 162     void addHelpButton(QPushButton *button, QString url);
 163     void setWikiURL(QString url);
 164
 165 protected slots:
 166     void apply();
 167     void save();
 168
 169 signals:
 170     void connected();
 171     void disconnected();
 172     void widgetContentsChanged(QWidget *widget);
 173     void defaultRequested(int group);
 174     void enableControlsChanged(bool enable);
 175
 176 protected:
 177     int boardModel() const
 178     {
 179         return m_currentBoardId;
 180     }
 181     bool expertMode() const;
 182     virtual QString mapObjectName(const QString objectName);
 183     virtual UAVObject *getObject(const QString name, quint32 instId = 0);
 184     virtual void buildOptionComboBox(QComboBox *combo, UAVObjectField *field, int index, bool applyLimits);
 185
 186     virtual void enableControls(bool enable);
 187     virtual void refreshWidgetsValuesImpl(UAVObject *) {};
 188     virtual void updateObjectsFromWidgetsImpl() {};
 189
 190     bool isConnected() const;
 191     void updateEnableControls();
 192
 193 protected slots:
 194     void setWidgetBindingObjectEnabled(QString objectName, bool enabled);
 195
 196     virtual void widgetsContentsChanged();
 197     void refreshWidgetsValues(UAVObject *obj = NULL);
 198     void updateObjectsFromWidgets();
 199
 200 private slots:
 201     void onConnect();
 202     void onDisconnect();
 203
 204     void disableObjectUpdates();
 205     void enableObjectUpdates();
 206     void objectUpdated(UAVObject *object);
 207     void invalidateObjects();
 208
 209     void saveSuccessful();
 210
 211     void defaultButtonClicked();
 212     void reloadButtonClicked();
 213     void helpButtonPressed();
 214
 215 private:
 216     struct ObjectComparator {
 217         quint32 objid;
 218         quint32 objinstid;
 219         bool operator==(const ObjectComparator & lhs)
 220         {
 221             return lhs.objid == this->objid && lhs.objinstid == this->objinstid;
 222         }
 223     };
 224
 225     enum ButtonTypeEnum { None, SaveButton, ApplyButton, ReloadButton, DefaultButton, HelpButton };
 226     struct BindingStruct {
 227         QString objectName;
 228         QString fieldName;
 229         QString elementName;
 230         int     index;
 231         QString url;
 232         ButtonTypeEnum buttonType;
 233         QList<int>     buttonGroup;
 234         double  scale;
 235         bool    haslimits;
 236     };
 237
 238     // indicates if this is an "autopilot" widget (CC3D, Revolution, ...), an OPLink widget or a Child widget (for vehicle config)
 239     // TODO the logic that this flag controls should be moved to derived classes
 240     ConfigTaskType m_configType;
 241
 242     // only valid for "autopilot" widgets
 243     int m_currentBoardId;
 244
 245     bool m_isConnected;
 246     bool m_isWidgetUpdatesAllowed;
 247     bool m_isDirty;
 248     bool m_refreshing;
 249
 250     QStringList m_objects;
 251
 252     // Wiki address for help button (will be concatenated with WIKI_URL_ROOT)
 253     QString m_wikiURL;
 254
 255     QMultiHash<int, WidgetBinding *> m_reloadGroups;
 256     QMultiHash<QWidget *, WidgetBinding *> m_widgetBindingsPerWidget;
 257     QMultiHash<UAVObject *, WidgetBinding *> m_widgetBindingsPerObject;
 258
 259     ExtensionSystem::PluginManager *m_pluginManager;
 260     UAVObjectUtilManager *m_objectUtilManager;
 261
 262     QHash<UAVObject *, bool> m_updatedObjects;
 263
 264     SmartSaveButton *m_saveButton;
 265     QHash<QPushButton *, QString> m_helpButtons;
 266     QList<QPushButton *> m_reloadButtons;
 267
 268     QString m_outOfLimitsStyle;
 269     QTimer *m_realtimeUpdateTimer;
 270
 271     bool setWidgetFromField(QWidget *widget, UAVObjectField *field, WidgetBinding *binding);
 272
 273     QVariant getVariantFromWidget(QWidget *widget, WidgetBinding *binding);
 274     bool setWidgetFromVariant(QWidget *widget, QVariant value, WidgetBinding *binding);
 275
 276     void connectWidgetUpdatesToSlot(QWidget *widget, const char *function);
 277     void disconnectWidgetUpdatesToSlot(QWidget *widget, const char *function);
 278
 279     void resetLimits();
 280
 281     void loadWidgetLimits(QWidget *widget, UAVObjectField *field, int index, bool applyLimits, double scale);
 282
 283     void checkWidgetsLimits(QWidget *widget, UAVObjectField *field, int index, bool hasLimits, QVariant value, double scale);
 284
 285     void dumpBindings();
 286
 287     int fieldIndexFromElementName(QString objectName, QString fieldName, QString elementName);
 288
 289     void doAddWidgetBinding(QString objectName, QString fieldName, QWidget *widget, int index = 0, double scale = 1,
 290                             bool isLimited = false, QList<int> *reloadGroupIDs = 0, quint32 instID = 0);
 291
 292     void addApplyButton(QPushButton *button);
 293     void addSaveButton(QPushButton *button);
 294     void addReloadButton(QPushButton *button, int buttonGroup);
 295     void addDefaultButton(QPushButton *button, int buttonGroup);
 296 };
 297
 298 #endif // CONFIGTASKWIDGET_H