File indexing completed on 2024-05-12 15:58:32

 /*
  *  SPDX-FileCopyrightText: 2015 Dmitry Kazakov <dimula73@gmail.com>
  *
  *  SPDX-License-Identifier: GPL-2.0-or-later
  */
 
 #ifndef __KIS_PAINT_DEVICE_FRAMES_INTERFACE_H
 #define __KIS_PAINT_DEVICE_FRAMES_INTERFACE_H
 
 #include "kis_types.h"
 #include "kritaimage_export.h"
 
 class KisPaintDeviceData;
 class KisPaintDeviceWriter;
 class KisDataManager;
 typedef KisSharedPtr<KisDataManager> KisDataManagerSP;
 
 class KisInterstrokeData;
 using KisInterstrokeDataSP = QSharedPointer<KisInterstrokeData>;
 
 
 class KRITAIMAGE_EXPORT KisPaintDeviceFramesInterface
 {
 public:
     KisPaintDeviceFramesInterface(KisPaintDevice *parentDevice);
 
     /**
      * Return a list of IDs for the frames contained in this paint device
      * @return list of frame IDs
      */
     QList<int> frames();
 
     /**
      * Creates a new frame on the device and returns an identifier for it.
      * @return frame id of the newly created frame
      */
     int createFrame(bool copy, int copySrc, const QPoint &offset, KUndo2Command *parentCommand);
 
     /**
      * Delete the frame with given id
      * @param frame frame ID
      * @param parentCommand parent command
      */
     void deleteFrame(int frame, KUndo2Command *parentCommand);
 
     /**
      * Copy the given frame into the target device
      * @param frameId ID of the frame to be copied
      * @param targetDevice paint device to copy to
      */
     void writeFrameToDevice(int frameId, KisPaintDeviceSP targetDevice);
 
     /**
      * Copy the given paint device contents into the specified frame
      * @param srcFrameId ID of the frame to copy from (must exist)
      * @param dstFrameId ID of the frame to be overwritten (must exist)
      * @param srcDevice paint device to copy from
      */
     void uploadFrame(int srcFrameId, int dstFrameId, KisPaintDeviceSP srcDevice);
 
     /**
      * Copy the given paint device contents into the specified frame
      * @param dstFrameId ID of the frame to be overwritten (must exist)
      * @param srcDevice paint device to copy from
      */
     void uploadFrame(int dstFrameId, KisPaintDeviceSP srcDevice);
 
     /**
      * @return extent() of \p frameId
      */
     QRect frameBounds(int frameId);
 
     /**
      * @return offset of a data on \p frameId
      */
     QPoint frameOffset(int frameId) const;
 
     /**
      * Sets default pixel for \p frameId
      */
     void setFrameDefaultPixel(const KoColor &defPixel, int frameId);
 
     /**
      * @return default pixel for \p frameId
      */
     KoColor frameDefaultPixel(int frameId) const;
 
     /**
      * Write a \p frameId onto \p store
      */
     bool writeFrame(KisPaintDeviceWriter &store, int frameId);
 
     /**
      * Loads content of a \p frameId from \p stream.
      *
      * NOTE: the frame must be created manually with createFrame()
      *       beforehand!
      */
     bool readFrame(QIODevice *stream, int frameId);
 
 
     /**
      * Returns frameId of the currently active frame.
      * Should be used by Undo framework only!
      */
     int currentFrameId() const;
 
     /**
      * Returns the data manager of the specified frame.
      * Should be used by Undo framework only!
      */
     KisDataManagerSP frameDataManager(int frameId) const;
 
     /**
      * Resets the cache object associated with the frame.
      * Should be used by Undo framework only!
      */
     void invalidateFrameCache(int frameId);
 
     /**
      * Sets the offset for \p frameId.
      * Should be used by Undo framework only!
      */
     void setFrameOffset(int frameId, const QPoint &offset);
 
     struct TestingDataObjects {
         typedef KisPaintDeviceData Data;
         typedef QHash<int, Data*> FramesHash;
 
         Data *m_data;
         Data *m_lodData;
         Data *m_externalFrameData;
 
         FramesHash m_frames;
 
         Data *m_currentData;
     };
 
     TestingDataObjects testingGetDataObjects() const;
     QList<KisPaintDeviceData*> testingGetDataObjectsList() const;
 
 private:
     KisPaintDevice *q;
 };
 
 #endif /* __KIS_PAINT_DEVICE_FRAMES_INTERFACE_H */