krita

KisCanvasController Class Reference

#include <kis_canvas_controller.h>

Inherited by KisView [private].

List of all members.


Detailed Description

Interface for classes that implement a canvas; i.e., a widget where KisImages are painted onto.

This is the "view" part of the model-view-controller paradigm; the naming is a confusing historical artefact.

Definition at line 39 of file kis_canvas_controller.h.


Public Member Functions

virtual KisCanvas * kiscanvas () const =0
virtual Q_INT32 horzValue () const =0
virtual Q_INT32 vertValue () const =0
virtual void scrollTo (Q_INT32 x, Q_INT32 y)=0
virtual void updateCanvas ()=0
virtual void updateCanvas (Q_INT32 x, Q_INT32 y, Q_INT32 w, Q_INT32 h)=0
virtual void updateCanvas (const QRect &rc)=0
virtual void zoomIn ()=0
virtual void zoomIn (Q_INT32 x, Q_INT32 y)=0
virtual void zoomOut ()=0
virtual void zoomOut (Q_INT32 x, Q_INT32 y)=0
virtual void zoomAroundPoint (double x, double y, double zf)=0
virtual void zoomTo (Q_INT32 x, Q_INT32 y, Q_INT32 w, Q_INT32 h)=0
virtual void zoomTo (const QRect &r)=0
virtual void zoomTo (const KisRect &r)=0
virtual QPoint viewToWindow (const QPoint &pt)=0
virtual KisPoint viewToWindow (const KisPoint &pt)=0
virtual QRect viewToWindow (const QRect &rc)=0
virtual KisRect viewToWindow (const KisRect &rc)=0
virtual void viewToWindow (Q_INT32 *x, Q_INT32 *y)=0
virtual QPoint windowToView (const QPoint &pt)=0
virtual KisPoint windowToView (const KisPoint &pt)=0
virtual QRect windowToView (const QRect &rc)=0
virtual KisRect windowToView (const KisRect &rc)=0
virtual void windowToView (Q_INT32 *x, Q_INT32 *y)=0
virtual QCursor setCanvasCursor (const QCursor &cursor)=0
virtual void setInputDevice (KisInputDevice inputDevice)=0
virtual KisInputDevice currentInputDevice () const =0

Member Function Documentation

virtual KisCanvas* KisCanvasController::kiscanvas (  )  const [pure virtual]

Returns:
the canvas object

virtual Q_INT32 KisCanvasController::horzValue (  )  const [pure virtual]

Returns:
the value of the horizontal scrollbar.

virtual Q_INT32 KisCanvasController::vertValue (  )  const [pure virtual]

Returns:
the value of the vertical scrollbar

virtual void KisCanvasController::scrollTo ( Q_INT32  x,
Q_INT32  y 
) [pure virtual]

Sets the horizontal and vertical scrollbars to the specified values.

Parameters:
x the value the horizontal scrollbar is set to
y the value the vertical scrollbar is set to

virtual void KisCanvasController::updateCanvas (  )  [pure virtual]

Tell all of the canvas to repaint itself.

virtual void KisCanvasController::updateCanvas ( Q_INT32  x,
Q_INT32  y,
Q_INT32  w,
Q_INT32  h 
) [pure virtual]

Tell the canvas to repaint the rectangle defined by x, y, w and h.

The coordinates are image coordinates.

virtual void KisCanvasController::updateCanvas ( const QRect &  rc  )  [pure virtual]

Tell the canvas repaint the specified rectangle.

The coordinates are image coordinates, not view coordinates.

virtual void KisCanvasController::zoomIn (  )  [pure virtual]

Increase the zoomlevel one step.

virtual void KisCanvasController::zoomIn ( Q_INT32  x,
Q_INT32  y 
) [pure virtual]

Increase the zoomlevel one step and make sure that x,y is the center point of the view.

Parameters:
x The x coordinate of the visible point in image coordinates
y the y coordinate of the visible point in image coordinates

virtual void KisCanvasController::zoomOut (  )  [pure virtual]

Decrease the zoomlevel one step.

virtual void KisCanvasController::zoomOut ( Q_INT32  x,
Q_INT32  y 
) [pure virtual]

Decrease the zoomlevel one step and make sure that x,y is the center point of the view.

Parameters:
x the x coordinate of the visible point in image coordinates
y the y coordinate of the visible point in image coordinates

virtual void KisCanvasController::zoomAroundPoint ( double  x,
double  y,
double  zf 
) [pure virtual]

To centre the view on the given point with the given zoom factor.

Parameters:
x the x coordinate of the center point in image coordinates
y the y coordinate of the center point in image coordinates
zf the zoomfactor

virtual void KisCanvasController::zoomTo ( Q_INT32  x,
Q_INT32  y,
Q_INT32  w,
Q_INT32  h 
) [pure virtual]

Make the rect defined by x, y, w and h visible, zooming in or out as necessary.

The view will be centered around the center point of the specified rect.

virtual void KisCanvasController::zoomTo ( const QRect &  r  )  [pure virtual]

Make the rect defined by x, y, w and h visible, zooming in or out as necessary.

The view will be centered around the center point of the specified rect.

virtual void KisCanvasController::zoomTo ( const KisRect r  )  [pure virtual]

Make the rect defined by x, y, w and h visible, zooming in or out as necessary.

The view will be centered around the center point of the specified rect.

virtual QPoint KisCanvasController::viewToWindow ( const QPoint &  pt  )  [pure virtual]

Conversion functions from view coordinates to image coordinates.

You can get the rectangle of the image that's visible using the viewToWindow() functions (KisCanvasController). E.g. viewToWindow(QRect(0, 0, canvasWidth, canvasHeight)).

Here, the view is the canvas widget in the view widget, and the window is the window on the image.

virtual QPoint KisCanvasController::windowToView ( const QPoint &  pt  )  [pure virtual]

Conversion functions from image coordinates to view coordinates.

virtual QCursor KisCanvasController::setCanvasCursor ( const QCursor &  cursor  )  [pure virtual]

Set the cursor shown when the pointer is over the canvas widget to the specified cursor.

Parameters:
cursor the new cursor
Returns:
the old cursor

virtual void KisCanvasController::setInputDevice ( KisInputDevice  inputDevice  )  [pure virtual]

Set the active input device to the specified input device, This could be a mouse, a stylus, an eraser or any other pointing input device.

Parameters:
inputDevice the new input device

virtual KisInputDevice KisCanvasController::currentInputDevice (  )  const [pure virtual]

Returns:
the current input device, such as a mouse or a stylus


The documentation for this class was generated from the following file:
KDE Home | KDE Accessibility Home | Description of Access Keys