AzQtComponents::ScrollBar Class Reference

Class to provide extra functionality for working with ScrollBar controls. More...

#include <ScrollBar.h>

Classes
struct	Config
	Style configuration for the ScrollBar class. More...

Public Types
enum class	ScrollBarMode { AlwaysShow = 0 , ShowOnHover }
	Enum used to determine the display mode of the ScrollBar. More...

Static Public Member Functions
static void	applyDarkStyle (QAbstractScrollArea *scrollArea)
static void	applyLightStyle (QAbstractScrollArea *scrollArea)
static Config	loadConfig (QSettings &settings)
static Config	defaultConfig ()
	Gets the default ScrollBar style configuration.
static void	setDisplayMode (QAbstractScrollArea *scrollArea, ScrollBarMode mode)
	Sets the ScrollBar display mode for the QAbstractScrollArea specified.

Friends
class	Style
class	AssetFolderThumbnailView
class	TableView
class	TreeView

Detailed Description

Class to provide extra functionality for working with ScrollBar controls.

Member Enumeration Documentation

ScrollBarMode

enum class AzQtComponents::ScrollBar::ScrollBarMode

strong

Enum used to determine the display mode of the ScrollBar.

Enumerator
AlwaysShow	Always shows scrollbars when content overflows (default).
ShowOnHover	Only show scrollbars when the parent widget is being hovered.

Member Function Documentation

applyDarkStyle()

static void AzQtComponents::ScrollBar::applyDarkStyle ( QAbstractScrollArea *  scrollArea )

static

Applies the qss classes to the QAbstractScrollArea to display the scrollbars in their dark style. Used to make the scrollbars visible in widgets with light backgrounds.

applyLightStyle()

static void AzQtComponents::ScrollBar::applyLightStyle ( QAbstractScrollArea *  scrollArea )

static

Resets the qss classes to the QAbstractScrollArea to display the scrollbars in their light style. This is the default styling, so it only needs to be called to revert to it after applyDarkStyle is used.

loadConfig()

static Config AzQtComponents::ScrollBar::loadConfig ( QSettings &  settings )

static

Sets the ScrollBar style configuration.

Parameters

settings

The settings object to load the configuration from.

Returns

The new configuration of the ScrollBar.

---

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

• Code/Framework/AzQtComponents/AzQtComponents/Components/Widgets/ScrollBar.h