tgui::PanelListBoxRenderer Class Reference

Inheritance diagram for tgui::PanelListBoxRenderer:

Public Member Functions
void	setItemsBackgroundColor (Color itemsBackgroundColor)
	Changes the items background color of the panel list box.
TGUI_NODISCARD Color	getItemsBackgroundColor () const
	Returns the items background color.
void	setItemsBackgroundColorHover (Color itemsBackgroundColor)
	Changes the background color used for the item below the mouse.
TGUI_NODISCARD Color	getItemsBackgroundColorHover () const
	Returns the background color used for the item below the mouse.
void	setSelectedItemsBackgroundColor (Color itemsBackgroundColor)
	Changes the background color of the selected item.
TGUI_NODISCARD Color	getSelectedItemsBackgroundColor () const
	Returns the background color of the selected item.
void	setSelectedItemsBackgroundColorHover (Color backgroundColor)
	Changes the background color used for the selected item when the mouse hovers over it.
TGUI_NODISCARD Color	getSelectedItemsBackgroundColorHover () const
	Returns the background color used for the selected item when the mouse hovers over it.
Public Member Functions inherited from tgui::ScrollablePanelRenderer
void	setScrollbar (std::shared_ptr< RendererData > scrollbarRendererData)
	Sets the renderer data of the scrollbars.
TGUI_NODISCARD std::shared_ptr< RendererData >	getScrollbar () 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 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.
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.
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.
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< RendererData >	getData () const
	Returns the renderer data.
TGUI_NODISCARD 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

getItemsBackgroundColor()

TGUI_NODISCARD Color tgui::PanelListBoxRenderer::getItemsBackgroundColor

(

)

const

Returns the items background color.

Returns

Background color

getItemsBackgroundColorHover()

TGUI_NODISCARD Color tgui::PanelListBoxRenderer::getItemsBackgroundColorHover

(

)

const

Returns the background color used for the item below the mouse.

Returns

Background color of hovered item

getSelectedItemsBackgroundColor()

TGUI_NODISCARD Color tgui::PanelListBoxRenderer::getSelectedItemsBackgroundColor

(

)

const

Returns the background color of the selected item.

Returns

Selected item background color

getSelectedItemsBackgroundColorHover()

TGUI_NODISCARD Color tgui::PanelListBoxRenderer::getSelectedItemsBackgroundColorHover

(

)

const

Returns the background color used for the selected item when the mouse hovers over it.

Returns

Background color of selected item in hover state

setItemsBackgroundColor()

void tgui::PanelListBoxRenderer::setItemsBackgroundColor

(

Color

itemsBackgroundColor

)

Changes the items background color of the panel list box.

Parameters

itemsBackgroundColor

The new background color

setItemsBackgroundColorHover()

void tgui::PanelListBoxRenderer::setItemsBackgroundColorHover

(

Color

itemsBackgroundColor

)

Changes the background color used for the item below the mouse.

Parameters

itemsBackgroundColor

The new hover background color

setSelectedItemsBackgroundColor()

void tgui::PanelListBoxRenderer::setSelectedItemsBackgroundColor

(

Color

itemsBackgroundColor

)

Changes the background color of the selected item.

Parameters

itemsBackgroundColor

The new selected item background color

setSelectedItemsBackgroundColorHover()

void tgui::PanelListBoxRenderer::setSelectedItemsBackgroundColorHover

(

Color

backgroundColor

)

Changes the background color used for the selected item when the mouse hovers over it.

Parameters

backgroundColor

The new selected hover background color

---

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

• include/TGUI/Renderers/PanelListBoxRenderer.hpp