24 , mMultiFrame( multiFrame )
25 , mMultiFrameUuid( multiFrame ? multiFrame->uuid() : QString() )
89 return mMultiFrame->
icon();
117 const double multiFrameHeight = mMultiFrame->
totalSize().height();
118 if ( multiFrameHeight <= mSection.top() )
159 return tr(
"<Frame>" );
165 mMultiFrame->handleFrameRemoval(
this );
166 mMultiFrame =
nullptr;
176 const int frameIndex = mMultiFrame->
frameIndex(
this );
177 Q_ASSERT_X( frameIndex >= 0,
"QgsLayoutFrame::draw",
"Invalid frame index for frame" );
178 mMultiFrame->
render( context, mSection, frameIndex );
184 if ( !
isEmpty() || !mHideBackgroundIfEmpty )
192 if ( !
isEmpty() || !mHideBackgroundIfEmpty )
200 parentElement.setAttribute( QStringLiteral(
"multiFrame" ), mMultiFrameUuid );
201 parentElement.setAttribute( QStringLiteral(
"multiFrameTemplateUuid" ), mMultiFrameUuid );
202 parentElement.setAttribute( QStringLiteral(
"sectionX" ), QString::number( mSection.x() ) );
203 parentElement.setAttribute( QStringLiteral(
"sectionY" ), QString::number( mSection.y() ) );
204 parentElement.setAttribute( QStringLiteral(
"sectionWidth" ), QString::number( mSection.width() ) );
205 parentElement.setAttribute( QStringLiteral(
"sectionHeight" ), QString::number( mSection.height() ) );
206 parentElement.setAttribute( QStringLiteral(
"hidePageIfEmpty" ), mHidePageIfEmpty );
207 parentElement.setAttribute( QStringLiteral(
"hideBackgroundIfEmpty" ), mHideBackgroundIfEmpty );
213 const double x = itemElem.attribute( QStringLiteral(
"sectionX" ) ).toDouble();
214 const double y = itemElem.attribute( QStringLiteral(
"sectionY" ) ).toDouble();
215 const double width = itemElem.attribute( QStringLiteral(
"sectionWidth" ) ).toDouble();
216 const double height = itemElem.attribute( QStringLiteral(
"sectionHeight" ) ).toDouble();
217 mSection = QRectF( x, y, width, height );
218 mHidePageIfEmpty = itemElem.attribute( QStringLiteral(
"hidePageIfEmpty" ), QStringLiteral(
"0" ) ).toInt();
219 mHideBackgroundIfEmpty = itemElem.attribute( QStringLiteral(
"hideBackgroundIfEmpty" ), QStringLiteral(
"0" ) ).toInt();
221 mMultiFrameUuid = itemElem.attribute( QStringLiteral(
"multiFrame" ) );
222 if ( mMultiFrameUuid.isEmpty( ) )
224 mMultiFrameUuid = itemElem.attribute( QStringLiteral(
"multiFrameTemplateUuid" ) );
226 mMultiFrame =
mLayout->multiFrameByUuid( mMultiFrameUuid );
@ Millimeters
Millimeters.
static QgsExpressionContextScope * layoutItemScope(const QgsLayoutItem *item)
Creates a new scope which contains variables and functions relating to a QgsLayoutItem.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void appendScope(QgsExpressionContextScope *scope)
Appends a scope to the end of the context.
Base class for frame items, which form a layout multiframe item.
QgsExpressionContext createExpressionContext() const override
This method needs to be reimplemented in all classes which implement this interface and return an exp...
QgsLayoutSize fixedSize() const override
Returns the fixed size of the item, if applicable, or an empty size if item can be freely resized.
bool isEmpty() const
Returns whether the frame is empty.
int type() const override
QIcon icon() const override
Returns the item's icon.
bool readPropertiesFromElement(const QDomElement &itemElement, const QDomDocument &document, const QgsReadWriteContext &context) override
Sets item state from a DOM element.
QgsLayoutFrame(QgsLayout *layout, QgsLayoutMultiFrame *multiFrame)
Constructor for QgsLayoutFrame, with the specified parent layout and belonging to a multiFrame.
void drawBackground(QgsRenderContext &context) override
Draws the background for the item.
void draw(QgsLayoutItemRenderContext &context) override
Draws the item's contents using the specified item render context.
~QgsLayoutFrame() override
QgsLayoutMultiFrame * multiFrame() const
Returns the parent multiframe for the frame.
QString displayName() const override
Gets item display name.
static QgsLayoutFrame * create(QgsLayout *layout)
Creates a new QgsLayoutFrame belonging to the specified layout.
ExportLayerBehavior exportLayerBehavior() const override
Returns the behavior of this item during exporting to layered exports (e.g.
bool writePropertiesToElement(QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const override
Stores item state within an XML DOM element.
bool hideBackgroundIfEmpty() const
Returns whether the background and frame stroke should be hidden if this frame is empty.
bool hidePageIfEmpty() const
Returns whether the page should be hidden (ie, not included in layout exports) if this frame is empty...
void setHideBackgroundIfEmpty(bool hideBackgroundIfEmpty)
Sets whether the background and frame stroke should be hidden if this frame is empty.
void drawFrame(QgsRenderContext &context) override
Draws the frame around the item.
void setHidePageIfEmpty(bool hidePageIfEmpty)
Sets whether the page should be hidden (ie, not included in layout exports) if this frame is empty.
QgsLayoutSize minimumSize() const override
Returns the minimum allowed size of the item, if applicable, or an empty size if item can be freely r...
void cleanup() override
Called just before a batch of items are deleted, allowing them to run cleanup tasks.
@ LayoutFrame
Frame item, part of a QgsLayoutMultiFrame object.
Contains settings and helpers relating to a render of a QgsLayoutItem.
Base class for graphical items within a QgsLayout.
virtual void drawFrame(QgsRenderContext &context)
Draws the frame around the item.
virtual void cleanup()
Called just before a batch of items are deleted, allowing them to run cleanup tasks.
void refreshItemSize()
Refreshes an item's size by rechecking it against any possible item fixed or minimum sizes.
QgsExpressionContext createExpressionContext() const override
This method needs to be reimplemented in all classes which implement this interface and return an exp...
virtual void drawBackground(QgsRenderContext &context)
Draws the background for the item.
QString id() const
Returns the item's ID name.
ExportLayerBehavior
Behavior of item when exporting to layered outputs.
@ CanGroupWithItemsOfSameType
Item can only be placed on layers with other items of the same type, but multiple items of this type ...
void setBackgroundEnabled(bool drawBackground)
Sets whether this item has a background drawn under it or not.
Abstract base class for layout items with the ability to distribute the content to several frames (Qg...
virtual QSizeF totalSize() const =0
Returns the total size of the multiframe's content, in layout units.
void contentsChanged()
Emitted when the contents of the multi frame have changed and the frames must be redrawn.
virtual QSizeF fixedFrameSize(int frameIndex=-1) const
Returns the fixed size for a frame, if desired.
QgsExpressionContext createExpressionContext() const override
This method needs to be reimplemented in all classes which implement this interface and return an exp...
virtual QIcon icon() const
Returns the item's icon.
virtual QSizeF minFrameSize(int frameIndex=-1) const
Returns the minimum size for a frames, if desired.
int frameIndex(QgsLayoutFrame *frame) const
Returns the index of a frame within the multiframe.
virtual QString displayName() const
Returns the multiframe display name.
virtual void render(QgsLayoutItemRenderContext &context, const QRectF &renderExtent, int frameIndex)=0
Renders a portion of the multiframe's content into a render context.
const QgsLayout * layout() const
Returns the layout the object is attached to.
QPointer< QgsLayout > mLayout
This class provides a method of storing sizes, consisting of a width and height, for use in QGIS layo...
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
The class is used as a container of context for various read/write operations on other objects.
Contains information about the context of a rendering operation.