SimpleCanvas Class Reference

Inheritance diagram for SimpleCanvas:

Public Member Functions
void	addCommand (KUndo2Command *) override
const QWidget *	canvasWidget () const override
QWidget *	canvasWidget () override
void	gridSize (QPointF *offset, QSizeF *spacing) const override
KoSelectedShapesProxy *	selectedShapesProxy () const override
	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	setCursor (const QCursor &) override
KoShapeManager *	shapeManager () const override
	SimpleCanvas ()
bool	snapToGrid () const override
KoToolProxy *	toolProxy () const override
KoUnit	unit () const override
void	updateCanvas (const QRectF &) override
const KoViewConverter *	viewConverter () const override
KoViewConverter *	viewConverter () override
	~SimpleCanvas () override
Public Member Functions inherited from KoCanvasBase
KoCanvasController *	canvasController () const
virtual bool	canvasIsOpenGL () const
virtual void	clipToDocument (const KoShape *shape, QPointF &move) const
virtual void	disconnectCanvasObserver (QObject *object)
virtual QPoint	documentOrigin () const
	KoCanvasBase (KoShapeControllerBase *shapeController, KoCanvasResourceProvider *sharedResourceManager=0)
	Private ()
KoCanvasResourceProvider *	resourceManager () const
void	setCanvasController (KoCanvasController *controller)
	called by KoCanvasController to set the controller that handles this canvas.
KoShapeController *	shapeController () const
KoSnapGuide *	snapGuide () const
virtual QPointF	viewToDocument (const QPointF &viewPoint) const
	~KoCanvasBase () override
	~Private ()

Private Attributes
QScopedPointer< KoSelectedShapesProxySimple >	m_selectedShapesProxy
QScopedPointer< KoShapeManager >	m_shapeManager

Additional Inherited Members
Public Attributes inherited from KoCanvasBase
KoCanvasController *	controller
bool	isResourceManagerShared
QPointer< KoCanvasResourceProvider >	resourceManager
QPointer< KoShapeController >	shapeController
KoSnapGuide *	snapGuide

Detailed Description

Definition at line 24 of file KoShapePainter.cpp.

Constructor & Destructor Documentation

SimpleCanvas()

SimpleCanvas::SimpleCanvas ( )

inline

Definition at line 27 of file KoShapePainter.cpp.

        : KoCanvasBase(0),
          m_shapeManager(new KoShapeManager(this)),
          m_selectedShapesProxy(new KoSelectedShapesProxySimple(m_shapeManager.data()))
    {
    }

~SimpleCanvas()

SimpleCanvas::~SimpleCanvas ( )

inlineoverride

Definition at line 34 of file KoShapePainter.cpp.

    {
    }

Member Function Documentation

addCommand()

void SimpleCanvas::addCommand ( KUndo2Command * command )

inlineoverridevirtual

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

Implements KoCanvasBase.

Definition at line 49 of file KoShapePainter.cpp.

    {
    }

canvasWidget() [1/2]

const QWidget * SimpleCanvas::canvasWidget ( ) const

inlineoverridevirtual

Return the widget that will be added to the scrollArea.

Implements KoCanvasBase.

Definition at line 87 of file KoShapePainter.cpp.

    {
        return 0;
    }

canvasWidget() [2/2]

QWidget * SimpleCanvas::canvasWidget ( )

inlineoverridevirtual

Return the widget that will be added to the scrollArea.

Implements KoCanvasBase.

Definition at line 82 of file KoShapePainter.cpp.

    {
        return 0;
    }

gridSize()

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

inlineoverridevirtual

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

Implements KoCanvasBase.

Definition at line 38 of file KoShapePainter.cpp.

    {
        *offset = QPointF();
        *spacing = QSizeF();
    };

selectedShapesProxy()

KoSelectedShapesProxy * SimpleCanvas::selectedShapesProxy ( ) const

inlineoverridevirtual

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

Implements KoCanvasBase.

Definition at line 58 of file KoShapePainter.cpp.

    {
        return m_selectedShapesProxy.data();
    }

References m_selectedShapesProxy.

setCursor()

void SimpleCanvas::setCursor ( const QCursor & cursor )

inlineoverridevirtual

set the specified cursor on this canvas

Parameters

cursor

the new cursor

Returns

the old cursor

Implements KoCanvasBase.

Definition at line 97 of file KoShapePainter.cpp.

{}

shapeManager()

KoShapeManager * SimpleCanvas::shapeManager ( ) const

inlineoverridevirtual

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

Implements KoCanvasBase.

Definition at line 53 of file KoShapePainter.cpp.

    {
        return m_shapeManager.data();
    }

References m_shapeManager.

snapToGrid()

bool SimpleCanvas::snapToGrid ( ) const

inlineoverridevirtual

return if snap to grid is enabled.

Returns

if snap to grid is enabled.

Implements KoCanvasBase.

Definition at line 44 of file KoShapePainter.cpp.

    {
        return false;
    }

toolProxy()

KoToolProxy * SimpleCanvas::toolProxy ( ) const

inlineoverridevirtual

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.

Implements KoCanvasBase.

Definition at line 67 of file KoShapePainter.cpp.

    {
        return 0;
    }

unit()

KoUnit SimpleCanvas::unit ( ) const

inlineoverridevirtual

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

See also

KoDocument::unit()

Implements KoCanvasBase.

Definition at line 92 of file KoShapePainter.cpp.

    {
        return KoUnit(KoUnit::Point);
    }

References KoUnit::Point.

updateCanvas()

void SimpleCanvas::updateCanvas ( const QRectF & rc )

inlineoverridevirtual

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

Implements KoCanvasBase.

Definition at line 63 of file KoShapePainter.cpp.

    {
    }

viewConverter() [1/2]

const KoViewConverter * SimpleCanvas::viewConverter ( ) const

inlineoverridevirtual

Return the viewConverter for this view.

Returns

the viewConverter for this view.

Implements KoCanvasBase.

Definition at line 72 of file KoShapePainter.cpp.

    {
        return 0;
    }

viewConverter() [2/2]

KoViewConverter * SimpleCanvas::viewConverter ( )

inlineoverridevirtual

Implements KoCanvasBase.

Definition at line 77 of file KoShapePainter.cpp.

    {
        return 0;
    }

Member Data Documentation

m_selectedShapesProxy

QScopedPointer<KoSelectedShapesProxySimple> SimpleCanvas::m_selectedShapesProxy

private

Definition at line 101 of file KoShapePainter.cpp.

m_shapeManager

QScopedPointer<KoShapeManager> SimpleCanvas::m_shapeManager

private

Definition at line 100 of file KoShapePainter.cpp.

---

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

• libs/flake/svg/KoShapePainter.cpp