QG4/src/api/QGCCorePlugin.h

/****************************************************************************
 *
 *   (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;

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

    Q_PROPERTY(QVariantList settings            READ settings           CONSTANT)
    Q_PROPERTY(int          defaultSettings     READ defaultSettings    CONSTANT)
    Q_PROPERTY(QGCOptions*  options             READ options            CONSTANT)
    Q_PROPERTY(QVariantList toolBarIndicators   READ toolBarIndicators  CONSTANT)

    /// The list of settings under the Settings Menu
    /// @return A list of QGCSettings
    virtual QVariantList&           settings            ();

    /// Allows the core plugin to override the toolbar indicators
    /// @return A list of QUrl with the indicators (see MainToolBarIndicators.qml)
    virtual QVariantList&           toolBarIndicators   ();

    /// The default settings panel to show
    /// @return The settings index
    virtual int                     defaultSettings     ();

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

    /// Allows the core plugin to override the default value for the specified setting
    ///     @param name - Setting name
    ///     @param defaultValue - Standard default value for setting
    /// @return New default value for setting, if no override just return passed in defaultValue
    virtual QVariant overrideSettingsDefault            (QString name, QVariant defaultValue);

    // Override from QGCTool
    void                            setToolbox          (QGCToolbox *toolbox);
private:
    QGCCorePlugin_p* _p;
};