TGUI  0.8.9
tgui::ScrollablePanelRenderer Class Reference
Inheritance diagram for tgui::ScrollablePanelRenderer:
tgui::PanelRenderer tgui::GroupRenderer tgui::WidgetRenderer

Public Member Functions

void setScrollbar (std::shared_ptr< RendererData > scrollbarRendererData)
 Sets the renderer data of the scrollbars. More...
 
std::shared_ptr< RendererDatagetScrollbar () const
 Returns the renderer data of the scrollbars. More...
 
void setScrollbarWidth (float scrollbarWidth)
 Sets the wanted width of the scrollbar. More...
 
float getScrollbarWidth () const
 Returns the wanted width of the scrollbar. More...
 
- Public Member Functions inherited from tgui::PanelRenderer
void setBorders (const Borders &borders)
 Changes the size of the borders. More...
 
Borders getBorders () const
 Returns the size of the borders. More...
 
void setBorderColor (Color color)
 Changes the color of the borders. More...
 
Color getBorderColor () const
 Returns the color of the borders. More...
 
void setBackgroundColor (Color color)
 Changes the background color of the panel. More...
 
Color getBackgroundColor () const
 Returns the background color of the panel. More...
 
void setTextureBackground (const Texture &texture)
 Changes the background image. More...
 
TexturegetTextureBackground () const
 Returns the background image. More...
 
- Public Member Functions inherited from tgui::GroupRenderer
void setPadding (const Padding &padding)
 Changes the size of the padding. More...
 
Padding getPadding () const
 Returns the size of the padding. More...
 
 WidgetRenderer ()=default
 Default constructor.
 
 WidgetRenderer (const std::shared_ptr< RendererData > &data)
 Construct the renderer from renderer data. 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 setOpacityDisabled (float opacity)
 Changes the opacity of the widget when it is disabled. More...
 
float getOpacityDisabled () const
 Returns the opacity of the widget when it is disabled. 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 setTransparentTexture (bool ignoreTransparentParts)
 Sets whether mouse events should be ignored on transparent parts of the texture of the widget in normal state. More...
 
bool getTransparentTexture () const
 Returns whether mouse events should be ignored on transparent parts of the texture of the widget. 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

◆ getScrollbar()

std::shared_ptr< RendererData > tgui::ScrollablePanelRenderer::getScrollbar ( ) const

Returns the renderer data of the scrollbars.

Returns
Data about how the scrollbars looks

◆ getScrollbarWidth()

float tgui::ScrollablePanelRenderer::getScrollbarWidth ( ) const

Returns the wanted width of the scrollbar.

Returns
Requested scrollbar width or 0 if no width was set (texture width or default value will be used)

◆ setScrollbar()

void tgui::ScrollablePanelRenderer::setScrollbar ( std::shared_ptr< RendererData scrollbarRendererData)

Sets the renderer data of the scrollbars.

Parameters
scrollbarRendererDataData about how the scrollbars should look

◆ setScrollbarWidth()

void tgui::ScrollablePanelRenderer::setScrollbarWidth ( float  scrollbarWidth)

Sets the wanted width of the scrollbar.

Parameters
scrollbarWidthRequested scrollbar width or 0 to use the default width (texture size if using textures)

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