TGUI  1.2.0
Loading...
Searching...
No Matches
tgui::ScrollablePanelRenderer Class Reference
Inheritance diagram for tgui::ScrollablePanelRenderer:
tgui::PanelRenderer tgui::GroupRenderer tgui::WidgetRenderer tgui::PanelListBoxRenderer

Public Member Functions

void setScrollbar (std::shared_ptr< RendererData > scrollbarRendererData)
 Sets the renderer data of the scrollbars.
 
TGUI_NODISCARD std::shared_ptr< RendererDatagetScrollbar () const
 Returns the renderer data of the scrollbars.
 
void setScrollbarWidth (float scrollbarWidth)
 Sets the wanted width of the scrollbar.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD Borders getBorders () const
 Returns the size of the borders.
 
void setBorderColor (Color color)
 Changes the color of the borders.
 
TGUI_NODISCARD Color getBorderColor () const
 Returns the color of the borders.
 
void setBackgroundColor (Color color)
 Changes the background color of the panel.
 
TGUI_NODISCARD Color getBackgroundColor () const
 Returns the background color of the panel.
 
void setTextureBackground (const Texture &texture)
 Changes the background image.
 
TGUI_NODISCARD const TexturegetTextureBackground () 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
WidgetRendereroperator= (const WidgetRenderer &)
 Copy assignment operator.
 
WidgetRendereroperator= (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.
 
TGUI_NODISCARD float getOpacity () const
 Returns the opacity of the widget.
 
void setOpacityDisabled (float opacity)
 Changes the opacity of the widget when it is disabled.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD ObjectConverter getProperty (const String &property) const
 Retrieves the value of a certain property.
 
TGUI_NODISCARD 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 (const std::shared_ptr< RendererData > &data)
 
TGUI_NODISCARD std::shared_ptr< RendererDatagetData () const
 Returns the renderer data.
 
TGUI_NODISCARD 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

◆ getScrollbar()

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

Returns the renderer data of the scrollbars.

Returns
Data about how the scrollbars looks

◆ getScrollbarWidth()

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