From a56c937012ce6d0197ecf93d3462856a5a75ff26 Mon Sep 17 00:00:00 2001 From: Nyall Dawson Date: Wed, 6 Dec 2017 18:55:43 +1000 Subject: [PATCH] Expand docs --- src/core/layout/qgslayout.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/core/layout/qgslayout.h b/src/core/layout/qgslayout.h index df21a602cb1..97f42ea5387 100644 --- a/src/core/layout/qgslayout.h +++ b/src/core/layout/qgslayout.h @@ -35,6 +35,13 @@ class QgsLayoutUndoStack; * \ingroup core * \class QgsLayout * \brief 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. + * * \since QGIS 3.0 */ class CORE_EXPORT QgsLayout : public QGraphicsScene, public QgsExpressionContextGenerator, public QgsLayoutUndoObjectInterface