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

#include <qgsdecoratedscrollbar.h>

Public Types
enum class	Priority : int { Invalid = -1 , LowPriority = 0 , NormalPriority = 1 , HighPriority = 2 , HighestPriority = 3 }
	Priority, which dictates how overlapping highlights are rendered. More...

Public Member Functions
	QgsScrollBarHighlight ()=default
	Default constructor for QgsScrollBarHighlight.

	QgsScrollBarHighlight (int category, int position, const QColor &color, QgsScrollBarHighlight::Priority priority=QgsScrollBarHighlight::Priority::NormalPriority)
	Constructor for QgsScrollBarHighlight.

Public Attributes
int	category = -1
	Category ID.

QColor	color
	Highlight color.

int	position = -1
	Position in scroll bar.

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

Detailed Description

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

Since: QGIS 3.38

Definition at line 39 of file qgsdecoratedscrollbar.h.

Member Enumeration Documentation

◆ Priority

enum class QgsScrollBarHighlight::Priority : int

strong

Priority, which dictates how overlapping highlights are rendered.

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

Definition at line 46 of file qgsdecoratedscrollbar.h.

Constructor & Destructor Documentation

◆ QgsScrollBarHighlight() [1/2]

PRIVATE QgsScrollBarHighlight::QgsScrollBarHighlight	(	int	category,
		int	position,
		const QColor &	color,
		QgsScrollBarHighlight::Priority	priority = `QgsScrollBarHighlight::Priority::NormalPriority`
	)

Constructor for QgsScrollBarHighlight.

Definition at line 312 of file qgsdecoratedscrollbar.cpp.

◆ QgsScrollBarHighlight() [2/2]

QgsScrollBarHighlight::QgsScrollBarHighlight ( )

default

Default constructor for QgsScrollBarHighlight.

Member Data Documentation

◆ category

int QgsScrollBarHighlight::category = -1

Category ID.

Definition at line 66 of file qgsdecoratedscrollbar.h.

◆ color

QColor QgsScrollBarHighlight::color

Highlight color.

Definition at line 72 of file qgsdecoratedscrollbar.h.

◆ position

int QgsScrollBarHighlight::position = -1

Position in scroll bar.

Definition at line 69 of file qgsdecoratedscrollbar.h.

◆ priority

QgsScrollBarHighlight::Priority QgsScrollBarHighlight::priority = QgsScrollBarHighlight::Priority::Invalid