File indexing completed on 2024-05-19 04:56:11

 /**
  * \file itaggedfilefactory.h
  * Interface for tagged file factory.
  *
  * \b Project: Kid3
  * \author Urs Fleisch
  * \date 22 Jul 2013
  *
  * Copyright (C) 2013-2018  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 <QtPlugin>
 #include <QStringList>
 #include "kid3api.h"
 
 class QPersistentModelIndex;
 class TaggedFile;
 
 /**
  * Interface for tagged file factory.
  */
 class KID3_CORE_EXPORT ITaggedFileFactory {
 public:
   /**
    * Destructor.
    */
   virtual ~ITaggedFileFactory();
 
   /**
    * Get name of factory, the same as the QObject::objectName() of the plugin.
    * @return factory name.
    */
   virtual QString name() const = 0;
 
   /**
    * Get keys of available tagged file formats.
    * @return list of keys.
    */
   virtual QStringList taggedFileKeys() const = 0;
 
   /**
    * Get features supported.
    * @param key tagged file key
    * @return bit mask with TaggedFile::Feature flags set.
    */
   virtual int taggedFileFeatures(const QString& key) const = 0;
 
   /**
    * Initialize tagged file factory.
    * This method has to be called before creating a tagged file.
    * It can be called after the application is initialized and therefore can
    * access application data which is not possible in the constructor.
    *
    * @param key tagged file key
    */
   virtual void initialize(const QString& key) = 0;
 
   /**
    * 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.
    */
   virtual TaggedFile* createTaggedFile(
       const QString& key,
       const QString& fileName,
       const QPersistentModelIndex& idx,
       int features = 0) = 0;
 
   /**
    * Get a list with all extensions (e.g. ".mp3") supported by TaggedFile subclass.
    *
    * @param key tagged file key
    *
    * @return list of file extensions.
    */
   virtual QStringList supportedFileExtensions(const QString& key) const = 0;
 
   /**
    * Notify about configuration change.
    * This method shall be called when the configuration changes.
    *
    * @param key tagged file key
    */
   virtual void notifyConfigurationChange(const QString& key) = 0;
 };
 
 Q_DECLARE_INTERFACE(ITaggedFileFactory,
                     "org.kde.kid3.ITaggedFileFactory")