TGUI  0.9.5
Loading...
Searching...
No Matches
Inheritance diagram for tgui::ChatBox:
tgui::Widget

Classes

struct  Line
 

Public Types

typedef std::shared_ptr< ChatBoxPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ChatBoxConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
typedef std::shared_ptr< WidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const WidgetConstPtr
 Shared constant widget pointer.
 

Public Member Functions

 ChatBox (const char *typeName="ChatBox", bool initRenderer=true)
 
ChatBoxRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
const ChatBoxRenderergetSharedRenderer () const
 
ChatBoxRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
const ChatBoxRenderergetRenderer () const
 
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 ()
 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 ()
 Returns the maximum amount of lines in the chat box.
 
void setTextSize (unsigned int size) override
 Changes the character size of the text.
 
void setTextColor (Color color)
 Changes the default color of the text.
 
const ColorgetTextColor () 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.
 
bool isMouseOnWidget (Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.
 
void leftMousePressed (Vector2f pos) override
 
void leftMouseReleased (Vector2f pos) override
 
void mouseMoved (Vector2f pos) override
 
bool mouseWheelScrolled (float delta, Vector2f pos) override
 
void mouseNoLongerOnWidget () override
 
void leftMouseButtonNoLongerDown () override
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget.
 
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 &&)
 Move constructor.
 
virtual ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&)
 Move assignment.
 
void setRenderer (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks.
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
const WidgetRenderergetSharedRenderer () const
 
WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
const WidgetRenderergetRenderer () const
 
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 () const
 Get the absolute position of the top-left point 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 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.
 
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 StringgetWidgetType () const
 Returns the type of the widget.
 
ContainergetParent () const
 Returns a pointer to the parent widget.
 
GuiBasegetParentGui () 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 T >
getUserData () const
 Returns 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 FontgetInheritedFont () 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.
 
virtual 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.
 
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 isDraggableWidget () const
 Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs)
 
bool isMouseDown () const
 Returns whether the left mouse button has been pressed on top of the widget.
 
virtual SignalgetSignal (String signalName)
 Retrieves a signal based on its name.
 
virtual void setParent (Container *parent)
 
virtual bool updateTime (Duration elapsedTime)
 
virtual void rightMousePressed (Vector2f pos)
 
virtual void rightMouseReleased (Vector2f pos)
 
virtual void mousePressed (Event::MouseButton button, Vector2f pos)
 
virtual void mouseReleased (Event::MouseButton button, Vector2f pos)
 
virtual void keyPressed (const Event::KeyEvent &event)
 
virtual void textEntered (char32_t key)
 
virtual void rightMouseButtonNoLongerDown ()
 
virtual Widget::Ptr askToolTip (Vector2f mousePos)
 
const Layout2dgetPositionLayout () const
 
const Layout2dgetSizeLayout () 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.
 

Static Public Member Functions

static ChatBox::Ptr create ()
 Creates a new chat box widget.
 
static ChatBox::Ptr copy (ChatBox::ConstPtr chatBox)
 Makes a copy of another chat box.
 

Protected Member Functions

void draw (BackendRenderTargetBase &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.
 
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.
 

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
 
CopiedSharedPtr< ScrollbarChildWidgetm_scroll
 
std::deque< Linem_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
 
Layout2d m_size
 
unsigned int m_textSize = 0
 
Vector2f m_origin
 
Optional< Vector2fm_rotationOrigin
 
Optional< Vector2fm_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
 
bool m_visible = true
 
Containerm_parent = nullptr
 
GuiBasem_parentGui = nullptr
 
bool m_mouseHover = false
 
bool m_mouseDown = false
 
bool m_focused = false
 
bool m_focusable = true
 
Duration m_animationTimeElapsed
 
bool m_draggableWidget = false
 
bool m_containerWidget = false
 
Widget::Ptr m_toolTip = nullptr
 
aurora::CopiedPtr< WidgetRendererm_renderer = nullptr
 
std::vector< std::shared_ptr< priv::Animation > > m_showAnimations
 
Font m_inheritedFont
 
float m_inheritedOpacity = 1
 
Font m_fontCached = Font::getGlobalFont()
 
float m_opacityCached = 1
 
bool m_transparentTextureCached = false
 
Any m_userData
 
Cursor::Type m_mouseCursor = Cursor::Type::Arrow
 
std::function< void(const String &property)> m_rendererChangedCallback = [this](const String& property){ rendererChangedCallback(property); }
 

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 onAnimationFinish = {"AnimationFinished"}
 
SignalShowEffect onShowEffectFinish = {"ShowEffectFinished"}
 A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.
 
- 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
textText 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
textText that will be added to the chat box
colorColor 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
textText that will be added to the chat box
colorColor of the text
styleText 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
chatBoxThe 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

◆ draw()

void tgui::ChatBox::draw ( BackendRenderTargetBase target,
RenderStates  states 
) const
overrideprotectedvirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Implements tgui::Widget.

◆ getLine()

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

Returns the contents of the requested line.

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

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

Returns the text style of the requested line.

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

TextStyles tgui::ChatBox::getTextStyle ( ) const

Returns the default text style.

Returns
The currently used default text style

◆ isMouseOnWidget()

bool tgui::ChatBox::isMouseOnWidget ( 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.

◆ leftMouseButtonNoLongerDown()

void tgui::ChatBox::leftMouseButtonNoLongerDown ( )
overridevirtual

Reimplemented from tgui::Widget.

◆ leftMousePressed()

void tgui::ChatBox::leftMousePressed ( Vector2f  pos)
overridevirtual

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.

◆ mouseWheelScrolled()

bool tgui::ChatBox::mouseWheelScrolled ( float  delta,
Vector2f  pos 
)
overridevirtual

Reimplemented from tgui::Widget.

◆ removeLine()

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

Removes the requested line.

Parameters
lineIndexThe 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
propertyName of the property that was changed

Reimplemented from tgui::Widget.

◆ save()

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

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

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
maxLinesThe 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
startFromTopLet 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
newLinesBelowOthersShould 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
valueNew value of the scrollbar

◆ setSize() [1/3]

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

Changes the size of the widget.

Parameters
sizeSize 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
sizeThe 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
widthWidth of the widget
heightHeight 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
colorThe new default text color

◆ setTextSize()

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

Changes the character size of the text.

Parameters
sizeThe new text size

Reimplemented from tgui::Widget.

◆ setTextStyle()

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

Changes the default text style.

Parameters
styleThe new default text style

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