mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-24 00:47:57 -05:00
50408edac6
We should be using the new name for the enum value instead of the old one in the enum class docstring. Move the old compatible name to an extra note "Available as ``xx.yy`` in older QGIS releases." Fixes #49171
104 lines
4.2 KiB
Python
104 lines
4.2 KiB
Python
# The following has been generated automatically from src/core/symbology/qgsstylemodel.h
|
|
QgsStyleModel.Role = QgsStyleModel.CustomRole
|
|
# monkey patching scoped based enum
|
|
QgsStyleModel.TypeRole = QgsStyleModel.CustomRole.Type
|
|
QgsStyleModel.Role.TypeRole = QgsStyleModel.CustomRole.Type
|
|
QgsStyleModel.TypeRole.is_monkey_patched = True
|
|
QgsStyleModel.TypeRole.__doc__ = "Style entity type, see QgsStyle.StyleEntity"
|
|
QgsStyleModel.TagRole = QgsStyleModel.CustomRole.Tag
|
|
QgsStyleModel.Role.TagRole = QgsStyleModel.CustomRole.Tag
|
|
QgsStyleModel.TagRole.is_monkey_patched = True
|
|
QgsStyleModel.TagRole.__doc__ = "String list of tags"
|
|
QgsStyleModel.EntityName = QgsStyleModel.CustomRole.EntityName
|
|
QgsStyleModel.EntityName.is_monkey_patched = True
|
|
QgsStyleModel.EntityName.__doc__ = "Entity name \n.. versionadded:: 3.26"
|
|
QgsStyleModel.SymbolTypeRole = QgsStyleModel.CustomRole.SymbolType
|
|
QgsStyleModel.Role.SymbolTypeRole = QgsStyleModel.CustomRole.SymbolType
|
|
QgsStyleModel.SymbolTypeRole.is_monkey_patched = True
|
|
QgsStyleModel.SymbolTypeRole.__doc__ = "Symbol type (for symbol or legend patch shape entities)"
|
|
QgsStyleModel.IsFavoriteRole = QgsStyleModel.CustomRole.IsFavorite
|
|
QgsStyleModel.Role.IsFavoriteRole = QgsStyleModel.CustomRole.IsFavorite
|
|
QgsStyleModel.IsFavoriteRole.is_monkey_patched = True
|
|
QgsStyleModel.IsFavoriteRole.__doc__ = "Whether entity is flagged as a favorite"
|
|
QgsStyleModel.LayerTypeRole = QgsStyleModel.CustomRole.LayerType
|
|
QgsStyleModel.Role.LayerTypeRole = QgsStyleModel.CustomRole.LayerType
|
|
QgsStyleModel.LayerTypeRole.is_monkey_patched = True
|
|
QgsStyleModel.LayerTypeRole.__doc__ = "Layer type (for label settings entities)"
|
|
QgsStyleModel.CompatibleGeometryTypesRole = QgsStyleModel.CustomRole.CompatibleGeometryTypes
|
|
QgsStyleModel.Role.CompatibleGeometryTypesRole = QgsStyleModel.CustomRole.CompatibleGeometryTypes
|
|
QgsStyleModel.CompatibleGeometryTypesRole.is_monkey_patched = True
|
|
QgsStyleModel.CompatibleGeometryTypesRole.__doc__ = "Compatible layer geometry types (for 3D symbols)"
|
|
QgsStyleModel.StyleName = QgsStyleModel.CustomRole.StyleName
|
|
QgsStyleModel.StyleName.is_monkey_patched = True
|
|
QgsStyleModel.StyleName.__doc__ = "Name of associated QgsStyle (QgsStyle.name()) \n.. versionadded:: 3.26"
|
|
QgsStyleModel.StyleFileName = QgsStyleModel.CustomRole.StyleFileName
|
|
QgsStyleModel.StyleFileName.is_monkey_patched = True
|
|
QgsStyleModel.StyleFileName.__doc__ = "File name of associated QgsStyle (QgsStyle.fileName()) \n.. versionadded:: 3.26"
|
|
QgsStyleModel.IsTitleRole = QgsStyleModel.CustomRole.IsTitle
|
|
QgsStyleModel.Role.IsTitleRole = QgsStyleModel.CustomRole.IsTitle
|
|
QgsStyleModel.IsTitleRole.is_monkey_patched = True
|
|
QgsStyleModel.IsTitleRole.__doc__ = "True if the index corresponds to a title item \n.. versionadded:: 3.26"
|
|
QgsStyleModel.CustomRole.__doc__ = """Custom model roles.
|
|
|
|
.. note::
|
|
|
|
Prior to QGIS 3.36 this was available as QgsStyleModel.Role
|
|
|
|
.. versionadded:: 3.36
|
|
|
|
* ``Type``: Style entity type, see QgsStyle.StyleEntity
|
|
|
|
Available as ``QgsStyleModel.TypeRole`` in older QGIS releases.
|
|
|
|
* ``Tag``: String list of tags
|
|
|
|
Available as ``QgsStyleModel.TagRole`` in older QGIS releases.
|
|
|
|
* ``EntityName``: Entity name
|
|
|
|
.. versionadded:: 3.26
|
|
|
|
* ``SymbolType``: Symbol type (for symbol or legend patch shape entities)
|
|
|
|
Available as ``QgsStyleModel.SymbolTypeRole`` in older QGIS releases.
|
|
|
|
* ``IsFavorite``: Whether entity is flagged as a favorite
|
|
|
|
Available as ``QgsStyleModel.IsFavoriteRole`` in older QGIS releases.
|
|
|
|
* ``LayerType``: Layer type (for label settings entities)
|
|
|
|
Available as ``QgsStyleModel.LayerTypeRole`` in older QGIS releases.
|
|
|
|
* ``CompatibleGeometryTypes``: Compatible layer geometry types (for 3D symbols)
|
|
|
|
Available as ``QgsStyleModel.CompatibleGeometryTypesRole`` in older QGIS releases.
|
|
|
|
* ``StyleName``: Name of associated QgsStyle (QgsStyle.name())
|
|
|
|
.. versionadded:: 3.26
|
|
|
|
* ``StyleFileName``: File name of associated QgsStyle (QgsStyle.fileName())
|
|
|
|
.. versionadded:: 3.26
|
|
|
|
* ``IsTitle``: True if the index corresponds to a title item
|
|
|
|
.. versionadded:: 3.26
|
|
|
|
|
|
Available as ``QgsStyleModel.IsTitleRole`` in older QGIS releases.
|
|
|
|
|
|
"""
|
|
# --
|
|
QgsStyleModel.CustomRole.baseClass = QgsStyleModel
|
|
try:
|
|
QgsStyleModel.__group__ = ['symbology']
|
|
except NameError:
|
|
pass
|
|
try:
|
|
QgsStyleProxyModel.__group__ = ['symbology']
|
|
except NameError:
|
|
pass
|