Class: QgsReadWriteContext¶
- class qgis.core.QgsReadWriteContext¶
Bases:
sip.wrapper
The class is used as a container of context for various read/write operations on other objects.
New in version 3.0.
QgsReadWriteContext() Constructor for QgsReadWriteContext.
QgsReadWriteContext(
QgsReadWriteContext
)Methods
Returns path resolver for conversion between relative and absolute paths
Returns the project translator
Append a message to the context
Sets up path resolver for conversion between relative and absolute paths
Sets the project translator.
Sets data coordinate transform context to
transformContext
Returns the stored messages and remove them
Returns data provider coordinate transform context
- class ReadWriteMessage(message: str = '', level: Qgis.MessageLevel = Qgis.MessageLevel.Warning, categories: Iterable[str] = [])¶
Bases:
sip.wrapper
Construct a container for
QgsReadWriteContext
error or warning messagesQgsReadWriteContext.ReadWriteMessage(QgsReadWriteContext.ReadWriteMessage)
- categories(self) List[str] ¶
Returns the stack of categories of the message
- Return type
List[str]
- level(self) Qgis.MessageLevel ¶
Returns the message level
- Return type
- message(self) str ¶
Returns the message string
- Return type
str
- enterCategory¶
alias of
ReadWriteContextEnterCategory
- pathResolver(self) QgsPathResolver ¶
Returns path resolver for conversion between relative and absolute paths
- Return type
- projectTranslator(self) QgsProjectTranslator ¶
Returns the project translator
New in version 3.4.
- Return type
- pushMessage(self, message: str, level: Qgis.MessageLevel = Qgis.MessageLevel.Warning)¶
Append a message to the context
New in version 3.2.
- Parameters
message (str) –
level (Qgis.MessageLevel = Qgis.MessageLevel.Warning) –
- setPathResolver(self, resolver: QgsPathResolver)¶
Sets up path resolver for conversion between relative and absolute paths
- Parameters
resolver (QgsPathResolver) –
- setProjectTranslator(self, projectTranslator: QgsProjectTranslator)¶
Sets the project translator. It’s usually the
QgsProject
where the function with the context is made and won’t be changed anymore.New in version 3.4.
- Parameters
projectTranslator (QgsProjectTranslator) –
- setTransformContext(self, transformContext: QgsCoordinateTransformContext)¶
Sets data coordinate transform context to
transformContext
See also
New in version 3.8.
- Parameters
transformContext (QgsCoordinateTransformContext) –
- takeMessages(self) List[QgsReadWriteContext.ReadWriteMessage] ¶
Returns the stored messages and remove them
New in version 3.2.
- Return type
- transformContext(self) QgsCoordinateTransformContext ¶
Returns data provider coordinate transform context
See also
New in version 3.8.
- Return type