GuidesConfig Class Reference

#include <GuidesConfig.h>

Inheritance diagram for GuidesConfig:

Public Slots
QColor	color () const
	Guides color.
bool	fromXml (const QString &xmlContent) const
	Load guides definition from an XML document.
bool	hasGuides () const
	indicate if there's guides defined
bool	hasSamePositionAs (const GuidesConfig &guideConfig) const
	indicate if position from current guides configuration match positions from another guides configuration
QList< qreal >	horizontalGuides () const
	The horizontal guides.
QString	lineType () const
	Guides line type.
bool	locked () const
	Returns guide lock status.
void	removeAllGuides ()
	Remove all guides.
void	setColor (const QColor &color) const
	Define guides color.
void	setHorizontalGuides (const QList< qreal > &lines)
	Set the horizontal guides.
void	setLineType (const QString &lineType)
	Define guides lines type.
void	setLocked (const bool value)
	Set guides lock status.
void	setSnap (const bool value)
	Set guides snap status.
void	setVerticalGuides (const QList< qreal > &lines)
	Set the vertical guides.
void	setVisible (const bool value)
	Set guides visibility status.
bool	snap () const
	Returns guide snap status.
QString	toXml () const
	Save guides definition as an XML document.
QList< qreal >	verticalGuides () const
	The vertical guides.
bool	visible () const
	Returns guides visibility status.

Public Member Functions
	GuidesConfig (KisGuidesConfig *guidesConfig)
	GuidesConfig (QObject *parent=0)
bool	operator!= (const GuidesConfig &other) const
bool	operator== (const GuidesConfig &other) const
	~GuidesConfig () override

Private Member Functions
KisGuidesConfig	guidesConfig () const

Private Attributes
Private *	d

Friends
class	Document

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.

    : QObject(0)
    , d(new Private)
{
    d->guidesConfig = guidesConfig;
}

References d, krita::GuidesConfig::Private::guidesConfig, and guidesConfig().

GuidesConfig() [2/2]

GuidesConfig::GuidesConfig ( QObject * parent = 0 )

explicit

Create a new, empty GuidesConfig.

Definition at line 25 of file GuidesConfig.cpp.

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

References d, and krita::GuidesConfig::Private::guidesConfig.

~GuidesConfig()

GuidesConfig::~GuidesConfig ( )

override

Definition at line 32 of file GuidesConfig.cpp.

{
    delete d;
}

References d.

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.

{
    return d->guidesConfig->guidesColor();
}

References d, KisGuidesConfig::guidesColor, and krita::GuidesConfig::Private::guidesConfig.

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.

{
    QDomDocument doc = QDomDocument();
    QString errorMsg {""};
    int errorLine {0}, errorColumn {0};
 
    if(doc.setContent(xmlContent, &errorMsg, &errorLine, &errorColumn)) {
        return d->guidesConfig->loadFromXml(doc.documentElement());
    }
 
    return false;
}

References d, krita::GuidesConfig::Private::guidesConfig, and KisGuidesConfig::loadFromXml().

guidesConfig()

KisGuidesConfig GuidesConfig::guidesConfig ( ) const

private

Definition at line 170 of file GuidesConfig.cpp.

{
    return *d->guidesConfig;
}

References d, and krita::GuidesConfig::Private::guidesConfig.

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.

{
    return d->guidesConfig->hasGuides();
}

References d, krita::GuidesConfig::Private::guidesConfig, and KisGuidesConfig::hasGuides().

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.

{
    return d->guidesConfig->hasSamePositionAs(guideConfig.guidesConfig());
}

References d, krita::GuidesConfig::Private::guidesConfig, guidesConfig(), and KisGuidesConfig::hasSamePositionAs().

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.

{
    return d->guidesConfig->horizontalGuideLines();
}

References d, krita::GuidesConfig::Private::guidesConfig, and KisGuidesConfig::horizontalGuideLines().

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.

{
    KisGuidesConfig::LineTypeInternal lineType = d->guidesConfig->guidesLineType();
    if(lineType == KisGuidesConfig::LineTypeInternal::LINE_DASHED) {
        return "dashed";
    }
    else if(lineType == KisGuidesConfig::LineTypeInternal::LINE_DOTTED) {
        return "dotted";
    }
    return "solid";
}

References d, krita::GuidesConfig::Private::guidesConfig, KisGuidesConfig::guidesLineType, KisGuidesConfig::LINE_DASHED, KisGuidesConfig::LINE_DOTTED, and lineType().

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.

{
    return d->guidesConfig->lockGuides();
}

References d, krita::GuidesConfig::Private::guidesConfig, and KisGuidesConfig::lockGuides.

operator!=()

bool GuidesConfig::operator!=

(

const GuidesConfig &

other

)

const

Definition at line 42 of file GuidesConfig.cpp.

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

References operator==().

operator==()

bool GuidesConfig::operator==

(

const GuidesConfig &

other

)

const

Definition at line 37 of file GuidesConfig.cpp.

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

References d, and krita::GuidesConfig::Private::guidesConfig.

removeAllGuides

void GuidesConfig::removeAllGuides ( )

slot

Remove all guides.

Definition at line 125 of file GuidesConfig.cpp.

{
    d->guidesConfig->removeAllGuides();
}

References d, krita::GuidesConfig::Private::guidesConfig, and KisGuidesConfig::removeAllGuides().

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.

{
    d->guidesConfig->setGuidesColor(color);
}

References color(), d, krita::GuidesConfig::Private::guidesConfig, and KisGuidesConfig::setGuidesColor().

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.

{
    d->guidesConfig->setHorizontalGuideLines(lines);
}

References d, krita::GuidesConfig::Private::guidesConfig, and KisGuidesConfig::setHorizontalGuideLines().

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.

{
    if (!d->guidesConfig) return;
 
    if(lineType == "dashed") {
        d->guidesConfig->setGuidesLineType(KisGuidesConfig::LineTypeInternal::LINE_DASHED);
    }
    else if(lineType == "dotted") {
        d->guidesConfig->setGuidesLineType(KisGuidesConfig::LineTypeInternal::LINE_DOTTED);
    }
    else {
        d->guidesConfig->setGuidesLineType(KisGuidesConfig::LineTypeInternal::LINE_SOLID);
    }
}

References d, krita::GuidesConfig::Private::guidesConfig, KisGuidesConfig::LINE_DASHED, KisGuidesConfig::LINE_DOTTED, KisGuidesConfig::LINE_SOLID, lineType(), and KisGuidesConfig::setGuidesLineType().

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.

{
    d->guidesConfig->setLockGuides(locked);
}

References d, krita::GuidesConfig::Private::guidesConfig, locked(), and KisGuidesConfig::setLockGuides().

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.

{
    d->guidesConfig->setSnapToGuides(snap);
}

References d, krita::GuidesConfig::Private::guidesConfig, KisGuidesConfig::setSnapToGuides(), and snap().

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.

{
    d->guidesConfig->setVerticalGuideLines(lines);
}

References d, krita::GuidesConfig::Private::guidesConfig, and KisGuidesConfig::setVerticalGuideLines().

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.

{
    d->guidesConfig->setShowGuides(value);
}

References d, krita::GuidesConfig::Private::guidesConfig, KisGuidesConfig::setShowGuides(), and value().

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.

{
    return d->guidesConfig->snapToGuides();
}

References d, krita::GuidesConfig::Private::guidesConfig, and KisGuidesConfig::snapToGuides.

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.

{
    QDomDocument doc = QDomDocument();
    QDomElement elt = d->guidesConfig->saveToXml(doc, "guides");
    doc.appendChild(elt);
    return doc.toString(2);
}

References d, krita::GuidesConfig::Private::guidesConfig, and KisGuidesConfig::saveToXml().

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.

{
    return d->guidesConfig->verticalGuideLines();
}

References d, krita::GuidesConfig::Private::guidesConfig, and KisGuidesConfig::verticalGuideLines().

visible

bool GuidesConfig::visible ( ) const

slot

Returns guides visibility status.

Returns

True if guides are visible, otherwise False

Definition at line 94 of file GuidesConfig.cpp.

{
    return d->guidesConfig->showGuides();
}

References d, krita::GuidesConfig::Private::guidesConfig, and KisGuidesConfig::showGuides.

Friends And Related Symbol Documentation

Document

friend class Document

friend

Definition at line 160 of file GuidesConfig.h.

Member Data Documentation

d

Private* GuidesConfig::d

private

Definition at line 166 of file GuidesConfig.h.

---

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

• libs/libkis/GuidesConfig.h
• libs/libkis/GuidesConfig.cpp