The Scratchpad class A scratchpad is a type of blank canvas area that can be painted on with the normal painting devices. More...

#include <Scratchpad.h>

Inheritance diagram for Scratchpad:

Classes
struct	Private

Public Slots
bool	canvasZoomLink ()
	return if scratchpad zoom level is linked with current view zoom level

void	clear ()
	Clears out scratchpad with color specified set during setup.

QRect	contentBounds () const
	The content of scratchpad can be bigger or smaller than scratchpad dimension. The bounds return the area in which there's some content.

QImage	copyScratchpadImageData ()
	Take what is on the scratchpad area and grab image.

void	fillBackground ()
	Fill the entire scratchpad with current background color.

void	fillDefault ()
	Fill the entire scratchpad with default color.

void	fillDocument (bool fullContent=true)
	Fill the entire scratchpad with current document projection content.

void	fillForeground ()
	Fill the entire scratchpad with current foreground color.

void	fillGradient (const QPoint &gradientVectorStart=QPoint(), const QPoint &gradientVectorEnd=QPoint(), const QString &gradientShape="linear", const QString &gradientRepeat="none", bool reverseGradient=false, bool dither=false)
	Fill the entire scratchpad with current gradient.

void	fillLayer (bool fullContent=true)
	Fill the entire scratchpad with current layer content.

void	fillPattern (QTransform transform=QTransform())
	Fill the entire scratchpad with current pattern.

void	fillTransparent ()
	Fill the entire scratchpad with a transparent color.

void	linkCanvasZoom (bool value)
	DEPRECATED – USE setCanvasZoomLink() instead Makes a connection between the zoom of the canvas and scratchpad area so they zoom in sync.

void	loadScratchpadImage (QImage image)
	Load image data to the scratchpad.

void	panCenter ()
	pan scratchpad content to center content in viewport

void	panTo (qint32 x, qint32 y)
	pan scratchpad content to top-left position of scratchpad viewport Provided value are absolute

qreal	scale ()
	return current zoom level applied on scratchpad (whatever the zoom source is: view zoom level or set manually)

void	scaleReset ()
	reset scale and pan to origin Note: call method is ignored if canvasZoomLink() is True

void	scaleToFit ()
	calculate scale automatically to fit scratchpad content in scratchpad viewport Note: call method is ignored if canvasZoomLink() is True

void	setCanvasZoomLink (bool value)
	Makes a connection between the zoom of the canvas and scratchpad area so they zoom in sync.

void	setFillColor (QColor color)
	Define default fill color for scratchpad.

void	setMode (QString modeName)
	Manually set what mode scratchpad is in. Ignored if "setModeManually is set to false.

void	setModeManually (bool value)
	Switches between a GUI controlling the current mode and when mouse clicks control mode.

bool	setScale (qreal scale) const
	allow to manually set scratchpad zoom level Note: call method is ignored if canvasZoomLink() is True,

QRect	viewportBounds () const
	The viewport indicates which part of scratchpad content is visible. It takes in account the current translation & scale.

Signals
void	contentChanged ()
	signal is emitted when scratchpad content is changed (stroke or fill)

void	scaleChanged (qreal scale)
	signal is emitted when scratchpad scale is changed (from zoom canvas or manually)

void	viewportChanged (const QRect rect)
	signal is emitted when scratchpad viewport has been modified (pan, zoom)

Public Member Functions
	Scratchpad (View view, const QColor &defaultColor, QWidget parent=0)

	~Scratchpad ()

Private Attributes
const QScopedPointer< Private >	d

Detailed Description

The Scratchpad class A scratchpad is a type of blank canvas area that can be painted on with the normal painting devices.

Definition at line 31 of file Scratchpad.h.

Constructor & Destructor Documentation

◆ Scratchpad()

Scratchpad::Scratchpad	(	View *	view,
		const QColor &	defaultColor,
		QWidget *	parent = 0 )

Definition at line 28 of file Scratchpad.cpp.

    : QWidget(parent), d(new Private)
{
    d->scratchpad = new KisScratchPad();
    d->scratchpad->setupScratchPad(view->view()->resourceProvider(), defaultColor);
    d->scratchpad->setMinimumSize(50, 50);
 
    QVBoxLayout *layout = new QVBoxLayout(this);
    layout->addWidget(d->scratchpad);
 
    // Forward KisScratchPad::scaleChanged to Scratchpad::scaleChanged
    connect(d->scratchpad, SIGNAL(scaleChanged(qreal)), this, SIGNAL(scaleChanged(qreal)));
 
    // Forward KisScratchPad::contentChanged to Scratchpad::contentChanged
    connect(d->scratchpad, SIGNAL(contentChanged()), this, SIGNAL(contentChanged()));
 
    // Forward KisScratchPad::viewportChanged to Scratchpad::viewportChanged
    connect(d->scratchpad, SIGNAL(viewportChanged(const QRect)), this, SIGNAL(viewportChanged(const QRect)));
}

References connect(), contentChanged(), d, KisView::resourceProvider(), scaleChanged(), View::view(), and viewportChanged().

◆ ~Scratchpad()

Scratchpad::~Scratchpad ( )

Definition at line 48 of file Scratchpad.cpp.

49{

50}

Member Function Documentation

◆ canvasZoomLink

bool Scratchpad::canvasZoomLink ( )

slot

return if scratchpad zoom level is linked with current view zoom level

Returns: return True if connection between the zoom of the canvas and scratchpad (so they zoom in sync) is active

Definition at line 73 of file Scratchpad.cpp.

{
    return d->scratchpad->canvasZoomLink();
}

References d.

◆ clear

void Scratchpad::clear ( )

slot

Clears out scratchpad with color specified set during setup.

Definition at line 131 of file Scratchpad.cpp.

{
    // need ability to set color
    d->scratchpad->fillDefault();
}

References d.

◆ contentBounds

QRect Scratchpad::contentBounds ( ) const

slot

The content of scratchpad can be bigger or smaller than scratchpad dimension. The bounds return the area in which there's some content.

Returns: scratchpad content bounds as a QRect

Definition at line 222 of file Scratchpad.cpp.

{
    return d->scratchpad->contentBounds();
}

References d.

◆ contentChanged

void Scratchpad::contentChanged ( )

signal

signal is emitted when scratchpad content is changed (stroke or fill)

◆ copyScratchpadImageData

QImage Scratchpad::copyScratchpadImageData ( )

slot

Take what is on the scratchpad area and grab image.

Returns: the image data from the scratchpad

Definition at line 126 of file Scratchpad.cpp.

{
    return d->scratchpad->copyScratchpadImageData();
}

References d.

◆ fillBackground

void Scratchpad::fillBackground ( )

slot

Fill the entire scratchpad with current background color.

Definition at line 152 of file Scratchpad.cpp.

{
    d->scratchpad->fillBackground();
}

References d.

◆ fillDefault

void Scratchpad::fillDefault ( )

slot

Fill the entire scratchpad with default color.

Definition at line 142 of file Scratchpad.cpp.

{
    d->scratchpad->fillDefault();
}

References d.

◆ fillDocument

void Scratchpad::fillDocument ( bool fullContent = true )

slot

Fill the entire scratchpad with current document projection content.

Parameters

fullContent when True, full document projection is loaded in scratchpad, otherwise only content matching scratchpad viewport is loaded

Definition at line 207 of file Scratchpad.cpp.

{
    d->scratchpad->fillDocument(fullContent);
}

References d.

◆ fillForeground

void Scratchpad::fillForeground ( )

slot

Fill the entire scratchpad with current foreground color.

Definition at line 157 of file Scratchpad.cpp.

{
    d->scratchpad->fillForeground();
}

References d.

◆ fillGradient

void Scratchpad::fillGradient	(	const QPoint &	gradientVectorStart = QPoint(),
		const QPoint &	gradientVectorEnd = QPoint(),
		const QString &	gradientShape = "linear",
		const QString &	gradientRepeat = "none",
		bool	reverseGradient = false,
		bool	dither = false )

slot

Fill the entire scratchpad with current gradient.

Parameters

gradientVectorStart	is a QPoint to define origin of gradient Set an empty QPoint() to use default scratchpad top-left
gradientVectorEnd	is a QPoint to define end of gradient set an empty QPoint() to use default scratchpad bottom-right
gradientShape	define which gradient to apply, can be: "linear" "bilinear" "radial" "square" "conical" "conicalSymmetric" "spiral" "reverseSpiral" "polygonal"
gradientRepeat	define how to repeat gradient, can be: "none" "alternate" "forwards"
reverseGradient	a boolean to define if gradient is reversed or not
dither	a boolean to define if gradient is dithered or not

Definition at line 162 of file Scratchpad.cpp.

{
    KisGradientPainter::enumGradientShape gradientShapeValue = KisGradientPainter::GradientShapeLinear;
    KisGradientPainter::enumGradientRepeat gradientRepeatValue = KisGradientPainter::GradientRepeatNone;
 
    if (gradientShape != "linear") {
        if (gradientShape == "bilinear") {
            gradientShapeValue = KisGradientPainter::GradientShapeBiLinear;
        } else if ( gradientShape == "radial") {
            gradientShapeValue = KisGradientPainter::GradientShapeRadial;
        } else if ( gradientShape == "square") {
            gradientShapeValue = KisGradientPainter::GradientShapeSquare;
        } else if ( gradientShape == "conical") {
            gradientShapeValue = KisGradientPainter::GradientShapeConical;
        } else if ( gradientShape == "conicalSymmetric") {
            gradientShapeValue = KisGradientPainter::GradientShapeConicalSymetric;
        } else if ( gradientShape == "spiral") {
            gradientShapeValue = KisGradientPainter::GradientShapeSpiral;
        } else if ( gradientShape == "reverseSpiral") {
            gradientShapeValue = KisGradientPainter::GradientShapeReverseSpiral;
        } else if ( gradientShape == "polygonal") {
            gradientShapeValue = KisGradientPainter::GradientShapePolygonal;
        }
    }
 
    if (gradientRepeat != "none") {
        if (gradientRepeat == "alternate") {
            gradientRepeatValue = KisGradientPainter::GradientRepeatAlternate;
        } else if (gradientRepeat == "forwards") {
            gradientRepeatValue = KisGradientPainter::GradientRepeatForwards;
        }
    }
    d->scratchpad->fillGradient(gradientVectorStart, gradientVectorEnd, gradientShapeValue, gradientRepeatValue, reverseGradient, dither);
}

◆ fillLayer

void Scratchpad::fillLayer ( bool fullContent = true )

slot

Fill the entire scratchpad with current layer content.

Parameters

fullContent when True, full layer content is loaded in scratchpad, otherwise only content matching scratchpad viewport is loaded

Definition at line 202 of file Scratchpad.cpp.

{
    d->scratchpad->fillLayer(fullContent);
}

References d.

◆ fillPattern

void Scratchpad::fillPattern ( QTransform transform = QTransform() )

slot

Fill the entire scratchpad with current pattern.

Parameters

transform is QTransform that let define pattern scale/rotation property

Definition at line 212 of file Scratchpad.cpp.

{
    d->scratchpad->fillPattern(transform);
}

References d.

◆ fillTransparent

void Scratchpad::fillTransparent ( )

slot

Fill the entire scratchpad with a transparent color.

Definition at line 147 of file Scratchpad.cpp.

{
    d->scratchpad->fillTransparent();
}

References d.

◆ linkCanvasZoom

void Scratchpad::linkCanvasZoom ( bool value )

slot

DEPRECATED – USE setCanvasZoomLink() instead Makes a connection between the zoom of the canvas and scratchpad area so they zoom in sync.

Parameters

value If True (default) the scratchpad will share the current view zoom level. If False, then use scratchpad scale methods to define current zoom level

Definition at line 62 of file Scratchpad.cpp.

{
    qWarning("[DEPRECATED] Use Scratchpad.setCanvasZoomLink() instead of Scratchpad.linkCanvasZoom()");
    d->scratchpad->setCanvasZoomLink(value);
}

References d, and value().

◆ loadScratchpadImage

void Scratchpad::loadScratchpadImage ( QImage image )

slot

Load image data to the scratchpad.

Parameters

image Image object to load

Definition at line 121 of file Scratchpad.cpp.

{
    d->scratchpad->loadScratchpadImage(image);
}

References d.

◆ panCenter

void Scratchpad::panCenter ( )

slot

pan scratchpad content to center content in viewport

Definition at line 116 of file Scratchpad.cpp.

{
    d->scratchpad->panCenter();
}

References d.

◆ panTo

void Scratchpad::panTo	(	qint32	x,
		qint32	y )

slot

pan scratchpad content to top-left position of scratchpad viewport Provided value are absolute

Parameters

x	abscissa position to pan to
y	ordinate position to pan to

Definition at line 111 of file Scratchpad.cpp.

{
    d->scratchpad->panTo(x, y);
}

References d.

◆ scale

qreal Scratchpad::scale ( )

slot

return current zoom level applied on scratchpad (whatever the zoom source is: view zoom level or set manually)

Returns: a float value (1.00 = 100%)

Definition at line 78 of file Scratchpad.cpp.

{
    // return scale X only, consider zoom X/Y will always be the same
    return d->scratchpad->scaleX();
}

References d.

◆ scaleChanged

void Scratchpad::scaleChanged ( qreal scale )

signal

signal is emitted when scratchpad scale is changed (from zoom canvas or manually)

Parameters

scale updated scale value (1.00 = 100%)

◆ scaleReset

void Scratchpad::scaleReset ( )

slot

reset scale and pan to origin Note: call method is ignored if canvasZoomLink() is True

Definition at line 102 of file Scratchpad.cpp.

{
    if (d->scratchpad->canvasZoomLink()) {
        // if zoom level is linked to canvas zoom level, ignore setScale()
        return;
    };
    d->scratchpad->scaleReset();
}

References d.

◆ scaleToFit

void Scratchpad::scaleToFit ( )

slot

calculate scale automatically to fit scratchpad content in scratchpad viewport Note: call method is ignored if canvasZoomLink() is True

Definition at line 93 of file Scratchpad.cpp.

{
    if (d->scratchpad->canvasZoomLink()) {
        // if zoom level is linked to canvas zoom level, ignore setScale()
        return;
    };
    d->scratchpad->scaleToFit();
}

References d.

◆ setCanvasZoomLink

void Scratchpad::setCanvasZoomLink ( bool value )

slot

Makes a connection between the zoom of the canvas and scratchpad area so they zoom in sync.

Parameters

value If True (default) the scratchpad will share the current view zoom level. If False, then use scratchpad scale methods to define current zoom level

Definition at line 68 of file Scratchpad.cpp.

{
    d->scratchpad->setCanvasZoomLink(value);
}

References d, and value().

◆ setFillColor

void Scratchpad::setFillColor ( QColor color )

slot

Define default fill color for scratchpad.

Parameters

Color to fill the canvas with

Definition at line 137 of file Scratchpad.cpp.

{
    d->scratchpad->setFillColor(color);
}

References d.

◆ setMode

void Scratchpad::setMode ( QString modeName )

slot

Manually set what mode scratchpad is in. Ignored if "setModeManually is set to false.

Parameters

modeName

Available options are:

"painting"
"panning"
"colorsampling"

Definition at line 57 of file Scratchpad.cpp.

{
    d->scratchpad->setModeType(modeType);
}

References d.

◆ setModeManually

void Scratchpad::setModeManually ( bool value )

slot

Switches between a GUI controlling the current mode and when mouse clicks control mode.

Parameters

value Set to True allows GUI to control the mode with explicitly setting mode

Definition at line 52 of file Scratchpad.cpp.

{
    d->scratchpad->setModeManually(value);
}

References d, and value().

◆ setScale

bool Scratchpad::setScale ( qreal scale ) const

slot

allow to manually set scratchpad zoom level Note: call method is ignored if canvasZoomLink() is True,

Parameters

scale zoom level to apply (1.00 = 100%)

Returns: if scale has been applied return True, otherwise return False

Definition at line 84 of file Scratchpad.cpp.

{
    if (d->scratchpad->canvasZoomLink()) {
        // if zoom level is linked to canvas zoom level, ignore setScale()
        return false;
    };
    return d->scratchpad->setScale(scale, scale);
}

References d, and scale().

◆ viewportBounds

QRect Scratchpad::viewportBounds ( ) const

slot

The viewport indicates which part of scratchpad content is visible. It takes in account the current translation & scale.

Example 1:

Scratchpad size: 500x500
Scratchpad content: 2000x2000
Scratchpad scale: 1.0
Scratchpad pan: 0, 0 Returned viewport is a QRect(0, 0, 500, 500) matching content really visible in scratchpad. If scale is 2.00, returned viewport will be QRect(0, 0, 250, 250) If scale is 0.50, returned viewport will be QRect(0, 0, 1000, 1000)

Example 2:

Scratchpad size: 500x500
Scratchpad content: 2000x2000
Scratchpad scale: 2.0
Scratchpad pan: 500, 1500 Returned viewport is a QRect(500, 1500, 250, 250) matching content really visible in scratchpad.

Returns: scratchpad viewport bounds as a QRect

Definition at line 217 of file Scratchpad.cpp.

{
    return d->scratchpad->imageBounds();
}

References d.

◆ viewportChanged

void Scratchpad::viewportChanged ( const QRect rect )

signal

signal is emitted when scratchpad viewport has been modified (pan, zoom)

Parameters

rect	new viewport bounds

Member Data Documentation

◆ d

const QScopedPointer<Private> Scratchpad::d

private

Definition at line 257 of file Scratchpad.h.

The documentation for this class was generated from the following files:

libs/libkis/Scratchpad.h
libs/libkis/Scratchpad.cpp

Classes

Public Slots

Signals

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Scratchpad()

◆ ~Scratchpad()

Member Function Documentation

◆ canvasZoomLink

◆ clear

◆ contentBounds

◆ contentChanged

◆ copyScratchpadImageData

◆ fillBackground

◆ fillDefault

◆ fillDocument

◆ fillForeground

◆ fillGradient

◆ fillLayer

◆ fillPattern

◆ fillTransparent

◆ linkCanvasZoom

◆ loadScratchpadImage

◆ panCenter

◆ panTo

◆ scale

◆ scaleChanged

◆ scaleReset

◆ scaleToFit

◆ setCanvasZoomLink

◆ setFillColor

◆ setMode

◆ setModeManually

◆ setScale

◆ viewportBounds

◆ viewportChanged

Member Data Documentation

◆ d