mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-25 00:58:06 -05:00
1c615c15cc
Use Qt style "returns .." tense instead of "return ..", and lock this in with a documentation compliance unit test
133 lines
3.4 KiB
Plaintext
133 lines
3.4 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsreadwritecontext.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
class QgsReadWriteContext
|
|
{
|
|
%Docstring
|
|
The class is used as a container of context for various read/write operations on other objects.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsreadwritecontext.h"
|
|
%End
|
|
public:
|
|
|
|
struct ReadWriteMessage
|
|
{
|
|
ReadWriteMessage( const QString &message, Qgis::MessageLevel level = Qgis::Warning, const QStringList &categories = QStringList() );
|
|
%Docstring
|
|
Construct a container for QgsReadWriteContext error or warning messages
|
|
%End
|
|
|
|
QString message() const;
|
|
%Docstring
|
|
Returns the message string
|
|
%End
|
|
|
|
Qgis::MessageLevel level() const;
|
|
%Docstring
|
|
Returns the message level
|
|
%End
|
|
|
|
QStringList categories() const;
|
|
%Docstring
|
|
Returns the stack of categories of the message
|
|
%End
|
|
|
|
};
|
|
|
|
QgsReadWriteContext();
|
|
%Docstring
|
|
Constructor for QgsReadWriteContext.
|
|
%End
|
|
|
|
~QgsReadWriteContext();
|
|
|
|
const QgsPathResolver &pathResolver() const;
|
|
%Docstring
|
|
Returns path resolver for conversion between relative and absolute paths
|
|
%End
|
|
|
|
void setPathResolver( const QgsPathResolver &resolver );
|
|
%Docstring
|
|
Sets up path resolver for conversion between relative and absolute paths
|
|
%End
|
|
|
|
void pushMessage( const QString &message, Qgis::MessageLevel level = Qgis::Warning );
|
|
%Docstring
|
|
Append a message to the context
|
|
|
|
.. versionadded:: 3.2
|
|
%End
|
|
|
|
QgsReadWriteContextCategoryPopper enterCategory( const QString &category, const QString &details = QString() ) /PyName=_enterCategory/;
|
|
%Docstring
|
|
Push a category to the stack
|
|
|
|
.. note::
|
|
|
|
The return value should always be used so category can be automatically left.
|
|
|
|
.. note::
|
|
|
|
It is not aimed at being used in Python. Instead use the context manager.
|
|
.. code-block:: python
|
|
|
|
context = QgsReadWriteContext()
|
|
with QgsReadWriteContext.enterCategory(context, category, details):
|
|
# do something
|
|
|
|
.. versionadded:: 3.2
|
|
%End
|
|
|
|
QList<QgsReadWriteContext::ReadWriteMessage> takeMessages();
|
|
%Docstring
|
|
Returns the stored messages and remove them
|
|
|
|
.. versionadded:: 3.2
|
|
%End
|
|
|
|
|
|
};
|
|
|
|
|
|
class QgsReadWriteContextCategoryPopper
|
|
{
|
|
%Docstring
|
|
Allows entering a context category and takes care of
|
|
leaving this category on deletion of the class.
|
|
This would happen when it gets out of scope.
|
|
|
|
.. versionadded:: 3.2
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsreadwritecontext.h"
|
|
%End
|
|
public:
|
|
QgsReadWriteContextCategoryPopper( QgsReadWriteContext &context );
|
|
%Docstring
|
|
Creates a popper
|
|
%End
|
|
~QgsReadWriteContextCategoryPopper();
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsreadwritecontext.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|