Class: QgsScrollBarHighlight¶

Encapsulates the details of a highlight in a scrollbar, used alongside QgsScrollBarHighlightController.

Added in version 3.38.

Enums

Priority

Priority, which dictates how overlapping highlights are rendered

Attributes

`category`	Category ID
`color`	Highlight color
`position`	Position in scroll bar
`priority`	Priority, which dictates how overlapping highlights are rendered

class qgis.gui.QgsScrollBarHighlight[source]¶

Bases: object

__init__(category: int, position: int, color: QColor | Qt.GlobalColor, priority: QgsScrollBarHighlight.Priority = QgsScrollBarHighlight.Priority.NormalPriority)

Constructor for QgsScrollBarHighlight.

Parameters:

category (int)
position (int)
color (Union[QColor, Qt.GlobalColor])
priority (QgsScrollBarHighlight.Priority = QgsScrollBarHighlight.Priority.NormalPriority)

__init__()

__init__(a0: QgsScrollBarHighlight)

Parameters:: a0 (QgsScrollBarHighlight)

class Priority(*values)¶

Bases: IntEnum

Priority, which dictates how overlapping highlights are rendered

Invalid: Invalid
LowPriority: Low priority, rendered below all other highlights
NormalPriority: Normal priority
HighPriority: High priority
HighestPriority: Highest priority, rendered above all other highlights

HighPriority = 2¶

HighestPriority = 3¶

Invalid = -1¶

LowPriority = 0¶

NormalPriority = 1¶

category: int¶: Category ID

color: QColor¶: Highlight color

position: int¶: Position in scroll bar

priority: QgsScrollBarHighlight.Priority¶: Priority, which dictates how overlapping highlights are rendered