Class GuidesConfig
Build from GuidesConfig.h
＋Krita 6.0.0-beta1

The GuidesConfig class encapsulates a Krita Guides configuration.

Methods

color() ➞ QColor fromXml(xmlContent: str) ➞ bool hasGuides() ➞ bool hasSamePositionAs(guideConfig: GuidesConfig) ➞ bool horizontalGuides() ➞ list[float] lineType() ➞ str locked() ➞ bool removeAllGuides() setColor(color: QColor) setHorizontalGuides(lines: list[float]) setLineType(lineType: str) setLocked(value: bool) setSnap(value: bool) setVerticalGuides(lines: list[float]) setVisible(value: bool) snap() ➞ bool toXml() ➞ str verticalGuides() ➞ list[float] visible() ➞ bool

Member documentation

color() ➞ QColor
＋Krita 6.0.0-beta1

Guides color

Return

color applied for all guides

fromXml(xmlContent: str) ➞ bool
＋Krita 6.0.0-beta1

Load guides definition from an XML document

Parameters

xmlContent

xml content provided as a string

Return

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

hasGuides() ➞ bool
＋Krita 6.0.0-beta1

indicate if there's guides defined

Return

True if at least one guide is defined, otherwise False

hasSamePositionAs(guideConfig: GuidesConfig) ➞ bool
＋Krita 6.0.0-beta1

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

Parameters

guideConfig(no description provided)

Return

True if positions are the same

horizontalGuides() ➞ list[float]
＋Krita 6.0.0-beta1

The horizontal guides.

Return

a list of the horizontal positions of guides.

lineType() ➞ str
＋Krita 6.0.0-beta1

Guides line type

Return

line type applied for all guides Can be: - "solid" - "dashed" - "dot"

locked() ➞ bool
＋Krita 6.0.0-beta1

Returns guide lock status

Return

True if guides are locked, otherwise False

removeAllGuides()
＋Krita 6.0.0-beta1

Remove all guides

setColor(color: QColor)
＋Krita 6.0.0-beta1

Define guides color

Parameters

color

color to apply

setHorizontalGuides(lines: list[float])
＋Krita 6.0.0-beta1

Set the horizontal guides.

Parameters

lines

a list of the horizontal positions of guides to set

setLineType(lineType: str)
＋Krita 6.0.0-beta1

Define guides lines type

Parameters

lineType

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

setLocked(value: bool)
＋Krita 6.0.0-beta1

Set guides lock status

Parameters

value

True to set guides locked, otherwise False

setSnap(value: bool)
＋Krita 6.0.0-beta1

Set guides snap status

Parameters

value

True to set snap to guides active, otherwise False

setVerticalGuides(lines: list[float])
＋Krita 6.0.0-beta1

Set the vertical guides.

Parameters

lines

a list of the vertical positions of guides to set

setVisible(value: bool)
＋Krita 6.0.0-beta1

Set guides visibility status

Parameters

value

True to set guides visible, otherwise False

snap() ➞ bool
＋Krita 6.0.0-beta1

Returns guide snap status

Return

True if snap to guides is active, otherwise False

toXml() ➞ str
＋Krita 6.0.0-beta1

Save guides definition as an XML document

Return

A string with xml content

verticalGuides() ➞ list[float]
＋Krita 6.0.0-beta1

The vertical guides.

Return

a list of vertical positions of guides.

visible() ➞ bool
＋Krita 6.0.0-beta1

Returns guides visibility status.

Return

True if guides are visible, otherwise False