View Class Reference

#include <View.h>

Inheritance diagram for View:

Classes
struct	Private

Public Slots
void	activateResource (Resource *resource)
	activateResource activates the given resource.
ManagedColor *	backgroundColor () const
	backgroundColor allows access to the currently active background color. This is nominally per canvas/view, but in practice per mainwindow.
qreal	brushRotation () const
	return the current rotation for brush tip
qreal	brushSize () const
	return the current size for brush
Canvas *	canvas () const
QString	currentBlendingMode () const
	return the current blending mode for brush
Resource *	currentBrushPreset () const
	return the current selected preset
Resource *	currentGradient () const
	return the current selected gradient
Resource *	currentPattern () const
	return the current selected pattern
bool	disablePressure () const
	return current disabled pressure status
Document *	document () const
bool	eraserMode () const
	return current eraser mode status (active/inactive)
QTransform	flakeToCanvasTransform () const
	flakeToCanvasTransform The transformation of the canvas relative to the view without rotation and mirroring
QTransform	flakeToDocumentTransform () const
	flakeToDocumentTransform The transformation of the document relative to the view without rotation and mirroring
QTransform	flakeToImageTransform () const
	flakeToImageTransform The transformation of the image relative to the view without rotation and mirroring
ManagedColor *	foregroundColor () const
bool	globalAlphaLock () const
	return current global alpha lock mode (active/inactive)
float	HDRExposure () const
float	HDRGamma () const
qreal	paintingFlow () const
	return the current flow for brush
qreal	paintingOpacity () const
	return the current opacity for brush
qreal	patternSize () const
	return the current pattern size for brush
QList< Node * >	selectedNodes () const
void	setBackGroundColor (ManagedColor *color)
void	setBrushRotation (qreal brushRotation)
	set the current rotation for brush tip
void	setBrushSize (qreal brushSize)
	set the current size for brush
void	setCurrentBlendingMode (const QString &blendingMode)
	set the current blending mode for brush
void	setCurrentBrushPreset (Resource *resource)
	set the current selected preset
void	setCurrentGradient (Resource *resource)
	set the current selected gradient
void	setCurrentPattern (Resource *resource)
	set the current selected pattern
void	setDisablePressure (bool value)
	set current disabled pressure status
void	setDocument (Document *document)
void	setEraserMode (bool value)
	set current eraser active/inactive
void	setForeGroundColor (ManagedColor *color)
void	setGlobalAlphaLock (bool value)
	set current global alpha lock mode active/inactive
void	setHDRExposure (float exposure)
	set the current HDR Exposure value
void	setHDRGamma (float gamma)
	set the current HDR Gamma value
void	setPaintingFlow (qreal flow)
	set the current flow value for brush
void	setPaintingOpacity (qreal opacity)
	set the current opacity for brush
void	setPatternSize (qreal size)
	set the current pattern size value for brush
void	setVisible ()
void	showFloatingMessage (const QString &message, const QIcon &icon, int timeout, int priority)
	showFloatingMessage displays a floating message box on the top-left corner of the canvas
bool	visible () const
Window *	window () const

Public Member Functions
bool	operator!= (const View &other) const
bool	operator== (const View &other) const
	View (KisView *view, QObject *parent=0)
	~View () override

Private Member Functions
KisView *	view ()

Private Attributes
Private *const	d

Friends
class	Scratchpad
class	Window

Detailed Description

View represents one view on a document. A document can be shown in more than one view at a time.

Definition at line 24 of file View.h.

Constructor & Destructor Documentation

View()

View::View ( KisView * view, QObject * parent = 0 )

explicit

Definition at line 38 of file View.cpp.

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

References d, View::Private::view, and view().

~View()

View::~View ( )

override

Definition at line 45 of file View.cpp.

{
    delete d;
}

References d.

Member Function Documentation

activateResource

void View::activateResource ( Resource * resource )

slot

activateResource activates the given resource.

Parameters

resource

a pattern, gradient or paintop preset

Definition at line 108 of file View.cpp.

{
    if (!d->view) return;
    if (!resource) return;
 
    KoResourceSP r = resource->resource();
    if (!r) return;
 
    if (KoPatternSP pattern = r.dynamicCast<KoPattern>()) {
        QVariant value = QVariant::fromValue(pattern);
        d->view->canvasBase()->resourceManager()->setResource(KoCanvasResource::CurrentPattern, value);
    } else if (KoAbstractGradientSP gradient = r.dynamicCast<KoAbstractGradient>()) {
        QVariant value = QVariant::fromValue(gradient);
        d->view->canvasBase()->resourceManager()->setResource(KoCanvasResource::CurrentGradient, value);
    } else if (KoResourceSP preset = r.dynamicCast<KisPaintOpPreset>()) {
        d->view->viewManager()->paintOpBox()->resourceSelected(preset);
    }
}

References KoCanvasResource::CurrentGradient, KoCanvasResource::CurrentPattern, d, Resource::resource(), value(), and View::Private::view.

backgroundColor

ManagedColor * View::backgroundColor ( ) const

slot

backgroundColor allows access to the currently active background color. This is nominally per canvas/view, but in practice per mainwindow.

Returns

The current background color

Definition at line 140 of file View.cpp.

{
    if (!d->view) return 0;
    return new ManagedColor(d->view->resourceProvider()->bgColor());
}

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

brushRotation

qreal View::brushRotation ( ) const

slot

return the current rotation for brush tip

Returns

the brush tip rotation value (in degrees)

Definition at line 249 of file View.cpp.

{
    if (!d->view) return 0.0;
    return d->view->resourceProvider()->brushRotation();
}

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

brushSize

qreal View::brushSize ( ) const

slot

return the current size for brush

Returns

the brush size value (in pixels)

Definition at line 237 of file View.cpp.

{
    if (!d->view) return 0.0;
    return d->view->resourceProvider()->size();
}

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

canvas

Canvas * View::canvas ( ) const

slot

Returns

the canvas this view is showing. The canvas controls things like zoom and rotation.

Definition at line 96 of file View.cpp.

{
    if (!d->view) return 0;
    Canvas *c = new Canvas(d->view->canvasBase());
    return c;
}

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

currentBlendingMode

QString View::currentBlendingMode ( ) const

slot

return the current blending mode for brush

Returns

the current blending mode identifier

Definition at line 185 of file View.cpp.

{
    if (!d->view) return "";
    return d->view->resourceProvider()->currentCompositeOp();
}

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

currentBrushPreset

Resource * View::currentBrushPreset ( ) const

slot

return the current selected preset

Returns

the current preset (Resource type = 'preset')

Definition at line 152 of file View.cpp.

{
    if (!d->view) return 0;
    return new Resource(d->view->resourceProvider()->currentPreset(), ResourceType::PaintOpPresets);
}

References d, ResourceType::PaintOpPresets, and View::Private::view.

currentGradient

Resource * View::currentGradient ( ) const

slot

return the current selected gradient

Returns

the current gradient (Resource type = 'gradient')

Definition at line 174 of file View.cpp.

{
    if (!d->view) return 0;
    return new Resource(d->view->resourceProvider()->currentGradient(), ResourceType::Gradients);
}

References d, ResourceType::Gradients, and View::Private::view.

currentPattern

Resource * View::currentPattern ( ) const

slot

return the current selected pattern

Returns

the current pattern (Resource type = 'pattern')

Definition at line 163 of file View.cpp.

{
    if (!d->view) return 0;
    return new Resource(d->view->resourceProvider()->currentPattern(), ResourceType::Patterns);
}

References d, ResourceType::Patterns, and View::Private::view.

disablePressure

bool View::disablePressure ( ) const

slot

return current disabled pressure status

Returns

True if is pressure is disabled, otherwise False

Definition at line 317 of file View.cpp.

{
    if (!d->view) {
        return false;
    }
    return d->view->resourceProvider()->disablePressure();
}

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

document

Document * View::document ( ) const

slot

Returns

the document this view is showing.

Definition at line 69 of file View.cpp.

{
    if (!d->view) return 0;
    Document *doc = new Document(d->view->document(), false);
    return doc;
}

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

eraserMode

bool View::eraserMode ( ) const

slot

return current eraser mode status (active/inactive)

Returns

True if eraser mode is active, otherwise False

Definition at line 285 of file View.cpp.

{
    if (!d->view) {
        return false;
    }
    return d->view->resourceProvider()->eraserMode();
}

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

flakeToCanvasTransform

QTransform View::flakeToCanvasTransform ( ) const

slot

flakeToCanvasTransform The transformation of the canvas relative to the view without rotation and mirroring

Returns

QTransform

Definition at line 360 of file View.cpp.

{
    if (!d->view->document()) return QTransform();
    return d->view->canvasBase()->coordinatesConverter()->flakeToWidgetTransform();
}

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

flakeToDocumentTransform

QTransform View::flakeToDocumentTransform ( ) const

slot

flakeToDocumentTransform The transformation of the document relative to the view without rotation and mirroring

Returns

QTransform

Definition at line 354 of file View.cpp.

{
    if (!d->view->document()) return QTransform();
    return d->view->canvasBase()->coordinatesConverter()->documentToFlakeTransform().inverted();
}

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

flakeToImageTransform

QTransform View::flakeToImageTransform ( ) const

slot

flakeToImageTransform The transformation of the image relative to the view without rotation and mirroring

Returns

QTransform

Definition at line 366 of file View.cpp.

{
    if (!d->view->document()) return QTransform();
 
    const KisCoordinatesConverter* coordinatesConverter(d->view->canvasBase()->coordinatesConverter());
    QTransform imageToFlakeTransform = coordinatesConverter->imageToDocumentTransform() * coordinatesConverter->documentToFlakeTransform();
 
    return imageToFlakeTransform.inverted();
}

References d, KisCoordinatesConverter::documentToFlakeTransform(), KisCoordinatesConverter::imageToDocumentTransform(), and View::Private::view.

foregroundColor

ManagedColor * View::foregroundColor ( ) const

slot

   @brief foregroundColor allows access to the currently active foreground color.
   This is nominally per canvas/view, but in practice per mainwindow.

   @code

color = Application.activeWindow().activeView().foregroundColor() components = color.components() components[0] = 1.0 components[1] = 0.6 components[2] = 0.7 color.setComponents(components) Application.activeWindow().activeView().setForeGroundColor(color)

Returns

The current foreground color

Definition at line 128 of file View.cpp.

{
    if (!d->view) return 0;
    return new ManagedColor(d->view->resourceProvider()->fgColor());
}

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

globalAlphaLock

bool View::globalAlphaLock ( ) const

slot

return current global alpha lock mode (active/inactive)

Returns

True if is active, otherwise False

Definition at line 301 of file View.cpp.

{
    if (!d->view) {
        return false;
    }
    return d->view->resourceProvider()->globalAlphaLock();
}

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

HDRExposure

float View::HDRExposure ( ) const

slot

Returns

the current HDR Exposure value

Definition at line 197 of file View.cpp.

{
    if (!d->view) return 0.0;
    KisExposureGammaCorrectionInterface *iface = d->view->canvasBase()->exposureGammaCorrectionInterface();
    return iface->currentExposure();
}

References KisExposureGammaCorrectionInterface::currentExposure(), d, and View::Private::view.

HDRGamma

float View::HDRGamma ( ) const

slot

Returns

the current HDR Gamma value

Definition at line 211 of file View.cpp.

{
    if (!d->view) return 0.0;
    KisExposureGammaCorrectionInterface *iface = d->view->canvasBase()->exposureGammaCorrectionInterface();
    return iface->currentGamma();
}

References KisExposureGammaCorrectionInterface::currentGamma(), d, and View::Private::view.

operator!=()

bool View::operator!=

(

const View &

other

)

const

Definition at line 55 of file View.cpp.

{
    return !(operator==(other));
}

References operator==().

operator==()

bool View::operator==

(

const View &

other

)

const

Definition at line 50 of file View.cpp.

{
    return (d->view == other.d->view);
}

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

paintingFlow

qreal View::paintingFlow ( ) const

slot

return the current flow for brush

Returns

the brush flow value

Definition at line 261 of file View.cpp.

{
    if (!d->view) return 0.0;
    return d->view->resourceProvider()->flow();
}

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

paintingOpacity

qreal View::paintingOpacity ( ) const

slot

return the current opacity for brush

Returns

the brush opacity value (0.00=fully transparent - 1.00=fully opaque)

Definition at line 225 of file View.cpp.

{
    if (!d->view) return 0.0;
    return d->view->resourceProvider()->opacity();
}

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

patternSize

qreal View::patternSize ( ) const

slot

return the current pattern size for brush

Returns

the brush pattern size value

Definition at line 273 of file View.cpp.

{
    if (!d->view) return 0.0;
    return d->view->resourceProvider()->patternSize();
}

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

selectedNodes

QList< Node * > View::selectedNodes ( ) const

slot

   @brief selectedNodes returns a list of Nodes that are selected in this view.

from krita import *
w = Krita.instance().activeWindow()
v = w.activeView()
selected_nodes = v.selectedNodes()
print(selected_nodes)

Returns

a list of Node objects which may be empty.

Definition at line 334 of file View.cpp.

{
    if (!d->view) return QList<Node *>();
    if (!d->view->viewManager()) return QList<Node *>();
    if (!d->view->viewManager()->nodeManager()) return QList<Node *>();
 
    KisNodeList selectedNodes = d->view->viewManager()->nodeManager()->selectedNodes();
    return LibKisUtils::createNodeList(selectedNodes, d->view->image());
}

References LibKisUtils::createNodeList(), d, selectedNodes(), and View::Private::view.

setBackGroundColor

void View::setBackGroundColor ( ManagedColor * color )

slot

Definition at line 146 of file View.cpp.

{
    if (!d->view) return;
    d->view->resourceProvider()->setBGColor(color->color());
}

References ManagedColor::color(), d, and View::Private::view.

setBrushRotation

void View::setBrushRotation ( qreal brushRotation )

slot

set the current rotation for brush tip

Parameters

brushRotation

the brush tip rotation (in degrees)

Definition at line 255 of file View.cpp.

{
    if (!d->view) return;
    d->view->resourceProvider()->setBrushRotation(brushRotation);
}

References brushRotation(), d, and View::Private::view.

setBrushSize

void View::setBrushSize ( qreal brushSize )

slot

set the current size for brush

Parameters

brushSize

the brush size (in pixels)

Definition at line 243 of file View.cpp.

{
    if (!d->view) return;
    d->view->resourceProvider()->setSize(brushSize);
}

References brushSize(), d, and View::Private::view.

setCurrentBlendingMode

void View::setCurrentBlendingMode ( const QString & blendingMode )

slot

set the current blending mode for brush

Parameters

blendingMode

the current belding mode identifier

Definition at line 191 of file View.cpp.

{
    if (!d->view) return;
    d->view->resourceProvider()->setCurrentCompositeOp(blendingMode);
}

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

setCurrentBrushPreset

void View::setCurrentBrushPreset ( Resource * resource )

slot

set the current selected preset

Parameters

resource

the current preset to set (Resource type = 'preset')

Definition at line 158 of file View.cpp.

{
    activateResource(resource);
}

References activateResource().

setCurrentGradient

void View::setCurrentGradient ( Resource * resource )

slot

set the current selected gradient

Parameters

resource

the current gradient to set (Resource type = 'gradient')

Definition at line 180 of file View.cpp.

{
    activateResource(resource);
}

References activateResource().

setCurrentPattern

void View::setCurrentPattern ( Resource * resource )

slot

set the current selected pattern

Parameters

resource

the current pattern to set (Resource type = 'pattern')

Definition at line 169 of file View.cpp.

{
    activateResource(resource);
}

References activateResource().

setDisablePressure

void View::setDisablePressure ( bool value )

slot

set current disabled pressure status

Parameters

value

Set to True to disable pressure, False to enabled pressure

Definition at line 325 of file View.cpp.

{
    if (!d->view) {
        return;
    }
    d->view->resourceProvider()->setDisablePressure(value);
}

References d, value(), and View::Private::view.

setDocument

void View::setDocument ( Document * document )

slot

Reset the view to show document.

Definition at line 76 of file View.cpp.

{
    if (!d->view || !document || !document->document()) return;
    d->view = d->view->replaceBy(document->document());
}

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

setEraserMode

void View::setEraserMode ( bool value )

slot

set current eraser active/inactive

Parameters

value

Set to True to activate eraser mode, False to deactivate

Definition at line 293 of file View.cpp.

{
    if (!d->view) {
        return;
    }
    d->view->resourceProvider()->setEraserMode(value);
}

References d, value(), and View::Private::view.

setForeGroundColor

void View::setForeGroundColor ( ManagedColor * color )

slot

Definition at line 134 of file View.cpp.

{
    if (!d->view) return;
    d->view->resourceProvider()->setFGColor(color->color());
}

References ManagedColor::color(), d, and View::Private::view.

setGlobalAlphaLock

void View::setGlobalAlphaLock ( bool value )

slot

set current global alpha lock mode active/inactive

Parameters

value

Set to True to lock global alpha mode, False to unlock

Definition at line 309 of file View.cpp.

{
    if (!d->view) {
        return;
    }
    d->view->resourceProvider()->setGlobalAlphaLock(value);
}

References d, value(), and View::Private::view.

setHDRExposure

void View::setHDRExposure ( float exposure )

slot

set the current HDR Exposure value

Parameters

exposure

the HDR Exposure to set

Definition at line 204 of file View.cpp.

{
    if (!d->view) return;
    KisExposureGammaCorrectionInterface *iface = d->view->canvasBase()->exposureGammaCorrectionInterface();
    iface->setCurrentExposure(exposure);
}

References d, KisExposureGammaCorrectionInterface::setCurrentExposure(), and View::Private::view.

setHDRGamma

void View::setHDRGamma ( float gamma )

slot

set the current HDR Gamma value

Parameters

exposure

the HDR Gamma to set

Definition at line 218 of file View.cpp.

{
    if (!d->view) return;
    KisExposureGammaCorrectionInterface *iface = d->view->canvasBase()->exposureGammaCorrectionInterface();
    return iface->setCurrentGamma(gamma);
}

References d, KisExposureGammaCorrectionInterface::setCurrentGamma(), and View::Private::view.

setPaintingFlow

void View::setPaintingFlow ( qreal flow )

slot

set the current flow value for brush

Parameters

flow	the brush flow

Definition at line 267 of file View.cpp.

{
    if (!d->view) return;
    d->view->resourceProvider()->setFlow(flow);
}

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

setPaintingOpacity

void View::setPaintingOpacity ( qreal opacity )

slot

set the current opacity for brush

Parameters

opacity

the opacity value (0.00=fully transparent - 1.00=fully opaque)

Definition at line 231 of file View.cpp.

{
    if (!d->view) return;
    d->view->resourceProvider()->setOpacity(opacity);
}

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

setPatternSize

void View::setPatternSize ( qreal size )

slot

set the current pattern size value for brush

Parameters

flow	the brush pattern size

Definition at line 279 of file View.cpp.

{
    if (!d->view) return;
    d->view->resourceProvider()->setPatternSize(size);
}

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

setVisible

void View::setVisible ( )

slot

Make the current view visible.

Definition at line 88 of file View.cpp.

{
    if (!d->view) return;
    KisMainWindow *mainwin = d->view->mainWindow();
    mainwin->setActiveView(d->view);
    mainwin->subWindowActivated();
}

References d, KisMainWindow::setActiveView(), KisMainWindow::subWindowActivated(), and View::Private::view.

showFloatingMessage

void View::showFloatingMessage ( const QString & message, const QIcon & icon, int timeout, int priority )

slot

showFloatingMessage displays a floating message box on the top-left corner of the canvas

Parameters

message	Message to be displayed inside the floating message box
icon	Icon to be displayed inside the message box next to the message string
timeout	Milliseconds until the message box disappears
priority	0 = High, 1 = Medium, 2 = Low. Higher priority messages will be displayed in place of lower priority messages

Definition at line 344 of file View.cpp.

{
    if (!d->view) return;
 
    KisFloatingMessage::Priority p;
    p = static_cast<KisFloatingMessage::Priority>(priority);
 
    d->view->showFloatingMessage(message, icon, timeout, p);
}

References d, p, and View::Private::view.

view()

KisView * View::view ( )

private

Definition at line 103 of file View.cpp.

{
    return d->view;
}

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

visible

bool View::visible ( ) const

slot

Returns

True if the current view is visible, False if not.

Definition at line 82 of file View.cpp.

{
    if (!d->view) return false;
    return d->view->isVisible();
}

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

window

Window * View::window ( ) const

slot

Returns

the window this view is shown in.

Definition at line 60 of file View.cpp.

{
    if (!d->view) return 0;
    KisMainWindow *mainwin = d->view->mainWindow();
    Window *win = new Window(mainwin);
    return win;
}

References d, View::Private::view, and Window.

Friends And Related Symbol Documentation

Scratchpad

friend class Scratchpad

friend

Definition at line 348 of file View.h.

Window

friend class Window

friend

Definition at line 347 of file View.h.

Member Data Documentation

d

Private* const View::d

private

Definition at line 354 of file View.h.

---

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

• libs/libkis/View.h
• libs/libkis/View.cpp