TGUI  0.9-beta

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

TextAreaRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
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 (const String &text)
 Changes the text of the text area. More...
 
void addText (const 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 setTextSize (unsigned int size) override
 Changes the character size of the text. 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...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
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. More...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
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...
 
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 (ShowAnimationType type, Duration duration)
 Shows the widget by introducing it with an animation. More...
 
void hideWithEffect (ShowAnimationType type, Duration duration)
 Hides the widget by making it leave with an animation. More...
 
virtual void setVisible (bool visible)
 Shows or hides a widget. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
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...
 
GuiBasegetParentGui () 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...
 
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...
 
virtual unsigned int getTextSize () const
 Returns the character size of text in this widget. More...
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip () const
 Returns the tool tip that is displayed when hovering over the widget. More...
 
void setWidgetName (const 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...
 
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...
 
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 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.
 
SignalAnimation onAnimationFinish = {"AnimationFinished"}
 A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.
 

Protected Member Functions

void draw (BackendRenderTargetBase &target, RenderStates states) const override
 Draw the widget to a render target. More...
 
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.
 
void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
 Loads the widget from a tree of nodes.
 
Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type. More...
 
- Protected Member Functions inherited from tgui::Widget
virtual void mouseEnteredWidget ()
 This function is called when the mouse enters the widget.
 
virtual void mouseLeftWidget ()
 This function is called when the mouse leaves the widget.
 

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

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

◆ rendererChanged()

void tgui::TextArea::rendererChanged ( const String property)
overrideprotectedvirtual

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

Parameters
propertyLowercase name of the property that was changed

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

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});

◆ 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
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 ( const String text)

Changes the text of the text area.

Parameters
textNew text

◆ setTextSize()

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

Changes the character size of the text.

Parameters
sizeThe new text size. The minimum text size is 8

Reimplemented from tgui::Widget.

◆ 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

The documentation for this class was generated from the following file:
TGUI_API Layout bindHeight(GuiBase &gui)
Bind to the height of the gui view.