mirror of
https://github.com/qgis/QGIS.git
synced 2025-05-02 00:05:04 -04:00
272b79b6ca
of page containing frame when frame is empty. This change allows users to create multiple pages containing extra frames for multiframe items (currently HTML and Attribute Table items), which are then only printed/exported if required. Sponsored by the City of Uster, Switzerland.
67 lines
2.3 KiB
Plaintext
67 lines
2.3 KiB
Plaintext
/**Frame item for a composer multiframe item*/
|
|
class QgsComposerFrame: QgsComposerItem
|
|
{
|
|
%TypeHeaderCode
|
|
#include "qgscomposerframe.h"
|
|
%End
|
|
|
|
public:
|
|
QgsComposerFrame( QgsComposition* c, QgsComposerMultiFrame* mf, qreal x, qreal y, qreal width, qreal height );
|
|
~QgsComposerFrame();
|
|
|
|
/**Sets the visible part of the multiframe's content which is visible within
|
|
* this frame (relative to the total multiframe extent in mm).
|
|
* @param section visible portion of content
|
|
* @see extent
|
|
*/
|
|
void setContentSection( const QRectF& section );
|
|
|
|
/**Returns the parent multiframe for the frame.
|
|
* @returns parent multiframe
|
|
*/
|
|
QgsComposerMultiFrame* multiFrame() const;
|
|
|
|
//Overriden to allow multiframe to set display name
|
|
virtual QString displayName() const;
|
|
|
|
//Overriden to handle fixed frame sizes set by multi frame
|
|
void setSceneRect( const QRectF& rectangle );
|
|
|
|
void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget );
|
|
void beginItemCommand( const QString& text );
|
|
void endItemCommand();
|
|
bool writeXML( QDomElement& elem, QDomDocument & doc ) const;
|
|
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );
|
|
int type() const;
|
|
|
|
/**Returns the visible portion of the multi frame's content which
|
|
* is shown in this frame.
|
|
* @returns extent of visible portion
|
|
* @note added in QGIS 2.5
|
|
* @see setContentSection
|
|
*/
|
|
QRectF extent() const;
|
|
|
|
/**Returns whether the page should be hidden (ie, not included in composer exports) if this frame is empty
|
|
* @returns true if page should be hidden if frame is empty
|
|
* @note added in QGIS 2.5
|
|
* @see setHidePageIfEmpty
|
|
*/
|
|
bool hidePageIfEmpty() const;
|
|
|
|
/**Sets whether the page should be hidden (ie, not included in composer exports) if this frame is empty
|
|
* @param hidePageIfEmpty set to true if page should be hidden if frame is empty
|
|
* @note added in QGIS 2.5
|
|
* @see hidePageIfEmpty
|
|
*/
|
|
void setHidePageIfEmpty( const bool hidePageIfEmpty );
|
|
|
|
/**Returns whether the frame is empty
|
|
* @returns true if frame is empty
|
|
* @note added in QGIS 2.5
|
|
* @see hidePageIfEmpty
|
|
*/
|
|
bool isEmpty() const;
|
|
|
|
};
|