Merge pull request #5837 from nyalldawson/layout_next

Layout raster image exports

images/images.qrc

@@ -617,6 +617,7 @@
         <file>themes/default/mIconQgsProjectFile.svg</file>
         <file>themes/default/mIconPythonFile.svg</file>
         <file>themes/default/mIconQptFile.svg</file>
+        <file>themes/default/mActionNewPage.svg</file>
     </qresource>
     <qresource prefix="/images/tips">
         <file alias="symbol_levels.png">qgis_tips/symbol_levels.png</file>

images/themes/default/mActionNewPage.svg

@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   height="24"
+   width="24"
+   version="1.1"
+   id="svg8"
+   sodipodi:docname="mActionNewPage.svg"
+   inkscape:version="0.92.2 (5c3e80d, 2017-08-06)">
+  <metadata
+     id="metadata14">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <defs
+     id="defs12" />
+  <sodipodi:namedview
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1"
+     objecttolerance="10"
+     gridtolerance="10"
+     guidetolerance="10"
+     inkscape:pageopacity="0"
+     inkscape:pageshadow="2"
+     inkscape:window-width="1920"
+     inkscape:window-height="1016"
+     id="namedview10"
+     showgrid="false"
+     inkscape:zoom="9.8333333"
+     inkscape:cx="23.59322"
+     inkscape:cy="4.0677966"
+     inkscape:window-x="0"
+     inkscape:window-y="27"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="svg8" />
+  <g
+     fill-rule="evenodd"
+     stroke="#727272"
+     stroke-linejoin="round"
+     transform="translate(0 -1028.3622)"
+     id="g6">
+    <path
+       d="m4.5 1050.8618v-21h10l5 5v16.0004z"
+       fill="#fff"
+       id="path2" />
+    <path
+       d="m14.5 1029.8618v5h5z"
+       fill="#f0f0f0"
+       id="path4" />
+  </g>
+  <g
+     id="g16"
+     transform="translate(33)">
+    <rect
+       style="fill:#c4a000"
+       id="rect10"
+       y="13"
+       x="-20"
+       width="11"
+       rx="2.0114901"
+       height="11" />
+    <path
+       style="fill:#fcffff"
+       inkscape:connector-curvature="0"
+       id="path12"
+       d="m -15,14 v 2.0625 c -0.537663,0.111041 -1.024662,0.383291 -1.375,0.78125 l -1.78125,-1.03125 -0.5,0.875 1.78125,1.03125 C -16.957063,17.966182 -17,18.225145 -17,18.5 c 0,0.274855 0.04294,0.533818 0.125,0.78125 l -1.78125,1.03125 0.5,0.875 1.78125,-1.03125 c 0.352503,0.40042 0.832682,0.670182 1.375,0.78125 V 23 h 1 v -2.0625 c 0.537663,-0.111041 1.024662,-0.383291 1.375,-0.78125 l 1.78125,1.03125 0.5,-0.875 -1.78125,-1.03125 C -12.042937,19.033818 -12,18.774855 -12,18.5 c 0,-0.274855 -0.04294,-0.533818 -0.125,-0.78125 l 1.78125,-1.03125 -0.5,-0.875 -1.78125,1.03125 C -12.977503,16.44333 -13.457682,16.173568 -14,16.0625 V 14 Z m 0.5,3.5 c 0.552,0 1,0.448 1,1 0,0.552 -0.448,1 -1,1 -0.552,0 -1,-0.448 -1,-1 0,-0.552 0.448,-1 1,-1 z" />
+    <path
+       style="opacity:0.3;fill:#fcffff;fill-rule:evenodd"
+       inkscape:connector-curvature="0"
+       id="path14"
+       d="m -19,19 9,-0.0096 c 0,0 0,0 0,-2 C -10,14 -11,14 -14.5,14 c -3.5,0 -4.5,0 -4.5,3 0,2 0,2 0,2 z" />
+  </g>
+</svg>

python/core/layout/qgslayout.sip

@@ -13,6 +13,12 @@ class QgsLayout : QGraphicsScene, QgsExpressionContextGenerator, QgsLayoutUndoOb
 %Docstring
  Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
 
+While the raw QGraphicsScene API can be used to render the contents of a QgsLayout
+to a QPainter, it is recommended to instead use a QgsLayoutExporter to handle rendering
+layouts instead. QgsLayoutExporter automatically takes care of the intracacies of
+preparing the layout and paint devices for correct exports, respecting various
+user settings such as the layout context DPI.
+
 .. versionadded:: 3.0
 %End
 
@@ -33,6 +39,12 @@ class QgsLayout : QGraphicsScene, QgsExpressionContextGenerator, QgsLayoutUndoOb
       ZSnapIndicator,
     };
 
+    enum UndoCommand
+    {
+      UndoLayoutDpi,
+      UndoNone,
+    };
+
     QgsLayout( QgsProject *project );
 %Docstring
 Construct a new layout linked to the specified ``project``.
@@ -66,12 +78,6 @@ relations and various other bits. It is never null.
     QgsLayoutModel *itemsModel();
 %Docstring
 Returns the items model attached to the layout.
-%End
-
-    QgsLayoutExporter &exporter();
-%Docstring
-Returns the layout's exporter, which is used for rendering the layout and exporting
-to various formats.
 %End
 
     QString name() const;
@@ -176,7 +182,7 @@ z order list. This should be called after any stacking changes
 which deferred z-order updates.
 %End
 
-    QgsLayoutItem *itemByUuid( const QString &uuid, bool includeTemplateUuids = false );
+    QgsLayoutItem *itemByUuid( const QString &uuid, bool includeTemplateUuids = false ) const;
 %Docstring
 Returns the layout item with matching ``uuid`` unique identifier, or a None
 if a matching item could not be found.
@@ -381,8 +387,25 @@ Return list of keys stored in custom properties for the layout.
 %End
 
     QgsLayoutItemMap *referenceMap() const;
+%Docstring
+Returns the map item which will be used to generate corresponding world files when the
+layout is exported. If no map was explicitly set via setReferenceMap(), the largest
+map in the layout will be returned (or None if there are no maps in the layout).
+
+.. seealso:: :py:func:`setReferenceMap()`
+
+.. seealso:: :py:func:`generateWorldFile()`
+%End
 
     void setReferenceMap( QgsLayoutItemMap *map );
+%Docstring
+Sets the ``map`` item which will be used to generate corresponding world files when the
+layout is exported.
+
+.. seealso:: :py:func:`referenceMap()`
+
+.. seealso:: :py:func:`setGenerateWorldFile()`
+%End
 
     QgsLayoutPageCollection *pageCollection();
 %Docstring
@@ -400,6 +423,20 @@ and other cosmetic items.
 :param margin: optional marginal (in percent, e.g., 0.05 = 5% ) to add around items
 
 :return: layout bounds, in layout units.
+
+.. seealso:: :py:func:`pageItemBounds()`
+%End
+
+    QRectF pageItemBounds( int page, bool visibleOnly = false ) const;
+%Docstring
+Returns the bounding box of the items contained on a specified ``page``.
+A page number of 0 represents the first page in the layout.
+
+Set ``visibleOnly`` to true to only include visible items.
+
+The returned bounds are in layout units.
+
+.. seealso:: :py:func:`layoutBounds()`
 %End
 
     void addLayoutItem( QgsLayoutItem *item /Transfer/ );
@@ -541,6 +578,13 @@ Updates the scene bounds of the layout.
 
   signals:
 
+    void changed();
+%Docstring
+Is emitted when properties of the layout change. This signal is only
+emitted for settings directly managed by the layout, and is not emitted
+when child items change.
+%End
+
     void variablesChanged();
 %Docstring
 Emitted whenever the expression variables stored in the layout have been changed.
@@ -567,9 +611,6 @@ Emitted when the layout's name is changed.
 
 };
 
-
-
-
 /************************************************************************
  * This file has been generated automatically from                      *
  *                                                                      *

python/core/layout/qgslayoutcontext.sip

@@ -27,6 +27,7 @@ class QgsLayoutContext : QObject
       FlagOutlineOnly,
       FlagAntialiasing,
       FlagUseAdvancedEffects,
+      FlagForceVectorOutput,
     };
     typedef QFlags<QgsLayoutContext::Flag> Flags;