Class: QgsReportSectionLayout

class qgis.core.QgsReportSectionLayout(parentSection: QgsAbstractReportSection = None)

Bases: QgsAbstractReportSection

Constructor for QgsReportSectionLayout, attached to the specified parent section. Note that ownership is not transferred to parent.

A report section consisting of a single QgsLayout body.

Warning

This is not considered stable API, and may change in future QGIS releases. It is exposed to the Python bindings for unit testing purposes only.

New in version 3.0.

Parameters

parentSection

beginRender(self) → bool
Return type

bool

body(self) → QgsLayout

Returns the body layout for the section.

See also

setBody()

See also

bodyEnabled()

See also

setBodyEnabled()

Return type

QgsLayout

bodyEnabled(self) → bool

Returns True if the body for the section is enabled.

See also

setBodyEnabled()

See also

body()

See also

setBody()

Return type

bool

clone(self) → QgsReportSectionLayout
Return type

QgsReportSectionLayout

copyCommonProperties()
description(self) → str
Return type

str

icon(self) → QIcon
Return type

QIcon

nextBody(self) → Tuple[QgsLayout, bool]
Return type

Tuple[QgsLayout, bool]

readPropertiesFromElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool
Parameters
Return type

bool

reloadSettings(self)
setBody(self, body: QgsLayout)

Sets the body layout for the section. Ownership of body is transferred to the report section.

See also

body()

See also

bodyEnabled()

See also

setBodyEnabled()

Parameters

body (QgsLayout) –

setBodyEnabled(self, enabled: bool)

Sets whether the body for the section is enabled.

See also

bodyEnabled()

See also

body()

See also

setBody()

Parameters

enabled (bool) –

setParentSection()
type(self) → str
Return type

str

writePropertiesToElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool
Parameters
Return type

bool