View Class Reference

#include <View.h>

Inheritance diagram for View:

Public Slots
void	activateResource (Resource *resource)
ManagedColor *	backgroundColor () const
qreal	brushRotation () const
qreal	brushSize () const
Canvas *	canvas () const
QString	currentBlendingMode () const
Resource *	currentBrushPreset () const
Resource *	currentGradient () const
Resource *	currentPattern () const
bool	disablePressure () const
Document *	document () const
bool	eraserMode () const
QTransform	flakeToCanvasTransform () const
QTransform	flakeToDocumentTransform () const
QTransform	flakeToImageTransform () const
ManagedColor *	foregroundColor () const
bool	globalAlphaLock () const
float	HDRExposure () const
float	HDRGamma () const
qreal	paintingFlow () const
qreal	paintingOpacity () const
qreal	patternSize () const
QList< Node * >	selectedNodes () const
void	setBackGroundColor (ManagedColor *color)
void	setBrushRotation (qreal brushRotation)
void	setBrushSize (qreal brushSize)
void	setCurrentBlendingMode (const QString &blendingMode)
void	setCurrentBrushPreset (Resource *resource)
void	setCurrentGradient (Resource *resource)
void	setCurrentPattern (Resource *resource)
void	setDisablePressure (bool value)
void	setDocument (Document *document)
void	setEraserMode (bool value)
void	setForeGroundColor (ManagedColor *color)
void	setGlobalAlphaLock (bool value)
void	setHDRExposure (float exposure)
void	setHDRGamma (float gamma)
void	setPaintingFlow (qreal flow)
void	setPaintingOpacity (qreal opacity)
void	setPatternSize (qreal size)
void	setVisible ()
void	showFloatingMessage (const QString &message, const QIcon &icon, int timeout, int priority)
bool	visible () const
Window *	window () const

Public Member Functions
	View (KisView *view, QObject *parent=0)
bool	operator!= (const View &other) const
bool	operator== (const View &other) const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

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 39 of file View.cpp.

~View()

View::~View ( )

override

Definition at line 46 of file View.cpp.

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 109 of file View.cpp.

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 141 of file View.cpp.

brushRotation

qreal View::brushRotation ( ) const

slot

return the current rotation for brush tip

Returns

the brush tip rotation value (in degrees)

Definition at line 250 of file View.cpp.

brushSize

qreal View::brushSize ( ) const

slot

return the current size for brush

Returns

the brush size value (in pixels)

Definition at line 238 of file View.cpp.

canvas

Canvas * View::canvas ( ) const

slot

Returns

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

Definition at line 97 of file View.cpp.

currentBlendingMode

QString View::currentBlendingMode ( ) const

slot

return the current blending mode for brush

Returns

the current blending mode identifier

Definition at line 186 of file View.cpp.

currentBrushPreset

Resource * View::currentBrushPreset ( ) const

slot

return the current selected preset

Returns

the current preset (Resource type = 'preset')

Definition at line 153 of file View.cpp.

currentGradient

Resource * View::currentGradient ( ) const

slot

return the current selected gradient

Returns

the current gradient (Resource type = 'gradient')

Definition at line 175 of file View.cpp.

currentPattern

Resource * View::currentPattern ( ) const

slot

return the current selected pattern

Returns

the current pattern (Resource type = 'pattern')

Definition at line 164 of file View.cpp.

disablePressure

bool View::disablePressure ( ) const

slot

return current disabled pressure status

Returns

True if is pressure is disabled, otherwise False

Definition at line 318 of file View.cpp.

document

Document * View::document ( ) const

slot

Returns

the document this view is showing.

Definition at line 70 of file View.cpp.

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 286 of file View.cpp.

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 361 of file View.cpp.

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 355 of file View.cpp.

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 367 of file View.cpp.

foregroundColor

ManagedColor * View::foregroundColor ( ) const

slot

foregroundColor allows access to the currently active foreground color.

This is nominally per canvas/view, but in practice per mainwindow.

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 129 of file View.cpp.

globalAlphaLock

bool View::globalAlphaLock ( ) const

slot

return current global alpha lock mode (active/inactive)

Returns

True if is active, otherwise False

Definition at line 302 of file View.cpp.

HDRExposure

float View::HDRExposure ( ) const

slot

Returns

the current HDR Exposure value

Definition at line 198 of file View.cpp.

HDRGamma

float View::HDRGamma ( ) const

slot

Returns

the current HDR Gamma value

Definition at line 212 of file View.cpp.

operator!=()

bool View::operator!=

(

const View &

other

)

const

Definition at line 56 of file View.cpp.

operator==()

bool View::operator==

(

const View &

other

)

const

Definition at line 51 of file View.cpp.

paintingFlow

qreal View::paintingFlow ( ) const

slot

return the current flow for brush

Returns

the brush flow value

Definition at line 262 of file View.cpp.

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 226 of file View.cpp.

patternSize

qreal View::patternSize ( ) const

slot

return the current pattern size for brush

Returns

the brush pattern size value

Definition at line 274 of file View.cpp.

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 335 of file View.cpp.

setBackGroundColor

void View::setBackGroundColor ( ManagedColor * color )

slot

Definition at line 147 of file View.cpp.

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 256 of file View.cpp.

setBrushSize

void View::setBrushSize ( qreal brushSize )

slot

set the current size for brush

Parameters

brushSize

the brush size (in pixels)

Definition at line 244 of file View.cpp.

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 192 of file View.cpp.

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 159 of file View.cpp.

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 181 of file View.cpp.

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 170 of file View.cpp.

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 326 of file View.cpp.

setDocument

void View::setDocument ( Document * document )

slot

Reset the view to show document.

Definition at line 77 of file View.cpp.

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 294 of file View.cpp.

setForeGroundColor

void View::setForeGroundColor ( ManagedColor * color )

slot

Definition at line 135 of file View.cpp.

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 310 of file View.cpp.

setHDRExposure

void View::setHDRExposure ( float exposure )

slot

set the current HDR Exposure value

Parameters

exposure

the HDR Exposure to set

Definition at line 205 of file View.cpp.

setHDRGamma

void View::setHDRGamma ( float gamma )

slot

set the current HDR Gamma value

Parameters

exposure

the HDR Gamma to set

Definition at line 219 of file View.cpp.

setPaintingFlow

void View::setPaintingFlow ( qreal flow )

slot

set the current flow value for brush

Parameters

flow	the brush flow

Definition at line 268 of file View.cpp.

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 232 of file View.cpp.

setPatternSize

void View::setPatternSize ( qreal size )

slot

set the current pattern size value for brush

Parameters

flow	the brush pattern size

Definition at line 280 of file View.cpp.

setVisible

void View::setVisible ( )

slot

Make the current view visible.

Definition at line 89 of file View.cpp.

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 345 of file View.cpp.

visible

bool View::visible ( ) const

slot

Returns

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

Definition at line 83 of file View.cpp.

window

Window * View::window ( ) const

slot

Returns

the window this view is shown in.

Definition at line 61 of file View.cpp.

---

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

• View.h
• View.cpp