Revert "Resolved merge conflicts when reverting 686f632"

This reverts commit a654e27.
qgis · Oct 4, 2012 · b5f736a · b5f736a
1 parent 45593bf
commit b5f736a
Show file tree

Hide file tree

Showing 3 changed files with 142 additions and 85 deletions.
diff --git a/python/core/composer/qgscomposition.sip b/python/core/composer/qgscomposition.sip
@@ -1,14 +1,41 @@
+/** \ingroup MapComposer
+ * Class used to render an Atlas, iterating over geometry features.
+ * prepareForFeature() modifies the atlas map's extent to zoom on the given feature.
+ * This class is used for printing, exporting to PDF and images.
+ * */
+class QgsAtlasRendering
+{
+  public:
+    QgsAtlasRendering( QgsComposition* composition );
+    ~QgsAtlasRendering();
+
+    /** Begins the rendering. Sets an optional output filename pattern */
+    void begin( const QString& filenamePattern = "" );
+    /** Ends the rendering. Restores original extent*/
+    void end();
+
+    /** Returns the number of features in the coverage layer */
+    size_t numFeatures() const;
+
+    /** Prepare the atlas map for the given feature. Sets the extent and context variables */
+    void prepareForFeature( size_t i );
+
+    /** Returns the current filename. Must be called after prepareForFeature( i ) */
+    const QString& currentFilename() const;
+};
+
 /** \ingroup MapComposer
  * Graphics scene for map printing. The class manages the paper item which always
  * is the item in the back (z-value 0). It maintains the z-Values of the items and stores
  * them in a list in ascending z-Order. This list can be changed to lower/raise items one position
  * or to bring them to front/back.
  * */
-class QgsComposition: QGraphicsScene
+class QgsComposition : QGraphicsScene
 {
 %TypeHeaderCode
 #include <qgscomposition.h>
 %End
+
   public:
 
     /** \brief Plot type */
@@ -67,20 +94,27 @@ class QgsComposition: QGraphicsScene
     /**Returns pointer to undo/redo command storage*/
     QUndoStack* undoStack();
 
-    /**Returns the topmose composer item. Ignores mPaperItem*/
+    /**Returns the topmost composer item. Ignores mPaperItem*/
     QgsComposerItem* composerItemAt( const QPointF & position );
 
+    /** Returns the page number (0-bsaed) given a coordinate */
+    int pageNumberAt( const QPointF& position ) const;
+
+    /** Returns on which page number (0-based) is displayed an item */
+    int itemPageNumber( const QgsComposerItem* ) const;
+
     QList<QgsComposerItem*> selectedComposerItems();
 
     /**Returns pointers to all composer maps in the scene*/
-    //todo: needs a new mapping for QList<const T*> ?
-    // QList<const QgsComposerMap*> composerMapItems() const;
+%If (QLISTCONSTPTR_CONVERSION)
+    QList<const QgsComposerMap*> composerMapItems() const;
+%End
 
     /**Return composer items of a specific type*/
     // template<class T> void composerItems( QList<T*>& itemList );
 
     /**Returns the composer map with specified id
-     @return id or 0 pointer if the composer map item does not exist*/
+     @return QgsComposerMap or 0 pointer if the composer map item does not exist*/
     const QgsComposerMap* getComposerMapById( int id ) const;
 
     /*Returns the composer html with specified id (a string as named in the
@@ -111,7 +145,10 @@ class QgsComposition: QGraphicsScene
     /**Returns pointer to map renderer of qgis map canvas*/
     QgsMapRenderer* mapRenderer();
 
-    QgsComposition::PlotStyle plotStyle();
+    QgsComposerMap* atlasMap();
+    void setAtlasMap( QgsComposerMap* map );
+
+    QgsComposition::PlotStyle plotStyle() const;
     void setPlotStyle( QgsComposition::PlotStyle style );
 
     /**Returns the pixel font size for a font that has point size set.
@@ -140,8 +177,13 @@ class QgsComposition: QGraphicsScene
       @param doc xml document
       @param mapsToRestore for reading from project file: set preview move 'rectangle' to all maps and save the preview states to show composer maps on demand
       @param addUndoCommands insert AddItem commands if true (e.g. for copy/paste)
-      @param pos item position. Optional, take position from xml if 0*/
-    //void addItemsFromXML( const QDomElement& elem, const QDomDocument& doc, QMap< QgsComposerMap*, int >* mapsToRestore, bool addUndoCommands = false, QPointF* pos = 0 );
+      @param pos item position. Optional, take position from xml if 0
+      @note not available in python bindings
+     */
+    /*
+    void addItemsFromXML( const QDomElement& elem, const QDomDocument& doc, QMap< QgsComposerMap*, int >* mapsToRestore = 0,
+                          bool addUndoCommands = false, QPointF* pos = 0 );
+    */
 
     /**Adds item to z list. Usually called from constructor of QgsComposerItem*/
     void addItemToZList( QgsComposerItem* item );
@@ -192,7 +234,7 @@ class QgsComposition: QGraphicsScene
     /**Removes multi frame (but does not delete it)*/
     void removeMultiFrame( QgsComposerMultiFrame* multiFrame );
     /**Adds an arrow item to the graphics scene and advices composer to create a widget for it (through signal)*/
-    //void addComposerArrow( QgsComposerArrow* arrow );
+    void addComposerArrow( QgsComposerArrow* arrow );
     /**Adds label to the graphics scene and advices composer to create a widget for it (through signal)*/
     void addComposerLabel( QgsComposerLabel* label );
     /**Adds map to the graphics scene and advices composer to create a widget for it (through signal)*/
@@ -219,10 +261,19 @@ class QgsComposition: QGraphicsScene
 
     //printing
 
-    void exportAsPDF( const QString& file );
+    /** Prepare the printer for printing */
+    void beginPrint( QPrinter& printer );
+    /** Prepare the printer for printing in a PDF */
+    void beginPrintAsPDF( QPrinter& printer, const QString& file );
+    /** Print on a preconfigured printer */
+    void doPrint( QPrinter& printer, QPainter& painter );
 
+    /** Convenience function that prepares the printer and prints */
     void print( QPrinter &printer );
 
+    /** Convenience function that prepares the printer for printing in PDF and prints */
+    void exportAsPDF( const QString& file );
+
     //! print composer page to image
     //! If the image does not fit into memory, a null image is returned
     QImage printPageAsRaster( int page );