Class: QgsLayoutGuide¶

Contains the configuration for a single snap guide used by a layout.

Class Hierarchy¶

Base classes¶

class qgis.core.QgsLayoutGuide[source]¶

Bases: QObject

__init__(orientation: Qt.Orientation, position: QgsLayoutMeasurement, page: QgsLayoutItemPage | None)

Constructor for a new guide with the specified orientation and initial position.

A layout must be set by calling setLayout() before the guide can be used. Adding the guide to a QgsLayoutGuideCollection will automatically set the corresponding layout for you.

Parameters:

orientation (Qt.Orientation)
position (QgsLayoutMeasurement)
page (Optional[QgsLayoutItemPage])

item(self) → QGraphicsLineItem | None[source]¶

Returns the guide’s line item.

Return type:: Optional[QGraphicsLineItem]

layout(self) → QgsLayout | None[source]¶

Returns the layout the guide belongs to.

See also

setLayout()

Return type:: Optional[QgsLayout]

layoutPosition(self) → float[source]¶

Returns the guide’s position in absolute layout units.

See also

setLayoutPosition()

Return type:: float

orientation(self) → Qt.Orientation[source]¶

Returns the guide’s orientation.

Return type:: Qt.Orientation

page(self) → QgsLayoutItemPage | None[source]¶

Returns the page the guide is contained within.

See also

setPage()

Return type:: Optional[QgsLayoutItemPage]

position(self) → QgsLayoutMeasurement[source]¶

Returns the guide’s position within the page.

The position indicates either the horizontal or vertical position of the guide, depending on the guide’s orientation().

See also

setPosition()

Return type:: QgsLayoutMeasurement

signal positionChanged[source]¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

setLayout(self, layout: QgsLayout | None)[source]¶

Sets the layout the guide belongs to.

Note

Adding the guide to a QgsLayoutGuideCollection will automatically set the corresponding layout for you.

See also

layout()

Parameters:: layout (Optional[QgsLayout])

setLayoutPosition(self, position: float)[source]¶

Sets the guide’s position in absolute layout units.

See also

layoutPosition()

Parameters:: position (float)

setPage(self, page: QgsLayoutItemPage | None)[source]¶

Sets the page the guide is contained within.

See also

page()

Parameters:: page (Optional[QgsLayoutItemPage])

setPosition(self, position: QgsLayoutMeasurement)[source]¶

Sets the guide’s position within the page.

The position argument indicates either the horizontal or vertical position of the guide, depending on the guide’s orientation().

See also

position()

Parameters:: position (QgsLayoutMeasurement)

update(self)[source]¶: Updates the position of the guide’s line item.