GridConfig Class Reference

#include <GridConfig.h>

Inheritance diagram for GridConfig:

Public Slots
bool	angleAspectLocked () const
	Returns status of "Aspect locked" property for angles values (mean, left and right angles values are linked to keep ratio) AngleAspectLocked value is used for grid type "isometric" and "isometric_legacy".
qreal	angleLeft () const
	Returns left angle (in degrees) of isometric grid for document. AngleLeft value is used for grid type "isometric".
bool	angleLeftActive () const
	Returns if left angle grid is active. Spacing value is used for grid type "isometric".
qreal	angleRight () const
	Returns right angle (in degrees) of isometric grid for document. AngleRight value is used for grid type "isometric".
bool	angleRightActive () const
	Returns if right angle grid is active. Spacing value is used for grid type "isometric".
int	cellSize () const
	Returns grid cell border size (in pixels) for document. Cell spacing value is used for grid type "isometric".
int	cellSpacing () const
	Returns grid cell spacing (in pixels) for document. Cell spacing value is used for grid type "isometric_legacy".
QColor	colorMain () const
	Returns grid main line color.
QColor	colorSubdivision () const
	Returns grid subdivision line color ColorSubdivision value is used for grid type "rectangular".
QColor	colorVertical () const
	Returns grid vertical line color ColorSubdivision value is used for grid type "isometric".
bool	fromXml (const QString &xmlContent) const
	Load grid definition from an XML document.
QString	lineTypeMain () const
	Returns grid main line type.
QString	lineTypeSubdivision () const
	Returns grid subdivision line type.
QString	lineTypeVertical () const
	Returns grid vertical line type.
QPoint	offset () const
	Returns grid offset (in pixels, from origin) for document.
bool	offsetAspectLocked () const
	Returns status of "Aspect locked" property for offset values (X and Y values are linked to keep ratio)
void	setAngleAspectLocked (bool angleAspectLocked)
	Set status of "Aspect locked" property for angles values (left and right angles values are linked to keep ratio) AngleAspectLocked value is used for grid type "isometric" and "isometric_legacy".
void	setAngleLeft (qreal angleLeft)
	Set left angle (in degrees) of isometric grid for document. AngleLeft value is used for grid type "isometric".
void	setAngleLeftActive (bool active)
	Set left angle grid active. Spacing value is used for grid type "isometric".
void	setAngleRight (qreal angleRight)
	Set right angle (in degrees) of isometric grid for document. AngleRight value is used for grid type "isometric".
void	setAngleRightActive (bool active)
	Set right angle grid active. Spacing value is used for grid type "isometric".
void	setCellSize (int cellSize)
	Set grid cell size (in pixels) for document. Cell spacing value is used for grid type "isometric".
void	setCellSpacing (int cellSpacing)
	Set grid cell spacing for document. Cell spacing value is used for grid type "isometric_legacy".
void	setColorMain (QColor colorMain)
	Set grid main line color.
void	setColorSubdivision (QColor colorSubdivision)
	Set grid subdivision line color ColorSubdivision value is used for grid type "rectangular".
void	setColorVertical (QColor colorVertical)
	Set grid vertical line color ColorSubdivision value is used for grid type "isometric".
void	setLineTypeMain (const QString &lineType)
	Set grid main line type.
void	setLineTypeSubdivision (const QString &lineType)
	Set grid subdivision line type.
void	setLineTypeVertical (const QString &lineType)
	Set grid vertical line type.
void	setOffset (QPoint offset)
	Define grid offset (in pixels, from origin) for document.
void	setOffsetAspectLocked (bool offsetAspectLocked)
	Set status of "Aspect locked" property for offset values (X and Y values are linked to keep ratio)
void	setSnap (bool snap)
	Activate or deactivate snap to grid for document.
void	setSpacing (QPoint spacing)
	Set grid spacing (in pixels) for document. Spacing value is used for grid type "rectangular".
void	setSpacingActiveHorizontal (bool active)
	Set horizontal grid spacing active. Spacing value is used for grid type "rectangular".
void	setSpacingActiveVertical (bool active)
	Set vertical grid spacing active. Spacing value is used for grid type "rectangular".
void	setSpacingAspectLocked (bool spacingAspectLocked)
	Set status of "Aspect locked" property for spacing values (X and Y values are linked to keep ratio) SpacingAspectLocked value is used for grid type "rectangular".
void	setSubdivision (int subdivision)
	Set number of grid subdivision for document. Subdivision value is used for grid type "rectangular".
void	setType (const QString &gridType)
	Set current grid type applied for document.
void	setVisible (bool visible)
	Set grid visibility for document.
bool	snap () const
	Returns snap to grid status for document.
QPoint	spacing () const
	Returns grid spacing (in pixels) for document. Spacing value is used for grid type "rectangular".
bool	spacingActiveHorizontal () const
	Returns if horizontal grid spacing is active. Spacing value is used for grid type "rectangular".
bool	spacingActiveVertical () const
	Returns if vertical grid spacing is active. Spacing value is used for grid type "rectangular".
bool	spacingAspectLocked () const
	Returns status of "Aspect locked" property for spacing values (mean, X and Y values are linked to keep ratio) SpacingAspectLocked value is used for grid type "rectangular".
int	subdivision () const
	Returns number of grid subdivision for document. Subdivision value is used for grid type "rectangular".
QString	toXml () const
	Save grid definition as an XML document.
QString	type () const
	Returns current grid type applied for document.
bool	visible () const
	Returns grid visibility for document.

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

Private Member Functions
KisGridConfig	gridConfig () const

Private Attributes
Private *	d

Friends
class	Document

Detailed Description

The GridConfig class encapsulates a Krita Guides configuration.

Definition at line 19 of file GridConfig.h.

Constructor & Destructor Documentation

GridConfig() [1/2]

GridConfig::GridConfig

(

KisGridConfig *

guidesConfig

)

Definition at line 19 of file GridConfig.cpp.

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

References d, krita::GridConfig::Private::gridConfig, and gridConfig().

GridConfig() [2/2]

GridConfig::GridConfig ( QObject * parent = 0 )

explicit

Create a new, empty GridConfig.

Definition at line 26 of file GridConfig.cpp.

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

References d, and krita::GridConfig::Private::gridConfig.

~GridConfig()

GridConfig::~GridConfig ( )

override

Definition at line 33 of file GridConfig.cpp.

{
    delete d;
}

References d.

Member Function Documentation

angleAspectLocked

bool GridConfig::angleAspectLocked ( ) const

slot

Returns status of "Aspect locked" property for angles values (mean, left and right angles values are linked to keep ratio) AngleAspectLocked value is used for grid type "isometric" and "isometric_legacy".

Returns

If locked, return True.

Definition at line 234 of file GridConfig.cpp.

{
    return d->gridConfig->angleAspectLocked();
}

References KisGridConfig::angleAspectLocked(), d, and krita::GridConfig::Private::gridConfig.

angleLeft

qreal GridConfig::angleLeft ( ) const

slot

Returns left angle (in degrees) of isometric grid for document. AngleLeft value is used for grid type "isometric".

Returns

A positive decimal value, in range [0.00 - 89.00]

Definition at line 129 of file GridConfig.cpp.

{
    return d->gridConfig->angleLeft();
}

References KisGridConfig::angleLeft(), d, and krita::GridConfig::Private::gridConfig.

angleLeftActive

bool GridConfig::angleLeftActive ( ) const

slot

Returns if left angle grid is active. Spacing value is used for grid type "isometric".

Returns

a boolean which indicate if left angle grid is active or not

Definition at line 149 of file GridConfig.cpp.

{
    return d->gridConfig->angleLeftActive();
}

References KisGridConfig::angleLeftActive(), d, and krita::GridConfig::Private::gridConfig.

angleRight

qreal GridConfig::angleRight ( ) const

slot

Returns right angle (in degrees) of isometric grid for document. AngleRight value is used for grid type "isometric".

Returns

A positive decimal value, in range [0.00 - 89.00]

Definition at line 139 of file GridConfig.cpp.

{
    return d->gridConfig->angleRight();
}

References KisGridConfig::angleRight(), d, and krita::GridConfig::Private::gridConfig.

angleRightActive

bool GridConfig::angleRightActive ( ) const

slot

Returns if right angle grid is active. Spacing value is used for grid type "isometric".

Returns

a boolean which indicate if right angle grid is active or not

Definition at line 159 of file GridConfig.cpp.

{
    return d->gridConfig->angleRightActive();
}

References KisGridConfig::angleRightActive(), d, and krita::GridConfig::Private::gridConfig.

cellSize

int GridConfig::cellSize ( ) const

slot

Returns grid cell border size (in pixels) for document. Cell spacing value is used for grid type "isometric".

Returns

A positive integer value, in range [10 - 1000]

Definition at line 179 of file GridConfig.cpp.

{
    return d->gridConfig->cellSize();
}

References KisGridConfig::cellSize(), d, and krita::GridConfig::Private::gridConfig.

cellSpacing

int GridConfig::cellSpacing ( ) const

slot

Returns grid cell spacing (in pixels) for document. Cell spacing value is used for grid type "isometric_legacy".

Returns

A positive integer value, minimum value is 10

Definition at line 169 of file GridConfig.cpp.

{
    return d->gridConfig->cellSpacing();
}

References KisGridConfig::cellSpacing(), d, and krita::GridConfig::Private::gridConfig.

colorMain

QColor GridConfig::colorMain ( ) const

slot

Returns grid main line color.

Returns

The color for grid main line

Definition at line 326 of file GridConfig.cpp.

{
    return d->gridConfig->colorMain();
}

References KisGridConfig::colorMain(), d, and krita::GridConfig::Private::gridConfig.

colorSubdivision

QColor GridConfig::colorSubdivision ( ) const

slot

Returns grid subdivision line color ColorSubdivision value is used for grid type "rectangular".

Returns

The color for grid subdivision line

Definition at line 336 of file GridConfig.cpp.

{
    return d->gridConfig->colorSubdivision();
}

References KisGridConfig::colorSubdivision(), d, and krita::GridConfig::Private::gridConfig.

colorVertical

QColor GridConfig::colorVertical ( ) const

slot

Returns grid vertical line color ColorSubdivision value is used for grid type "isometric".

Returns

The color for grid vertical line

Definition at line 346 of file GridConfig.cpp.

{
    return d->gridConfig->colorVertical();
}

References KisGridConfig::colorVertical(), d, and krita::GridConfig::Private::gridConfig.

fromXml

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

slot

Load grid definition from an XML document.

Parameters

xmlContent

xml content provided as a string

Returns

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

Definition at line 356 of file GridConfig.cpp.

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

References d, krita::GridConfig::Private::gridConfig, and KisGridConfig::loadDynamicDataFromXml().

gridConfig()

KisGridConfig GridConfig::gridConfig ( ) const

private

Definition at line 379 of file GridConfig.cpp.

{
    return *d->gridConfig;
}

References d, and krita::GridConfig::Private::gridConfig.

lineTypeMain

QString GridConfig::lineTypeMain ( ) const

slot

Returns grid main line type.

Returns

The main line type for grid in current document Can be:

• "solid"
• "dashed"
• "dotted"

Definition at line 244 of file GridConfig.cpp.

{
    KisGridConfig::LineTypeInternal type = d->gridConfig->lineTypeMain();
    if(type == KisGridConfig::LineTypeInternal::LINE_DASHED) {
        return "dashed";
    }
    else if(type == KisGridConfig::LineTypeInternal::LINE_DOTTED) {
        return "dotted";
    }
    return "solid";
}

References d, krita::GridConfig::Private::gridConfig, KisGridConfig::LINE_DASHED, KisGridConfig::LINE_DOTTED, KisGridConfig::lineTypeMain(), and type().

lineTypeSubdivision

QString GridConfig::lineTypeSubdivision ( ) const

slot

Returns grid subdivision line type.

Returns

The subdivision line type for grid in current document Can be:

• "solid"
• "dashed"
• "dotted"

LineTypeSubdivision value is used for grid type "rectangular".

Definition at line 269 of file GridConfig.cpp.

{
    KisGridConfig::LineTypeInternal type = d->gridConfig->lineTypeSubdivision();
    if(type == KisGridConfig::LineTypeInternal::LINE_DASHED) {
        return "dashed";
    }
    else if(type == KisGridConfig::LineTypeInternal::LINE_DOTTED) {
        return "dotted";
    }
    return "solid";
}

References d, krita::GridConfig::Private::gridConfig, KisGridConfig::LINE_DASHED, KisGridConfig::LINE_DOTTED, KisGridConfig::lineTypeSubdivision(), and type().

lineTypeVertical

QString GridConfig::lineTypeVertical ( ) const

slot

Returns grid vertical line type.

Returns

The vertical line type for grid in current document Can be:

• "solid"
• "dashed"
• "dotted"
• "none"

LineTypeVertical value is used for grid type "isometric".

Definition at line 294 of file GridConfig.cpp.

{
    KisGridConfig::LineTypeInternal type = d->gridConfig->lineTypeVertical();
    if(type == KisGridConfig::LineTypeInternal::LINE_DASHED) {
        return "dashed";
    }
    else if(type == KisGridConfig::LineTypeInternal::LINE_DOTTED) {
        return "dotted";
    }
    else if(type == KisGridConfig::LineTypeInternal::LINE_NONE) {
        return "none";
    }
    return "solid";
}

References d, krita::GridConfig::Private::gridConfig, KisGridConfig::LINE_DASHED, KisGridConfig::LINE_DOTTED, KisGridConfig::LINE_NONE, KisGridConfig::lineTypeVertical(), and type().

offset

QPoint GridConfig::offset ( ) const

slot

Returns grid offset (in pixels, from origin) for document.

Returns

A QPoint that define X and Y offset.

Definition at line 69 of file GridConfig.cpp.

{
    return d->gridConfig->offset();
}

References d, krita::GridConfig::Private::gridConfig, and KisGridConfig::offset().

offsetAspectLocked

bool GridConfig::offsetAspectLocked ( ) const

slot

Returns status of "Aspect locked" property for offset values (X and Y values are linked to keep ratio)

Returns

If locked, return True.

Definition at line 214 of file GridConfig.cpp.

{
    return d->gridConfig->offsetAspectLocked();
}

References d, krita::GridConfig::Private::gridConfig, and KisGridConfig::offsetAspectLocked().

operator!=()

bool GridConfig::operator!=

(

const GridConfig &

other

)

const

Definition at line 43 of file GridConfig.cpp.

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

References operator==().

operator==()

bool GridConfig::operator==

(

const GridConfig &

other

)

const

Definition at line 38 of file GridConfig.cpp.

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

References d, and krita::GridConfig::Private::gridConfig.

setAngleAspectLocked

void GridConfig::setAngleAspectLocked ( bool angleAspectLocked )

slot

Set status of "Aspect locked" property for angles values (left and right angles values are linked to keep ratio) AngleAspectLocked value is used for grid type "isometric" and "isometric_legacy".

Parameters

angleAspectLocked

Set to True lock aspect.

Definition at line 239 of file GridConfig.cpp.

{
    d->gridConfig->setAngleAspectLocked(angleAspectLocked);
}

References angleAspectLocked(), d, krita::GridConfig::Private::gridConfig, and KisGridConfig::setAngleAspectLocked().

setAngleLeft

void GridConfig::setAngleLeft ( qreal angleLeft )

slot

Set left angle (in degrees) of isometric grid for document. AngleLeft value is used for grid type "isometric".

Parameters

angleLeft

A positive decimal value, in range [0.00 - 89.00]

Definition at line 134 of file GridConfig.cpp.

{
    d->gridConfig->setAngleLeft(qBound(0.0, angleLeft, 89.0));
}

References angleLeft(), d, krita::GridConfig::Private::gridConfig, and KisGridConfig::setAngleLeft().

setAngleLeftActive

void GridConfig::setAngleLeftActive ( bool active )

slot

Set left angle grid active. Spacing value is used for grid type "isometric".

Parameters

active

True to activate left angle grid, False to deactivate it.

Definition at line 154 of file GridConfig.cpp.

{
    d->gridConfig->setAngleLeftActive(active);
}

References d, krita::GridConfig::Private::gridConfig, and KisGridConfig::setAngleLeftActive().

setAngleRight

void GridConfig::setAngleRight ( qreal angleRight )

slot

Set right angle (in degrees) of isometric grid for document. AngleRight value is used for grid type "isometric".

Parameters

angleRight

A positive decimal value, in range [0.00 - 89.00]

Definition at line 144 of file GridConfig.cpp.

{
    d->gridConfig->setAngleRight(qBound(0.0, angleRight, 89.0));
}

References angleRight(), d, krita::GridConfig::Private::gridConfig, and KisGridConfig::setAngleRight().

setAngleRightActive

void GridConfig::setAngleRightActive ( bool active )

slot

Set right angle grid active. Spacing value is used for grid type "isometric".

Parameters

active

True to activate right angle grid, False to deactivate it.

Definition at line 164 of file GridConfig.cpp.

{
    d->gridConfig->setAngleRightActive(active);
}

References d, krita::GridConfig::Private::gridConfig, and KisGridConfig::setAngleRightActive().

setCellSize

void GridConfig::setCellSize ( int cellSize )

slot

Set grid cell size (in pixels) for document. Cell spacing value is used for grid type "isometric".

Parameters

cellSize

An integer that define cell border size.

Definition at line 184 of file GridConfig.cpp.

{
    d->gridConfig->setCellSize(qBound(10, cellSize, 1000));
}

References cellSize(), d, krita::GridConfig::Private::gridConfig, and KisGridConfig::setCellSize().

setCellSpacing

void GridConfig::setCellSpacing ( int cellSpacing )

slot

Set grid cell spacing for document. Cell spacing value is used for grid type "isometric_legacy".

Parameters

cellSpacing

A integer that define spacing, in range [10 - 1000]

Definition at line 174 of file GridConfig.cpp.

{
    d->gridConfig->setCellSpacing(qBound(10, cellSpacing, 1000));
}

References cellSpacing(), d, krita::GridConfig::Private::gridConfig, and KisGridConfig::setCellSpacing().

setColorMain

void GridConfig::setColorMain ( QColor colorMain )

slot

Set grid main line color.

Parameters

color

The color to apply for grid main line

Definition at line 331 of file GridConfig.cpp.

{
    d->gridConfig->setColorMain(colorMain);
}

References colorMain(), d, krita::GridConfig::Private::gridConfig, and KisGridConfig::setColorMain().

setColorSubdivision

void GridConfig::setColorSubdivision ( QColor colorSubdivision )

slot

Set grid subdivision line color ColorSubdivision value is used for grid type "rectangular".

Parameters

color

The color to apply for grid subdivision line

Definition at line 341 of file GridConfig.cpp.

{
    d->gridConfig->setColorSubdivision(colorSubdivision);
}

References colorSubdivision(), d, krita::GridConfig::Private::gridConfig, and KisGridConfig::setColorSubdivision().

setColorVertical

void GridConfig::setColorVertical ( QColor colorVertical )

slot

Set grid vertical line color ColorSubdivision value is used for grid type "isometric".

Parameters

color

The color to apply for grid vertical line

Definition at line 351 of file GridConfig.cpp.

{
    d->gridConfig->setColorVertical(colorVertical);
}

References colorVertical(), d, krita::GridConfig::Private::gridConfig, and KisGridConfig::setColorVertical().

setLineTypeMain

void GridConfig::setLineTypeMain ( const QString & lineType )

slot

Set grid main line type.

Parameters

lineType

The main line type to apply for grid Can be: "solid" "dashed" "dotted"

Definition at line 256 of file GridConfig.cpp.

{
    if(lineType == "dashed") {
        d->gridConfig->setLineTypeMain(KisGridConfig::LineTypeInternal::LINE_DASHED);
    }
    else if(lineType == "dotted") {
        d->gridConfig->setLineTypeMain(KisGridConfig::LineTypeInternal::LINE_DOTTED);
    }
    else {
        d->gridConfig->setLineTypeMain(KisGridConfig::LineTypeInternal::LINE_SOLID);
    }
}

References d, krita::GridConfig::Private::gridConfig, KisGridConfig::LINE_DASHED, KisGridConfig::LINE_DOTTED, KisGridConfig::LINE_SOLID, and KisGridConfig::setLineTypeMain().

setLineTypeSubdivision

void GridConfig::setLineTypeSubdivision ( const QString & lineType )

slot

Set grid subdivision line type.

Parameters

lineType

The subdivision line type to apply for grid Can be: "solid" "dashed" "dotted"

LineTypeSubdivision value is used for grid type "rectangular".

Definition at line 281 of file GridConfig.cpp.

{
    if(lineType == "dashed") {
        d->gridConfig->setLineTypeSubdivision(KisGridConfig::LineTypeInternal::LINE_DASHED);
    }
    else if(lineType == "dotted") {
        d->gridConfig->setLineTypeSubdivision(KisGridConfig::LineTypeInternal::LINE_DOTTED);
    }
    else {
        d->gridConfig->setLineTypeSubdivision(KisGridConfig::LineTypeInternal::LINE_SOLID);
    }
}

References d, krita::GridConfig::Private::gridConfig, KisGridConfig::LINE_DASHED, KisGridConfig::LINE_DOTTED, KisGridConfig::LINE_SOLID, and KisGridConfig::setLineTypeSubdivision().

setLineTypeVertical

void GridConfig::setLineTypeVertical ( const QString & lineType )

slot

Set grid vertical line type.

Parameters

lineType

The vertical line type to apply for grid Can be: "solid" "dashed" "dotted" "none"

LineTypeVertical value is used for grid type "isometric".

Definition at line 309 of file GridConfig.cpp.

{
    if(lineType == "dashed") {
        d->gridConfig->setLineTypeVertical(KisGridConfig::LineTypeInternal::LINE_DASHED);
    }
    else if(lineType == "dotted") {
        d->gridConfig->setLineTypeVertical(KisGridConfig::LineTypeInternal::LINE_DOTTED);
    }
    else if(lineType == "none") {
        d->gridConfig->setLineTypeVertical(KisGridConfig::LineTypeInternal::LINE_NONE);
    }
    else {
        d->gridConfig->setLineTypeVertical(KisGridConfig::LineTypeInternal::LINE_SOLID);
    }
}

References d, krita::GridConfig::Private::gridConfig, KisGridConfig::LINE_DASHED, KisGridConfig::LINE_DOTTED, KisGridConfig::LINE_NONE, KisGridConfig::LINE_SOLID, and KisGridConfig::setLineTypeVertical().

setOffset

void GridConfig::setOffset ( QPoint offset )

slot

Define grid offset (in pixels, from origin) for document.

Parameters

offset

A QPoint that define X and Y offset (X and Y in range [0 - 500])

Definition at line 74 of file GridConfig.cpp.

{
    QPoint rangeOffset = QPoint(offset);
    rangeOffset.setX(qBound(0, rangeOffset.x(), 500));
    rangeOffset.setY(qBound(0, rangeOffset.y(), 500));
    d->gridConfig->setOffset(rangeOffset);
}

References d, krita::GridConfig::Private::gridConfig, offset(), and KisGridConfig::setOffset().

setOffsetAspectLocked

void GridConfig::setOffsetAspectLocked ( bool offsetAspectLocked )

slot

Set status of "Aspect locked" property for offset values (X and Y values are linked to keep ratio)

Parameters

offsetAspectLocked

Set to True lock aspect.

Definition at line 219 of file GridConfig.cpp.

{
    d->gridConfig->setOffsetAspectLocked(offsetAspectLocked);
}

References d, krita::GridConfig::Private::gridConfig, offsetAspectLocked(), and KisGridConfig::setOffsetAspectLocked().

setSnap

void GridConfig::setSnap ( bool snap )

slot

Activate or deactivate snap to grid for document.

Parameters

snap	Set to True to activate snap to grid.

Definition at line 64 of file GridConfig.cpp.

{
    d->gridConfig->setSnapToGrid(snap);
}

References d, krita::GridConfig::Private::gridConfig, KisGridConfig::setSnapToGrid(), and snap().

setSpacing

void GridConfig::setSpacing ( QPoint spacing )

slot

Set grid spacing (in pixels) for document. Spacing value is used for grid type "rectangular".

Parameters

spacing

A QPoint that define X and Y spacing (minimum value for X and Y is 1)

Definition at line 87 of file GridConfig.cpp.

{
    QPoint rangeSpacing = QPoint(spacing);
    if (rangeSpacing.x() < 1) {
        rangeSpacing.setX(1);
    }
    if (rangeSpacing.y() < 1) {
        rangeSpacing.setY(1);
    }
    d->gridConfig->setSpacing(rangeSpacing);
}

References d, krita::GridConfig::Private::gridConfig, KisGridConfig::setSpacing(), and spacing().

setSpacingActiveHorizontal

void GridConfig::setSpacingActiveHorizontal ( bool active )

slot

Set horizontal grid spacing active. Spacing value is used for grid type "rectangular".

Parameters

active

True to activate horizontal spacing, False to deactivate it.

Definition at line 104 of file GridConfig.cpp.

{
    d->gridConfig->setXSpacingActive(active);
}

References d, krita::GridConfig::Private::gridConfig, and KisGridConfig::setXSpacingActive().

setSpacingActiveVertical

void GridConfig::setSpacingActiveVertical ( bool active )

slot

Set vertical grid spacing active. Spacing value is used for grid type "rectangular".

Parameters

active

True to activate vertical spacing, False to deactivate it.

Definition at line 114 of file GridConfig.cpp.

{
    d->gridConfig->setYSpacingActive(active);
}

References d, krita::GridConfig::Private::gridConfig, and KisGridConfig::setYSpacingActive().

setSpacingAspectLocked

void GridConfig::setSpacingAspectLocked ( bool spacingAspectLocked )

slot

Set status of "Aspect locked" property for spacing values (X and Y values are linked to keep ratio) SpacingAspectLocked value is used for grid type "rectangular".

Parameters

spacingAspectLocked

Set to True lock aspect.

Definition at line 229 of file GridConfig.cpp.

{
    d->gridConfig->setSpacingAspectLocked(spacingAspectLocked);
}

References d, krita::GridConfig::Private::gridConfig, KisGridConfig::setSpacingAspectLocked(), and spacingAspectLocked().

setSubdivision

void GridConfig::setSubdivision ( int subdivision )

slot

Set number of grid subdivision for document. Subdivision value is used for grid type "rectangular".

Parameters

subdivision

A positive integer value, in range [1 - 10]

Definition at line 124 of file GridConfig.cpp.

{
    d->gridConfig->setSubdivision(qBound(1, subdivision, 10));
}

References d, krita::GridConfig::Private::gridConfig, KisGridConfig::setSubdivision(), and subdivision().

setType

void GridConfig::setType ( const QString & gridType )

slot

Set current grid type applied for document.

Parameters

gridType

The grid type can be: "rectangular" "isometric" "isometric_legacy"

Definition at line 201 of file GridConfig.cpp.

{
    if(gridType == "isometric") {
        d->gridConfig->setGridType(KisGridConfig::GridType::GRID_ISOMETRIC);
    }
    else if(gridType == "isometric_legacy") {
        d->gridConfig->setGridType(KisGridConfig::GridType::GRID_ISOMETRIC_LEGACY);
    }
    else {
        d->gridConfig->setGridType(KisGridConfig::GridType::GRID_RECTANGULAR);
    }
}

References d, KisGridConfig::GRID_ISOMETRIC, KisGridConfig::GRID_ISOMETRIC_LEGACY, KisGridConfig::GRID_RECTANGULAR, krita::GridConfig::Private::gridConfig, and KisGridConfig::setGridType().

setVisible

void GridConfig::setVisible ( bool visible )

slot

Set grid visibility for document.

Parameters

snap	Set to True to get grid visible.

Definition at line 54 of file GridConfig.cpp.

{
    d->gridConfig->setShowGrid(visible);
}

References d, krita::GridConfig::Private::gridConfig, KisGridConfig::setShowGrid(), and visible().

snap

bool GridConfig::snap ( ) const

slot

Returns snap to grid status for document.

Returns

If snap to grid is active on document, return True.

Definition at line 59 of file GridConfig.cpp.

{
    return d->gridConfig->showGrid();
}

References d, krita::GridConfig::Private::gridConfig, and KisGridConfig::showGrid().

spacing

QPoint GridConfig::spacing ( ) const

slot

Returns grid spacing (in pixels) for document. Spacing value is used for grid type "rectangular".

Returns

A QPoint that define X and Y spacing.

Definition at line 82 of file GridConfig.cpp.

{
    return d->gridConfig->spacing();
}

References d, krita::GridConfig::Private::gridConfig, and KisGridConfig::spacing().

spacingActiveHorizontal

bool GridConfig::spacingActiveHorizontal ( ) const

slot

Returns if horizontal grid spacing is active. Spacing value is used for grid type "rectangular".

Returns

a boolean which indicate if horizontal grid is active or not

Definition at line 99 of file GridConfig.cpp.

{
    return d->gridConfig->xSpacingActive();
}

References d, krita::GridConfig::Private::gridConfig, and KisGridConfig::xSpacingActive().

spacingActiveVertical

bool GridConfig::spacingActiveVertical ( ) const

slot

Returns if vertical grid spacing is active. Spacing value is used for grid type "rectangular".

Returns

a boolean which indicate if vertical grid is active or not

Definition at line 109 of file GridConfig.cpp.

{
    return d->gridConfig->ySpacingActive();
}

References d, krita::GridConfig::Private::gridConfig, and KisGridConfig::ySpacingActive().

spacingAspectLocked

bool GridConfig::spacingAspectLocked ( ) const

slot

Returns status of "Aspect locked" property for spacing values (mean, X and Y values are linked to keep ratio) SpacingAspectLocked value is used for grid type "rectangular".

Returns

If locked, return True.

Definition at line 224 of file GridConfig.cpp.

{
    return d->gridConfig->spacingAspectLocked();
}

References d, krita::GridConfig::Private::gridConfig, and KisGridConfig::spacingAspectLocked().

subdivision

int GridConfig::subdivision ( ) const

slot

Returns number of grid subdivision for document. Subdivision value is used for grid type "rectangular".

Returns

A positive integer value, starting from 1

Definition at line 119 of file GridConfig.cpp.

{
    return d->gridConfig->subdivision();
}

References d, krita::GridConfig::Private::gridConfig, and KisGridConfig::subdivision().

toXml

QString GridConfig::toXml ( ) const

slot

Save grid definition as an XML document.

Returns

A string with xml content

Definition at line 370 of file GridConfig.cpp.

{
    QDomDocument doc = QDomDocument();
    QDomElement elt = d->gridConfig->saveDynamicDataToXml(doc, "grid");
    doc.appendChild(elt);
    return doc.toString(2);
}

References d, krita::GridConfig::Private::gridConfig, and KisGridConfig::saveDynamicDataToXml().

type

QString GridConfig::type ( ) const

slot

Returns current grid type applied for document.

Returns

The grid type can be:

• "rectangular"
• "isometric"
• "isometric_legacy"

Definition at line 189 of file GridConfig.cpp.

{
    KisGridConfig::GridType type = d->gridConfig->gridType();
    if(type == KisGridConfig::GridType::GRID_ISOMETRIC) {
        return "isometric";
    }
    else if(type == KisGridConfig::GridType::GRID_ISOMETRIC_LEGACY) {
        return "isometric_legacy";
    }
    return "rectangular";
}

References d, KisGridConfig::GRID_ISOMETRIC, KisGridConfig::GRID_ISOMETRIC_LEGACY, krita::GridConfig::Private::gridConfig, KisGridConfig::gridType(), and type().

visible

bool GridConfig::visible ( ) const

slot

Returns grid visibility for document.

Returns

If grid is visible, return True.

Definition at line 49 of file GridConfig.cpp.

{
    return d->gridConfig->showGrid();
}

References d, krita::GridConfig::Private::gridConfig, and KisGridConfig::showGrid().

Friends And Related Symbol Documentation

Document

friend class Document

friend

Definition at line 410 of file GridConfig.h.

Member Data Documentation

d

Private* GridConfig::d

private

Definition at line 416 of file GridConfig.h.

---

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

• libs/libkis/GridConfig.h
• libs/libkis/GridConfig.cpp