Inheritance diagram for tgui::ChatBox:

Classes
struct	Line

Public Types
typedef std::shared_ptr< ChatBox >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const ChatBox >	ConstPtr
	Shared constant widget pointer.

Public Types inherited from tgui::Widget
typedef std::shared_ptr< Widget >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const Widget >	ConstPtr
	Shared constant widget pointer.

Public Member Functions
ChatBoxRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

ChatBoxRenderer *	getRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

void	setSize (const Layout2d &size) override
	Changes the size of the chat box. More...

void	addLine (const sf::String &text)
	Adds a new line of text to the chat box. More...

void	addLine (const sf::String &text, Color color)
	Adds a new line of text to the chat box. More...

void	addLine (const sf::String &text, Color color, TextStyle style)
	Adds a new line of text to the chat box. More...

sf::String	getLine (std::size_t lineIndex) const
	Returns the contents of the requested line. More...

Color	getLineColor (std::size_t lineIndex) const
	Returns the color of the requested line. More...

TextStyle	getLineTextStyle (std::size_t lineIndex) const
	Returns the text style of the requested line. More...

bool	removeLine (std::size_t lineIndex)
	Removes the requested line. More...

void	removeAllLines ()
	Removes all lines from the chat box.

std::size_t	getLineAmount ()
	Returns the amount of lines in the chat box. More...

void	setLineLimit (std::size_t maxLines)
	Sets a maximum amount of lines in the chat box. More...

std::size_t	getLineLimit ()
	Returns the maximum amount of lines in the chat box. More...

void	setTextSize (unsigned int size) override
	Changes the character size of the text. More...

void	setTextColor (Color color)
	Changes the default color of the text. More...

const Color &	getTextColor () const
	Returns the default color of the text. More...

void	setTextStyle (TextStyle style)
	Changes the default text style. More...

TextStyle	getTextStyle () const
	Returns the default text style. More...

void	setLinesStartFromTop (bool startFromTop=true)
	Lets the first lines start from the top or from the bottom of the chat box. More...

bool	getLinesStartFromTop () const
	Returns whether the first lines start from the top or from the bottom of the chat box. More...

void	setNewLinesBelowOthers (bool newLinesBelowOthers=true)
	Sets whether new lines are added below the other lines or above them. More...

bool	getNewLinesBelowOthers () const
	Returns whether new lines are added below the other lines or above them. More...

void	setScrollbarValue (unsigned int value)
	Changes the thumb position of the scrollbar. More...

unsigned int	getScrollbarValue () const
	Returns the thumb position of the scrollbar. More...

bool	mouseOnWidget (Vector2f pos) const override
	Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...

virtual void	setSize (const Layout2d &size)
	Changes the size of the widget. More...

void	setSize (Layout width, Layout height)
	Changes the size of the widget. More...

Public Member Functions inherited from tgui::Widget
	Widget ()
	Default constructor.

	Widget (const Widget &)
	Copy constructor.

	Widget (Widget &&)
	Move constructor.

	~Widget ()
	Destructor.

Widget &	operator= (const Widget &)
	Overload of copy assignment operator.

Widget &	operator= (Widget &&)
	Move assignment.

void	setRenderer (std::shared_ptr< RendererData > rendererData)
	Sets a new renderer for the widget. The renderer determines how the widget looks. More...

WidgetRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

WidgetRenderer *	getRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

virtual void	setPosition (const Layout2d &position)
	sets the position of the widget More...

void	setPosition (Layout x, Layout y)
	Sets the position of the widget. More...

Vector2f	getPosition () const
	Gets the position of the widget. More...

void	setSize (Layout width, Layout height)
	Changes the size of the widget. More...

Vector2f	getSize () const
	Returns the size of the widget. More...

virtual Vector2f	getFullSize () const
	Returns the entire size that the widget is using. More...

virtual Vector2f	getAbsolutePosition () const
	Get the absolute position of the widget instead of the relative position to its parent. More...

virtual Vector2f	getWidgetOffset () const
	Returns the distance between the position where the widget is drawn and where the widget is placed. More...

virtual void	showWithEffect (ShowAnimationType type, sf::Time duration)
	Shows the widget by introducing it with an animation. More...

virtual void	hideWithEffect (ShowAnimationType type, sf::Time duration)
	Hides the widget by making it leave with an animation. More...

virtual void	setVisible (bool visible)
	Shows or hides a widget. More...

bool	isVisible () const
	Returns true when the widget is visible. More...

virtual void	setEnabled (bool enabled)
	Enables or disables the widget. More...

bool	isEnabled () const
	Returns true when the widget is enabled. More...

virtual void	setFocused (bool focused)
	Focus or unfocus the widget. More...

bool	isFocused () const
	Returns true when the widget is focused and false otherwise. More...

const std::string &	getWidgetType () const
	Returns the type of the widget. More...

Container *	getParent () const
	Returns a pointer to the parent widget. More...

bool	isAnimationPlaying () const
	Returns whether there is an active animation (started with showWithEffect or hideWithEffect) More...

virtual void	moveToFront ()
	Places the widget before all other widgets. More...

virtual void	moveToBack ()
	Places the widget behind all other widgets. More...

void	setUserData (std::any userData)
	Stores some data into the widget. More...

template<typename T >
T	getUserData () const
	Returns data stored in the widget. More...

void	setInheritedFont (const Font &font)
	Sets the font of the widget that is used when no font is set in the renderer. More...

const Font &	getInheritedFont () const
	Returns the font of the widget that is used when no font is set in the renderer. More...

void	setInheritedOpacity (float opacity)
	Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. More...

float	getInheritedOpacity () const
	Returns the opacity of the widget that is multiplied with the opacity set in the renderer. More...

virtual unsigned int	getTextSize () const
	Returns the character size of text in this widget. More...

void	setToolTip (Widget::Ptr toolTip)
	Sets the tool tip that should be displayed when hovering over the widget. More...

Widget::Ptr	getToolTip () const
	Returns the tool tip that is displayed when hovering over the widget. More...

void	setWidgetName (const sf::String &name)
	Changes the name of a widget. More...

sf::String	getWidgetName () const
	Returns the name of a widget. More...

void	setFocusable (bool focusable)
	Changes whether a widget could be focused. More...

bool	isFocusable () const
	Returns whether a widget could be focused. More...

virtual bool	canGainFocus () const
	Returns whether the widget can currently gain focus. More...

bool	isContainer () const
	Returns whether the widget is a container widget or not. More...

Signal &	getSignal (std::string signalName) override
	Retrieves a signal based on its name. More...

template<typename WidgetType >
std::shared_ptr< const WidgetType >	cast () const
	Downcast const widget.

template<typename WidgetType >
std::shared_ptr< WidgetType >	cast ()
	Downcast widget.

Public Member Functions inherited from tgui::SignalWidgetBase
template<typename Func , typename... Args, typename std::enable_if< std::is_convertible< Func, std::function< void(const Args &...)> >::value >::type * = nullptr>
unsigned int	connect (std::string signalName, Func &&handler, const Args &... args)
	Connects a signal handler that will be called when this signal is emitted. More...

template<typename Func , typename... BoundArgs, typename std::enable_if<!std::is_convertible< Func, std::function< void(const BoundArgs &...)> >::value &&std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)> >::value , ::type * = nullptr>
unsigned int	connect (std::string signalName, Func &&handler, BoundArgs &&... args)
	Connects a signal handler that will be called when this signal is emitted. More...

template<typename Func , typename... BoundArgs, typename std::enable_if<!std::is_convertible< Func, std::function< void(const BoundArgs &...)> >::value &&!std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)> >::value , ::type * = nullptr>
unsigned int	connect (std::string signalName, Func &&handler, BoundArgs &&... args)
	Connects a signal handler that will be called when this signal is emitted. More...

template<typename Func , typename... BoundArgs>
unsigned int	connect (std::initializer_list< std::string > signalNames, Func &&handler, BoundArgs &&... args)
	Connect a signal handler to multiple signals. More...

bool	disconnect (unsigned int id)
	Disconnects a signal handler. More...

void	disconnectAll (std::string signalName)
	Disconnects all signal handler from a certain signal. More...

void	disconnectAll ()
	Disconnects all signal handlers from signals.

Static Public Member Functions
static ChatBox::Ptr	create ()
	Creates a new chat box widget. More...

static ChatBox::Ptr	copy (ChatBox::ConstPtr chatBox)
	Makes a copy of another chat box. More...

Protected Member Functions
void	rendererChanged (const std::string &property) override
	Function called when one of the properties of the renderer is changed. More...

std::unique_ptr< DataIO::Node >	save (SavingRenderersMap &renderers) const override
	Saves the widget as a tree node in order to save it to a file.

void	load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
	Loads the widget from a tree of nodes.

Widget::Ptr	clone () const override
	Makes a copy of the widget if you don't know its exact type. More...

Protected Member Functions inherited from tgui::Widget
virtual void	mouseEnteredWidget ()
	This function is called when the mouse enters the widget.

virtual void	mouseLeftWidget ()
	This function is called when the mouse leaves the widget.

Additional Inherited Members
Public Attributes inherited from tgui::Widget
SignalVector2f	onPositionChange = {"PositionChanged"}
	The position of the widget changed. Optional parameter: new position.

SignalVector2f	onSizeChange = {"SizeChanged"}
	The size of the widget changed. Optional parameter: new size.

Signal	onFocus = {"Focused"}
	The widget was focused.

Signal	onUnfocus = {"Unfocused"}
	The widget was unfocused.

Signal	onMouseEnter = {"MouseEntered"}
	The mouse entered the widget.

Signal	onMouseLeave = {"MouseLeft"}
	The mouse left the widget.

SignalAnimation	onAnimationFinished = {"AnimationFinished"}
	A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.

Member Function Documentation

◆ addLine() [1/3]

void tgui::ChatBox::addLine ( const sf::String & text )

Adds a new line of text to the chat box.

The whole text passed to this function will be considered as one line for the getLine and removeLine functions, even if it is too long and gets split over multiple lines.

The default text color and style will be used.

Parameters

text	Text that will be added to the chat box

◆ addLine() [2/3]

void tgui::ChatBox::addLine	(	const sf::String &	text,
		Color	color
	)

Adds a new line of text to the chat box.

The whole text passed to this function will be considered as one line for the getLine and removeLine functions, even if it is too long and gets split over multiple lines.

The default text style will be used.

Parameters

text	Text that will be added to the chat box
color	Color of the text

◆ addLine() [3/3]

void tgui::ChatBox::addLine	(	const sf::String &	text,
		Color	color,
		TextStyle	style
	)

Adds a new line of text to the chat box.

The whole text passed to this function will be considered as one line for the getLine and removeLine functions, even if it is too long and gets split over multiple lines.

Parameters

text	Text that will be added to the chat box
color	Color of the text
style	Text style

◆ clone()

Widget::Ptr tgui::ChatBox::clone ( ) const

inlineoverrideprotectedvirtual

Makes a copy of the widget if you don't know its exact type.

This function should only be used when you don't know the type of the widget. If you know what kind of widget you are copying, you should use the copy function.

Returns: Copy of the widget

Implements tgui::Widget.

◆ copy()

static ChatBox::Ptr tgui::ChatBox::copy ( ChatBox::ConstPtr chatBox )

static

Makes a copy of another chat box.

Parameters

chatBox The other chat box

Returns: The new chat box

◆ create()

static ChatBox::Ptr tgui::ChatBox::create ( )

static

Creates a new chat box widget.

Returns: The new chat box

◆ getLine()

sf::String tgui::ChatBox::getLine ( std::size_t lineIndex ) const

Returns the contents of the requested line.

Parameters

lineIndex The index of the line of which you request the contents The first line has index 0

Returns: The contents of the requested line An empty string will be returned when the index is too high

◆ getLineAmount()

std::size_t tgui::ChatBox::getLineAmount ( )

Returns the amount of lines in the chat box.

Returns: Number of lines in the chat box

◆ getLineColor()

Color tgui::ChatBox::getLineColor ( std::size_t lineIndex ) const

Returns the color of the requested line.

Parameters

lineIndex The index of the line of which you request the color. The first line has index 0

Returns: The color of the requested line. The default color (set with setTextColor) when the index is too high.

◆ getLineLimit()

std::size_t tgui::ChatBox::getLineLimit ( )

Returns the maximum amount of lines in the chat box.

Only the last maxLines lines will be kept. Lines above those will be removed. Disabled when set to 0 (default).

Returns: The maximum amount of lines that the chat box can contain

◆ getLinesStartFromTop()

bool tgui::ChatBox::getLinesStartFromTop ( ) const

Returns whether the first lines start from the top or from the bottom of the chat box.

Note that this only makes a difference when the lines don't fill the entire chat box. This does not change the order of the lines.

Returns: Are the first lines displayed at the top of the chat box?

◆ getLineTextStyle()

TextStyle tgui::ChatBox::getLineTextStyle ( std::size_t lineIndex ) const

Returns the text style of the requested line.

Parameters

lineIndex The index of the line of which you request the text style. The first line has index 0.

Returns: The text style of the requested line. The default style (set with setTextStyle) when the index is too high.

◆ getNewLinesBelowOthers()

bool tgui::ChatBox::getNewLinesBelowOthers ( ) const

Returns whether new lines are added below the other lines or above them.

Returns: Does the addLine function insert the line below the existing lines?

◆ getRenderer()

ChatBoxRenderer * tgui::ChatBox::getRenderer ( )

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns: Temporary pointer to the renderer

Warning: After calling this function, the widget has its own copy of the renderer and it will no longer be shared.

◆ getScrollbarValue()

unsigned int tgui::ChatBox::getScrollbarValue ( ) const

Returns the thumb position of the scrollbar.

Returns: Value of the scrollbar

◆ getSharedRenderer()

ChatBoxRenderer * tgui::ChatBox::getSharedRenderer ( )

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns: Temporary pointer to the renderer that may be shared with other widgets using the same renderer

◆ getTextColor()

const Color & tgui::ChatBox::getTextColor ( ) const

Returns the default color of the text.

Returns: The currently used default text color

◆ getTextStyle()

TextStyle tgui::ChatBox::getTextStyle ( ) const

Returns the default text style.

Returns: The currently used default text style

◆ mouseOnWidget()

bool tgui::ChatBox::mouseOnWidget ( Vector2f pos ) const

overridevirtual

Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

Returns: Is the mouse on top of the widget?

Implements tgui::Widget.

◆ removeLine()

bool tgui::ChatBox::removeLine ( std::size_t lineIndex )

Removes the requested line.

Parameters

lineIndex The index of the line that should be removed The first line has index 0

Returns: True if the line was removed, false if no such line existed (index too high)

◆ rendererChanged()

void tgui::ChatBox::rendererChanged ( const std::string & property )

overrideprotectedvirtual

Function called when one of the properties of the renderer is changed.

Parameters

property Lowercase name of the property that was changed

Reimplemented from tgui::Widget.

◆ setLineLimit()

void tgui::ChatBox::setLineLimit ( std::size_t maxLines )

Sets a maximum amount of lines in the chat box.

Only the last maxLines lines will be kept. Lines above those will be removed. Set to 0 to disable the line limit (default).

Parameters

maxLines The maximum amount of lines that the chat box can contain

◆ setLinesStartFromTop()

void tgui::ChatBox::setLinesStartFromTop ( bool startFromTop = true )

Lets the first lines start from the top or from the bottom of the chat box.

Note that this only makes a difference when the lines don't fill the entire chat box. This does not change the order of the lines.

Parameters

startFromTop Let the first lines be placed at the top of the chat box, or remain at the bottom?

By default the first lines will be placed at the bottom of the chat box.

◆ setNewLinesBelowOthers()

void tgui::ChatBox::setNewLinesBelowOthers ( bool newLinesBelowOthers = true )

Sets whether new lines are added below the other lines or above them.

Parameters

newLinesBelowOthers Should the addLine function insert the line below the existing lines?

By default the new lines are always added below the others.

◆ setScrollbarValue()

void tgui::ChatBox::setScrollbarValue ( unsigned int value )

Changes the thumb position of the scrollbar.

Parameters

value New value of the scrollbar

◆ setSize() [1/3]

virtual void tgui::Widget::setSize ( const Layout2d & size )

virtual

Changes the size of the widget.

Parameters

size	Size of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
 
// Give the widget a size relative to the size of its parent
widget->setSize({"20%", "5%"});
 
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize({200, tgui::bindHeight(otherWidget) + 50});

Reimplemented from tgui::Widget.

◆ setSize() [2/3]

void tgui::ChatBox::setSize ( const Layout2d & size )

overridevirtual

Changes the size of the chat box.

This size does not include the borders.

Parameters

size	The new size of the chat box

Reimplemented from tgui::Widget.

◆ setSize() [3/3]

void tgui::Widget::setSize	(	Layout	width,
		Layout	height
	)

inline

Changes the size of the widget.

Parameters

width	Width of the widget
height	Height of the widget

Warning: This setSize overload must never be used from internal TGUI code or by custom widget implementations

◆ setTextColor()

void tgui::ChatBox::setTextColor ( Color color )

Changes the default color of the text.

Parameters

color The new default text color

◆ setTextSize()

void tgui::ChatBox::setTextSize ( unsigned int size )

overridevirtual

Changes the character size of the text.

Parameters

size	The new text size

Reimplemented from tgui::Widget.

◆ setTextStyle()

void tgui::ChatBox::setTextStyle ( TextStyle style )

Changes the default text style.

Parameters

style The new default text style

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

include/TGUI/Widgets/ChatBox.hpp

TGUI

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ addLine() [1/3]

◆ addLine() [2/3]

◆ addLine() [3/3]

◆ clone()

◆ copy()

◆ create()

◆ getLine()

◆ getLineAmount()

◆ getLineColor()

◆ getLineLimit()

◆ getLinesStartFromTop()

◆ getLineTextStyle()

◆ getNewLinesBelowOthers()

◆ getRenderer()

◆ getScrollbarValue()

◆ getSharedRenderer()

◆ getTextColor()

◆ getTextStyle()

◆ mouseOnWidget()

◆ removeLine()

◆ rendererChanged()

◆ setLineLimit()

◆ setLinesStartFromTop()

◆ setNewLinesBelowOthers()

◆ setScrollbarValue()

◆ setSize() [1/3]

◆ setSize() [2/3]

◆ setSize() [3/3]

◆ setTextColor()

◆ setTextSize()

◆ setTextStyle()