Layouts have a name

qgis · Jul 18, 2017 · a6156d9 · a6156d9
1 parent ab79b15
commit a6156d9
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 0 deletions.
diff --git a/python/core/layout/qgslayout.sip b/python/core/layout/qgslayout.sip
@@ -26,6 +26,19 @@ class QgsLayout : QGraphicsScene
 
     QgsLayout();
 
+    QString name() const;
+%Docstring
+ Returns the layout's name.
+.. seealso:: setName()
+ :rtype: str
+%End
+
+    void setName( const QString &name );
+%Docstring
+ Sets the layout's name.
+.. seealso:: name()
+%End
+
     void setUnits( QgsUnitTypes::LayoutUnit units );
 %Docstring
  Sets the native measurement ``units`` for the layout. These also form the default unit

diff --git a/src/core/layout/qgslayout.h b/src/core/layout/qgslayout.h
@@ -40,6 +40,18 @@ class CORE_EXPORT QgsLayout : public QGraphicsScene
 
     QgsLayout();
 
+    /**
+     * Returns the layout's name.
+     * \see setName()
+     */
+    QString name() const { return mName; }
+
+    /**
+     * Sets the layout's name.
+     * \see name()
+     */
+    void setName( const QString &name ) { mName = name; }
+
     /**
      * Sets the native measurement \a units for the layout. These also form the default unit
      * for measurements for the layout.
@@ -117,6 +129,8 @@ class CORE_EXPORT QgsLayout : public QGraphicsScene
 
   private:
 
+    QString mName;
+
     QgsUnitTypes::LayoutUnit mUnits = QgsUnitTypes::LayoutMillimeters;
     QgsLayoutContext mContext;
 

diff --git a/tests/src/core/testqgslayout.cpp b/tests/src/core/testqgslayout.cpp
@@ -29,6 +29,7 @@ class TestQgsLayout: public QObject
     void cleanup();// will be called after every testfunction.
     void creation(); //test creation of QgsLayout
     void units();
+    void name();
 
   private:
     QString mReport;
@@ -117,6 +118,14 @@ void TestQgsLayout::units()
   QCOMPARE( pointResult.y(), 2.0 );
 }
 
+void TestQgsLayout::name()
+{
+  QgsLayout layout;
+  QString layoutName = "test name";
+  layout.setName( layoutName );
+  QCOMPARE( layout.name(), layoutName );
+}
+
 
 QGSTEST_MAIN( TestQgsLayout )
 #include "testqgslayout.moc"