KisCanvasDecoration Class Reference

#include <kis_canvas_decoration.h>

Inheritance diagram for KisCanvasDecoration:

Classes
struct	Private

Public Slots
virtual void	setVisible (bool v)
void	toggleVisibility ()

Public Member Functions
const QString &	id () const
	KisCanvasDecoration (const QString &id, QPointer< KisView >parent)
virtual void	notifyWindowMinimized (bool minimized)
void	paint (QPainter &gc, const QRectF &updateRect, const KisCoordinatesConverter *converter, KisCanvas2 *canvas)
int	priority () const
void	setView (QPointer< KisView > imageView)
bool	visible () const
	~KisCanvasDecoration () override
Public Member Functions inherited from KisShared
bool	deref ()
bool	ref ()
int	refCount ()
QAtomicInt *	sharedWeakReference ()

Static Public Member Functions
static bool	comparePriority (KisCanvasDecorationSP decoration1, KisCanvasDecorationSP decoration2)

Protected Member Functions
int	decorationThickness () const
virtual void	drawDecoration (QPainter &gc, const QRectF &updateArea, const KisCoordinatesConverter *converter, KisCanvas2 *canvas)=0
void	setPriority (int value)
QPointer< KisView >	view () const
Protected Member Functions inherited from KisShared
	KisShared ()
	~KisShared ()

Private Attributes
Private *const	d

Detailed Description

This class is the base class for object that draw a decoration on the canvas, for instance, selections, grids, tools, ...

Definition at line 30 of file kis_canvas_decoration.h.

Constructor & Destructor Documentation

KisCanvasDecoration()

KisCanvasDecoration::KisCanvasDecoration	(	const QString &	id,
		QPointer< KisView >	parent )

Definition at line 19 of file kis_canvas_decoration.cc.

    : QObject(parent)
    , d(new Private)
{
    d->visible = false;
    d->view = parent;
    d->id = id;
}

References d, KisCanvasDecoration::Private::id, id(), KisCanvasDecoration::Private::view, and KisCanvasDecoration::Private::visible.

~KisCanvasDecoration()

KisCanvasDecoration::~KisCanvasDecoration ( )

override

Definition at line 28 of file kis_canvas_decoration.cc.

{
    delete d;
}

References d.

Member Function Documentation

comparePriority()

bool KisCanvasDecoration::comparePriority ( KisCanvasDecorationSP decoration1, KisCanvasDecorationSP decoration2 )

static

Definition at line 93 of file kis_canvas_decoration.cc.

{
    return decoration1->priority() < decoration2->priority();
}

decorationThickness()

int KisCanvasDecoration::decorationThickness ( ) const

protected

Definition at line 85 of file kis_canvas_decoration.cc.

{
    if (d->view && d->view->canvasBase() && d->view->canvasBase()->resourceManager()) {
        return d->view->canvasBase()->resourceManager()->decorationThickness();
    }
    return 1;
}

References d, and KisCanvasDecoration::Private::view.

drawDecoration()

virtual void KisCanvasDecoration::drawDecoration ( QPainter & gc, const QRectF & updateArea, const KisCoordinatesConverter * converter, KisCanvas2 * canvas )

protectedpure virtual

Implemented in KisGridDecoration, KisGuidesDecoration, KisInfinityManager, KisMirrorAxis, KisFpsDecoration, KisPaintingAssistantsDecoration, KisSelectionDecoration, and KisReferenceImagesDecoration.

id()

const QString & KisCanvasDecoration::id

(

)

const

Definition at line 39 of file kis_canvas_decoration.cc.

{
    return d->id;
}

References d, and KisCanvasDecoration::Private::id.

notifyWindowMinimized()

void KisCanvasDecoration::notifyWindowMinimized ( bool minimized )

virtual

Reimplemented in KisSelectionDecoration.

Definition at line 97 of file kis_canvas_decoration.cc.

{
 
}

paint()

void KisCanvasDecoration::paint	(	QPainter &	gc,
		const QRectF &	updateRect,
		const KisCoordinatesConverter *	converter,
		KisCanvas2 *	canvas = 0 )

Will paint the decoration on the QPainter, if the visible is set to true.

Parameters

gc	the painter
updateRect	dirty rect in document pixels
converter	coordinate converter
canvas	the canvas

Definition at line 64 of file kis_canvas_decoration.cc.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(visible());
 
    if (!canvas) {
        dbgFile<<"canvas does not exist:"<<canvas;
    }
 
    drawDecoration(gc, updateArea, converter,canvas);
}

References dbgFile, drawDecoration(), KIS_SAFE_ASSERT_RECOVER_RETURN, and visible().

priority()

int KisCanvasDecoration::priority

(

)

const

Return z-order priority of the decoration. The higher the priority, the higher the decoration is painted.

Definition at line 75 of file kis_canvas_decoration.cc.

{
    return d->priority;
}

References d, and KisCanvasDecoration::Private::priority.

setPriority()

void KisCanvasDecoration::setPriority ( int value )

protected

Set the priority of the decoration. The higher the priority, the higher the decoration is painted.

Definition at line 80 of file kis_canvas_decoration.cc.

{
    d->priority = value;
}

References d, KisCanvasDecoration::Private::priority, and value().

setView()

void KisCanvasDecoration::setView

(

QPointer< KisView >

imageView

)

Definition at line 33 of file kis_canvas_decoration.cc.

{
    d->view = imageView;
}

References d, and KisCanvasDecoration::Private::view.

setVisible

void KisCanvasDecoration::setVisible ( bool v )

virtualslot

Set if the decoration is visible or not.

Reimplemented in KisMirrorAxis, and KisSelectionDecoration.

Definition at line 44 of file kis_canvas_decoration.cc.

{
    d->visible = v;
    if (d->view &&
            d->view->canvasBase()) {
 
        d->view->canvasBase()->updateCanvas();
    }
}

References d, v, KisCanvasDecoration::Private::view, and KisCanvasDecoration::Private::visible.

toggleVisibility

void KisCanvasDecoration::toggleVisibility ( )

slot

If decoration is visible, hide it, if not show it.

Definition at line 59 of file kis_canvas_decoration.cc.

{
    setVisible(!visible());
}

References setVisible(), and visible().

view()

QPointer< KisView > KisCanvasDecoration::view ( ) const

protected

Returns

the parent KisView

Definition at line 101 of file kis_canvas_decoration.cc.

{
    return d->view;
}

References d, and KisCanvasDecoration::Private::view.

visible()

bool KisCanvasDecoration::visible

(

)

const

Returns

whether the decoration is visible.

Definition at line 54 of file kis_canvas_decoration.cc.

{
    return d->visible;
}

References d, and KisCanvasDecoration::Private::visible.

Member Data Documentation

d

Private* const KisCanvasDecoration::d

private

Definition at line 95 of file kis_canvas_decoration.h.

---

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

• libs/ui/canvas/kis_canvas_decoration.h
• libs/ui/canvas/kis_canvas_decoration.cc