Inheritance diagram for tgui::ScrollbarRenderer:

Public Member Functions
void	setTrackColor (Color color)
	Changes the color of the track.

TGUI_NODISCARD Color	getTrackColor () const
	Returns the color of the track.

void	setTrackColorHover (Color color)
	Changes the color of the track in hover state (when the mouse is on top of it)

TGUI_NODISCARD Color	getTrackColorHover () const
	Returns the color of the track in hover state (when the mouse is on top of it)

void	setThumbColor (Color color)
	Changes the color of the thumb.

TGUI_NODISCARD Color	getThumbColor () const
	Returns the color of the thumb.

void	setThumbColorHover (Color color)
	Changes the color of the thumb in hover state (when the mouse is on top of it)

TGUI_NODISCARD Color	getThumbColorHover () const
	Returns the color of the thumb in hover state (when the mouse is on top of it)

void	setArrowBackgroundColor (Color color)
	Changes the color behind the arrow.

TGUI_NODISCARD Color	getArrowBackgroundColor () const
	Returns the color behind the arrow.

void	setArrowBackgroundColorHover (Color color)
	Changes the color behind the arrow in hover state (when the mouse is on top of it)

TGUI_NODISCARD Color	getArrowBackgroundColorHover () const
	Returns the color behind the arrow in hover state (when the mouse is on top of it)

void	setArrowColor (Color color)
	Changes the color of the arrow.

TGUI_NODISCARD Color	getArrowColor () const
	Returns the color of the arrow.

void	setArrowColorHover (Color color)
	Changes the color of the arrow in hover state (when the mouse is on top of it)

TGUI_NODISCARD Color	getArrowColorHover () const
	Returns the color of the arrow in hover state (when the mouse is on top of it)

void	setTextureTrack (const Texture &texture)
	Changes the image of the track.

TGUI_NODISCARD const Texture &	getTextureTrack () const
	Returns the image of the track.

void	setTextureTrackHover (const Texture &texture)
	Changes the image of the track that is displayed when the mouse is on top of it.

TGUI_NODISCARD const Texture &	getTextureTrackHover () const
	Returns the image of the track that is displayed when the mouse is on top of it.

void	setTextureThumb (const Texture &texture)
	Changes the image of the thumb.

TGUI_NODISCARD const Texture &	getTextureThumb () const
	Returns the image of the thumb.

void	setTextureThumbHover (const Texture &texture)
	Changes the image of the thumb that is displayed when the mouse is on top of it.

TGUI_NODISCARD const Texture &	getTextureThumbHover () const
	Returns the image of the thumb that is displayed when the mouse is on top of it.

void	setTextureArrowUp (const Texture &texture)
	Changes the image of the up arrow.

TGUI_NODISCARD const Texture &	getTextureArrowUp () const
	Returns the image of the up arrow.

void	setTextureArrowUpHover (const Texture &texture)
	Changes the image of the up arrow that is displayed when the mouse is on top of it.

TGUI_NODISCARD const Texture &	getTextureArrowUpHover () const
	Returns the image of the up arrow that is displayed when the mouse is on top of it.

void	setTextureArrowDown (const Texture &texture)
	Changes the image of the down arrow.

TGUI_NODISCARD const Texture &	getTextureArrowDown () const
	Returns the image of the down arrow.

void	setTextureArrowDownHover (const Texture &texture)
	Changes the image of the down arrow that is displayed when the mouse is on top of it.

TGUI_NODISCARD const Texture &	getTextureArrowDownHover () const
	Returns the image of the down arrow that is displayed when the mouse is on top of it.

	WidgetRenderer ()=default
	Default constructor.

	WidgetRenderer (const WidgetRenderer &)
	Copy constructor.

	WidgetRenderer (WidgetRenderer &&)=default
	Default move constructor.

	WidgetRenderer (const std::shared_ptr< RendererData > &data)
	Construct the renderer from renderer data.

Public Member Functions inherited from tgui::WidgetRenderer
	WidgetRenderer ()=default
	Default constructor.

	WidgetRenderer (const WidgetRenderer &)
	Copy constructor.

	WidgetRenderer (WidgetRenderer &&)=default
	Default move constructor.

WidgetRenderer &	operator= (const WidgetRenderer &)
	Copy assignment operator.

WidgetRenderer &	operator= (WidgetRenderer &&)=default
	Default move assignment operator.

	WidgetRenderer (const std::shared_ptr< RendererData > &data)
	Construct the renderer from renderer data.

virtual	~WidgetRenderer ()=default
	Virtual destructor.

void	setOpacity (float opacity)
	Changes the opacity of the widget.

TGUI_NODISCARD float	getOpacity () const
	Returns the opacity of the widget.

void	setOpacityDisabled (float opacity)
	Changes the opacity of the widget when it is disabled.

TGUI_NODISCARD float	getOpacityDisabled () const
	Returns the opacity of the widget when it is disabled.

void	setFont (const Font &font)
	Changes the font used for the text in the widget.

TGUI_NODISCARD Font	getFont () const
	Returns the font associated with the widget (if any)

void	setTextSize (unsigned int size)
	Changes the text size of the widget that is specified by the renderer.

TGUI_NODISCARD unsigned int	getTextSize () const
	Returns text size of the widget that is specified by the renderer.

void	setTransparentTexture (bool ignoreTransparentParts)
	Sets whether mouse events should be ignored on transparent parts of the texture of the widget in normal state.

TGUI_NODISCARD bool	getTransparentTexture () const
	Returns whether mouse events should be ignored on transparent parts of the texture of the widget.

void	setProperty (const String &property, ObjectConverter &&value)
	Changes a property of the renderer.

TGUI_NODISCARD ObjectConverter	getProperty (const String &property) const
	Retrieves the value of a certain property.

TGUI_NODISCARD const std::map< String, ObjectConverter > &	getPropertyValuePairs () const
	Gets a map with all properties and their values.

void	subscribe (Widget *widget)
	Subscribes a callback function to changes in the renderer.

void	unsubscribe (Widget *widget)
	Subscribes a callback function to changes in the renderer.

void	setData (const std::shared_ptr< RendererData > &data)

TGUI_NODISCARD std::shared_ptr< RendererData >	getData () const
	Returns the renderer data.

TGUI_NODISCARD std::shared_ptr< RendererData >	clone () const
	Gets a clone of the renderer data.

Additional Inherited Members
Protected Attributes inherited from tgui::WidgetRenderer
std::shared_ptr< RendererData >	m_data = RendererData::create()

Member Function Documentation

◆ getArrowBackgroundColor()

TGUI_NODISCARD Color tgui::ScrollbarRenderer::getArrowBackgroundColor ( ) const

Returns the color behind the arrow.

Returns: Arrow background color

◆ getArrowBackgroundColorHover()

TGUI_NODISCARD Color tgui::ScrollbarRenderer::getArrowBackgroundColorHover ( ) const

Returns the color behind the arrow in hover state (when the mouse is on top of it)

Returns: Hover arrow background color

◆ getArrowColor()

TGUI_NODISCARD Color tgui::ScrollbarRenderer::getArrowColor ( ) const

Returns the color of the arrow.

Returns: Arrow color

◆ getArrowColorHover()

TGUI_NODISCARD Color tgui::ScrollbarRenderer::getArrowColorHover ( ) const

Returns the color of the arrow in hover state (when the mouse is on top of it)

Returns: Hover arrow color

◆ getTextureArrowDown()

TGUI_NODISCARD const Texture & tgui::ScrollbarRenderer::getTextureArrowDown ( ) const

Returns the image of the down arrow.

Returns: Down arrow texture

◆ getTextureArrowDownHover()

TGUI_NODISCARD const Texture & tgui::ScrollbarRenderer::getTextureArrowDownHover ( ) const

Returns the image of the down arrow that is displayed when the mouse is on top of it.

Returns: Hover down arrow texture

◆ getTextureArrowUp()

TGUI_NODISCARD const Texture & tgui::ScrollbarRenderer::getTextureArrowUp ( ) const

Returns the image of the up arrow.

Returns: Up arrow texture

◆ getTextureArrowUpHover()

TGUI_NODISCARD const Texture & tgui::ScrollbarRenderer::getTextureArrowUpHover ( ) const

Returns the image of the up arrow that is displayed when the mouse is on top of it.

Returns: Hover up arrow texture

◆ getTextureThumb()

TGUI_NODISCARD const Texture & tgui::ScrollbarRenderer::getTextureThumb ( ) const

Returns the image of the thumb.

Returns: Thumb texture

◆ getTextureThumbHover()

TGUI_NODISCARD const Texture & tgui::ScrollbarRenderer::getTextureThumbHover ( ) const

Returns the image of the thumb that is displayed when the mouse is on top of it.

Returns: Hover thumb texture

◆ getTextureTrack()

TGUI_NODISCARD const Texture & tgui::ScrollbarRenderer::getTextureTrack ( ) const

Returns the image of the track.

Returns: Track texture

◆ getTextureTrackHover()

TGUI_NODISCARD const Texture & tgui::ScrollbarRenderer::getTextureTrackHover ( ) const

Returns the image of the track that is displayed when the mouse is on top of it.

Returns: Hover track texture

◆ getThumbColor()

TGUI_NODISCARD Color tgui::ScrollbarRenderer::getThumbColor ( ) const

Returns the color of the thumb.

Returns: Thumb color

◆ getThumbColorHover()

TGUI_NODISCARD Color tgui::ScrollbarRenderer::getThumbColorHover ( ) const

Returns the color of the thumb in hover state (when the mouse is on top of it)

Returns: Hover thumb color

◆ getTrackColor()

TGUI_NODISCARD Color tgui::ScrollbarRenderer::getTrackColor ( ) const

Returns the color of the track.

Returns: Track color

◆ getTrackColorHover()

TGUI_NODISCARD Color tgui::ScrollbarRenderer::getTrackColorHover ( ) const

Returns the color of the track in hover state (when the mouse is on top of it)

Returns: Hover track color

◆ setArrowBackgroundColor()

void tgui::ScrollbarRenderer::setArrowBackgroundColor ( Color color )

Changes the color behind the arrow.

Parameters

color The new arrow background color

Note that this color is ignored when the arrow up and down textures are set.

◆ setArrowBackgroundColorHover()

void tgui::ScrollbarRenderer::setArrowBackgroundColorHover ( Color color )

Changes the color behind the arrow in hover state (when the mouse is on top of it)

Parameters

color The new hover arrow background color

◆ setArrowColor()

void tgui::ScrollbarRenderer::setArrowColor ( Color color )

Changes the color of the arrow.

Parameters

color The new arrow color

Note that this color is ignored when the arrow up and down textures are set.

◆ setArrowColorHover()

void tgui::ScrollbarRenderer::setArrowColorHover ( Color color )

Changes the color of the arrow in hover state (when the mouse is on top of it)

Parameters

color The new hover arrow color

◆ setTextureArrowDown()

void tgui::ScrollbarRenderer::setTextureArrowDown ( const Texture & texture )

Changes the image of the down arrow.

Parameters

texture The new down arrow texture

When this texture is set then the arrow background color and arrow color will be ignored for the down arrow

◆ setTextureArrowDownHover()

void tgui::ScrollbarRenderer::setTextureArrowDownHover ( const Texture & texture )

Changes the image of the down arrow that is displayed when the mouse is on top of it.

Parameters

texture The new hover down arrow texture

◆ setTextureArrowUp()

void tgui::ScrollbarRenderer::setTextureArrowUp ( const Texture & texture )

Changes the image of the up arrow.

Parameters

texture The new up arrow texture

When this texture is set then the arrow background color and arrow color will be ignored for the up arrow

◆ setTextureArrowUpHover()

void tgui::ScrollbarRenderer::setTextureArrowUpHover ( const Texture & texture )

Changes the image of the up arrow that is displayed when the mouse is on top of it.

Parameters

texture The new hover up arrow texture

◆ setTextureThumb()

void tgui::ScrollbarRenderer::setTextureThumb ( const Texture & texture )

Changes the image of the thumb.

Parameters

texture The new thumb texture

When this texture is set then the thumb color will be ignored

◆ setTextureThumbHover()

void tgui::ScrollbarRenderer::setTextureThumbHover ( const Texture & texture )

Changes the image of the thumb that is displayed when the mouse is on top of it.

Parameters

texture The new hover thumb texture

◆ setTextureTrack()

void tgui::ScrollbarRenderer::setTextureTrack ( const Texture & texture )

Changes the image of the track.

Parameters

texture The new track texture

When this texture is set then the track color will be ignored.

◆ setTextureTrackHover()

void tgui::ScrollbarRenderer::setTextureTrackHover ( const Texture & texture )

Changes the image of the track that is displayed when the mouse is on top of it.

Parameters

texture The new hover track texture

◆ setThumbColor()

void tgui::ScrollbarRenderer::setThumbColor ( Color color )

Changes the color of the thumb.

Parameters

color The new thumb color

Note that this color is ignored when the thumb texture is set.

◆ setThumbColorHover()

void tgui::ScrollbarRenderer::setThumbColorHover ( Color color )

Changes the color of the thumb in hover state (when the mouse is on top of it)

Parameters

color The new hover thumb color

◆ setTrackColor()

void tgui::ScrollbarRenderer::setTrackColor ( Color color )

Changes the color of the track.

Parameters

color The new track color

Note that this color is ignored when the track texture is set.

◆ setTrackColorHover()

void tgui::ScrollbarRenderer::setTrackColorHover ( Color color )

Changes the color of the track in hover state (when the mouse is on top of it)

Parameters

color The new hover track color

◆ WidgetRenderer()

tgui::WidgetRenderer::WidgetRenderer ( const std::shared_ptr< RendererData > & data )

inline

Construct the renderer from renderer data.

Parameters

data	Renderer data to initialize the renderer with

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

include/TGUI/Renderers/ScrollbarRenderer.hpp

TGUI

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ getArrowBackgroundColor()

◆ getArrowBackgroundColorHover()

◆ getArrowColor()

◆ getArrowColorHover()

◆ getTextureArrowDown()

◆ getTextureArrowDownHover()

◆ getTextureArrowUp()

◆ getTextureArrowUpHover()

◆ getTextureThumb()

◆ getTextureThumbHover()

◆ getTextureTrack()

◆ getTextureTrackHover()

◆ getThumbColor()

◆ getThumbColorHover()

◆ getTrackColor()

◆ getTrackColorHover()

◆ setArrowBackgroundColor()

◆ setArrowBackgroundColorHover()

◆ setArrowColor()

◆ setArrowColorHover()

◆ setTextureArrowDown()

◆ setTextureArrowDownHover()

◆ setTextureArrowUp()

◆ setTextureArrowUpHover()

◆ setTextureThumb()

◆ setTextureThumbHover()

◆ setTextureTrack()

◆ setTextureTrackHover()

◆ setThumbColor()

◆ setThumbColorHover()

◆ setTrackColor()

◆ setTrackColorHover()

◆ WidgetRenderer()