TGUI
0.9.5
|
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 | |
ChatBox (const char *typeName="ChatBox", bool initRenderer=true) | |
ChatBoxRenderer * | getSharedRenderer () |
Returns the renderer, which gives access to functions that determine how the widget is displayed. | |
const ChatBoxRenderer * | getSharedRenderer () const |
ChatBoxRenderer * | getRenderer () |
Returns the renderer, which gives access to functions that determine how the widget is displayed. | |
const ChatBoxRenderer * | getRenderer () 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 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. | |
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. | |
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. | |
WidgetRenderer * | getSharedRenderer () |
Returns the renderer, which gives access to functions that determine how the widget is displayed. | |
const WidgetRenderer * | getSharedRenderer () const |
WidgetRenderer * | getRenderer () |
Returns the renderer, which gives access to functions that determine how the widget is displayed. | |
const WidgetRenderer * | getRenderer () 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 String & | getWidgetType () const |
Returns the type of the widget. | |
Container * | getParent () const |
Returns a pointer to the parent widget. | |
GuiBase * | 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 T > | |
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 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. | |
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 Signal & | getSignal (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 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. | |
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< ScrollbarChildWidget > | m_scroll |
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 |
Layout2d | m_size |
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 |
bool | m_visible = true |
Container * | m_parent = nullptr |
GuiBase * | m_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< WidgetRenderer > | m_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 > > |
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.
text | Text that will be added to the chat box |
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.
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.
|
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.
Implements tgui::Widget.
|
static |
Makes a copy of another chat box.
chatBox | The other chat box |
|
static |
Creates a new chat box widget.
|
overrideprotectedvirtual |
Draw the widget to a render target.
target | Render target to draw to |
states | Current render states |
Implements tgui::Widget.
String tgui::ChatBox::getLine | ( | std::size_t | lineIndex | ) | const |
Returns the contents of the requested line.
lineIndex | The index of the line of which you request the contents The first line has index 0 |
std::size_t tgui::ChatBox::getLineAmount | ( | ) |
Returns the amount of lines in the chat box.
Color tgui::ChatBox::getLineColor | ( | std::size_t | lineIndex | ) | const |
Returns the color of the requested line.
lineIndex | The index of the line of which you request the color. The first line has index 0 |
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).
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.
TextStyles tgui::ChatBox::getLineTextStyle | ( | std::size_t | lineIndex | ) | const |
Returns the text style of the requested line.
lineIndex | The index of the line of which you request the text style. The first line has index 0. |
bool tgui::ChatBox::getNewLinesBelowOthers | ( | ) | const |
Returns whether new lines are added below the other lines or above them.
ChatBoxRenderer * tgui::ChatBox::getRenderer | ( | ) |
Returns the renderer, which gives access to functions that determine how the widget is displayed.
unsigned int tgui::ChatBox::getScrollbarValue | ( | ) | const |
Returns the thumb position of the scrollbar.
ChatBoxRenderer * tgui::ChatBox::getSharedRenderer | ( | ) |
Returns the renderer, which gives access to functions that determine how the widget is displayed.
const Color & tgui::ChatBox::getTextColor | ( | ) | const |
Returns the default color of the text.
TextStyles tgui::ChatBox::getTextStyle | ( | ) | const |
Returns the default text style.
|
overridevirtual |
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.
Implements tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overrideprotectedvirtual |
Loads the widget from a tree of nodes.
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
bool tgui::ChatBox::removeLine | ( | std::size_t | lineIndex | ) |
Removes the requested line.
lineIndex | The index of the line that should be removed The first line has index 0 |
|
overrideprotectedvirtual |
Function called when one of the properties of the renderer is changed.
property | Name of the property that was changed |
Reimplemented from tgui::Widget.
|
overrideprotectedvirtual |
Saves the widget as a tree node in order to save it to a file.
Reimplemented from tgui::Widget.
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).
maxLines | The maximum amount of lines that the chat box can contain |
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.
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.
void tgui::ChatBox::setNewLinesBelowOthers | ( | bool | newLinesBelowOthers = true | ) |
Sets whether new lines are added below the other lines or above them.
newLinesBelowOthers | Should the addLine function insert the line below the existing lines? |
By default the new lines are always added below the others.
void tgui::ChatBox::setScrollbarValue | ( | unsigned int | value | ) |
Changes the thumb position of the scrollbar.
value | New value of the scrollbar |
|
virtual |
Changes the size of the widget.
size | Size of the widget |
Usage examples:
Reimplemented from tgui::Widget.
|
overridevirtual |
Changes the size of the chat box.
This size does not include the borders.
size | The new size of the chat box |
Reimplemented from tgui::Widget.
Changes the size of the widget.
width | Width of the widget |
height | Height of the widget |
void tgui::ChatBox::setTextColor | ( | Color | color | ) |
Changes the default color of the text.
color | The new default text color |
|
overridevirtual |
Changes the character size of the text.
size | The new text size |
Reimplemented from tgui::Widget.
void tgui::ChatBox::setTextStyle | ( | TextStyles | style | ) |
Changes the default text style.
style | The new default text style |