mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-27 00:33:48 -05:00
88 lines
3.2 KiB
Plaintext
88 lines
3.2 KiB
Plaintext
|
|
/**Abstract base class for composer entries with the ability to distribute the content to several frames (items)*/
|
|
class QgsComposerMultiFrame: QObject
|
|
{
|
|
%TypeHeaderCode
|
|
#include "qgscomposermultiframe.h"
|
|
%End
|
|
|
|
public:
|
|
|
|
enum ResizeMode
|
|
{
|
|
UseExistingFrames = 0,
|
|
ExtendToNextPage, //uses the next page(s) until the content has been printed
|
|
RepeatOnEveryPage, //repeats the same frame on every page
|
|
RepeatUntilFinished //duplicates last frame to next page to fit the total size
|
|
};
|
|
|
|
QgsComposerMultiFrame( QgsComposition* c, bool createUndoCommands );
|
|
virtual ~QgsComposerMultiFrame();
|
|
virtual QSizeF totalSize() const = 0;
|
|
virtual void render( QPainter* p, const QRectF& renderExtent ) = 0;
|
|
|
|
virtual void addFrame( QgsComposerFrame* frame, bool recalcFrameSizes = true ) = 0;
|
|
|
|
/**Finds the optimal position to break a frame at.
|
|
* @param yPos maximum vertical position for break
|
|
* @returns the optimal breakable position which occurs in the multi frame close
|
|
* to and before the specified yPos
|
|
* @note added in version 2.3*/
|
|
virtual double findNearbyPageBreak( double yPos );
|
|
|
|
void removeFrame( int i );
|
|
|
|
void update();
|
|
|
|
void setResizeMode( ResizeMode mode );
|
|
ResizeMode resizeMode() const;
|
|
|
|
virtual bool writeXML( QDomElement& elem, QDomDocument & doc, bool ignoreFrames = false ) const = 0;
|
|
bool _writeXML( QDomElement& elem, QDomDocument& doc, bool ignoreFrames = false ) const;
|
|
|
|
virtual bool readXML( const QDomElement& itemElem, const QDomDocument& doc, bool ignoreFrames = false ) = 0;
|
|
bool _readXML( const QDomElement& itemElem, const QDomDocument& doc, bool ignoreFrames = false );
|
|
|
|
QgsComposition* composition();
|
|
|
|
bool createUndoCommands() const;
|
|
void setCreateUndoCommands( bool enabled );
|
|
|
|
/**Removes and deletes all frames from mComposition*/
|
|
void deleteFrames();
|
|
|
|
/** Return the number of frames associated with this multiframeset.
|
|
@note added in 2.0, replaces nFrames
|
|
**/
|
|
int frameCount() const;
|
|
QgsComposerFrame* frame( int i );
|
|
|
|
/**Creates a new frame and adds it to the multi frame and composition.
|
|
* @param currentFrame an existing QgsComposerFrame from which to copy the size
|
|
* and general frame properties (eg frame style, background, rendering settings).
|
|
* @param pos position of top-left corner of the new frame
|
|
* @param size size of the new frame
|
|
* @returns new QgsComposerFrame
|
|
* @note added in version 2.3
|
|
*/
|
|
QgsComposerFrame* createNewFrame( QgsComposerFrame* currentFrame, QPointF pos, QSizeF size );
|
|
|
|
public slots:
|
|
|
|
/**Recalculates the portion of the multiframe item which is shown in each of it's
|
|
* component frames. If the resize mode is set to anything but UseExistingFrames then
|
|
* this may cause new frames to be added or frames to be removed, in order to fit
|
|
* the current size of the multiframe's content.
|
|
*/
|
|
void recalculateFrameSizes();
|
|
|
|
protected slots:
|
|
/**Called before a frame is going to be removed (update frame list)*/
|
|
void handleFrameRemoval( QgsComposerItem* item );
|
|
/**Adapts to changed number of pages if resize type is RepeatOnEveryPage*/
|
|
void handlePageChange();
|
|
|
|
signals:
|
|
void changed();
|
|
};
|