QGIS API Documentation 3.41.0-Master (3440c17df1d)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsScrollBarHighlightController Class Reference

Adds highlights (colored markers) to a scrollbar. More...

#include <qgsdecoratedscrollbar.h>

Public Member Functions

 QgsScrollBarHighlightController ()
 
 ~QgsScrollBarHighlightController ()
 
void addHighlight (const QgsScrollBarHighlight &highlight)
 Adds a highlight to the scrollbar.
 
QHash< int, QVector< QgsScrollBarHighlight > > highlights () const
 Returns the hash of all highlights in the scrollbar, with highlight categories as hash keys.
 
double lineHeight () const
 Returns the line height for text associated with the scroll area.
 
double margin () const
 Returns the document margins for the associated viewport.
 
void removeAllHighlights ()
 Removes all highlights from the scroll bar.
 
void removeHighlights (int category)
 Removes all highlights with matching category from the scrollbar.
 
QAbstractScrollArea * scrollArea () const
 Returns the associated scroll area.
 
QScrollBar * scrollBar () const
 Returns the associated scroll bar.
 
void setLineHeight (double height)
 Sets the line height for text associated with the scroll area.
 
void setMargin (double margin)
 Sets the document margin for the associated viewport.
 
void setScrollArea (QAbstractScrollArea *scrollArea)
 Sets the associated scroll bar.
 
void setVisibleRange (double visibleRange)
 Sets the visible range of the scroll area (i.e.
 
double visibleRange () const
 Returns the visible range of the scroll area (i.e.
 

Detailed Description

Adds highlights (colored markers) to a scrollbar.

Since
QGIS 3.38

Definition at line 80 of file qgsdecoratedscrollbar.h.

Constructor & Destructor Documentation

◆ QgsScrollBarHighlightController()

QgsScrollBarHighlightController::QgsScrollBarHighlightController ( )
default

◆ ~QgsScrollBarHighlightController()

QgsScrollBarHighlightController::~QgsScrollBarHighlightController ( )

Definition at line 329 of file qgsdecoratedscrollbar.cpp.

Member Function Documentation

◆ addHighlight()

void QgsScrollBarHighlightController::addHighlight ( const QgsScrollBarHighlight highlight)

Adds a highlight to the scrollbar.

Definition at line 403 of file qgsdecoratedscrollbar.cpp.

◆ highlights()

QHash< int, QVector< QgsScrollBarHighlight > > QgsScrollBarHighlightController::highlights ( ) const

Returns the hash of all highlights in the scrollbar, with highlight categories as hash keys.

Note
Not available in Python bindings

Definition at line 398 of file qgsdecoratedscrollbar.cpp.

◆ lineHeight()

double QgsScrollBarHighlightController::lineHeight ( ) const

Returns the line height for text associated with the scroll area.

See also
setLineHeight()

Definition at line 368 of file qgsdecoratedscrollbar.cpp.

◆ margin()

double QgsScrollBarHighlightController::margin ( ) const

Returns the document margins for the associated viewport.

See also
setMargin()

Definition at line 388 of file qgsdecoratedscrollbar.cpp.

◆ removeAllHighlights()

void QgsScrollBarHighlightController::removeAllHighlights ( )

Removes all highlights from the scroll bar.

Definition at line 421 of file qgsdecoratedscrollbar.cpp.

◆ removeHighlights()

void QgsScrollBarHighlightController::removeHighlights ( int  category)

Removes all highlights with matching category from the scrollbar.

Definition at line 412 of file qgsdecoratedscrollbar.cpp.

◆ scrollArea()

QAbstractScrollArea * QgsScrollBarHighlightController::scrollArea ( ) const

Returns the associated scroll area.

See also
setScrollArea()

Definition at line 343 of file qgsdecoratedscrollbar.cpp.

◆ scrollBar()

QScrollBar * QgsScrollBarHighlightController::scrollBar ( ) const

Returns the associated scroll bar.

Definition at line 335 of file qgsdecoratedscrollbar.cpp.

◆ setLineHeight()

void QgsScrollBarHighlightController::setLineHeight ( double  height)

Sets the line height for text associated with the scroll area.

See also
lineHeight()

Definition at line 373 of file qgsdecoratedscrollbar.cpp.

◆ setMargin()

void QgsScrollBarHighlightController::setMargin ( double  margin)

Sets the document margin for the associated viewport.

See also
margin()

Definition at line 393 of file qgsdecoratedscrollbar.cpp.

◆ setScrollArea()

void QgsScrollBarHighlightController::setScrollArea ( QAbstractScrollArea *  scrollArea)

Sets the associated scroll bar.

See also
scrollArea()

Definition at line 348 of file qgsdecoratedscrollbar.cpp.

◆ setVisibleRange()

void QgsScrollBarHighlightController::setVisibleRange ( double  visibleRange)

Sets the visible range of the scroll area (i.e.

the viewport's height).

See also
visibleRange()

Definition at line 383 of file qgsdecoratedscrollbar.cpp.

◆ visibleRange()

double QgsScrollBarHighlightController::visibleRange ( ) const

Returns the visible range of the scroll area (i.e.

the viewport's height).

See also
setVisibleRange()

Definition at line 378 of file qgsdecoratedscrollbar.cpp.


The documentation for this class was generated from the following files: