QGIS API Documentation  3.8.0-Zanzibar (11aff65)
qgslayoutframe.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgslayoutframe.cpp
3  ------------------
4  begin : October 2017
5  copyright : (C) 2017 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #include "qgslayoutframe.h"
17 #include "qgslayoutmultiframe.h"
18 #include "qgslayoutitemregistry.h"
19 #include "qgslayout.h"
21 
23  : QgsLayoutItem( layout )
24  , mMultiFrame( multiFrame )
25  , mMultiFrameUuid( multiFrame ? multiFrame->uuid() : QString() )
26 {
27 
28  //default to no background
29  setBackgroundEnabled( false );
30 
31  if ( multiFrame )
32  {
33  //repaint frame when multiframe content changes
34  connect( multiFrame, &QgsLayoutMultiFrame::contentsChanged, this, [ = ]
35  {
36  update();
37  } );
38 
39  //force recalculation of rect, so that multiframe specified sizes can be applied
41  }
42 }
43 
45 {
46  return new QgsLayoutFrame( layout, nullptr );
47 }
48 
50 {
51  return mMultiFrame;
52 }
53 
55 {
56  if ( !mMultiFrame )
57  return QgsLayoutSize();
58 
59  //calculate index of frame
60  int frameIndex = mMultiFrame->frameIndex( const_cast< QgsLayoutFrame * >( this ) );
61  //check minimum size
62  return QgsLayoutSize( mMultiFrame->minFrameSize( frameIndex ), QgsUnitTypes::LayoutMillimeters );
63 }
64 
66 {
67  if ( !mMultiFrame )
68  return QgsLayoutSize();
69 
70  //calculate index of frame
71  int frameIndex = mMultiFrame->frameIndex( const_cast< QgsLayoutFrame * >( this ) );
72  //check fixed size
73  return QgsLayoutSize( mMultiFrame->fixedFrameSize( frameIndex ), QgsUnitTypes::LayoutMillimeters );
74 }
75 
77 {
79 }
80 
81 QIcon QgsLayoutFrame::icon() const
82 {
83  if ( mMultiFrame )
84  return mMultiFrame->icon();
85  else
86  return QIcon();
87 }
88 
90 {
91  mHidePageIfEmpty = hidePageIfEmpty;
92 }
93 
95 {
96  if ( hideBackgroundIfEmpty == mHideBackgroundIfEmpty )
97  {
98  return;
99  }
100 
101  mHideBackgroundIfEmpty = hideBackgroundIfEmpty;
102  update();
103 }
104 
106 {
107  if ( !mMultiFrame )
108  {
109  return true;
110  }
111 
112  double multiFrameHeight = mMultiFrame->totalSize().height();
113  if ( multiFrameHeight <= mSection.top() )
114  {
115  //multiframe height is less than top of this frame's visible portion
116  return true;
117  }
118 
119  return false;
120 
121 }
122 
124 {
125  if ( !mMultiFrame )
127 
128  //start with multiframe's context
129  QgsExpressionContext context = mMultiFrame->createExpressionContext();
130 
131  //add frame's individual context
133 
134  return context;
135 }
136 
137 
139 {
140  if ( !id().isEmpty() )
141  {
142  return id();
143  }
144 
145  if ( mMultiFrame )
146  {
147  return mMultiFrame->displayName();
148  }
149 
150  return tr( "<Frame>" );
151 }
152 
154 {
155  if ( mMultiFrame )
156  mMultiFrame->handleFrameRemoval( this );
157 
159 }
160 
162 {
163  if ( mMultiFrame )
164  {
165  //calculate index of frame
166  int frameIndex = mMultiFrame->frameIndex( this );
167  Q_ASSERT_X( frameIndex >= 0, "QgsLayoutFrame::draw", "Invalid frame index for frame" );
168  mMultiFrame->render( context, mSection, frameIndex );
169  }
170 }
171 
173 {
174  if ( !isEmpty() || !mHideBackgroundIfEmpty )
175  {
176  QgsLayoutItem::drawFrame( context );
177  }
178 }
179 
181 {
182  if ( !isEmpty() || !mHideBackgroundIfEmpty )
183  {
185  }
186 }
187 
188 bool QgsLayoutFrame::writePropertiesToElement( QDomElement &parentElement, QDomDocument &, const QgsReadWriteContext & ) const
189 {
190  parentElement.setAttribute( QStringLiteral( "multiFrame" ), mMultiFrameUuid );
191  parentElement.setAttribute( QStringLiteral( "multiFrameTemplateUuid" ), mMultiFrameUuid );
192  parentElement.setAttribute( QStringLiteral( "sectionX" ), QString::number( mSection.x() ) );
193  parentElement.setAttribute( QStringLiteral( "sectionY" ), QString::number( mSection.y() ) );
194  parentElement.setAttribute( QStringLiteral( "sectionWidth" ), QString::number( mSection.width() ) );
195  parentElement.setAttribute( QStringLiteral( "sectionHeight" ), QString::number( mSection.height() ) );
196  parentElement.setAttribute( QStringLiteral( "hidePageIfEmpty" ), mHidePageIfEmpty );
197  parentElement.setAttribute( QStringLiteral( "hideBackgroundIfEmpty" ), mHideBackgroundIfEmpty );
198  return true;
199 }
200 
201 bool QgsLayoutFrame::readPropertiesFromElement( const QDomElement &itemElem, const QDomDocument &, const QgsReadWriteContext & )
202 {
203  double x = itemElem.attribute( QStringLiteral( "sectionX" ) ).toDouble();
204  double y = itemElem.attribute( QStringLiteral( "sectionY" ) ).toDouble();
205  double width = itemElem.attribute( QStringLiteral( "sectionWidth" ) ).toDouble();
206  double height = itemElem.attribute( QStringLiteral( "sectionHeight" ) ).toDouble();
207  mSection = QRectF( x, y, width, height );
208  mHidePageIfEmpty = itemElem.attribute( QStringLiteral( "hidePageIfEmpty" ), QStringLiteral( "0" ) ).toInt();
209  mHideBackgroundIfEmpty = itemElem.attribute( QStringLiteral( "hideBackgroundIfEmpty" ), QStringLiteral( "0" ) ).toInt();
210 
211  mMultiFrameUuid = itemElem.attribute( QStringLiteral( "multiFrame" ) );
212  if ( mMultiFrameUuid.isEmpty( ) )
213  {
214  mMultiFrameUuid = itemElem.attribute( QStringLiteral( "multiFrameTemplateUuid" ) );
215  }
216  mMultiFrame = mLayout->multiFrameByUuid( mMultiFrameUuid );
217  return true;
218 }
The class is used as a container of context for various read/write operations on other objects...
void draw(QgsLayoutItemRenderContext &context) override
Draws the item&#39;s contents using the specified item render context.
QgsExpressionContext createExpressionContext() const override
This method needs to be reimplemented in all classes which implement this interface and return an exp...
virtual QSizeF totalSize() const =0
Returns the total size of the multiframe&#39;s content, in layout units.
QgsExpressionContext createExpressionContext() const override
Creates an expression context relating to the objects&#39; current state.
virtual QIcon icon() const
Returns the item&#39;s icon.
virtual QSizeF minFrameSize(int frameIndex=-1) const
Returns the minimum size for a frames, if desired.
Base class for graphical items within a QgsLayout.
QString displayName() const override
Gets item display name.
int type() const override
int frameIndex(QgsLayoutFrame *frame) const
Returns the index of a frame within the multiframe.
QgsExpressionContext createExpressionContext() const override
This method needs to be reimplemented in all classes which implement this interface and return an exp...
bool readPropertiesFromElement(const QDomElement &itemElement, const QDomDocument &document, const QgsReadWriteContext &context) override
Sets item state from a DOM element.
void cleanup() override
Called just before a batch of items are deleted, allowing them to run cleanup tasks.
Abstract base class for layout items with the ability to distribute the content to several frames (Qg...
static QgsExpressionContextScope * layoutItemScope(const QgsLayoutItem *item)
Creates a new scope which contains variables and functions relating to a QgsLayoutItem.
void refreshItemSize()
Refreshes an item&#39;s size by rechecking it against any possible item fixed or minimum sizes...
virtual void drawFrame(QgsRenderContext &context)
Draws the frame around the item.
void contentsChanged()
Emitted when the contents of the multi frame have changed and the frames must be redrawn.
const QgsLayout * layout() const
Returns the layout the object is attached to.
virtual void drawBackground(QgsRenderContext &context)
Draws the background for the item.
void drawBackground(QgsRenderContext &context) override
Draws the background for the item.
QgsLayoutSize fixedSize() const override
Returns the fixed size of the item, if applicable, or an empty size if item can be freely resized...
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
virtual void cleanup()
Called just before a batch of items are deleted, allowing them to run cleanup tasks.
QPointer< QgsLayout > mLayout
QgsLayoutMultiFrame * multiFrame() const
Returns the parent multiframe for the frame.
void setHideBackgroundIfEmpty(bool hideBackgroundIfEmpty)
Sets whether the background and frame stroke should be hidden 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...
QString id() const
Returns the item&#39;s ID name.
QIcon icon() const override
Returns the item&#39;s icon.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition: qgslayout.h:49
Frame item, part of a QgsLayoutMultiFrame object.
void setBackgroundEnabled(bool drawBackground)
Sets whether this item has a background drawn under it or not.
Contains settings and helpers relating to a render of a QgsLayoutItem.
Definition: qgslayoutitem.h:44
QgsLayoutFrame(QgsLayout *layout, QgsLayoutMultiFrame *multiFrame)
Constructor for QgsLayoutFrame, with the specified parent layout and belonging to a multiFrame...
virtual QString displayName() const
Returns the multiframe display name.
Contains information about the context of a rendering operation.
virtual void render(QgsLayoutItemRenderContext &context, const QRectF &renderExtent, int frameIndex)=0
Renders a portion of the multiframe&#39;s content into a render context.
virtual QSizeF fixedFrameSize(int frameIndex=-1) const
Returns the fixed size for a frame, if desired.
void appendScope(QgsExpressionContextScope *scope)
Appends a scope to the end of the context.
bool hidePageIfEmpty() const
Returns whether the page should be hidden (ie, not included in layout exports) if this frame is empty...
bool hideBackgroundIfEmpty() const
Returns whether the background and frame stroke should be hidden if this frame is empty...
This class provides a method of storing sizes, consisting of a width and height, for use in QGIS layo...
Definition: qgslayoutsize.h:40
void drawFrame(QgsRenderContext &context) override
Draws the frame around the item.
bool isEmpty() const
Returns whether the frame is empty.
bool writePropertiesToElement(QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const override
Stores item state within an XML DOM element.
Base class for frame items, which form a layout multiframe item.
void setHidePageIfEmpty(bool hidePageIfEmpty)
Sets whether the page should be hidden (ie, not included in layout exports) if this frame is empty...
static QgsLayoutFrame * create(QgsLayout *layout)
Creates a new QgsLayoutFrame belonging to the specified layout.