#include <kis_guides_config.h>

Inheritance diagram for KisGuidesConfig:

Public Types
enum	LineTypeInternal { LINE_SOLID = 0 , LINE_DASHED , LINE_DOTTED }

Public Member Functions
void	addGuideLine (Qt::Orientation orientation, qreal position)
	Add a guide line to the canvas.

QColor	guidesColor () const

LineTypeInternal	guidesLineType () const

QPen	guidesPen () const

bool	hasGuides () const

bool	hasSamePositionAs (const KisGuidesConfig &rhs) const

const QList< qreal > &	horizontalGuideLines () const
	Returns the list of horizontal guide lines.

bool	isDefault () const

	KisGuidesConfig ()

	KisGuidesConfig (const KisGuidesConfig &rhs)

bool	loadFromXml (const QDomElement &parent)

void	loadStaticData ()

bool	lockGuides () const

KisGuidesConfig &	operator= (const KisGuidesConfig &rhs)

bool	operator== (const KisGuidesConfig &rhs) const

bool	operator== (const Private &rhs)

void	removeAllGuides ()

bool	rulersMultiple2 () const

void	saveStaticData () const

QDomElement	saveToXml (QDomDocument &doc, const QString &tag) const

void	setGuidesColor (const QColor &value)

void	setGuidesLineType (LineTypeInternal value)

void	setHorizontalGuideLines (const QList< qreal > &lines)
	Set the positions of the horizontal guide lines.

void	setLockGuides (bool value)

void	setRulersMultiple2 (bool value)

void	setShowGuides (bool value)

void	setSnapToGuides (bool value)

void	setUnitType (KoUnit::Type type)

void	setVerticalGuideLines (const QList< qreal > &lines)
	Set the positions of the vertical guide lines.

bool	showGuides () const

bool	snapToGuides () const

Qt::PenStyle	toPenStyle (LineTypeInternal type)

void	transform (const QTransform &transform)

KoUnit::Type	unitType () const

const QList< qreal > &	verticalGuideLines () const
	Returns the list of vertical guide lines.

	~KisGuidesConfig ()

Public Attributes
QColor	guidesColor

LineTypeInternal	guidesLineType {LINE_SOLID}

QList< qreal >	horzGuideLines

bool	lockGuides {false}

bool	rulersMultiple2 {false}

bool	showGuides {false}

bool	snapToGuides {false}

KoUnit::Type	unitType {KoUnit::Pixel}

QList< qreal >	vertGuideLines

Private Attributes
const QScopedPointer< Private >	d

Private Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Additional Inherited Members
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Detailed Description

Definition at line 25 of file kis_guides_config.cpp.

Member Enumeration Documentation

◆ LineTypeInternal

enum KisGuidesConfig::LineTypeInternal

Enumerator
LINE_SOLID
LINE_DASHED
LINE_DOTTED

Definition at line 27 of file kis_guides_config.h.

                          {
        LINE_SOLID = 0,
        LINE_DASHED,
        LINE_DOTTED
    };

Constructor & Destructor Documentation

◆ KisGuidesConfig() [1/2]

KisGuidesConfig::KisGuidesConfig ( )

Definition at line 57 of file kis_guides_config.cpp.

    : d(new Private())
{
    loadStaticData();
}

References loadStaticData().

◆ ~KisGuidesConfig()

KisGuidesConfig::~KisGuidesConfig ( )

Definition at line 63 of file kis_guides_config.cpp.

64{

65}

◆ KisGuidesConfig() [2/2]

KisGuidesConfig::KisGuidesConfig ( const KisGuidesConfig & rhs )

Definition at line 67 of file kis_guides_config.cpp.

    : d(new Private(*rhs.d))
{
}

Member Function Documentation

◆ addGuideLine()

void KisGuidesConfig::addGuideLine	(	Qt::Orientation	orientation,
		qreal	position )

Add a guide line to the canvas.

Parameters

orientation	the orientation of the guide line
position	the position in document coordinates of the guide line

Definition at line 102 of file kis_guides_config.cpp.

{
    if (o == Qt::Horizontal) {
        d->horzGuideLines.append(pos);
    } else {
        d->vertGuideLines.append(pos);
    }
}

References d.

◆ guidesColor()

QColor KisGuidesConfig::guidesColor ( ) const

◆ guidesLineType()

LineTypeInternal KisGuidesConfig::guidesLineType ( ) const

◆ guidesPen()

QPen KisGuidesConfig::guidesPen ( ) const

Definition at line 197 of file kis_guides_config.cpp.

{
    return QPen(d->guidesColor, 0, d->toPenStyle(d->guidesLineType));
}

References d.

◆ hasGuides()

bool KisGuidesConfig::hasGuides ( ) const

Definition at line 212 of file kis_guides_config.cpp.

{
    return !d->horzGuideLines.isEmpty() || !d->vertGuideLines.isEmpty();
}

References d.

◆ hasSamePositionAs()

bool KisGuidesConfig::hasSamePositionAs ( const KisGuidesConfig & rhs ) const

Definition at line 86 of file kis_guides_config.cpp.

{
    return horizontalGuideLines() == rhs.horizontalGuideLines() &&
        verticalGuideLines() == rhs.verticalGuideLines();
}

References horizontalGuideLines(), and verticalGuideLines().

◆ horizontalGuideLines()

const QList< qreal > & KisGuidesConfig::horizontalGuideLines ( ) const

Returns the list of horizontal guide lines.

Definition at line 202 of file kis_guides_config.cpp.

{
    return d->horzGuideLines;
}

References d.

◆ isDefault()

bool KisGuidesConfig::isDefault ( ) const

Definition at line 289 of file kis_guides_config.cpp.

{
    KisGuidesConfig defaultObject;
    defaultObject.loadStaticData();
 
    return *this == defaultObject;
}

References loadStaticData().

◆ loadFromXml()

bool KisGuidesConfig::loadFromXml ( const QDomElement & parent )

Definition at line 250 of file kis_guides_config.cpp.

{
    KisConfig cfg(false);
    bool result = true;
 
    result &= KisDomUtils::loadValue(parent, "showGuides", &d->showGuides);
    result &= KisDomUtils::loadValue(parent, "snapToGuides", &d->snapToGuides);
    result &= KisDomUtils::loadValue(parent, "lockGuides", &d->lockGuides);
 
    QVector<qreal> hGuides;
    QVector<qreal> vGuides;
 
    result &= KisDomUtils::loadValue(parent, "horizontalGuides", &hGuides);
    result &= KisDomUtils::loadValue(parent, "verticalGuides", &vGuides);
 
    d->horzGuideLines = QList<qreal>::fromVector(hGuides);
    d->vertGuideLines = QList<qreal>::fromVector(vGuides);
 
    result &= KisDomUtils::loadValue(parent, "rulersMultiple2", &d->rulersMultiple2);
    QString unit;
    result &= KisDomUtils::loadValue(parent, "unit", &unit);
    bool ok = false;
    KoUnit tmp = KoUnit::fromSymbol(unit, &ok);
    if (ok) {
        d->unitType = tmp.type();
    }
    result &= ok;
 
    // following variables may not be present in older files; do not update result variable
    int guidesLineType = cfg.guidesLineStyle();
    KisDomUtils::loadValue(parent, "lineTypeGuides", &guidesLineType);
    d->guidesLineType = LineTypeInternal(guidesLineType);
 
    d->guidesColor = cfg.guidesColor();
    KisDomUtils::loadValue(parent, "colorGuides", &d->guidesColor);
 
    return result;
}

References d, KoUnit::fromSymbol(), KisConfig::guidesColor(), KisConfig::guidesLineStyle(), guidesLineType, and KisDomUtils::loadValue().

◆ loadStaticData()

void KisGuidesConfig::loadStaticData ( )

Definition at line 217 of file kis_guides_config.cpp.

{
    KisConfig cfg(true);
    d->guidesLineType = LineTypeInternal(cfg.guidesLineStyle());
    d->guidesColor = cfg.guidesColor();
}

References d, KisConfig::guidesColor(), and KisConfig::guidesLineStyle().

◆ lockGuides()

bool KisGuidesConfig::lockGuides ( ) const

◆ operator=()

KisGuidesConfig & KisGuidesConfig::operator= ( const KisGuidesConfig & rhs )

Definition at line 72 of file kis_guides_config.cpp.

{
    if (&rhs != this) {
        *d = *rhs.d;
    }
 
    return *this;
}

References d.

◆ operator==() [1/2]

bool KisGuidesConfig::operator== ( const KisGuidesConfig & rhs ) const

Definition at line 81 of file kis_guides_config.cpp.

{
    return *d == *rhs.d;
}

References d.

◆ operator==() [2/2]

bool KisGuidesConfig::operator== ( const Private & rhs )

inline

Definition at line 29 of file kis_guides_config.cpp.

                                        {
        return horzGuideLines == rhs.horzGuideLines &&
            vertGuideLines == rhs.vertGuideLines &&
            showGuides == rhs.showGuides &&
            snapToGuides == rhs.snapToGuides &&
            lockGuides == rhs.lockGuides &&
            guidesColor == rhs.guidesColor &&
            guidesLineType == rhs.guidesLineType &&
            rulersMultiple2 == rhs.rulersMultiple2 &&
            unitType == rhs.unitType;
    }

◆ removeAllGuides()

void KisGuidesConfig::removeAllGuides ( )

Definition at line 111 of file kis_guides_config.cpp.

{
    QList<qreal> emptyGuides ;
    setVerticalGuideLines(emptyGuides);
    setHorizontalGuideLines(emptyGuides);
}

References setHorizontalGuideLines(), and setVerticalGuideLines().

◆ rulersMultiple2()

bool KisGuidesConfig::rulersMultiple2 ( ) const

◆ saveStaticData()

void KisGuidesConfig::saveStaticData ( ) const

Definition at line 224 of file kis_guides_config.cpp.

{
    KisConfig cfg(false);
    cfg.setGuidesLineStyle(d->guidesLineType);
    cfg.setGuidesColor(d->guidesColor);
}

References d, KisConfig::setGuidesColor(), and KisConfig::setGuidesLineStyle().

◆ saveToXml()

QDomElement KisGuidesConfig::saveToXml	(	QDomDocument &	doc,
		const QString &	tag ) const

Definition at line 231 of file kis_guides_config.cpp.

{
    QDomElement guidesElement = doc.createElement(tag);
    KisDomUtils::saveValue(&guidesElement, "showGuides", d->showGuides);
    KisDomUtils::saveValue(&guidesElement, "snapToGuides", d->snapToGuides);
    KisDomUtils::saveValue(&guidesElement, "lockGuides", d->lockGuides);
    KisDomUtils::saveValue(&guidesElement, "colorGuides", d->guidesColor);
    KisDomUtils::saveValue(&guidesElement, "lineTypeGuides", d->guidesLineType);
 
    KisDomUtils::saveValue(&guidesElement, "horizontalGuides", d->horzGuideLines.toVector());
    KisDomUtils::saveValue(&guidesElement, "verticalGuides", d->vertGuideLines.toVector());
 
    KisDomUtils::saveValue(&guidesElement, "rulersMultiple2", d->rulersMultiple2);
    KoUnit tmp(d->unitType);
    KisDomUtils::saveValue(&guidesElement, "unit", tmp.symbol());
 
    return guidesElement;
}

References d, and KisDomUtils::saveValue().

◆ setGuidesColor()

void KisGuidesConfig::setGuidesColor ( const QColor & value )

Definition at line 185 of file kis_guides_config.cpp.

{
    d->guidesColor = value;
}

References d, and value().

◆ setGuidesLineType()

void KisGuidesConfig::setGuidesLineType ( LineTypeInternal value )

Definition at line 174 of file kis_guides_config.cpp.

{
    d->guidesLineType = value;
}

References d, and value().

◆ setHorizontalGuideLines()

void KisGuidesConfig::setHorizontalGuideLines ( const QList< qreal > & lines )

Set the positions of the horizontal guide lines.

Parameters

lines a list of positions of the horizontal guide lines

Definition at line 92 of file kis_guides_config.cpp.

{
    d->horzGuideLines = lines;
}

References d.

◆ setLockGuides()

void KisGuidesConfig::setLockGuides ( bool value )

Definition at line 133 of file kis_guides_config.cpp.

{
    d->lockGuides = value;
}

References d, and value().

◆ setRulersMultiple2()

void KisGuidesConfig::setRulersMultiple2 ( bool value )

Definition at line 153 of file kis_guides_config.cpp.

{
    d->rulersMultiple2 = value;
}

References d, and value().

◆ setShowGuides()

void KisGuidesConfig::setShowGuides ( bool value )

Definition at line 123 of file kis_guides_config.cpp.

{
    d->showGuides = value;
}

References d, and value().

◆ setSnapToGuides()

void KisGuidesConfig::setSnapToGuides ( bool value )

Definition at line 143 of file kis_guides_config.cpp.

{
    d->snapToGuides = value;
}

References d, and value().

◆ setUnitType()

void KisGuidesConfig::setUnitType ( KoUnit::Type type )

Definition at line 163 of file kis_guides_config.cpp.

{
    d->unitType = type;
}

References d.

◆ setVerticalGuideLines()

void KisGuidesConfig::setVerticalGuideLines ( const QList< qreal > & lines )

Set the positions of the vertical guide lines.

Parameters

lines a list of positions of the vertical guide lines

Definition at line 97 of file kis_guides_config.cpp.

{
    d->vertGuideLines = lines;
}

References d.

◆ showGuides()

bool KisGuidesConfig::showGuides ( ) const

◆ snapToGuides()

bool KisGuidesConfig::snapToGuides ( ) const

◆ toPenStyle()

Qt::PenStyle KisGuidesConfig::toPenStyle ( LineTypeInternal type )

◆ transform()

void KisGuidesConfig::transform ( const QTransform & transform )

Transform the guides using the given transform. Please note that transform should be in 'document' coordinate system. Used with image-wide transformations.

Definition at line 297 of file kis_guides_config.cpp.

{
    if (transform.type() >= QTransform::TxShear) return;
 
    KisAlgebra2D::DecomposedMatrix m(transform);
 
    QTransform t = m.scaleTransform();
 
    const qreal eps = 1e-3;
    int numWraps = 0;
    const qreal wrappedRotation = KisAlgebra2D::wrapValue(m.angle, 90.0);
    if (wrappedRotation <= eps || wrappedRotation >= 90.0 - eps) {
        t *= m.rotateTransform();
        numWraps = qRound(normalizeAngleDegrees(m.angle) / 90.0);
    }
 
    t *= m.translateTransform();
 
 
    QList<qreal> newHorzGuideLines;
    QList<qreal> newVertGuideLines;
 
    Q_FOREACH (qreal hRuler, d->horzGuideLines) {
        const QPointF pt = t.map(QPointF(0, hRuler));
 
        if (numWraps & 0x1) {
            newVertGuideLines << pt.x();
        } else {
            newHorzGuideLines << pt.y();
        }
    }
 
    Q_FOREACH (qreal vRuler, d->vertGuideLines) {
        const QPointF pt = t.map(QPointF(vRuler, 0));
 
        if (!(numWraps & 0x1)) {
            newVertGuideLines << pt.x();
        } else {
            newHorzGuideLines << pt.y();
        }
    }
 
    d->horzGuideLines = newHorzGuideLines;
    d->vertGuideLines = newVertGuideLines;
}

References KisAlgebra2D::DecomposedMatrix::angle, d, eps, normalizeAngleDegrees(), KisAlgebra2D::DecomposedMatrix::rotateTransform(), KisAlgebra2D::DecomposedMatrix::scaleTransform(), transform(), KisAlgebra2D::DecomposedMatrix::translateTransform(), and KisAlgebra2D::wrapValue().

◆ unitType()

KoUnit::Type KisGuidesConfig::unitType ( ) const

◆ verticalGuideLines()

const QList< qreal > & KisGuidesConfig::verticalGuideLines ( ) const

Returns the list of vertical guide lines.

Definition at line 207 of file kis_guides_config.cpp.

{
    return d->vertGuideLines;
}

References d.

Member Data Documentation

◆ d

const QScopedPointer<Private> KisGuidesConfig::d

private

Definition at line 109 of file kis_guides_config.h.

◆ guidesColor

QColor KisGuidesConfig::guidesColor

Definition at line 51 of file kis_guides_config.cpp.

◆ guidesLineType

KisGuidesConfig::LineTypeInternal KisGuidesConfig::guidesLineType {LINE_SOLID}

Definition at line 52 of file kis_guides_config.cpp.

52{LINE_SOLID};

◆ horzGuideLines

QList<qreal> KisGuidesConfig::horzGuideLines

Definition at line 41 of file kis_guides_config.cpp.

◆ lockGuides

bool KisGuidesConfig::lockGuides {false}

Definition at line 46 of file kis_guides_config.cpp.

46{false};

◆ rulersMultiple2

bool KisGuidesConfig::rulersMultiple2 {false}

Definition at line 47 of file kis_guides_config.cpp.

47{false};

◆ showGuides

bool KisGuidesConfig::showGuides {false}

Definition at line 44 of file kis_guides_config.cpp.

44{false};

◆ snapToGuides

bool KisGuidesConfig::snapToGuides {false}

Definition at line 45 of file kis_guides_config.cpp.

45{false};

◆ unitType

KoUnit::Type KisGuidesConfig::unitType {KoUnit::Pixel}

Definition at line 49 of file kis_guides_config.cpp.

49{KoUnit::Pixel};

KoUnit::Pixel

@ Pixel

Definition KoUnit.h:82

◆ vertGuideLines

QList<qreal> KisGuidesConfig::vertGuideLines

Definition at line 42 of file kis_guides_config.cpp.

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

libs/ui/canvas/kis_guides_config.cpp
libs/ui/canvas/kis_guides_config.h

Public Types

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ LineTypeInternal

Constructor & Destructor Documentation

◆ KisGuidesConfig() [1/2]

◆ ~KisGuidesConfig()

◆ KisGuidesConfig() [2/2]

Member Function Documentation

◆ addGuideLine()

◆ guidesColor()

◆ guidesLineType()

◆ guidesPen()

◆ hasGuides()

◆ hasSamePositionAs()

◆ horizontalGuideLines()

◆ isDefault()

◆ loadFromXml()

◆ loadStaticData()

◆ lockGuides()

◆ operator=()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ removeAllGuides()

◆ rulersMultiple2()

◆ saveStaticData()

◆ saveToXml()

◆ setGuidesColor()

◆ setGuidesLineType()

◆ setHorizontalGuideLines()

◆ setLockGuides()

◆ setRulersMultiple2()

◆ setShowGuides()

◆ setSnapToGuides()

◆ setUnitType()

◆ setVerticalGuideLines()

◆ showGuides()

◆ snapToGuides()

◆ toPenStyle()

◆ transform()

◆ unitType()

◆ verticalGuideLines()

Member Data Documentation

◆ d

◆ guidesColor

◆ guidesLineType

◆ horzGuideLines

◆ lockGuides

◆ rulersMultiple2

◆ showGuides

◆ snapToGuides

◆ unitType

◆ vertGuideLines