src/core/composer/qgscomposition.h

Go to the documentation of this file.

/***************************************************************************
                              qgscomposition.h
                             -------------------
    begin                : January 2005
    copyright            : (C) 2005 by Radim Blazek
    email                : [email protected]
 ***************************************************************************/
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSCOMPOSITION_H
#define QGSCOMPOSITION_H

#include <QDomDocument>
#include <QGraphicsScene>
#include <QLinkedList>
#include <QUndoStack>

#include "qgscomposeritemcommand.h"
#include "qgsaddremoveitemcommand.h"

class QgsComposerItem;
class QgsComposerMap;
class QgsPaperItem;
class QGraphicsRectItem;
class QgsMapRenderer;
class QDomElement;
class QgsComposerArrow;
class QgsComposerItem;
class QgsComposerLabel;
class QgsComposerLegend;
class QgsComposerMap;
class QgsComposerPicture;
class QgsComposerScaleBar;
class QgsComposerShape;
class QgsComposerAttributeTable;

class CORE_EXPORT QgsComposition: public QGraphicsScene
{
    Q_OBJECT
  public:

    enum PlotStyle
    {
      Preview = 0, // Use cache etc
      Print,       // Render well
      Postscript   // Fonts need different scaling!
    };

    enum GridStyle
    {
      Solid,
      Dots,
      Crosses
    };

    QgsComposition( QgsMapRenderer* mapRenderer );
    ~QgsComposition();

    void setPaperSize( double width, double height );

    double paperHeight() const;

    double paperWidth() const;

    void setSnapToGridEnabled( bool b );
    bool snapToGridEnabled() const {return mSnapToGrid;}

    void setSnapGridResolution( double r );
    double snapGridResolution() const {return mSnapGridResolution;}

    void setSnapGridOffsetX( double offset );
    double snapGridOffsetX() const {return mSnapGridOffsetX;}

    void setSnapGridOffsetY( double offset );
    double snapGridOffsetY() const {return mSnapGridOffsetY;}

    void setGridPen( const QPen& p );
    const QPen& gridPen() const {return mGridPen;}

    void setGridStyle( GridStyle s );
    GridStyle gridStyle() const {return mGridStyle;}

    QUndoStack* undoStack() { return &mUndoStack; }

    QgsComposerItem* composerItemAt( const QPointF & position );

    QList<QgsComposerItem*> selectedComposerItems();

    QList<const QgsComposerMap*> composerMapItems() const;

    const QgsComposerMap* getComposerMapById( int id ) const;

    int printResolution() const {return mPrintResolution;}
    void setPrintResolution( int dpi ) {mPrintResolution = dpi;}

    bool printAsRaster() const {return mPrintAsRaster;}
    void setPrintAsRaster( bool enabled ) { mPrintAsRaster = enabled; }

    double selectionTolerance() const { return mSelectionTolerance; }
    void setSelectionTolerance( double tol );

    QgsMapRenderer* mapRenderer() {return mMapRenderer;}

    QgsComposition::PlotStyle plotStyle() const {return mPlotStyle;}
    void setPlotStyle( QgsComposition::PlotStyle style ) {mPlotStyle = style;}

    int pixelFontSize( double pointSize ) const;

    double pointFontSize( int pixelSize ) const;

    bool writeXML( QDomElement& composerElem, QDomDocument& doc );

    bool readXML( const QDomElement& compositionElem, const QDomDocument& doc );

    void addItemsFromXML( const QDomElement& elem, const QDomDocument& doc, QMap< QgsComposerMap*, int >* mapsToRestore = 0,
                          bool addUndoCommands = false, QPointF* pos = 0 );

    void addItemToZList( QgsComposerItem* item );
    void removeItemFromZList( QgsComposerItem* item );

    //functions to move selected items in hierarchy
    void raiseSelectedItems();
    void raiseItem( QgsComposerItem* item );
    void lowerSelectedItems();
    void lowerItem( QgsComposerItem* item );
    void moveSelectedItemsToTop();
    void moveItemToTop( QgsComposerItem* item );
    void moveSelectedItemsToBottom();
    void moveItemToBottom( QgsComposerItem* item );

    //functions to align selected items
    void alignSelectedItemsLeft();
    void alignSelectedItemsHCenter();
    void alignSelectedItemsRight();
    void alignSelectedItemsTop();
    void alignSelectedItemsVCenter();
    void alignSelectedItemsBottom();

    void sortZList();

    QPointF snapPointToGrid( const QPointF& scenePoint ) const;

    void beginCommand( QgsComposerItem* item, const QString& commandText, QgsComposerMergeCommand::Context c = QgsComposerMergeCommand::Unknown );

    void endCommand();
    void cancelCommand();

    void addComposerArrow( QgsComposerArrow* arrow );
    void addComposerLabel( QgsComposerLabel* label );
    void addComposerMap( QgsComposerMap* map, bool setDefaultPreviewStyle = true );
    void addComposerScaleBar( QgsComposerScaleBar* scaleBar );
    void addComposerLegend( QgsComposerLegend* legend );
    void addComposerPicture( QgsComposerPicture* picture );
    void addComposerShape( QgsComposerShape* shape );
    void addComposerTable( QgsComposerAttributeTable* table );

    void removeComposerItem( QgsComposerItem* item );

    void pushAddRemoveCommand( QgsComposerItem* item, const QString& text, QgsAddRemoveItemCommand::State state = QgsAddRemoveItemCommand::Added );

  public slots:
    void sendItemAddedSignal( QgsComposerItem* item );

  private:
    QgsMapRenderer* mMapRenderer;
    QgsComposition::PlotStyle mPlotStyle;
    QgsPaperItem* mPaperItem;

    QLinkedList<QgsComposerItem*> mItemZList;

    int mPrintResolution;

    bool mPrintAsRaster;

    double mSelectionTolerance;

    bool mSnapToGrid;
    double mSnapGridResolution;
    double mSnapGridOffsetX;
    double mSnapGridOffsetY;
    QPen mGridPen;
    GridStyle mGridStyle;

    QUndoStack mUndoStack;

    QgsComposerItemCommand* mActiveCommand;

    QgsComposition(); //default constructor is forbidden

    void updateZValues();

    int boundingRectOfSelectedItems( QRectF& bRect );

    void loadSettings();
    void saveSettings();

    void connectAddRemoveCommandSignals( QgsAddRemoveItemCommand* c );

  signals:
    void paperSizeChanged();

    void selectedItemChanged( QgsComposerItem* selected );
    void composerArrowAdded( QgsComposerArrow* arrow );
    void composerLabelAdded( QgsComposerLabel* label );
    void composerMapAdded( QgsComposerMap* map );
    void composerScaleBarAdded( QgsComposerScaleBar* scalebar );
    void composerLegendAdded( QgsComposerLegend* legend );
    void composerPictureAdded( QgsComposerPicture* picture );
    void composerShapeAdded( QgsComposerShape* shape );
    void composerTableAdded( QgsComposerAttributeTable* table );
    void itemRemoved( QgsComposerItem* );
};

#endif