Subgroup: Layout

Class: QgsLayoutGuide

class qgis.core.QgsLayoutGuide

Bases: PyQt5.QtCore.QObject

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

New in version 3.0: Methods

blockSignals
childEvent
children
connectNotify
customEvent
deleteLater
disconnect
disconnectNotify
dumpObjectInfo
dumpObjectTree
dynamicPropertyNames
event
eventFilter
findChild	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
findChildren	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
inherits
installEventFilter
isSignalConnected
isWidgetType
isWindowType
item	Returns the guide’s line item.
killTimer
layout	Returns the layout the guide belongs to.
layoutPosition	Returns the guide’s position in absolute layout units.
metaObject
moveToThread
objectName
orientation	Returns the guide’s orientation.
page	Returns the page the guide is contained within.
parent
position	Returns the guide’s position within the page.
property
pyqtConfigure	Each keyword argument is either the name of a Qt property or a Qt signal.
receivers
removeEventFilter
sender
senderSignalIndex
setLayout	Sets the layout the guide belongs to.
setLayoutPosition	Sets the guide’s position in absolute layout units.
setObjectName
setPage	Sets the page the guide is contained within.
setParent
setPosition	Sets the guide’s position within the page.
setProperty
signalsBlocked
startTimer
thread
timerEvent
tr
update	Updates the position of the guide’s line item.

Attributes

destroyed	destroyed(self, QObject = None) [signal]
objectNameChanged	objectNameChanged(self, str) [signal]
positionChanged	Emitted when the guide’s position is changed.
staticMetaObject

childEvent()

connectNotify()

customEvent()

disconnectNotify()

isSignalConnected()

item(self) → QGraphicsLineItem

Returns the guide’s line item.

layout(self) → QgsLayout

Returns the layout the guide belongs to.

See also

setLayout()

layoutPosition(self) → float

Returns the guide’s position in absolute layout units.

See also

setLayoutPosition()

orientation(self) → Qt.Orientation

Returns the guide’s orientation.

page(self) → QgsLayoutItemPage

Returns the page the guide is contained within.

See also

setPage()

position(self) → QgsLayoutMeasurement

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()

positionChanged

Emitted when the guide’s position is changed. [signal]

receivers()

sender()

senderSignalIndex()

setLayout(self, layout: QgsLayout)

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()

setLayoutPosition(self, position: float)

Sets the guide’s position in absolute layout units.

See also

layoutPosition()

setPage(self, page: QgsLayoutItemPage)

Sets the page the guide is contained within.

See also

page()

setPosition(self, position: QgsLayoutMeasurement)

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()

timerEvent()

update(self)

Updates the position of the guide’s line item.