Inheritance diagram for tgui::ChatBox:

Classes
struct	Line

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

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

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

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

Public Member Functions
	ChatBox (const char *typeName=StaticWidgetType, bool initRenderer=true)

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

const ChatBoxRenderer *	getSharedRenderer () const override

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	setTextStyle (TextStyles style)
	Changes the default text style.

TextStyles	getTextStyle () const
	Returns the default text style.

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

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

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

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

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

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

unsigned int	getScrollbarMaxValue () const
	Returns the maximum thumb position of the scrollbar.

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

bool	leftMousePressed (Vector2f pos) override
	Called by the parent when the left mouse button goes down on top of the widget.

void	leftMouseReleased (Vector2f pos) override

void	mouseMoved (Vector2f pos) override

bool	scrolled (float delta, Vector2f pos, bool touch) override
	Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)

void	mouseNoLongerOnWidget () override

void	leftMouseButtonNoLongerDown () override

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

Public Member Functions inherited from tgui::Widget
	Widget (const char *typeName, bool initRenderer)

	Widget (const Widget &)
	Copy constructor.

	Widget (Widget &&) noexcept
	Move constructor.

virtual	~Widget ()
	Destructor.

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

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

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

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

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

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

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

void	setWidth (Layout width)
	Changes the width of the widget.

void	setHeight (Layout height)
	Changes the height of the widget.

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

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

virtual Vector2f	getAbsolutePosition (Vector2f offset={}) const
	Get the absolute position of the widget instead of the relative position to its parent.

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

void	setAutoLayout (AutoLayout layout)
	Sets how the position is determined compared to the other widgets in the parent.

AutoLayout	getAutoLayout () const
	Returns how the position is determined compared to the other widgets in the parent.

void	setOrigin (float x, float y)
	Sets the origin point on which the position, scale and rotation is based.

void	setOrigin (Vector2f origin)
	Sets the origin point on which the position, scale and rotation is based.

Vector2f	getOrigin () const
	Returns the relative origin point on which the position, scale and rotation is based.

void	setScale (Vector2f scaleFactors)
	Sets the scaling to be applied to the widget.

void	setScale (Vector2f scaleFactors, Vector2f origin)
	Sets the scaling to be applied to the widget.

void	setScale (float scaleFactor)
	Sets the scaling to be applied to the widget.

void	setScale (float scaleFactor, Vector2f origin)
	Sets the scaling to be applied to the widget.

Vector2f	getScale () const
	Returns the scaling to be applied to the widget.

Vector2f	getScaleOrigin () const
	Returns the origin used for scaling.

void	setRotation (float angle)
	Sets the rotation to be applied to the widget.

void	setRotation (float angle, Vector2f origin)
	Sets the rotation to be applied to the widget.

float	getRotation () const
	Returns the rotation to be applied to the widget.

Vector2f	getRotationOrigin () const
	Returns the origin used for rotations.

void	showWithEffect (ShowEffectType type, Duration duration)
	Shows the widget by introducing it with an animation.

void	hideWithEffect (ShowEffectType type, Duration duration)
	Hides the widget by making it leave with an animation.

void	moveWithAnimation (Layout2d position, Duration duration)
	Moves the widget from its current position to the given position, over a given duration.

void	resizeWithAnimation (Layout2d size, Duration duration)
	Resizes the widget from its current size to the given size, over a given duration.

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

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

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

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

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

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

const String &	getWidgetType () const
	Returns the type of the widget.

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

BackendGui *	getParentGui () const
	Returns a pointer to the gui to which this widget belongs.

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

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

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

void	setUserData (Any userData)
	Stores some data into the widget.

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

bool	hasUserData () const
	Returns whether data stored in the widget.

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

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

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

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

void	setTextSize (unsigned int size)
	Changes the character size of text in this widget if it uses text.

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

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

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

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

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

void	setMouseCursor (Cursor::Type cursor)
	Changes which mouse cursor is shown when hovering over the widget.

Cursor::Type	getMouseCursor () const
	Returns which mouse cursor is shown when hovering over the widget.

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

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

void	setNavigationUp (const Widget::Ptr &widgetAbove)
	Changes which widget should become focused when navigating upwards from this widget.

Widget::Ptr	getNavigationUp () const
	Returns which widget would become focused when navigating upwards from this widget.

void	setNavigationDown (const Widget::Ptr &widgetBelow)
	Changes which widget should become focused when navigating downwards from this widget.

Widget::Ptr	getNavigationDown () const
	Returns which widget would become focused when navigating downwards from this widget.

void	setNavigationLeft (const Widget::Ptr &widgetLeft)
	Changes which widget should become focused when navigating to the left from this widget.

Widget::Ptr	getNavigationLeft () const
	Returns which widget would become focused when navigating to the left from this widget.

void	setNavigationRight (const Widget::Ptr &widgetRight)
	Changes which widget should become focused when navigating to the right from this widget.

Widget::Ptr	getNavigationRight () const
	Returns which widget would become focused when navigating to the right from this widget.

void	setIgnoreMouseEvents (bool ignore)
	Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind it.

bool	getIgnoreMouseEvents () const
	Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it.

void	finishAllAnimations ()
	Makes all animations of the widget finish immediately.

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

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

bool	isMouseDown () const
	Returns whether the left mouse button has been pressed on top of the widget.

virtual Signal &	getSignal (String signalName)
	Retrieves a signal based on its name.

virtual void	setParent (Container *parent)

virtual bool	updateTime (Duration elapsedTime)

void	setAutoLayoutUpdateEnabled (bool enabled)

virtual void	rightMousePressed (Vector2f pos)

virtual void	rightMouseReleased (Vector2f pos)

virtual void	mouseReleased (Event::MouseButton button, Vector2f pos)

virtual void	keyPressed (const Event::KeyEvent &event)

virtual bool	canHandleKeyPress (const Event::KeyEvent &event)
	Called by the parent of the widget to check if keyPressed would process the event.

virtual void	textEntered (char32_t key)

virtual void	rightMouseButtonNoLongerDown ()

virtual Widget::Ptr	askToolTip (Vector2f mousePos)

const Layout2d &	getPositionLayout () const

const Layout2d &	getSizeLayout () const

void	bindPositionLayout (Layout *layout)

void	unbindPositionLayout (Layout *layout)

void	bindSizeLayout (Layout *layout)

void	unbindSizeLayout (Layout *layout)

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

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

void	rendererChangedCallback (const String &property)

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

	ScrollbarChildInterface (const ScrollbarChildInterface &)
	Copy constructor.

	ScrollbarChildInterface (ScrollbarChildInterface &&) noexcept
	Move constructor.

virtual	~ScrollbarChildInterface ()=default
	Destructor.

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

ScrollbarChildInterface &	operator= (ScrollbarChildInterface &&) noexcept
	Move assignment.

ScrollbarAccessor *	getScrollbar ()
	Returns an object that provides access to the widget's scrollbar.

const ScrollbarAccessor *	getScrollbar () const
	Returns an object that provides access to the widget's scrollbar.

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

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

Static Public Attributes
static constexpr const char	StaticWidgetType [] = "ChatBox"
	Type name of the widget.

Protected Member Functions
void	draw (BackendRenderTarget &target, RenderStates states) const override
	Draw the widget to a render target.

void	rendererChanged (const String &property) override
	Function called when one of the properties of the renderer is changed.

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.

void	updateTextSize () override
	Called when the text size is changed (either by setTextSize or via the renderer)

Vector2f	getInnerSize () const

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

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.

void	recalculateBoundPositionLayouts ()
	Calls recalculateValue() on each layout in m_boundPositionLayouts.

void	recalculateBoundSizeLayouts ()
	Calls recalculateValue() on each layout in m_boundSizeLayouts.

Protected Member Functions inherited from tgui::ScrollbarChildInterface
virtual void	scrollbarValueChanged ()
	Called when the value of the scrollbar has been changed via getScrollbar()->setValue(...)

virtual void	scrollbarPolicyChanged ()
	Called when the policy of the scrollbar has been changed via getScrollbar()->setPolicy(...)

virtual void	scrollbarScrollAmountChanged ()
	Called when the scroll amount of the scrollbar has been changed via getScrollbar()->setScrollAmount(...)

void	saveScrollbarPolicy (std::unique_ptr< DataIO::Node > &node) const
	This function should be called inside the save function in order to save the configured scrollbar policy.

void	loadScrollbarPolicy (const std::unique_ptr< DataIO::Node > &node)
	This function should be called inside the load function in order to load the wanted scrollbar policy.

Protected Attributes
Color	m_textColor = Color::Black

TextStyles	m_textStyle

std::size_t	m_maxLines = 0

float	m_fullTextHeight = 0

bool	m_linesStartFromTop = false

bool	m_newLinesBelowOthers = true

std::deque< Line >	m_lines

Sprite	m_spriteBackground

Borders	m_bordersCached

Padding	m_paddingCached

Color	m_backgroundColorCached

Color	m_borderColorCached

Protected Attributes inherited from tgui::Widget
String	m_type

String	m_name

Layout2d	m_position
	Stores the position of this widget.

Layout2d	m_size
	Stores the size of this widget.

unsigned int	m_textSize = 0

Vector2f	m_origin

Optional< Vector2f >	m_rotationOrigin

Optional< Vector2f >	m_scaleOrigin

Vector2f	m_scaleFactors = {1, 1}

float	m_rotationDeg = 0

Vector2f	m_prevPosition

Vector2f	m_prevSize

std::unordered_set< Layout * >	m_boundPositionLayouts

std::unordered_set< Layout * >	m_boundSizeLayouts

bool	m_enabled = true
	Stores the flag indicating whether this widget is enabled.

bool	m_visible = true
	Stores the flag indicating whether this widget is visible.

Container *	m_parent = nullptr

BackendGui *	m_parentGui = nullptr

bool	m_mouseHover = false

bool	m_mouseDown = false

bool	m_focused = false

bool	m_focusable = true

std::weak_ptr< Widget >	m_navWidgetUp

std::weak_ptr< Widget >	m_navWidgetDown

std::weak_ptr< Widget >	m_navWidgetRight

std::weak_ptr< Widget >	m_navWidgetLeft

Duration	m_animationTimeElapsed

bool	m_containerWidget = false

Widget::Ptr	m_toolTip = nullptr

aurora::CopiedPtr< WidgetRenderer >	m_renderer = nullptr

std::vector< std::unique_ptr< priv::Animation > >	m_showAnimations

Font	m_inheritedFont

float	m_inheritedOpacity = 1

Any	m_userData

Cursor::Type	m_mouseCursor = Cursor::Type::Arrow

AutoLayout	m_autoLayout = AutoLayout::Manual

bool	m_autoLayoutUpdateEnabled = true

bool	m_ignoreMouseEvents = false

Font	m_fontCached = Font::getGlobalFont()

float	m_opacityCached = 1

bool	m_transparentTextureCached = false

unsigned int	m_textSizeCached = 0

Protected Attributes inherited from tgui::ScrollbarChildInterface
CopiedSharedPtr< ScrollbarChildWidget >	m_scrollbar

ScrollbarAccessor	m_scrollbarAccessor

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.

SignalShowEffect	onShowEffectFinish = {"ShowEffectFinished"}
	A show or hide effect finished. Optional parameters: effect type, new widget visibility or both.

SignalAnimationType	onAnimationFinish = {"AnimationFinished"}
	An animation has finished.

Protected Types inherited from tgui::Widget
using	SavingRenderersMap = std::map<const Widget*, std::pair<std::unique_ptr<DataIO::Node>, String>>

using	LoadingRenderersMap = std::map<String, std::shared_ptr<RendererData>>

Member Function Documentation

◆ addLine() [1/3]

void tgui::ChatBox::addLine ( const 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 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 String &	text,
		Color	color,
		TextStyles	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

nodiscardoverrideprotectedvirtual

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 ( const ChatBox::ConstPtr & chatBox )

staticnodiscard

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 ( )

staticnodiscard

Creates a new chat box widget.

Returns: The new chat box

◆ draw()

void tgui::ChatBox::draw	(	BackendRenderTarget &	target,
		RenderStates	states ) const

overrideprotectedvirtual

Draw the widget to a render target.

Parameters

target	Render target to draw to
states	Current render states

Implements tgui::Widget.

◆ getLine()

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

nodiscard

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 ( ) const

nodiscard

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

nodiscard

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 ( ) const

nodiscard

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

nodiscard

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()

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

nodiscard

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

nodiscard

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 ( )

nodiscardoverridevirtual

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.

Reimplemented from tgui::Widget.

◆ getScrollbarMaxValue()

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

nodiscard

Returns the maximum thumb position of the scrollbar.

Returns: Maximum value of the scrollbar

Since: TGUI 1.4

◆ getScrollbarValue()

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

nodiscard

Returns the thumb position of the scrollbar.

Returns: Value of the scrollbar

◆ getSharedRenderer() [1/2]

const ChatBoxRenderer * tgui::ChatBox::getSharedRenderer ( ) const

nodiscardoverridevirtual

Reimplemented from tgui::Widget.

◆ getSharedRenderer() [2/2]

ChatBoxRenderer * tgui::ChatBox::getSharedRenderer ( )

nodiscardoverridevirtual

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

Reimplemented from tgui::Widget.

◆ getTextColor()

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

nodiscard

Returns the default color of the text.

Returns: The currently used default text color

◆ getTextStyle()

TextStyles tgui::ChatBox::getTextStyle ( ) const

nodiscard

Returns the default text style.

Returns: The currently used default text style

◆ isMouseOnWidget()

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

nodiscardoverridevirtual

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.

◆ leftMouseButtonNoLongerDown()

void tgui::ChatBox::leftMouseButtonNoLongerDown ( )

overridevirtual

Reimplemented from tgui::Widget.

◆ leftMousePressed()

bool tgui::ChatBox::leftMousePressed ( Vector2f pos )

overridevirtual

Called by the parent when the left mouse button goes down on top of the widget.

Parameters

pos	Mouse position in view coordinates relative to the parent widget

Returns: True if the clicked part of the widget is draggable, i.e. if the widget should continue to receive mouse move events until the mouse is released, even when the mouse leaves the widget. When false is returned, the mouse move events will only be sent to the widget as long as the mouse is on top of the widget.

Reimplemented from tgui::Widget.

◆ leftMouseReleased()

void tgui::ChatBox::leftMouseReleased ( Vector2f pos )

overridevirtual

Reimplemented from tgui::Widget.

◆ load()

void tgui::ChatBox::load	(	const std::unique_ptr< DataIO::Node > &	node,
		const LoadingRenderersMap &	renderers )

overrideprotectedvirtual

Loads the widget from a tree of nodes.

Reimplemented from tgui::Widget.

◆ mouseMoved()

void tgui::ChatBox::mouseMoved ( Vector2f pos )

overridevirtual

Reimplemented from tgui::Widget.

◆ mouseNoLongerOnWidget()

void tgui::ChatBox::mouseNoLongerOnWidget ( )

overridevirtual

Reimplemented from 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 String & property )

overrideprotectedvirtual

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

Parameters

property Name of the property that was changed

Reimplemented from tgui::Widget.

◆ save()

std::unique_ptr< DataIO::Node > tgui::ChatBox::save ( SavingRenderersMap & renderers ) const

nodiscardoverrideprotectedvirtual

Saves the widget as a tree node in order to save it to a file.

Reimplemented from tgui::Widget.

◆ scrolled()

bool tgui::ChatBox::scrolled	(	float	delta,
		Vector2f	pos,
		bool	touch )

overridevirtual

Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)

Parameters

delta	Scroll offset (positive is up, negative is down). High-precision mice may use non-integral offsets.
pos	Mouse position, or the initial position of the touch events
touch	Was this a touch event or a mouse wheel scroll?

Returns: Was the scrolling was handled by the widget?

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/2]

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() [2/2]

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

◆ setTextStyle()

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

Changes the default text style.

Parameters

style The new default text style

◆ updateTextSize()

void tgui::ChatBox::updateTextSize ( )

overrideprotectedvirtual

Called when the text size is changed (either by setTextSize or via the renderer)

Reimplemented from tgui::Widget.

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

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ addLine() [1/3]

◆ addLine() [2/3]

◆ addLine() [3/3]

◆ clone()

◆ copy()

◆ create()

◆ draw()

◆ getLine()

◆ getLineAmount()

◆ getLineColor()

◆ getLineLimit()

◆ getLinesStartFromTop()

◆ getLineTextStyle()

◆ getNewLinesBelowOthers()

◆ getRenderer()

◆ getScrollbarMaxValue()

◆ getScrollbarValue()

◆ getSharedRenderer() [1/2]

◆ getSharedRenderer() [2/2]

◆ getTextColor()

◆ getTextStyle()

◆ isMouseOnWidget()

◆ leftMouseButtonNoLongerDown()

◆ leftMousePressed()

◆ leftMouseReleased()

◆ load()

◆ mouseMoved()

◆ mouseNoLongerOnWidget()

◆ removeLine()

◆ rendererChanged()

◆ save()

◆ scrolled()

◆ setLineLimit()

◆ setLinesStartFromTop()

◆ setNewLinesBelowOthers()

◆ setScrollbarValue()

◆ setSize() [1/2]

◆ setSize() [2/2]

◆ setTextColor()

◆ setTextStyle()

◆ updateTextSize()