File indexing completed on 2024-05-12 15:59:15

 /*
  *  SPDX-FileCopyrightText: 2007 Cyrille Berger <cberger@cberger.net>
  *  SPDX-FileCopyrightText: 2021 L. E. Segovia <amy@amyspark.me>
  *
  *  SPDX-License-Identifier: LGPL-2.1-or-later
  */
 
 #ifndef _KIS_META_DATA_IO_BACKEND_H_
 #define _KIS_META_DATA_IO_BACKEND_H_
 
 #include <kritametadata_export.h>
 
 class QIODevice;
 class QString;
 
 namespace KisMetaData
 {
 class Store;
 /**
  * This is a the interface for input or output backend to KisMetaData.
  * For instance, to add support to exif or xmp or iptc or dublin core
  * or anything else, it is needed to extend this interface.
  */
 class KRITAMETADATA_EXPORT IOBackend
 {
 public:
     /**
      * Tell whether the backend input/output from/to binary data
      * or text (XML or RDF) data.
      */
     enum BackendType { Binary, Text };
 
     enum HeaderType {
         NoHeader, ///< Don't append any header
         JpegHeader ///< Append Jpeg-style header
     };
 
 public:
     virtual ~IOBackend(){};
 
     virtual QString id() const = 0;
 
     virtual QString name() const = 0;
 
     /**
      * @return the type of the backend
      */
     virtual BackendType type() const = 0;
 
     /**
      * @return tell if this backend support saving
      */
     virtual bool supportSaving() const = 0;
 
     /**
      * @param store the list of metadata to save
      * @param ioDevice the device to where the metadata will be saved
      * @param headerType determine if an header must be prepend to the binary header, and if it does,
      *                   which type of header
      * @return true if the save was successful (XXX: actually, all backends always return true...)
      */
     virtual bool saveTo(Store *store, QIODevice *ioDevice, HeaderType headerType = NoHeader) const = 0;
 
     /**
      * @param store the list of metadata
      * @return true if this backend is capable of saving all the metadata
      * of the store
      */
     virtual bool canSaveAllEntries(Store *store) const = 0;
 
     /**
      * @return true if this backend support loading
      */
     virtual bool supportLoading() const = 0;
 
     /**
      * @param store the list of metadata to load
      * @param ioDevice the device from where the metadata will be loaded
      * @return true if the load was successful
      */
     virtual bool loadFrom(Store *store, QIODevice *ioDevice) const = 0;
 };
 }
 
 #endif