tgui::ScrollablePanelRenderer Class Reference

Inheritance diagram for tgui::ScrollablePanelRenderer:

Public Member Functions
void	setScrollbar (std::shared_ptr< RendererData > scrollbarRendererData)
	Sets the renderer data of the scrollbars.
std::shared_ptr< RendererData >	getScrollbar () const
	Returns the renderer data of the scrollbars.
void	setScrollbarWidth (float scrollbarWidth)
	Sets the wanted width of the scrollbar.
float	getScrollbarWidth () const
	Returns the wanted width of the scrollbar.
Public Member Functions inherited from tgui::PanelRenderer
void	setBorders (const Borders &borders)
	Changes the size of the borders.
Borders	getBorders () const
	Returns the size of the borders.
void	setBorderColor (Color color)
	Changes the color of the borders.
Color	getBorderColor () const
	Returns the color of the borders.
void	setBackgroundColor (Color color)
	Changes the background color of the panel.
Color	getBackgroundColor () const
	Returns the background color of the panel.
void	setTextureBackground (const Texture &texture)
	Changes the background image.
const Texture &	getTextureBackground () const
	Returns the background image.
void	setRoundedBorderRadius (float radius)
	Changes the radius for the rounded corners if you want to draw a rounded rectangle as background.
float	getRoundedBorderRadius () const
	Returns the radius for the rounded corners if you want to draw a rounded rectangle as background.
Public Member Functions inherited from tgui::GroupRenderer
void	setPadding (const Padding &padding)
	Changes the size of the padding.
Padding	getPadding () const
	Returns the size of the padding.
	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.
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 (const 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	setTextSize (unsigned int size)
	Changes the text size of the widget that is specified by the renderer.
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.
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 (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 (std::shared_ptr< RendererData > data)
std::shared_ptr< RendererData >	getData () const
	Returns the renderer data.
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

getScrollbar()

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

nodiscard

Returns the renderer data of the scrollbars.

Returns

Data about how the scrollbars looks

getScrollbarWidth()

float tgui::ScrollablePanelRenderer::getScrollbarWidth ( ) const

nodiscard

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

scrollbarRendererData

Data about how the scrollbars should look

setScrollbarWidth()

void tgui::ScrollablePanelRenderer::setScrollbarWidth

(

float

scrollbarWidth

)

Sets the wanted width of the scrollbar.

Parameters

scrollbarWidth

Requested 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:

• include/TGUI/Renderers/ScrollablePanelRenderer.hpp