sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-12-16 00:06:09 -05:00
Code Issues Packages Projects Releases Wiki Activity

Expand documentation for QgsAuxiliaryStorage constructors

Browse Source
This commit is contained in:
Blottiere Paul 2017-08-30 08:42:19 +01:00
parent 05eeb87cda
commit ae09135926
2 changed files with 40 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
python/core/qgsauxiliarystorage.sip
View File

@ -184,6 +184,11 @@ class QgsAuxiliaryStorage
%Docstring %Docstring
Constructor. Constructor.
The project filename is used to build a database path at the same
location, but with a different extension. Then, it's the same logic as
.. seealso:: QgsAuxiliaryStorage(const QString &, bool copy).
\param project The project for which the auxiliary storage has to be used \param project The project for which the auxiliary storage has to be used
\param copy Parameter indicating if a copy of the database has to be used \param copy Parameter indicating if a copy of the database has to be used
%End %End
@ -192,6 +197,21 @@ class QgsAuxiliaryStorage
%Docstring %Docstring
Constructor. Constructor.
If a valid database path is given in parameter and copy mode is
deactivated, then every changes is directly committed on the original
database. But if the copy mode is activated, then changes are committed
on a copy of the database (a temporary file) and a save action is
therefore necessary to keep modifications in the original file.
If an empty string for the database path is given in parameter, then
a database is created in a temporary file whatever the copy mode.
If the database path given in parameter is not empty but does not exist,
then a database is created at this location when copy mode is
deactivated. When copy mode is activated, a temporary database is used
instead and a save action will be necessary to create the database at
the original location given in parameter.
\param filename The path of the database \param filename The path of the database
\param copy Parameter indicating if a copy of the database has to be used \param copy Parameter indicating if a copy of the database has to be used
%End %End

20
src/core/qgsauxiliarystorage.h
View File

@ -206,6 +206,11 @@ class CORE_EXPORT QgsAuxiliaryStorage
/** /**
* Constructor. * Constructor.
* *
* The project filename is used to build a database path at the same
* location, but with a different extension. Then, it's the same logic as
* described for \see QgsAuxiliaryStorage(const QString &, bool copy).
*
*
* \param project The project for which the auxiliary storage has to be used * \param project The project for which the auxiliary storage has to be used
* \param copy Parameter indicating if a copy of the database has to be used * \param copy Parameter indicating if a copy of the database has to be used
*/ */
@ -214,6 +219,21 @@ class CORE_EXPORT QgsAuxiliaryStorage
/** /**
* Constructor. * Constructor.
* *
* If a valid database path is given in parameter and copy mode is
* deactivated, then every changes is directly committed on the original
* database. But if the copy mode is activated, then changes are committed
* on a copy of the database (a temporary file) and a save action is
* therefore necessary to keep modifications in the original file.
*
* If an empty string for the database path is given in parameter, then
* a database is created in a temporary file whatever the copy mode.
*
* If the database path given in parameter is not empty but does not exist,
* then a database is created at this location when copy mode is
* deactivated. When copy mode is activated, a temporary database is used
* instead and a save action will be necessary to create the database at
* the original location given in parameter.
*
* \param filename The path of the database * \param filename The path of the database
* \param copy Parameter indicating if a copy of the database has to be used * \param copy Parameter indicating if a copy of the database has to be used
*/ */