TGUI  1.0-alpha

Text area widget. More...

#include <TGUI/Widgets/TextArea.hpp>

Inheritance diagram for tgui::TextArea:
tgui::Widget

Public Types

typedef std::shared_ptr< TextAreaPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const TextAreaConstPtr
 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

 TextArea (const char *typeName="TextArea", bool initRenderer=true)
 
TextAreaRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
const TextAreaRenderergetSharedRenderer () const
 
TextAreaRenderergetRenderer ()
 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 text area. More...
 
void setText (String text)
 Changes the text of the text area. More...
 
void addText (String text)
 Appends some text to the text that was already in the text area. More...
 
String getText () const
 Returns the text of the text area. More...
 
void setDefaultText (const String &text)
 Changes the default text of the text area. This is the text drawn when the text area is empty. More...
 
const StringgetDefaultText () const
 Returns the default text of the text area. This is the text drawn when the text area is empty. More...
 
void setSelectedText (std::size_t selectionStartIndex, std::size_t selectionEndIndex)
 Changes which part of the text is selected. More...
 
String getSelectedText () const
 Returns the text that you currently have selected. More...
 
std::size_t getSelectionStart () const
 Returns the index where the selection starts. More...
 
std::size_t getSelectionEnd () const
 Returns the index where the selection ends. More...
 
void setMaximumCharacters (std::size_t maxChars=0)
 Changes the maximum character limit. More...
 
std::size_t getMaximumCharacters () const
 Returns the maximum character limit. More...
 
void setCaretPosition (std::size_t charactersBeforeCaret)
 Sets the blinking caret to after a specific character. More...
 
std::size_t getCaretPosition () const
 Returns after which character the blinking cursor is currently located. More...
 
void setReadOnly (bool readOnly=true)
 Makes the text area read-only or make it writable again. More...
 
bool isReadOnly () const
 Checks if the text area read-only or writable. More...
 
void setVerticalScrollbarPolicy (Scrollbar::Policy policy)
 Changes when the vertical scrollbar should be displayed. More...
 
Scrollbar::Policy getVerticalScrollbarPolicy () const
 Returns when the vertical scrollbar should be displayed. More...
 
void setHorizontalScrollbarPolicy (Scrollbar::Policy policy)
 Changes when the horizontal scrollbar should be displayed. More...
 
Scrollbar::Policy getHorizontalScrollbarPolicy () const
 Returns when the horizontal scrollbar should be displayed. More...
 
std::size_t getLinesCount () const
 Returns the amount of lines that the text occupies in the TextArea. More...
 
void setFocused (bool focused) override
 Focus or unfocus the widget. More...
 
void enableMonospacedFontOptimization (bool enable=true)
 Changes whether an optimization is made that only works when using a monospaced font. More...
 
void setVerticalScrollbarValue (unsigned int value)
 Changes the thumb position of the vertical scrollbar. More...
 
unsigned int getVerticalScrollbarValue () const
 Returns the thumb position of the vertical scrollbar. More...
 
void setHorizontalScrollbarValue (unsigned int value)
 Changes the thumb position of the horizontal scrollbar. More...
 
unsigned int getHorizontalScrollbarValue () const
 Returns the thumb position of the horizontal scrollbar. More...
 
bool isMouseOnWidget (Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
void leftMousePressed (Vector2f pos) override
 
void leftMouseReleased (Vector2f pos) override
 
void mouseMoved (Vector2f pos) override
 
void keyPressed (const Event::KeyEvent &event) override
 
void textEntered (char32_t key) 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. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
- 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.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (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. More...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
const WidgetRenderergetSharedRenderer () const
 
WidgetRenderergetRenderer ()
 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...
 
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...
 
void setWidth (Layout width)
 Changes the width of the widget. More...
 
void setHeight (Layout height)
 Changes the height 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 top-left point 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...
 
void setOrigin (float x, float y)
 Sets the origin point on which the position, scale and rotation is based. More...
 
void setOrigin (Vector2f origin)
 Sets the origin point on which the position, scale and rotation is based. More...
 
Vector2f getOrigin () const
 Returns the relative origin point on which the position, scale and rotation is based. More...
 
void setScale (Vector2f scaleFactors)
 Sets the scaling to be applied to the widget. More...
 
void setScale (Vector2f scaleFactors, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor)
 Sets the scaling to be applied to the widget. More...
 
void setScale (float scaleFactor, Vector2f origin)
 Sets the scaling to be applied to the widget. More...
 
Vector2f getScale () const
 Returns the scaling to be applied to the widget. More...
 
Vector2f getScaleOrigin () const
 Returns the origin used for scaling. More...
 
void setRotation (float angle)
 Sets the rotation to be applied to the widget. More...
 
void setRotation (float angle, Vector2f origin)
 Sets the rotation to be applied to the widget. More...
 
float getRotation () const
 Returns the rotation to be applied to the widget. More...
 
Vector2f getRotationOrigin () const
 Returns the origin used for rotations. More...
 
void showWithEffect (ShowEffectType type, Duration duration)
 Shows the widget by introducing it with an animation. More...
 
void hideWithEffect (ShowEffectType type, Duration duration)
 Hides the widget by making it leave with an animation. More...
 
void moveWithAnimation (Layout2d position, Duration duration)
 Moves the widget from its current position to the given position, over a given duration. More...
 
void resizeWithAnimation (Layout2d size, Duration duration)
 Resizes the widget from its current size to the given size, over a given duration. 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 StringgetWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
BackendGuigetParentGui () const
 Returns a pointer to the gui to which this widget belongs. More...
 
bool isAnimationPlaying () const
 Returns whether there is an active animation (started with showWithEffect or hideWithEffect) More...
 
void moveToFront ()
 Places the widget before all other widgets. More...
 
void moveToBack ()
 Places the widget behind all other widgets. More...
 
void setUserData (Any userData)
 Stores some data into the widget. More...
 
template<typename T >
getUserData () const
 Returns data stored in the widget. More...
 
bool hasUserData () const
 Returns whether 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 FontgetInheritedFont () 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...
 
void setTextSize (unsigned int size)
 Changes the character size of text in this widget if it uses text. More...
 
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 String &name)
 Changes the name of a widget. More...
 
String getWidgetName () const
 Returns the name of a widget. More...
 
void setMouseCursor (Cursor::Type cursor)
 Changes which mouse cursor is shown when hovering over the widget. More...
 
Cursor::Type getMouseCursor () const
 Returns which mouse cursor is shown when hovering over the 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...
 
void finishAllAnimations ()
 Makes all animations of the widget finish immediately.
 
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...
 
bool isDraggableWidget () const
 Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs) More...
 
bool isMouseDown () const
 Returns whether the left mouse button has been pressed on top of the widget. More...
 
virtual SignalgetSignal (String signalName)
 Retrieves a signal based on its name. More...
 
virtual void setParent (Container *parent)
 
virtual bool updateTime (Duration elapsedTime)
 
virtual bool isMouseOnWidget (Vector2f pos) const =0
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
virtual void leftMousePressed (Vector2f pos)
 
virtual void leftMouseReleased (Vector2f pos)
 
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 mouseMoved (Vector2f pos)
 
virtual void keyPressed (const Event::KeyEvent &event)
 
virtual void textEntered (char32_t key)
 
virtual bool mouseWheelScrolled (float delta, Vector2f pos)
 
virtual void mouseNoLongerOnWidget ()
 
virtual void leftMouseButtonNoLongerDown ()
 
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)
 
virtual void draw (BackendRenderTarget &target, RenderStates states) const =0
 Draw the widget to a render target. More...
 
template<typename WidgetType >
std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 
virtual Widget::Ptr clone () const =0
 Makes a copy of the widget if you don't know its exact type. More...
 
void rendererChangedCallback (const String &property)
 

Static Public Member Functions

static TextArea::Ptr create ()
 Creates a new text area widget. More...
 
static TextArea::Ptr copy (TextArea::ConstPtr textArea)
 Makes a copy of another text area. More...
 

Public Attributes

SignalString onTextChange = {"TextChanged"}
 The text was changed. Optional parameter: new text.
 
Signal onSelectionChange = {"SelectionChanged"}
 Selected text changed.
 
- 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. More...
 

Protected Member Functions

Vector2< std::size_t > findCaretPosition (Vector2f position) const
 
std::size_t getIndexOfSelectionPos (Vector2< std::size_t > selectionPos) const
 
void selectText (float posX, float posY)
 
void deleteSelectedCharacters ()
 
void rearrangeText (bool keepSelection)
 
void updateScrollbars ()
 
void updateSelectionTexts ()
 
void backspaceKeyPressed ()
 
void deleteKeyPressed ()
 
void copySelectedTextToClipboard ()
 
void cutSelectedTextToClipboard ()
 
void pasteTextFromClipboard ()
 
void selectAllText ()
 
void moveCaretPageUp ()
 
void moveCaretPageDown ()
 
void moveCaretLeft (bool shiftPressed)
 
void moveCaretRight (bool shiftPressed)
 
void moveCaretWordBegin ()
 
void moveCaretWordEnd ()
 
void draw (BackendRenderTarget &target, RenderStates states) const override
 Draw the widget to a render target. More...
 
Vector2f getInnerSize () const
 
bool updateTime (Duration elapsedTime) override
 
void recalculatePositions ()
 
void recalculateVisibleLines ()
 
SignalgetSignal (String signalName) override
 Retrieves a signal based on its name. More...
 
void rendererChanged (const 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. More...
 
void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
 Loads the widget from a tree of nodes. More...
 
void updateTextSize () override
 Called when the text size is changed (either by setTextSize or via the renderer) More...
 
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 rendererChanged (const String &property)
 Function called when one of the properties of the renderer is changed. More...
 
virtual std::unique_ptr< DataIO::Node > save (SavingRenderersMap &renderers) const
 Saves the widget as a tree node in order to save it to a file. More...
 
virtual void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers)
 Loads the widget from a tree of nodes. More...
 
virtual void updateTextSize ()
 Called when the text size is changed (either by setTextSize or via the renderer) More...
 
virtual void mouseEnteredWidget ()
 This function is called when the mouse enters the widget. More...
 
virtual void mouseLeftWidget ()
 This function is called when the mouse leaves the widget. More...
 

Protected Attributes

String m_text
 
unsigned int m_lineHeight = 24
 
float m_maxLineWidth
 
std::vector< Stringm_lines
 
std::size_t m_maxChars = 0
 
std::size_t m_topLine = 1
 
std::size_t m_visibleLines = 1
 
Vector2< std::size_t > m_selStart
 
Vector2< std::size_t > m_selEnd
 
std::pair< Vector2< std::size_t >, Vector2< std::size_t > > m_lastSelection
 
Vector2f m_caretPosition
 
bool m_caretVisible = true
 
Text m_textBeforeSelection
 
Text m_textSelection1
 
Text m_textSelection2
 
Text m_textAfterSelection1
 
Text m_textAfterSelection2
 
Text m_defaultText
 
std::vector< FloatRectm_selectionRects
 
CopiedSharedPtr< ScrollbarChildWidgetm_verticalScrollbar
 
CopiedSharedPtr< ScrollbarChildWidgetm_horizontalScrollbar
 
Scrollbar::Policy m_verticalScrollbarPolicy = Scrollbar::Policy::Automatic
 
Scrollbar::Policy m_horizontalScrollbarPolicy = Scrollbar::Policy::Never
 
bool m_possibleDoubleClick = false
 
bool m_readOnly = false
 
bool m_monospacedFontOptimizationEnabled = false
 
Sprite m_spriteBackground
 
Borders m_bordersCached
 
Padding m_paddingCached
 
Color m_borderColorCached
 
Color m_backgroundColorCached
 
Color m_caretColorCached
 
Color m_selectedTextBackgroundColorCached
 
float m_caretWidthCached = 1
 
- 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
 
BackendGuim_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
 
unsigned int m_textSizeCached = 0
 
Any m_userData
 
Cursor::Type m_mouseCursor = Cursor::Type::Arrow
 

Additional Inherited Members

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

Detailed Description

Text area widget.

A text area is a multi-line input box which supports word-wrap and a vertical scrollbar. If you are looking for a single line input field then check out the EditBox class.

Member Function Documentation

◆ addText()

void tgui::TextArea::addText ( String  text)

Appends some text to the text that was already in the text area.

Parameters
textText that will be added to the text that is already in the text area

◆ clone()

Widget::Ptr tgui::TextArea::clone ( ) const
overrideprotectedvirtual

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 TextArea::Ptr tgui::TextArea::copy ( TextArea::ConstPtr  textArea)
static

Makes a copy of another text area.

Parameters
textAreaThe other text area
Returns
The new text area

◆ create()

static TextArea::Ptr tgui::TextArea::create ( )
static

Creates a new text area widget.

Returns
The new text area

◆ draw()

void tgui::TextArea::draw ( BackendRenderTarget target,
RenderStates  states 
) const
overrideprotectedvirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Implements tgui::Widget.

◆ enableMonospacedFontOptimization()

void tgui::TextArea::enableMonospacedFontOptimization ( bool  enable = true)

Changes whether an optimization is made that only works when using a monospaced font.

Parameters
enableWhether the optimization should be enabled

Rearranging text when a horizontal scrollbar is enabled can be almost as expensive as the word-wrap which is performed when there is no horizontal scrollbar. When using a monospaced font there is no need for such expensive calculation. Call this function when using a monospaced font to make changing the text faster.

This function has no effect when the horizontal scrollbar is disabled (default).

◆ getCaretPosition()

std::size_t tgui::TextArea::getCaretPosition ( ) const

Returns after which character the blinking cursor is currently located.

Returns
Characters before the caret

This function is an alias for getSelectionEnd.

◆ getDefaultText()

const String & tgui::TextArea::getDefaultText ( ) const

Returns the default text of the text area. This is the text drawn when the text area is empty.

Returns
The default text of the text area

◆ getHorizontalScrollbarPolicy()

Scrollbar::Policy tgui::TextArea::getHorizontalScrollbarPolicy ( ) const

Returns when the horizontal scrollbar should be displayed.

Returns
The policy for displaying the horizontal scrollbar

The default policy is Never, which means word-wrap will be used to keep the text within the TextArea.

◆ getHorizontalScrollbarValue()

unsigned int tgui::TextArea::getHorizontalScrollbarValue ( ) const

Returns the thumb position of the horizontal scrollbar.

Returns
Value of the horizontal scrollbar

◆ getLinesCount()

std::size_t tgui::TextArea::getLinesCount ( ) const

Returns the amount of lines that the text occupies in the TextArea.

Returns
Lines of text

Note that this is the amount of lines after word-wrap is applied.

◆ getMaximumCharacters()

std::size_t tgui::TextArea::getMaximumCharacters ( ) const

Returns the maximum character limit.

Returns
The character limit The function will return 0 when there is no limit.

There is no character limit by default.

◆ getRenderer()

TextAreaRenderer * tgui::TextArea::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.

◆ getSelectedText()

String tgui::TextArea::getSelectedText ( ) const

Returns the text that you currently have selected.

Returns
The selected text of the text area

◆ getSelectionEnd()

std::size_t tgui::TextArea::getSelectionEnd ( ) const

Returns the index where the selection ends.

The selection end always equals the caret position.

Note that the start of the selection may be behind the end of the selection when the user selected the text from right to left or from bottom to top.

Returns
Amount of characters before the end of the selection

◆ getSelectionStart()

std::size_t tgui::TextArea::getSelectionStart ( ) const

Returns the index where the selection starts.

When no text is selected, this function returns the same getSelectionEnd.

Note that the start of the selection may be behind the end of the selection when the user selected the text from right to left or from bottom to top.

Returns
Amount of characters before the start of the selection

◆ getSharedRenderer()

TextAreaRenderer * tgui::TextArea::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

◆ getSignal()

Signal & tgui::TextArea::getSignal ( String  signalName)
overrideprotectedvirtual

Retrieves a signal based on its name.

Parameters
signalNameName of the signal
Returns
Signal that corresponds to the name
Exceptions
Exceptionwhen the name does not match any signal

Reimplemented from tgui::Widget.

◆ getText()

String tgui::TextArea::getText ( ) const

Returns the text of the text area.

Returns
The text that is currently inside the text area

◆ getVerticalScrollbarPolicy()

Scrollbar::Policy tgui::TextArea::getVerticalScrollbarPolicy ( ) const

Returns when the vertical scrollbar should be displayed.

Returns
The policy for displaying the vertical scrollbar

The default policy is Automatic, which means it only shows when the text doesn't fit inside the TextArea.

◆ getVerticalScrollbarValue()

unsigned int tgui::TextArea::getVerticalScrollbarValue ( ) const

Returns the thumb position of the vertical scrollbar.

Returns
Value of the vertical scrollbar

◆ isMouseOnWidget()

bool tgui::TextArea::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.

◆ isReadOnly()

bool tgui::TextArea::isReadOnly ( ) const

Checks if the text area read-only or writable.

Returns
Is the text area read-only?

When the text area is read-only, you can no longer delete characters and type text. Selecting text, copying text and even calling the setText function will still work.

◆ keyPressed()

void tgui::TextArea::keyPressed ( const Event::KeyEvent event)
overridevirtual

Reimplemented from tgui::Widget.

◆ leftMouseButtonNoLongerDown()

void tgui::TextArea::leftMouseButtonNoLongerDown ( )
overridevirtual

Reimplemented from tgui::Widget.

◆ leftMousePressed()

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

Reimplemented from tgui::Widget.

◆ leftMouseReleased()

void tgui::TextArea::leftMouseReleased ( Vector2f  pos)
overridevirtual

Reimplemented from tgui::Widget.

◆ load()

void tgui::TextArea::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::TextArea::mouseMoved ( Vector2f  pos)
overridevirtual

Reimplemented from tgui::Widget.

◆ mouseNoLongerOnWidget()

void tgui::TextArea::mouseNoLongerOnWidget ( )
overridevirtual

Reimplemented from tgui::Widget.

◆ mouseWheelScrolled()

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

Reimplemented from tgui::Widget.

◆ rendererChanged()

void tgui::TextArea::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::TextArea::save ( SavingRenderersMap &  renderers) const
overrideprotectedvirtual

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

Reimplemented from tgui::Widget.

◆ setCaretPosition()

void tgui::TextArea::setCaretPosition ( std::size_t  charactersBeforeCaret)

Sets the blinking caret to after a specific character.

Parameters
charactersBeforeCaretThe new position

This function will set both the selection start and selection end to the requested value.

◆ setDefaultText()

void tgui::TextArea::setDefaultText ( const String text)

Changes the default text of the text area. This is the text drawn when the text area is empty.

Parameters
textThe new default text

◆ setFocused()

void tgui::TextArea::setFocused ( bool  focused)
overridevirtual

Focus or unfocus the widget.

Parameters
focusedIs the widget focused?

When a widget is focused, the previously focused widget will be unfocused.

Warning
This function only works properly when the widget was already added to its parent (e.g. the Gui).

Reimplemented from tgui::Widget.

◆ setHorizontalScrollbarPolicy()

void tgui::TextArea::setHorizontalScrollbarPolicy ( Scrollbar::Policy  policy)

Changes when the horizontal scrollbar should be displayed.

Parameters
policyThe policy for displaying the horizontal scrollbar

The default policy is Never, which means word-wrap will be used to keep the text within the TextArea.

◆ setHorizontalScrollbarValue()

void tgui::TextArea::setHorizontalScrollbarValue ( unsigned int  value)

Changes the thumb position of the horizontal scrollbar.

Parameters
valueNew value of the horizontal scrollbar

◆ setMaximumCharacters()

void tgui::TextArea::setMaximumCharacters ( std::size_t  maxChars = 0)

Changes the maximum character limit.

Parameters
maxCharsThe new character limit. Set it to 0 to disable the limit

This character limit is disabled by default.

◆ setReadOnly()

void tgui::TextArea::setReadOnly ( bool  readOnly = true)

Makes the text area read-only or make it writable again.

Parameters
readOnlyShould the text area be read-only?

When the text area is read-only, you can no longer delete characters and type text. Selecting text, copying text and even calling the setText function will still work.

◆ setSelectedText()

void tgui::TextArea::setSelectedText ( std::size_t  selectionStartIndex,
std::size_t  selectionEndIndex 
)

Changes which part of the text is selected.

Parameters
selectionStartIndexAmount of characters before the start of the selection
selectionEndIndexAmount of characters before the end of the selection

◆ 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});
TGUI_API Layout bindHeight(std::shared_ptr< Widget > widget)
Bind to the height of the widget.

Reimplemented from tgui::Widget.

◆ setSize() [2/3]

void tgui::TextArea::setSize ( const Layout2d size)
overridevirtual

Changes the size of the text area.

This size does not include the borders.

Parameters
sizeThe new size of the text area

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

◆ setText()

void tgui::TextArea::setText ( String  text)

Changes the text of the text area.

Parameters
textNew text

◆ setVerticalScrollbarPolicy()

void tgui::TextArea::setVerticalScrollbarPolicy ( Scrollbar::Policy  policy)

Changes when the vertical scrollbar should be displayed.

Parameters
policyThe policy for displaying the vertical scrollbar

The default policy is Automatic, which means it only shows when the text doesn't fit inside the TextArea.

◆ setVerticalScrollbarValue()

void tgui::TextArea::setVerticalScrollbarValue ( unsigned int  value)

Changes the thumb position of the vertical scrollbar.

Parameters
valueNew value of the vertical scrollbar

◆ textEntered()

void tgui::TextArea::textEntered ( char32_t  key)
overridevirtual

Reimplemented from tgui::Widget.

◆ updateTextSize()

void tgui::TextArea::updateTextSize ( )
overrideprotectedvirtual

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

Reimplemented from tgui::Widget.

◆ updateTime()

bool tgui::TextArea::updateTime ( Duration  elapsedTime)
overrideprotectedvirtual

Reimplemented from tgui::Widget.


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