TGUI  0.9.5
Loading...
Searching...
No Matches
tgui::SliderRenderer Class Reference
Inheritance diagram for tgui::SliderRenderer:
tgui::WidgetRenderer tgui::RangeSliderRenderer

Public Member Functions

void setBorders (const Borders &borders)
 Changes the size of the borders.
 
Borders getBorders () const
 Returns the size of the borders.
 
void setTrackColor (Color color)
 Changes the color of the track.
 
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)
 
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.
 
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)
 
Color getThumbColorHover () const
 Returns the color of the thumb in hover state (when the mouse is on top of it)
 
void setBorderColor (Color color)
 Changes the color of the borders.
 
Color getBorderColor () const
 Returns the color of the borders.
 
void setBorderColorHover (Color color)
 Changes the color of the borders in the hover state (when the mouse is on top of the slider)
 
Color getBorderColorHover () const
 Returns the color of the borders in the hover state (when the mouse is on top of the slider)
 
void setTextureTrack (const Texture &texture)
 Changes the image of the track.
 
const TexturegetTextureTrack () 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.
 
const TexturegetTextureTrackHover () 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.
 
const TexturegetTextureThumb () 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.
 
const TexturegetTextureThumbHover () const
 Returns the image of the thumb that is displayed when the mouse is on top of it.
 
void setThumbWithinTrack (bool keepThumbInside)
 Changes whether the center of the thumb or the sides of the thumb must remain on top of the track.
 
bool getThumbWithinTrack () const
 Returns whether the center of the thumb or the sides of the thumb must remain on top of the track.
 
 WidgetRenderer ()=default
 Default 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 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.
 
float getOpacity () const
 Returns the opacity of the widget.
 
void setOpacityDisabled (float opacity)
 Changes the opacity of the widget when it is disabled.
 
float getOpacityDisabled () const
 Returns the opacity of the widget when it is disabled.
 
void setFont (Font font)
 Changes the font used for the text in the widget.
 
Font getFont () const
 Returns the font associated with the widget (if any)
 
void setTransparentTexture (bool ignoreTransparentParts)
 Sets whether mouse events should be ignored on transparent parts of the texture of the widget in normal state.
 
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.
 
ObjectConverter getProperty (const String &property) const
 Retrieves the value of a certain property.
 
const std::map< String, ObjectConverter > & getPropertyValuePairs () const
 Gets a map with all properties and their values.
 
void subscribe (const void *id, const std::function< void(const String &property)> &function)
 Subscribes a callback function to changes in the renderer.
 
void unsubscribe (const void *id)
 Subscribes a callback function to changes in the renderer.
 
void setData (const std::shared_ptr< RendererData > &data)
 
std::shared_ptr< RendererDatagetData () const
 Returns the renderer data.
 
std::shared_ptr< RendererDataclone () const
 Gets a clone of the renderer data.
 

Additional Inherited Members

- Protected Attributes inherited from tgui::WidgetRenderer
std::shared_ptr< RendererDatam_data = RendererData::create()
 

Member Function Documentation

◆ getBorderColor()

Color tgui::SliderRenderer::getBorderColor ( ) const

Returns the color of the borders.

Returns
Border color

◆ getBorderColorHover()

Color tgui::SliderRenderer::getBorderColorHover ( ) const

Returns the color of the borders in the hover state (when the mouse is on top of the slider)

Returns
Border color

◆ getBorders()

Borders tgui::SliderRenderer::getBorders ( ) const

Returns the size of the borders.

Returns
border size

◆ getTextureThumb()

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

Returns the image of the thumb.

Returns
Thumb texture

◆ getTextureThumbHover()

const Texture & tgui::SliderRenderer::getTextureThumbHover ( ) const

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

Returns
Hover thumb texture

◆ getTextureTrack()

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

Returns the image of the track.

Returns
Track texture

◆ getTextureTrackHover()

const Texture & tgui::SliderRenderer::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::SliderRenderer::getThumbColor ( ) const

Returns the color of the thumb.

Returns
Thumb color

◆ getThumbColorHover()

Color tgui::SliderRenderer::getThumbColorHover ( ) const

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

Returns
Hover thumb color

◆ getThumbWithinTrack()

bool tgui::SliderRenderer::getThumbWithinTrack ( ) const

Returns whether the center of the thumb or the sides of the thumb must remain on top of the track.

Returns
Should the sides of the thumb align with the sides of the track at min and max values?

◆ getTrackColor()

Color tgui::SliderRenderer::getTrackColor ( ) const

Returns the color of the track.

Returns
Track color

◆ getTrackColorHover()

Color tgui::SliderRenderer::getTrackColorHover ( ) const

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

Returns
Hover track color

◆ setBorderColor()

void tgui::SliderRenderer::setBorderColor ( Color  color)

Changes the color of the borders.

Parameters
colorNew border color

◆ setBorderColorHover()

void tgui::SliderRenderer::setBorderColorHover ( Color  color)

Changes the color of the borders in the hover state (when the mouse is on top of the slider)

Parameters
colorNew border color

◆ setBorders()

void tgui::SliderRenderer::setBorders ( const Borders borders)

Changes the size of the borders.

Parameters
bordersSize of the borders

◆ setTextureThumb()

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

Changes the image of the thumb.

Parameters
textureThe new thumb texture

When this image is set, the thumb color property will be ignored.

◆ setTextureThumbHover()

void tgui::SliderRenderer::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::SliderRenderer::setTextureTrack ( const Texture texture)

Changes the image of the track.

Parameters
textureThe new track texture

When this image is set, the track color property will be ignored.

◆ setTextureTrackHover()

void tgui::SliderRenderer::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::SliderRenderer::setThumbColor ( Color  color)

Changes the color of the thumb.

Parameters
colorThe new thumb color

◆ setThumbColorHover()

void tgui::SliderRenderer::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

◆ setThumbWithinTrack()

void tgui::SliderRenderer::setThumbWithinTrack ( bool  keepThumbInside)

Changes whether the center of the thumb or the sides of the thumb must remain on top of the track.

Parameters
keepThumbInsideShould the sides of the thumb align with the sides of the track at min and max values?

◆ setTrackColor()

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

Changes the color of the track.

Parameters
colorThe new track color

◆ setTrackColorHover()

void tgui::SliderRenderer::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

◆ WidgetRenderer()

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

Construct the renderer from renderer data.

Parameters
dataRenderer data to initialize the renderer with

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