Add QgsProject::write( filename ) convenience function

qgis · Dec 21, 2016 · cbac49b · cbac49b
1 parent 4644af3
commit cbac49b
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/python/core/qgsproject.sip b/python/core/qgsproject.sip
@@ -144,6 +144,7 @@ class QgsProject : QObject, QgsExpressionContextGenerator
      *
      */
     bool read( QDomNode& layerNode );
+    bool write(const QString& filename);
 
     /** Writes the project to a file.
      * @param file destination file

diff --git a/src/core/qgsproject.cpp b/src/core/qgsproject.cpp
@@ -1147,6 +1147,13 @@ bool QgsProject::read( QDomNode &layerNode )
   return false;
 }
 
+bool QgsProject::write( const QString& filename )
+{
+  mFile.setFileName( filename );
+
+  return write();
+}
+
 bool QgsProject::write( QFileInfo const &file )
 {
   mFile.setFileName( file.filePath() );

diff --git a/src/core/qgsproject.h b/src/core/qgsproject.h
@@ -205,6 +205,17 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
      */
     bool read( QDomNode& layerNode );
 
+    /**
+     * Writes the project to a file.
+     * @param file destination file
+     * @note calling this implicitly sets the project's filename (see setFileName() )
+     * @note isDirty() will be set to false if project is successfully written
+     * @returns true if project was written successfully
+     *
+     * \note Added in QGIS 3.0
+     */
+    bool write( const QString& filename );
+
     /** Writes the project to a file.
      * @param file destination file
      * @note calling this implicitly sets the project's filename (see setFileName() )