TGUI  0.8-dev
tgui::ScrollbarRenderer Class Reference
Inheritance diagram for tgui::ScrollbarRenderer:
tgui::WidgetRenderer

Public Member Functions

void setTrackColor (Color color)
 Changes the color of the track. More...
 
Color getTrackColor () const
 Returns the color of the track. More...
 
void setTrackColorHover (Color color)
 Changes the color of the track in hover state (when the mouse is on top of it) More...
 
Color getTrackColorHover () const
 Returns the color of the track in hover state (when the mouse is on top of it) More...
 
void setThumbColor (Color color)
 Changes the color of the thumb. More...
 
Color getThumbColor () const
 Returns the color of the thumb. More...
 
void setThumbColorHover (Color color)
 Changes the color of the thumb in hover state (when the mouse is on top of it) More...
 
Color getThumbColorHover () const
 Returns the color of the thumb in hover state (when the mouse is on top of it) More...
 
void setArrowBackgroundColor (Color color)
 Changes the color behind the arrow. More...
 
Color getArrowBackgroundColor () const
 Returns the color behind the arrow. More...
 
void setArrowBackgroundColorHover (Color color)
 Changes the color behind the arrow in hover state (when the mouse is on top of it) More...
 
Color getArrowBackgroundColorHover () const
 Returns the color behind the arrow in hover state (when the mouse is on top of it) More...
 
void setArrowColor (Color color)
 Changes the color of the arrow. More...
 
Color getArrowColor () const
 Returns the color of the arrow. More...
 
void setArrowColorHover (Color color)
 Changes the color of the arrow in hover state (when the mouse is on top of it) More...
 
Color getArrowColorHover () const
 Returns the color of the arrow in hover state (when the mouse is on top of it) More...
 
void setTextureTrack (const Texture &texture)
 Changes the image of the track. More...
 
TexturegetTextureTrack () const
 Returns the image of the track. More...
 
void setTextureTrackHover (const Texture &texture)
 Changes the image of the track that is displayed when the mouse is on top of it. More...
 
TexturegetTextureTrackHover () const
 Returns the image of the track that is displayed when the mouse is on top of it. More...
 
void setTextureThumb (const Texture &texture)
 Changes the image of the thumb. More...
 
TexturegetTextureThumb () const
 Returns the image of the thumb. More...
 
void setTextureThumbHover (const Texture &texture)
 Changes the image of the thumb that is displayed when the mouse is on top of it. More...
 
TexturegetTextureThumbHover () const
 Returns the image of the thumb that is displayed when the mouse is on top of it. More...
 
void setTextureArrowUp (const Texture &texture)
 Changes the image of the up arrow. More...
 
TexturegetTextureArrowUp () const
 Returns the image of the up arrow. More...
 
void setTextureArrowUpHover (const Texture &texture)
 Changes the image of the up arrow that is displayed when the mouse is on top of it. More...
 
TexturegetTextureArrowUpHover () const
 Returns the image of the up arrow that is displayed when the mouse is on top of it. More...
 
void setTextureArrowDown (const Texture &texture)
 Changes the image of the down arrow. More...
 
TexturegetTextureArrowDown () const
 Returns the image of the down arrow. More...
 
void setTextureArrowDownHover (const Texture &texture)
 Changes the image of the down arrow that is displayed when the mouse is on top of it. More...
 
TexturegetTextureArrowDownHover () const
 Returns the image of the down arrow that is displayed when the mouse is on top of it. More...
 
- Public Member Functions inherited from tgui::WidgetRenderer
 WidgetRenderer ()=default
 Default constructor.
 
 WidgetRenderer (const std::shared_ptr< RendererData > &data)
 Construct the renderer from renderer data. More...
 
virtual ~WidgetRenderer ()=default
 Virtual destructor.
 
void setOpacity (float opacity)
 Changes the opacity of the widget. More...
 
float getOpacity () const
 Returns the opacity of the widget. More...
 
void setFont (Font font)
 Changes the font used for the text in the widget. More...
 
Font getFont () const
 Returns the font associated with the widget (if any) More...
 
void setProperty (const std::string &property, ObjectConverter &&value)
 Changes a property of the renderer. More...
 
ObjectConverter getProperty (const std::string &property) const
 Retrieves the value of a certain property. More...
 
const std::map< std::string, ObjectConverter > & getPropertyValuePairs () const
 Gets a map with all properties and their values. More...
 
void subscribe (const void *id, const std::function< void(const std::string &property)> &function)
 Subscribes a callback function to changes in the renderer. More...
 
void unsubscribe (const void *id)
 Subscribes a callback function to changes in the renderer. More...
 
std::shared_ptr< RendererDatagetData () const
 Returns the renderer data. More...
 
std::shared_ptr< RendererDataclone () const
 Gets a clone of the renderer data. More...
 

Member Function Documentation

◆ getArrowBackgroundColor()

Color tgui::ScrollbarRenderer::getArrowBackgroundColor ( ) const

Returns the color behind the arrow.

Returns
Arrow background color

◆ getArrowBackgroundColorHover()

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()

Color tgui::ScrollbarRenderer::getArrowColor ( ) const

Returns the color of the arrow.

Returns
Arrow color

◆ getArrowColorHover()

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()

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

Returns the image of the down arrow.

Returns
Down arrow texture

◆ getTextureArrowDownHover()

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()

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

Returns the image of the up arrow.

Returns
Up arrow texture

◆ getTextureArrowUpHover()

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()

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

Returns the image of the thumb.

Returns
Thumb texture

◆ getTextureThumbHover()

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()

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

Returns the image of the track.

Returns
Track texture

◆ getTextureTrackHover()

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()

Color tgui::ScrollbarRenderer::getThumbColor ( ) const

Returns the color of the thumb.

Returns
Thumb color

◆ getThumbColorHover()

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()

Color tgui::ScrollbarRenderer::getTrackColor ( ) const

Returns the color of the track.

Returns
Track color

◆ getTrackColorHover()

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
colorThe new arrow background color

Note that this color is ignored when all normal images have been 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
colorThe new hover arrow background color

◆ setArrowColor()

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

Changes the color of the arrow.

Parameters
colorThe new arrow color

Note that this color is ignored when all normal images have been 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
colorThe new hover arrow color

◆ setTextureArrowDown()

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

Changes the image of the down arrow.

Parameters
textureThe new down arrow texture

When all textures are set, then the alternative color properties will be ignored.

◆ 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
textureThe new hover down arrow texture

◆ setTextureArrowUp()

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

Changes the image of the up arrow.

Parameters
textureThe new up arrow texture

When all textures are set, then the alternative color properties will be ignored.

◆ 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
textureThe new hover up arrow texture

◆ setTextureThumb()

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

Changes the image of the thumb.

Parameters
textureThe new thumb texture

When all textures are set, then the alternative color properties 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
textureThe new hover thumb texture

◆ setTextureTrack()

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

Changes the image of the track.

Parameters
textureThe new track texture

When all textures are set, then the alternative color properties 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
textureThe new hover track texture

◆ setThumbColor()

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

Changes the color of the thumb.

Parameters
colorThe new thumb color

Note that this color is ignored when all normal images have been 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
colorThe new hover thumb color

◆ setTrackColor()

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

Changes the color of the track.

Parameters
colorThe new track color

Note that this color is ignored when all normal images have been 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
colorThe new hover track color

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