Class: QgsReportSectionLayout¶
- class qgis.core.QgsReportSectionLayout(parentSection: QgsAbstractReportSection = None)¶
Bases:
QgsAbstractReportSection
Constructor for
QgsReportSectionLayout
, attached to the specifiedparent
section. Note that ownership is not transferred toparent
.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.
Methods
- rtype
bool
Returns the body layout for the section.
Returns
True
if the body for the section is enabled.- rtype
QgsReportSectionLayout
Copies the common properties of a report section to a
destination
section.- rtype
str
- rtype
QIcon
- rtype
Tuple[
QgsLayout
, bool]
- param element
Sets the
body
layout for the section.Sets whether the body for the section is
enabled
.Sets the
parent
report section.- rtype
str
- param element
- beginRender(self) → bool¶
- Return type
bool
- body(self) → QgsLayout¶
Returns the body layout for the section.
See also
See also
See also
- Return type
- bodyEnabled(self) → bool¶
Returns
True
if the body for the section is enabled.See also
See also
See also
- Return type
bool
- clone(self) → QgsReportSectionLayout¶
- Return type
- copyCommonProperties(self, destination: QgsAbstractReportSection)¶
Copies the common properties of a report section to a
destination
section. This method should be called fromclone()
implementations.
- description(self) → str¶
- Return type
str
- icon(self) → QIcon¶
- Return type
QIcon
- readPropertiesFromElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool¶
- Parameters
element (QDomElement) –
document (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
bool
- reloadSettings(self)¶
- setBody(self, body: QgsLayout)¶
Sets the
body
layout for the section. Ownership ofbody
is transferred to the report section.See also
See also
See also
- Parameters
body (QgsLayout) –
- setBodyEnabled(self, enabled: bool)¶
Sets whether the body for the section is
enabled
.See also
See also
See also
- Parameters
enabled (bool) –
- setParentSection(self, parent: QgsAbstractReportSection)¶
Sets the
parent
report section.
- type(self) → str¶
- Return type
str
- writePropertiesToElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool¶
- Parameters
element (QDomElement) –
document (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
bool