File indexing completed on 2024-04-28 15:16:06

 // SPDX-License-Identifier: LGPL-2.1-or-later
 //
 // SPDX-FileCopyrightText: 2010 Dennis Nienhüser <nienhueser@kde.org>
 // SPDX-FileCopyrightText: 2011 Thibaut Gridel <tgridel@free.fr>
 // SPDX-FileCopyrightText: 2012 Bernhard Beschow <bbeschow@cs.tu-berlin.de>
 //
 
 #ifndef MARBLE_ROUTINGRUNNERPLUGIN_H
 #define MARBLE_ROUTINGRUNNERPLUGIN_H
 
 #include <QObject>
 #include "PluginInterface.h"
 
 #include <QHash>
 #include <QWidget>
 
 #include "routing/RoutingProfilesModel.h"
 
 namespace Marble
 {
 
 class MarbleAbstractRunner;
 class RoutingRunner;
 
 /**
   * A plugin for Marble to execute a routing task.
   */
 class MARBLE_EXPORT RoutingRunnerPlugin : public QObject, public PluginInterface
 {
     Q_OBJECT
 
 public:
     /** Constructor with optional parent object */
     explicit RoutingRunnerPlugin( QObject* parent = nullptr );
 
     /** Destructor */
     ~RoutingRunnerPlugin() override;
 
     /**
      * @brief Returns the string that should appear in the user interface.
      *
      * For example, "OpenRouteService" should be returned for the OpenRouteService routing plugin.
      */
     virtual QString guiString() const = 0;
 
     /** Plugin factory method to create a new runner instance.
       * Method caller gets ownership of the returned object
       */
     virtual RoutingRunner *newRunner() const = 0;
 
     /** True if the plugin supports its tasks on the given planet */
     bool supportsCelestialBody( const QString &celestialBodyId ) const;
 
     /** True if the plugin can execute its tasks without network access */
     bool canWorkOffline() const;
 
     /**
      * @brief Returns @code true @endcode if the plugin is able to perform its claimed task.
      *
      * The default implementation returns @code true @endcode. This method can be
      * overridden for example to indicate an incomplete installation.
      */
     virtual bool canWork() const;
 
     // Overridden methods with default implementations
 
     QIcon icon() const override;
 
     /** A status message showing whether the plugin will be able to deliver results */
     QString statusMessage() const;
 
     class ConfigWidget : public QWidget
     {
     public:
         virtual void loadSettings( const QHash<QString, QVariant> &settings ) = 0;
         virtual QHash<QString, QVariant> settings() const = 0;
     };
     /**
      * @brief Method for getting a pointer to the configuration widget of the plugin.
      *
      * @return The configuration widget or, if no configuration widget exists, 0.
      */
     virtual ConfigWidget *configWidget();
 
     /** True if the plugin supports the given routing profile template */
     virtual bool supportsTemplate( RoutingProfilesModel::ProfileTemplate profileTemplate ) const;
 
     /** Settings for the given routing profile template */
     virtual QHash<QString, QVariant> templateSettings( RoutingProfilesModel::ProfileTemplate profileTemplate ) const;
 
 protected:
     void setStatusMessage( const QString &message );
 
     void setSupportedCelestialBodies( const QStringList &celestialBodies );
 
     void setCanWorkOffline( bool canWorkOffline );
 
 private:
     class Private;
     Private *const d;
 };
 
 }
 
 Q_DECLARE_INTERFACE( Marble::RoutingRunnerPlugin, "org.kde.Marble.RunnerRunnerPlugin/1.01" )
 
 #endif // MARBLE_ROUTINGRUNNERPLUGIN_H