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

 /*
  *  SPDX-FileCopyrightText: 2017 Wolthera van Hövell tot Westerflier <griffinvalley@gmail.com>
  *
  *  SPDX-License-Identifier: LGPL-2.0-or-later
  */
 #ifndef LIBKIS_FILELAYER_H
 #define LIBKIS_FILELAYER_H
 
 #include <QObject>
 #include "Node.h"
 
 #include <kis_types.h>
 
 #include "kritalibkis_export.h"
 #include "libkis.h"
 
 /**
  * @brief The FileLayer class
  * A file layer is a layer that can reference an external image
  * and show said reference in the layer stack.
  *
  * If the external image is updated, Krita will try to update the
  * file layer image as well.
  */
 
 class KRITALIBKIS_EXPORT FileLayer : public Node
 {
     Q_OBJECT
     Q_DISABLE_COPY(FileLayer)
 
 public:
     explicit FileLayer(KisImageSP image,
                         const QString name = QString(),
                         const QString baseName=QString(),
                         const QString fileName=QString(),
                         const QString scalingMethod=QString(),
                         QObject *parent = 0);
     explicit FileLayer(KisFileLayerSP layer, QObject *parent = 0);
     ~FileLayer() override;
 public Q_SLOTS:
 
     /**
      * @brief type Krita has several types of nodes, split in layers and masks. Group
      * layers can contain other layers, any layer can contain masks.
      *
      * @return "filelayer"
      */
     QString type() const override;
 
     /**
      * @brief setProperties
      * Change the properties of the file layer.
      * @param fileName - A String containing the absolute file name.
      * @param scalingMethod - a string with the scaling method, defaults to "None",
      *  other options are "ToImageSize" and "ToImagePPI"
      */
     void setProperties(QString fileName, QString scalingMethod = QString("None"));
 
     /**
      * @brief makes the file layer to reload the connected image from disk
      */
     void resetCache();
 
     /**
      * @brief path
      * @return A QString with the full path of the referenced image.
      */
     QString path() const;
 
     /**
      * @brief scalingMethod
      * returns how the file referenced is scaled.
      * @return one of the following:
      * <ul>
      *  <li> None - The file is not scaled in any way.
      *  <li> ToImageSize - The file is scaled to the full image size;
      *  <li> ToImagePPI - The file is scaled by the PPI of the image. This keep the physical dimensions the same.
      * </ul>
      */
     QString scalingMethod() const;
 
 private:
     /**
      * @brief getFileNameFromAbsolute
      * referenced from the fileLayer dialog, this will jumps through all the hoops
      * to ensure that an appropriate filename will be gotten.
      * @param baseName the location of the document.
      * @param absolutePath the absolute location of the file referenced.
      * @return the appropriate relative path.
      */
     QString getFileNameFromAbsolute(const QString &basePath, QString filePath);
     QString m_baseName;
 };
 
 #endif // LIBKIS_FILELAYER_H