QgsReadWriteContext class

The class is used as a container of context for various read/write operations on other objects.

Reference

Public types

struct ReadWriteMessage: Struct for QgsReadWriteContext error or warning messages.

Constructors, destructors, conversion operators

QgsReadWriteContext(): Constructor for QgsReadWriteContext.

Public functions

auto enterCategory(const QString& category, const QString& details = QString()) -> MAYBE_UNUSED NODISCARD QgsReadWriteContextCategoryPopper: Push a category to the stack.
auto pathResolver() const -> const QgsPathResolver&: Returns path resolver for conversion between relative and absolute paths.
auto projectTranslator() const -> const QgsProjectTranslator*: Returns the project translator.
void pushMessage(const QString& message, Qgis::MessageLevel level = Qgis::Warning): Append a message to the context.
void setPathResolver(const QgsPathResolver& resolver): Sets up path resolver for conversion between relative and absolute paths.
void setProjectTranslator(QgsProjectTranslator* projectTranslator): Sets the project translator.
auto takeMessages() -> QList<QgsReadWriteContext::ReadWriteMessage>: Returns the stored messages and remove them.

Function documentation

MAYBE_UNUSED NODISCARD QgsReadWriteContextCategoryPopper QgsReadWriteContext::enterCategory(const QString& category, const QString& details = QString())

Push a category to the stack.

Note

The return value should always be used so category can be automatically left.

It is not aimed at being used in Python. Instead use the context manager.

context = QgsReadWriteContext()
with QgsReadWriteContext.enterCategory(context, category, details):
  # do something

const QgsProjectTranslator* QgsReadWriteContext::projectTranslator() const

Returns the project translator.

void QgsReadWriteContext::pushMessage(const QString& message, Qgis::MessageLevel level = Qgis::Warning)

Append a message to the context.

void QgsReadWriteContext::setProjectTranslator(QgsProjectTranslator* projectTranslator)

Sets the project translator.

Means it shouldn't conform mDefaultTranslator anymore. It's usually the QgsProject where the function with the context is made and won't be changed anymore.

QList<QgsReadWriteContext::ReadWriteMessage> QgsReadWriteContext::takeMessages()

Returns the stored messages and remove them.