File indexing completed on 2024-05-12 04:55:37

 /**
  * \file id3libmetadataplugin.h
  * id3lib metadata plugin.
  *
  * \b Project: Kid3
  * \author Urs Fleisch
  * \date 23 Jul 2013
  *
  * Copyright (C) 2013-2024  Urs Fleisch
  *
  * This file is part of Kid3.
  *
  * Kid3 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.
  *
  * Kid3 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/>.
  */
 
 #pragma once
 
 #include <QObject>
 #include "itaggedfilefactory.h"
 
 /**
  * id3lib metadata plugin.
  */
 class KID3_PLUGIN_EXPORT Id3libMetadataPlugin
     : public QObject, public ITaggedFileFactory {
   Q_OBJECT
   Q_PLUGIN_METADATA(IID "org.kde.kid3.ITaggedFileFactory")
   Q_INTERFACES(ITaggedFileFactory)
 public:
   /*!
    * Constructor.
    * @param parent parent object
    */
   explicit Id3libMetadataPlugin(QObject* parent = nullptr);
 
   /**
    * Destructor.
    */
   ~Id3libMetadataPlugin() override = default;
 
   /**
    * Get name of factory, the same as the QObject::objectName() of the plugin.
    * @return factory name.
    */
   QString name() const override;
 
   /**
    * Get keys of available tagged file formats.
    * @return list of keys.
    */
   QStringList taggedFileKeys() const override;
 
   /**
    * Get features supported.
    * @param key tagged file key
    * @return bit mask with TaggedFile::Feature flags set.
    */
   int taggedFileFeatures(const QString& key) const override;
 
   /**
    * Initialize tagged file factory.
    *
    * @param key tagged file key
    */
   void initialize(const QString& key) override;
 
   /**
    * Create a tagged file.
    *
    * @param key tagged file key
    * @param fileName filename
    * @param idx model index
    * @param features optional tagged file features (TaggedFile::Feature flags)
    * to activate at creation
    *
    * @return tagged file, 0 if type not supported.
    */
   TaggedFile* createTaggedFile(
       const QString& key,
       const QString& fileName,
       const QPersistentModelIndex& idx,
       int features = 0) override;
 
   /**
    * Get a list with all extensions (e.g. ".mp3") supported by TaggedFile subclass.
    *
    * @param key tagged file key
    *
    * @return list of file extensions.
    */
   QStringList supportedFileExtensions(const QString& key) const override;
 
   /**
    * Notify about configuration change.
    * This method shall be called when the configuration changes.
    *
    * @param key tagged file key
    */
   void notifyConfigurationChange(const QString& key) override;
 };