configtaskwidget.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, see <http://www.gnu.org/licenses/>
 */
#ifndef CONFIGTASKWIDGET_H
#define CONFIGTASKWIDGET_H

#include <uavobjectwidgetutils/uavobjectwidgetutils_global.h>
#include <extensionsystem/pluginmanager.h>

#include <QQueue>
#include <QWidget>
#include <QList>
#include <QLabel>
#include <QTableWidget>
#include <QDoubleSpinBox>
#include <QSpinBox>
#include <QCheckBox>
#include <QGroupBox>
#include <QPushButton>
#include <QDesktopServices>
#include <QUrl>
#include <QEvent>

class UAVObject;
class UAVDataObject;
class UAVObjectField;
class UAVObjectManager;
class UAVObjectUtilManager;
class smartSaveButton;

class UAVOBJECTWIDGETUTILS_EXPORT ConfigTaskWidget : public QWidget
{
    Q_OBJECT

public:
    struct shadow
    {
        QWidget *widget;
        double scale;
        bool isLimited;
        bool useUnits;
    };
    struct objectToWidget
    {
        UAVObject *object;
        UAVObjectField *field;
        QWidget *widget;
        int index;
        double scale;
        bool isLimited;
        bool useUnits;
        bool oneWayBind;
        QList<shadow *> shadowsList;
    };

    struct temphelper
    {
        quint32 objid;
        quint32 objinstid;
        bool operator==(const temphelper &lhs)
        {
            return (lhs.objid == this->objid && lhs.objinstid == this->objinstid);
        }
    };

    enum buttonTypeEnum {
        none,
        save_button,
        apply_button,
        reload_button,
        default_button,
        help_button,
        reboot_button,
        connections_button
    };
    enum metadataSetEnum { ALL_METADATA, SETTINGS_METADATA_ONLY, NONSETTINGS_METADATA_ONLY };

    struct uiRelationAutomation
    {
        QString objname;
        QString fieldname;
        QString element;
        QString url;
        unsigned instanceId;
        double scale;
        bool haslimits;
        bool useUnits;
        bool oneWayBind;
        buttonTypeEnum buttonType;
        QList<int> buttonGroup;
    };

    ConfigTaskWidget(QWidget *parent = nullptr);
    virtual ~ConfigTaskWidget();

    void disableMouseWheelEvents();
    bool eventFilter(QObject *obj, QEvent *evt);

    void saveObjectToSD(UAVObject *obj);
    UAVObjectManager *getObjectManager();
    UAVObjectUtilManager *getObjectUtilManager();
    static double listMean(QList<double> list);
    static double listVar(QList<double> list);

    void addUAVObject(QString objectName, QList<int> *reloadGroups = NULL);
    void addUAVObject(UAVObject *objectName, QList<int> *reloadGroups = NULL);

    void addWidget(QWidget *widget);

    void addUAVObjectToWidgetRelation(QString object, QString field, QWidget *widget, int index = 0,
                                      double scale = 1, bool isLimited = false,
                                      bool useUnits = false, QList<int> *defaultReloadGroups = nullptr,
                                      quint32 instID = 0, bool oneWayBind = false);

    void addConnectionsButton(QPushButton *button);

    void addWidgetToDefaultReloadGroups(QWidget *widget, QList<int> *groups);

    // bool addShadowWidget(QWidget *masterWidget, QWidget *shadowWidget, double shadowScale = 1,
    // bool shadowIsLimited = false, bool shadowUseUnits = false);
    bool addShadowWidget(QString object, QString field, QWidget *widget, int index = 0,
                         double scale = 1, bool isLimited = false, bool useUnits = false,
                         QList<int> *defaultReloadGroups = NULL, quint32 instID = 0);

    void autoLoadWidgets();
    void loadAllLimits();

    bool isAutopilotConnected();
    bool isDirty();
    void setDirty(bool value);

    bool allObjectsUpdated();
    void setOutOfLimitsStyle(QString style) { outOfLimitsStyle = style; }
    void addHelpButton(QPushButton *button, QString url);
    void forceShadowUpdates();
    void forceConnectedState();

    void setNotMandatory(QString object);

    virtual void tabSwitchingAway() {}

public slots:
    void onAutopilotDisconnect();
    void onAutopilotConnect();
    void invalidateObjects();
    void apply();
    void save();
signals:
    // fired when a widgets contents changes
    void widgetContentsChanged(QWidget *widget);
    // fired when the framework requests that the widgets values be populated, use for custom
    // behaviour
    void populateWidgetsRequested();
    // fired when the framework requests that the widgets values be refreshed, use for custom
    // behaviour
    void refreshWidgetsValuesRequested();
    // fired when the framework requests that the UAVObject values be updated from the widgets
    // value, use for custom behaviour
    void updateObjectsFromWidgetsRequested();
    // fired when the autopilot connects
    void autoPilotConnected();
    // fired when the autopilot disconnects
    void autoPilotDisconnected();
    void defaultRequested(int group);

private slots:
    void objectUpdated(UAVObject *);
    void defaultButtonClicked();
    void reloadButtonClicked();
    void rebootButtonClicked();
    void connectionsButtonClicked();
    void doRefreshHiddenObjects(UAVDataObject *);

private:
    int currentBoard;
    bool isConnected;
    bool allowWidgetUpdates;
    QStringList objectsList;
    QList<objectToWidget *> objOfInterest;
    ExtensionSystem::PluginManager *pm;
    UAVObjectManager *objManager;
    smartSaveButton *smartsave;
    QMap<UAVObject *, bool> objectUpdates;
    QMap<int, QList<objectToWidget *> *> defaultReloadGroups;
    QMap<QWidget *, objectToWidget *> shadowsList;
    QMap<QPushButton *, QString> helpButtonList;
    QList<QPushButton *> reloadButtonList;
    QList<QPushButton *> rebootButtonList;
    QList<QPushButton *> connectionsButtonList;
    bool dirty;
    bool setFieldFromWidget(QWidget *widget, UAVObjectField *field, int index, double scale,
                            bool usesUnits = false);
    bool setWidgetFromField(QWidget *widget, UAVObjectField *field, int index, double scale,
                            bool hasLimits, bool useUnits = false);
    bool widgetReadOnly(QWidget *widget) const;
    void connectWidgetUpdatesToSlot(QWidget *widget, const char *function);
    void disconnectWidgetUpdatesToSlot(QWidget *widget, const char *function);
    void loadWidgetLimits(QWidget *widget, UAVObjectField *field, int index, bool hasLimits,
                          bool useUnits, double scale);
    QString applyScaleToUnits(QString units, double scale);
    void setWidgetEnabledByObj(QWidget *widget, bool enabled);

    // BUTTONS
    void addApplySaveButtons(QPushButton *update, QPushButton *save);
    void addReloadButton(QPushButton *button, int buttonGroup);
    void addDefaultButton(QPushButton *button, int buttonGroup);
    void addRebootButton(QPushButton *button);

    void addUAVObjectToWidgetRelation(QString object, QString field, QWidget *widget,
                                      QString element, double scale, bool isLimited = false,
                                      bool useUnits = false, QList<int> *defaultReloadGroups = nullptr,
                                      quint32 instID = 0, bool oneWayBind = false);


    QString outOfLimitsStyle;
    QTimer *timeOut;
protected slots:
    virtual void disableObjUpdates();
    virtual void enableObjUpdates();
    virtual void clearDirty();
    virtual void widgetsContentsChanged();
    virtual void populateWidgets();
    virtual void refreshWidgetsValues(UAVObject *obj = NULL);
    virtual void updateObjectsFromWidgets();
    virtual void helpButtonPressed();

protected:
    virtual void enableControls(bool enable);
    void checkWidgetsLimits(QWidget *widget, UAVObjectField *field, int index, bool hasLimits,
                            bool useUnits, QVariant value, double scale);
    virtual QVariant getVariantFromWidget(QWidget *widget, double scale, bool usesUnits = false);
    virtual bool setWidgetFromVariant(QWidget *widget, QVariant value, double scale,
                                      QString units = "");
    virtual QString getOptionFromChecked(QWidget *widget, bool checked);
    virtual bool getCheckedFromOption(QWidget *widget, QString option);
    bool resetWidgetToDefault(QWidget *widget);
    void setWidgetProperty(QWidget *widget, const char *prop, const QVariant &value);
    void setWidgetEnabled(QWidget *widget, bool enabled = true);

    UAVObjectUtilManager *utilMngr;
};

#endif // CONFIGTASKWIDGET_H