#include <KoCanvasBase.h>

Inheritance diagram for KoCanvasBase:

Public Member Functions
virtual void	addCommand (KUndo2Command *command)=0

KoCanvasController *	canvasController () const

virtual bool	canvasIsOpenGL () const

virtual const QWidget *	canvasWidget () const =0

virtual QWidget *	canvasWidget ()=0

virtual void	clipToDocument (const KoShape *shape, QPointF &move) const

virtual void	disconnectCanvasObserver (QObject *object)

virtual QPoint	documentOrigin () const

virtual void	gridSize (QPointF offset, QSizeF spacing) const =0

	KoCanvasBase (KoShapeControllerBase shapeController, KoCanvasResourceProvider sharedResourceManager=0)

	Private ()

KoCanvasResourceProvider *	resourceManager () const

virtual KoSelectedShapesProxy *	selectedShapesProxy () const =0
	selectedShapesProxy() is a special interface for keeping a persistent connections to selectionChanged() and selectionContentChanged() signals. While shapeManager() can change throughout the life time of the canvas, selectedShapesProxy() is guaranteed to stay the same.

void	setCanvasController (KoCanvasController *controller)
	called by KoCanvasController to set the controller that handles this canvas.

virtual void	setCursor (const QCursor &cursor)=0

KoShapeController *	shapeController () const

virtual KoShapeManager *	shapeManager () const =0

KoSnapGuide *	snapGuide () const

virtual bool	snapToGrid () const =0

virtual KoToolProxy *	toolProxy () const =0

virtual KoUnit	unit () const =0

virtual void	updateCanvas (const QRectF &rc)=0

virtual const KoViewConverter *	viewConverter () const =0

virtual KoViewConverter *	viewConverter ()=0

virtual QPointF	viewToDocument (const QPointF &viewPoint) const

	~KoCanvasBase () override

	~Private ()

Public Attributes
KoCanvasController *	controller

bool	isResourceManagerShared

QPointer< KoCanvasResourceProvider >	resourceManager

QPointer< KoShapeController >	shapeController

KoSnapGuide *	snapGuide

Private Member Functions
	KoCanvasBase ()

Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Private Attributes
Private *const	d

Private Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Detailed Description

KoCanvasBase is the interface actual application canvas classes should implement. Flake tools know about the canvas, so they can do things like scroll, redraw, set a cursor etc.

Definition at line 23 of file KoCanvasBase.cpp.

Constructor & Destructor Documentation

◆ ~Private()

KoCanvasBase::~Private ( )

inline

Definition at line 35 of file KoCanvasBase.cpp.

               {
        delete shapeController;
        if (!isResourceManagerShared) {
            delete resourceManager;
        }
        delete snapGuide;
    }

◆ KoCanvasBase() [1/2]

KoCanvasBase::KoCanvasBase	(	KoShapeControllerBase *	shapeController,
		KoCanvasResourceProvider *	sharedResourceManager = 0 )

explicit

The constructor.

Parameters

shapeController the implementation of the shapeController that the application provides to allow shapes to be added in multiple views.

Definition at line 49 of file KoCanvasBase.cpp.

        : d(new Private())
{
    d->resourceManager = sharedResourceManager ?
        sharedResourceManager : new KoCanvasResourceProvider();
    d->isResourceManagerShared = sharedResourceManager;
 
    d->shapeController = new KoShapeController(this, shapeController);
    d->snapGuide = new KoSnapGuide(this);
}

References d, and shapeController.

◆ ~KoCanvasBase()

KoCanvasBase::~KoCanvasBase ( )

override

Definition at line 60 of file KoCanvasBase.cpp.

{
    d->shapeController->reset();
    delete d;
}

References d.

◆ KoCanvasBase() [2/2]

KoCanvasBase::KoCanvasBase ( )

private

Member Function Documentation

◆ addCommand()

virtual void KoCanvasBase::addCommand ( KUndo2Command * command )

pure virtual

Adds a command to the history. Call this for each command you create. This will also execute the command. This means, most of the application's code will look like MyCommand * cmd = new MyCommand( parameters ); canvas.addCommand( cmd );

Note that the command history takes ownership of the command, it will delete it when the undo limit is reached, or when deleting the command history itself.

Parameters

command the command to add

Implemented in SimpleCanvas, KisCanvas2, KisShapeLayerCanvasBase, and KisShapeSelectionCanvas.

◆ canvasController()

KoCanvasController * KoCanvasBase::canvasController ( ) const

Return the canvas controller for this canvas.

Definition at line 99 of file KoCanvasBase.cpp.

{
    return d->controller;
}

References d.

◆ canvasIsOpenGL()

virtual bool KoCanvasBase::canvasIsOpenGL ( ) const

inlinevirtual

Returns: true if opengl can be used directly on the canvas

Reimplemented in KisCanvas2.

Definition at line 62 of file KoCanvasBase.h.

62{ return false; }

◆ canvasWidget() [1/2]

virtual const QWidget * KoCanvasBase::canvasWidget ( ) const

pure virtual

Return the widget that will be added to the scrollArea.

Implemented in SimpleCanvas, KisCanvas2, KisShapeLayerCanvasBase, and KisShapeSelectionCanvas.

◆ canvasWidget() [2/2]

virtual QWidget * KoCanvasBase::canvasWidget ( )

pure virtual

Return the widget that will be added to the scrollArea.

Implemented in SimpleCanvas, KisCanvas2, KisShapeLayerCanvasBase, and KisShapeSelectionCanvas.

◆ clipToDocument()

void KoCanvasBase::clipToDocument	(	const KoShape *	shape,
		QPointF &	move ) const

virtual

Called when the user tries to move the argument shape to allow the application to limit the users movement to stay within the document bounds. An implementation can alter the parameter move to make sure that if the distance moved is applied to the shape it will not become unreachable for the user. The default implementation does not restrict movement.

Parameters

shape	the shape that will be moved soon.
move	the distance the caller intends to move the shape.

Definition at line 104 of file KoCanvasBase.cpp.

105{

106}

◆ disconnectCanvasObserver()

void KoCanvasBase::disconnectCanvasObserver ( QObject * object )

virtual

disconnect the given QObject completely and utterly from any and all connections it has to any QObject owned by the canvas. Do this in the setCanvas of every KoCanvasObserver.

Reimplemented in KisCanvas2.

Definition at line 79 of file KoCanvasBase.cpp.

{
    if (shapeManager()) shapeManager()->selection()->disconnect(object);
    if (resourceManager()) resourceManager()->disconnect(object);
    if (shapeManager()) shapeManager()->disconnect(object);
    if (toolProxy()) toolProxy()->disconnect(object);
    if (selectedShapesProxy()) selectedShapesProxy()->disconnect(object);
}

References resourceManager, selectedShapesProxy(), KoShapeManager::selection, shapeManager(), and toolProxy().

◆ documentOrigin()

virtual QPoint KoCanvasBase::documentOrigin ( ) const

inlinevirtual

Return the position of the document origin inside the canvas widget, in pixels. By default the origin of the canvas widget and the position of the document origin are coincident, thus an empty point is returned.

Reimplemented in KisCanvas2.

Definition at line 177 of file KoCanvasBase.h.

                                          {
        return QPoint(0, 0);
    }

◆ gridSize()

virtual void KoCanvasBase::gridSize	(	QPointF *	offset,
		QSizeF *	spacing ) const

pure virtual

retrieve the grid size setting. The grid spacing will be provided in pt.

Parameters

horizontal	a pointer to a qreal that will be filled with the horizontal grid-spacing
vertical	a pointer to a qreal that will be filled with the vertical grid-spacing

Implemented in SimpleCanvas, KisCanvas2, KisShapeLayerCanvasBase, and KisShapeSelectionCanvas.

◆ Private()

KoCanvasBase::Private ( )

inline

Definition at line 26 of file KoCanvasBase.cpp.

        : shapeController(0),
        resourceManager(0),
        isResourceManagerShared(false),
        controller(0),
        snapGuide(0)
    {
    }

◆ resourceManager()

KoCanvasResourceProvider * KoCanvasBase::resourceManager ( ) const

Return a pointer to the resource manager associated with this canvas. The resource manager contains per-canvas settings such as current foreground and background color. If instead of per-canvas resources you need per-document resources you can by going via the shapeController instead;

canvasBase->shapeController()->resourceManager();

See also: KoShapeController::resourceManager()

◆ selectedShapesProxy()

virtual KoSelectedShapesProxy * KoCanvasBase::selectedShapesProxy ( ) const

pure virtual

selectedShapesProxy() is a special interface for keeping a persistent connections to selectionChanged() and selectionContentChanged() signals. While shapeManager() can change throughout the life time of the canvas, selectedShapesProxy() is guaranteed to stay the same.

Returns: persistent KoSelectedShapesProxy object

Implemented in SimpleCanvas, KisCanvas2, KisShapeLayerCanvasBase, and KisShapeSelectionCanvas.

◆ setCanvasController()

void KoCanvasBase::setCanvasController ( KoCanvasController * controller )

called by KoCanvasController to set the controller that handles this canvas.

Definition at line 94 of file KoCanvasBase.cpp.

{
    d->controller = controller;
}

References controller, and d.

◆ setCursor()

virtual void KoCanvasBase::setCursor ( const QCursor & cursor )

pure virtual

set the specified cursor on this canvas

Parameters

cursor the new cursor

Returns: the old cursor

Implemented in SimpleCanvas, KisShapeLayerCanvasBase, KisShapeSelectionCanvas, and KisCanvas2.

◆ shapeController()

KoShapeController * KoCanvasBase::shapeController ( ) const

Return the shape controller for this canvas. A shape controller is used to create or delete shapes and show the relevant dialogs to the user.

◆ shapeManager()

virtual KoShapeManager * KoCanvasBase::shapeManager ( ) const

pure virtual

Return the current shapeManager. WARNING: the shape manager can switch in time, e.g. when a layer is changed. Please don't keep any persistent connections to it. Instead please use selectedShapesProxy(), which is guaranteed to be the same throughout the life of the canvas.

Returns: the current shapeManager

Implemented in SimpleCanvas, KisCanvas2, KisShapeLayerCanvasBase, and KisShapeSelectionCanvas.

◆ snapGuide()

KoSnapGuide * KoCanvasBase::snapGuide ( ) const

Returns the snap guide of the canvas

◆ snapToGrid()

virtual bool KoCanvasBase::snapToGrid ( ) const

pure virtual

return if snap to grid is enabled.

Returns: if snap to grid is enabled.

Implemented in SimpleCanvas, KisCanvas2, KisShapeLayerCanvasBase, and KisShapeSelectionCanvas.

◆ toolProxy()

virtual KoToolProxy * KoCanvasBase::toolProxy ( ) const

pure virtual

Return the proxy to the active tool (determining which tool is really, really active is hard when tablets are involved, so leave that to others.

Implemented in SimpleCanvas, KisCanvas2, KisShapeLayerCanvasBase, and KisShapeSelectionCanvas.

◆ unit()

virtual KoUnit KoCanvasBase::unit ( ) const

pure virtual

Return the unit of the current document for initialization of the widgets created by the flake framework.

See also: KoDocument::unit()

Implemented in SimpleCanvas, KisCanvas2, KisShapeLayerCanvasBase, and KisShapeSelectionCanvas.

◆ updateCanvas()

virtual void KoCanvasBase::updateCanvas ( const QRectF & rc )

pure virtual

Tell the canvas to repaint the specified rectangle. The coordinates are document coordinates, not view coordinates.

Implemented in SimpleCanvas, KisCanvas2, KisShapeLayerCanvas, KisShapeSelectionCanvas, and ReferenceImagesCanvas.

◆ viewConverter() [1/2]

virtual const KoViewConverter * KoCanvasBase::viewConverter ( ) const

pure virtual

Return the viewConverter for this view.

Returns: the viewConverter for this view.

Implemented in SimpleCanvas, KisCanvas2, KisShapeLayerCanvasBase, and KisShapeSelectionCanvas.

◆ viewConverter() [2/2]

virtual KoViewConverter * KoCanvasBase::viewConverter ( )

pure virtual

Implemented in SimpleCanvas, KisCanvas2, KisShapeLayerCanvasBase, and KisShapeSelectionCanvas.

◆ viewToDocument()

QPointF KoCanvasBase::viewToDocument ( const QPointF & viewPoint ) const

virtual

Convert a coordinate in pixels to pt.

Parameters

viewPoint the point in the coordinate system of the widget, or window.

Definition at line 66 of file KoCanvasBase.cpp.

{
    return viewConverter()->viewToDocument(viewPoint - documentOrigin());
}

References documentOrigin(), viewConverter(), and KoViewConverter::viewToDocument().

Member Data Documentation

◆ controller

KoCanvasController* KoCanvasBase::controller

Definition at line 45 of file KoCanvasBase.cpp.

◆ d

Private* const KoCanvasBase::d

private

Definition at line 225 of file KoCanvasBase.h.

◆ isResourceManagerShared

bool KoCanvasBase::isResourceManagerShared

Definition at line 44 of file KoCanvasBase.cpp.

◆ resourceManager

KoCanvasResourceProvider * KoCanvasBase::resourceManager

Definition at line 43 of file KoCanvasBase.cpp.

◆ shapeController

KoShapeController * KoCanvasBase::shapeController

Definition at line 42 of file KoCanvasBase.cpp.

◆ snapGuide

KoSnapGuide * KoCanvasBase::snapGuide

Definition at line 46 of file KoCanvasBase.cpp.

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

libs/flake/KoCanvasBase.cpp
libs/flake/KoCanvasBase.h

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~Private()

◆ KoCanvasBase() [1/2]

◆ ~KoCanvasBase()

◆ KoCanvasBase() [2/2]

Member Function Documentation

◆ addCommand()

◆ canvasController()

◆ canvasIsOpenGL()

◆ canvasWidget() [1/2]

◆ canvasWidget() [2/2]

◆ clipToDocument()

◆ disconnectCanvasObserver()

◆ documentOrigin()

◆ gridSize()

◆ Private()

◆ resourceManager()

◆ selectedShapesProxy()

◆ setCanvasController()

◆ setCursor()

◆ shapeController()

◆ shapeManager()

◆ snapGuide()

◆ snapToGrid()

◆ toolProxy()

◆ unit()

◆ updateCanvas()

◆ viewConverter() [1/2]

◆ viewConverter() [2/2]

◆ viewToDocument()

Member Data Documentation

◆ controller

◆ d

◆ isResourceManagerShared

◆ resourceManager

◆ shapeController

◆ snapGuide