GuidesConfig Class Reference

#include <GuidesConfig.h>

Inheritance diagram for GuidesConfig:

Public Slots
QColor	color () const
bool	fromXml (const QString &xmlContent) const
bool	hasGuides () const
bool	hasSamePositionAs (const GuidesConfig &guideConfig) const
QList< qreal >	horizontalGuides () const
QString	lineType () const
bool	locked () const
void	removeAllGuides ()
void	setColor (const QColor &color) const
void	setHorizontalGuides (const QList< qreal > &lines)
void	setLineType (const QString &lineType)
void	setLocked (const bool value)
void	setSnap (const bool value)
void	setVerticalGuides (const QList< qreal > &lines)
void	setVisible (const bool value)
bool	snap () const
QString	toXml () const
QList< qreal >	verticalGuides () const
bool	visible () const

Public Member Functions
	GuidesConfig (KisGuidesConfig *guidesConfig)
	GuidesConfig (QObject *parent=0)
bool	operator!= (const GuidesConfig &other) const
bool	operator== (const GuidesConfig &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

The GuidesConfig class encapsulates a Krita Guides configuration.

Definition at line 19 of file GuidesConfig.h.

Constructor & Destructor Documentation

GuidesConfig() [1/2]

GuidesConfig::GuidesConfig

(

KisGuidesConfig *

guidesConfig

)

Definition at line 18 of file GuidesConfig.cpp.

GuidesConfig() [2/2]

GuidesConfig::GuidesConfig ( QObject * parent = 0 )

explicit

Create a new, empty GuidesConfig.

Definition at line 25 of file GuidesConfig.cpp.

~GuidesConfig()

GuidesConfig::~GuidesConfig ( )

override

Definition at line 32 of file GuidesConfig.cpp.

Member Function Documentation

color

QColor GuidesConfig::color ( ) const

slot

Guides color.

Returns

color applied for all guides

Definition at line 47 of file GuidesConfig.cpp.

fromXml

bool GuidesConfig::fromXml ( const QString & xmlContent ) const

slot

Load guides definition from an XML document.

Parameters

xmlContent

xml content provided as a string

Returns

True if xml content is valid and guides has been loaded, otherwise False

Definition at line 104 of file GuidesConfig.cpp.

hasGuides

bool GuidesConfig::hasGuides ( ) const

slot

indicate if there's guides defined

Returns

True if at least one guide is defined, otherwise False

Definition at line 84 of file GuidesConfig.cpp.

hasSamePositionAs

bool GuidesConfig::hasSamePositionAs ( const GuidesConfig & guideConfig ) const

slot

indicate if position from current guides configuration match positions from another guides configuration

Returns

True if positions are the same

Definition at line 89 of file GuidesConfig.cpp.

horizontalGuides

QList< qreal > GuidesConfig::horizontalGuides ( ) const

slot

The horizontal guides.

Returns

a list of the horizontal positions of guides.

Definition at line 160 of file GuidesConfig.cpp.

lineType

QString GuidesConfig::lineType ( ) const

slot

Guides line type.

Returns

line type applied for all guides Can be:

• "solid"
• "dashed"
• "dot"

Definition at line 57 of file GuidesConfig.cpp.

locked

bool GuidesConfig::locked ( ) const

slot

Returns guide lock status.

Returns

True if guides are locked, otherwise False

Definition at line 130 of file GuidesConfig.cpp.

operator!=()

bool GuidesConfig::operator!=

(

const GuidesConfig &

other

)

const

Definition at line 42 of file GuidesConfig.cpp.

operator==()

bool GuidesConfig::operator==

(

const GuidesConfig &

other

)

const

Definition at line 37 of file GuidesConfig.cpp.

removeAllGuides

void GuidesConfig::removeAllGuides ( )

slot

Remove all guides.

Definition at line 125 of file GuidesConfig.cpp.

setColor

void GuidesConfig::setColor ( const QColor & color ) const

slot

Define guides color.

Parameters

color

color to apply

Definition at line 52 of file GuidesConfig.cpp.

setHorizontalGuides

void GuidesConfig::setHorizontalGuides ( const QList< qreal > & lines )

slot

Set the horizontal guides.

Parameters

lines

a list of the horizontal positions of guides to set

Definition at line 150 of file GuidesConfig.cpp.

setLineType

void GuidesConfig::setLineType ( const QString & lineType )

slot

Define guides lines type.

Parameters

lineType

line type to use for guides: Can be: "solid" "dashed" "dot"

Definition at line 69 of file GuidesConfig.cpp.

setLocked

void GuidesConfig::setLocked ( const bool value )

slot

Set guides lock status.

Parameters

value

True to set guides locked, otherwise False

Definition at line 135 of file GuidesConfig.cpp.

setSnap

void GuidesConfig::setSnap ( const bool value )

slot

Set guides snap status.

Parameters

value

True to set snap to guides active, otherwise False

Definition at line 145 of file GuidesConfig.cpp.

setVerticalGuides

void GuidesConfig::setVerticalGuides ( const QList< qreal > & lines )

slot

Set the vertical guides.

Parameters

lines

a list of the vertical positions of guides to set

Definition at line 155 of file GuidesConfig.cpp.

setVisible

void GuidesConfig::setVisible ( const bool value )

slot

Set guides visibility status.

Parameters

value

True to set guides visible, otherwise False

Definition at line 99 of file GuidesConfig.cpp.

snap

bool GuidesConfig::snap ( ) const

slot

Returns guide snap status.

Returns

True if snap to guides is active, otherwise False

Definition at line 140 of file GuidesConfig.cpp.

toXml

QString GuidesConfig::toXml ( ) const

slot

Save guides definition as an XML document.

Returns

A string with xml content

Definition at line 117 of file GuidesConfig.cpp.

verticalGuides

QList< qreal > GuidesConfig::verticalGuides ( ) const

slot

The vertical guides.

Returns

a list of vertical positions of guides.

Definition at line 165 of file GuidesConfig.cpp.

visible

bool GuidesConfig::visible ( ) const

slot

Returns guides visibility status.

Returns

True if guides are visibles, otherwise False

Definition at line 94 of file GuidesConfig.cpp.

---

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

• GuidesConfig.h
• GuidesConfig.cpp