QGCCorePlugin.h 3.36 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
/****************************************************************************
 *
 *   (c) 2009-2016 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
 *
 * QGroundControl is licensed according to the terms in the file
 * COPYING.md in the root of the source code directory.
 *
 ****************************************************************************/

#pragma once

#include "QGCToolbox.h"

#include <QObject>
#include <QVariantList>

/// @file
///     @brief Core Plugin Interface for QGroundControl
///     @author Gus Grubba <mavlink@grubba.com>

// Work In Progress

class QGCApplication;
class QGCOptions;
class QGCSettings;
class QGCCorePlugin_p;
27
class FactMetaData;
28 29 30 31 32 33 34 35

class QGCCorePlugin : public QGCTool
{
    Q_OBJECT
public:
    QGCCorePlugin(QGCApplication* app);
    ~QGCCorePlugin();

36
    Q_PROPERTY(QVariantList settingsPages       READ settingsPages      NOTIFY settingsPagesChanged)
37 38
    Q_PROPERTY(int          defaultSettings     READ defaultSettings    CONSTANT)
    Q_PROPERTY(QGCOptions*  options             READ options            CONSTANT)
39

DonLakeFlyer's avatar
DonLakeFlyer committed
40 41
    Q_PROPERTY(bool         showTouchAreas      READ showTouchAreas     WRITE setShowTouchAreas    NOTIFY showTouchAreasChanged)
    Q_PROPERTY(bool         showAdvancedUI      READ showAdvancedUI     WRITE setShowAdvancedUI    NOTIFY showAdvancedUIChanged)
42 43

    Q_PROPERTY(QString      brandImageIndoor    READ brandImageIndoor   CONSTANT)
Donald Gagne's avatar
Donald Gagne committed
44
    Q_PROPERTY(QString      brandImageOutdoor   READ brandImageOutdoor  CONSTANT)
45

46 47
    /// The list of settings under the Settings Menu
    /// @return A list of QGCSettings
48
    virtual QVariantList&           settingsPages       ();
49

50 51 52 53 54 55 56
    /// The default settings panel to show
    /// @return The settings index
    virtual int                     defaultSettings     ();

    /// Global options
    /// @return An instance of QGCOptions
    virtual QGCOptions*             options             ();
57

Don Gagne's avatar
Don Gagne committed
58
    /// Allows the core plugin to override the visibility for a settings group
59 60
    ///     @param name - Setting group name
    /// @return true: Show settings ui, false: Hide settings ui
Don Gagne's avatar
Don Gagne committed
61
    virtual bool overrideSettingsGroupVisibility        (QString name);
62

63 64 65 66
    /// Allows the core plugin to override the setting meta data before the setting fact is created.
    ///     @param metaData - MetaData for setting fact
    /// @return true: Setting should be visible in ui, false: Setting should not be shown in ui
    virtual bool adjustSettingMetaData                  (FactMetaData& metaData);
67

68 69 70 71 72 73
    /// Return the resource file which contains the brand image for for Indoor theme.
    virtual QString brandImageIndoor(void) const { return QString(); }

    /// Return the resource file which contains the brand image for for Outdoor theme.
    virtual QString brandImageOutdoor(void) const { return QString(); }

DonLakeFlyer's avatar
DonLakeFlyer committed
74 75 76 77
    bool showTouchAreas(void) const { return _showTouchAreas; }
    bool showAdvancedUI(void) const { return _showAdvancedUI; }
    void setShowTouchAreas(bool show);
    void setShowAdvancedUI(bool show);
78

79
    // Override from QGCTool
80
    void                            setToolbox          (QGCToolbox *toolbox);
81 82 83 84 85 86 87 88 89 90

signals:
    void settingsPagesChanged   (void);
    void showTouchAreasChanged  (bool showTouchAreas);
    void showAdvancedUIChanged  (bool showAdvancedUI);

protected:
    bool                _showTouchAreas;
    bool                _showAdvancedUI;

91
private:
92
    QGCCorePlugin_p*    _p;
93
};