File indexing completed on 2024-05-05 04:48:33

 /****************************************************************************************
  * Copyright (c) 2013 Konrad Zemek <konrad.zemek@gmail.com>                             *
  *                                                                                      *
  * 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 2 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 STATSYNCING_IMPORTER_PROVIDER_H
 #define STATSYNCING_IMPORTER_PROVIDER_H
 
 #include "statsyncing/Provider.h"
 
 #include "amarok_export.h"
 
 namespace StatSyncing
 {
 
 class ImporterManager;
 
 /**
  * The ImporterProvider class is a base class for every @see StatSyncing::Provider
  * derived statistic importer. It serves to reduce boilerplate by offering a common
  * implementation of some StatSyncing::Provider methods.
  *
  * For details about methods' purpose, and other methods that need to be implemented
  * in a concrete ImporterProvider, see StatSyncing::Provider documentation.
  */
 class AMAROK_EXPORT ImporterProvider : public Provider
 {
     Q_OBJECT
 
     /// Give ImporterManager access to config field in order to save and restore state.
     friend class ImporterManager;
 
 public:
     /**
      * The constructor stores @param config as a protected @see m_config variable, and
      * @param manager as @see m_manager. If config["uid"] isn't set, it's generated here.
      */
     ImporterProvider( const QVariantMap &config, ImporterManager *manager );
     ~ImporterProvider() override;
 
     /**
      * Provider's unique id which may be used as a key for configuration storage.
      * Returns m_config["uid"] by default.
      */
     QString id() const override;
 
     /**
      * Description of the provider. Returns m_importer->description() by default.
      */
     QString description() const override;
 
     /**
      * Provider's icon. Returns m_importer->icon() by default.
      */
     QIcon icon() const override;
 
     /**
      * Provider's name as displayed in Amarok's Metadata Configuration tab. Returns
      * m_config["name"] by default.
      */
     QString prettyName() const override;
 
     /**
      * Returns true if provider is configurable. Returns true by default.
      */
     bool isConfigurable() const override;
 
     /**
      * Returns configuration widget used to reconfigure this provider. By default
      * delegates to m_importer->getConfigWidget( m_config ).
      */
     ProviderConfigWidget *configWidget() override;
 
     /**
      * Reconfigures current provider. An ImporterManager subclass handles the
      * task, _recreating_ this provider with new configuration. Please note that
      * m_config["uid"] is not subject to reconfiguration.
      */
     void reconfigure( const QVariantMap &config ) override;
 
     /**
      * Determines if this provider should participate in statistics synchronization
      * by default. By default returns StatSyncing::Provider::NoByDefault .
      */
     Preference defaultPreference() override;
 
 Q_SIGNALS:
     void reconfigurationRequested( const QVariantMap &config );
 
 protected:
     /**
      * Configuration of this provider. It is saved and restored by an ImporterManager
      * subclass.
      */
     QVariantMap m_config;
     ImporterManager *m_manager;
 };
 
 } // namespace StatSyncing
 
 #endif // STATSYNCING_IMPORTER_PROVIDER_H