Scratchpad.h

/*
 *  SPDX-FileCopyrightText: 2020 Scott Petrovic <scottpetrovic@gmail.com>
 *
 *  SPDX-License-Identifier: LGPL-2.0-or-later
 */
#ifndef LIBKIS_SCRATCHPAD_H
#define LIBKIS_SCRATCHPAD_H
 
#include <QObject>
#include <QColor>
#include <kis_types.h>
#include "kritalibkis_export.h"
#include "libkis.h"
#include "kis_scratch_pad.h"
#include "View.h"
 
class KoCanvasBase;
class Canvas; // This comes from Python. This would be maybe better
class KisView;
 
/**
 * @brief The Scratchpad class
 * A scratchpad is a type of blank canvas area that can be painted on 
 * with the normal painting devices
 *
 */
class KRITALIBKIS_EXPORT Scratchpad: public QWidget
{
    Q_OBJECT
public:
    Scratchpad(View *view, const QColor & defaultColor, QWidget *parent = 0);
    ~Scratchpad();
 
public Q_SLOTS:
 
    /**
     * @brief Clears out scratchpad with color specified set during setup
     */
    void clear();
 
    /**
     * @brief Fill the entire scratchpad with a color
     * @param Color to fill the canvas with
     */
    void setFillColor(QColor color);
 
    /**
     * @brief Switches between a GUI controlling the current mode and when mouse clicks control mode
     * @param Setting to true allows GUI to control the mode with explicitly setting mode
     */
    void setModeManually(bool value);
 
 
    /**
     * @brief Manually set what mode scratchpad is in. Ignored if "setModeManually is set to false
     * @param Available options are: "painting", "panning", and "colorsampling"
     */
    void setMode(QString modeName);
 
    /**
     * @brief Makes a connection between the zoom of the canvas and scratchpad area so they zoom in sync
     * @param Should the scratchpad share the zoom level. Default is true
     */
    void linkCanvasZoom(bool value);
 
 
    /**
     * @brief Load image data to the scratchpad
     * @param Image object to load
     */
    void loadScratchpadImage(QImage image);
 
    /**
     * @brief Take what is on the scratchpad area and grab image
     * @return the image data from the scratchpad
     */
    QImage copyScratchpadImageData();
 
 
private:
    struct Private;
    const QScopedPointer<Private> d;
 
};
 
#endif // LIBKIS_SCRATCHPAD_H