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

Public Member Functions

void setBorders (const Borders &borders)
 Changes the size of the borders. More...
 
Borders getBorders () const
 Returns the size of the borders. More...
 
void setSpaceBetweenArrows (float space)
 Changes the space that is left between the arrows. More...
 
float getSpaceBetweenArrows () const
 Returns the space that is left between the arrows. More...
 
void setBackgroundColor (Color color)
 Changes the color of the background of the arrows. More...
 
Color getBackgroundColor () const
 Returns the background color of the arrows. More...
 
void setBackgroundColorHover (Color color)
 Changes the background color of the arrows in the hover state (mouse standing on top of the spin button) More...
 
Color getBackgroundColorHover () const
 Returns the background color of the arrows in the hover state (mouse standing on top of the spin button) More...
 
void setArrowColor (Color color)
 Changes the color of the arrows. More...
 
Color getArrowColor () const
 Returns the color of the arrows. More...
 
void setArrowColorHover (Color color)
 Changes the color of the arrows in the hover state (mouse standing on top of the spin button) More...
 
Color getArrowColorHover () const
 Returns the color of the arrows in the hover state (mouse standing on top of the spin button) More...
 
void setBorderColor (Color color)
 Changes the color of the borders. More...
 
Color getBorderColor () const
 Returns the color of the borders. More...
 
void setTextureArrowUp (const Texture &texture)
 Changes the image that is used as the up arrow. More...
 
TexturegetTextureArrowUp () const
 Returns the image that is used as the up arrow. More...
 
void setTextureArrowUpHover (const Texture &texture)
 Changes the image that is used as the up arrow when the mouse is located on top of the spin button. More...
 
TexturegetTextureArrowUpHover () const
 Returns the image that is used as the up arrow when the mouse is located on top of the spin button. More...
 
void setTextureArrowDown (const Texture &texture)
 Changes the image that is used as the down arrow. More...
 
TexturegetTextureArrowDown () const
 Returns the image that is used as the up arrow. More...
 
void setTextureArrowDownHover (const Texture &texture)
 Changes the image that is used as the down arrow when the mouse is located on top of the spin button. More...
 
TexturegetTextureArrowDownHover () const
 Returns the image that is used as the down arrow when the mouse is located on top of the spin button. 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

◆ getArrowColor()

Color tgui::SpinButtonRenderer::getArrowColor ( ) const

Returns the color of the arrows.

Returns
arrow color

◆ getArrowColorHover()

Color tgui::SpinButtonRenderer::getArrowColorHover ( ) const

Returns the color of the arrows in the hover state (mouse standing on top of the spin button)

Returns
arrow color

◆ getBackgroundColor()

Color tgui::SpinButtonRenderer::getBackgroundColor ( ) const

Returns the background color of the arrows.

Returns
background color

◆ getBackgroundColorHover()

Color tgui::SpinButtonRenderer::getBackgroundColorHover ( ) const

Returns the background color of the arrows in the hover state (mouse standing on top of the spin button)

Returns
background color

◆ getBorderColor()

Color tgui::SpinButtonRenderer::getBorderColor ( ) const

Returns the color of the borders.

Returns
Border color

◆ getBorders()

Borders tgui::SpinButtonRenderer::getBorders ( ) const

Returns the size of the borders.

Returns
border size

◆ getSpaceBetweenArrows()

float tgui::SpinButtonRenderer::getSpaceBetweenArrows ( ) const

Returns the space that is left between the arrows.

Returns
space between the arrows

◆ getTextureArrowDown()

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

Returns the image that is used as the up arrow.

Returns
down arrow texture

◆ getTextureArrowDownHover()

Texture& tgui::SpinButtonRenderer::getTextureArrowDownHover ( ) const

Returns the image that is used as the down arrow when the mouse is located on top of the spin button.

Returns
down hover arrow texture

◆ getTextureArrowUp()

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

Returns the image that is used as the up arrow.

Returns
up arrow texture

◆ getTextureArrowUpHover()

Texture& tgui::SpinButtonRenderer::getTextureArrowUpHover ( ) const

Returns the image that is used as the up arrow when the mouse is located on top of the spin button.

Returns
up hover arrow texture

◆ setArrowColor()

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

Changes the color of the arrows.

Parameters
colorNew arrow color

Note that this color is ignored when an up and down arrow texture were set.

◆ setArrowColorHover()

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

Changes the color of the arrows in the hover state (mouse standing on top of the spin button)

Parameters
colorNew arrow color

◆ setBackgroundColor()

void tgui::SpinButtonRenderer::setBackgroundColor ( Color  color)

Changes the color of the background of the arrows.

Parameters
colorNew background color

Note that this color is ignored when you set an image as background.

◆ setBackgroundColorHover()

void tgui::SpinButtonRenderer::setBackgroundColorHover ( Color  color)

Changes the background color of the arrows in the hover state (mouse standing on top of the spin button)

Parameters
colorNew background color

◆ setBorderColor()

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

Changes the color of the borders.

Parameters
colorNew border color

◆ setBorders()

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

Changes the size of the borders.

Parameters
bordersSize of the borders

◆ setSpaceBetweenArrows()

void tgui::SpinButtonRenderer::setSpaceBetweenArrows ( float  space)

Changes the space that is left between the arrows.

Parameters
spaceThe space between the arrows

◆ setTextureArrowDown()

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

Changes the image that is used as the down arrow.

Parameters
textureThe new down arrow texture

When this image and the up image are set, the arrow color property will be ignored.

◆ setTextureArrowDownHover()

void tgui::SpinButtonRenderer::setTextureArrowDownHover ( const Texture texture)

Changes the image that is used as the down arrow when the mouse is located on top of the spin button.

Parameters
textureThe new down hover arrow texture

◆ setTextureArrowUp()

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

Changes the image that is used as the up arrow.

Parameters
textureThe new up arrow texture

When this image and the down image are set, the arrow color property will be ignored.

◆ setTextureArrowUpHover()

void tgui::SpinButtonRenderer::setTextureArrowUpHover ( const Texture texture)

Changes the image that is used as the up arrow when the mouse is located on top of the spin button.

Parameters
textureThe new up hover arrow texture

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