TGUI  0.8-dev

Text box widget. More...

#include <TextBox.hpp>

Inheritance diagram for tgui::TextBox:
tgui::Widget tgui::SignalWidgetBase

Public Types

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

TextBoxRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
TextBoxRenderergetRenderer ()
 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 box. More...
 
void setText (const sf::String &text)
 Changes the text of the text box. More...
 
void addText (const sf::String &text)
 Appends some text to the text that was already in the text box. More...
 
const sf::String & getText () const
 Returns the text of the text box. More...
 
sf::String getSelectedText () const
 Returns the text that you currently have selected. More...
 
void setTextSize (unsigned int size)
 Changes the character size of the text. More...
 
unsigned int getTextSize () const
 Returns 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 box read-only or make it writable again. More...
 
bool isReadOnly () const
 Checks if the text box read-only or writable. More...
 
void setVerticalScrollbarPresent (bool present)
 Sets whether the vertical scrollbar is present. More...
 
bool isVerticalScrollbarPresent () const
 Returns whether the vertical scrollbar is present. More...
 
std::size_t getLinesCount () const
 Returns the amount of lines that the text occupies in the TextBox. More...
 
bool mouseOnWidget (sf::Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
 ~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...
 
sf::Vector2f getPosition () const
 Gets the position of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
sf::Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual sf::Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
virtual sf::Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. More...
 
virtual sf::Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
virtual void show ()
 Shows the widget. More...
 
virtual void showWithEffect (ShowAnimationType type, sf::Time duration)
 Shows the widget by introducing it with an animation. More...
 
virtual void hide ()
 Hides the widget. More...
 
virtual void hideWithEffect (ShowAnimationType type, sf::Time duration)
 Hides the widget by making it leave with an animation. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void enable ()
 Enables the widget. More...
 
virtual void disable ()
 Disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
virtual void focus ()
 Focus the widget. More...
 
virtual void unfocus ()
 Unfocus the widget. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const std::string & getWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
virtual void moveToFront ()
 Places the widget before all other widgets. More...
 
virtual void moveToBack ()
 Places the widget behind all other widgets. 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 setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip ()
 Returns the tool tip that is displayed when hovering over the widget. More...
 
- Public Member Functions inherited from tgui::SignalWidgetBase
template<typename Func , typename... Args, typename std::enable_if< std::is_convertible< Func, std::function< void(const Args &...)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, const Args &... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs, typename std::enable_if< std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, BoundArgs &&... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs, typename std::enable_if<!std::is_convertible< Func, std::function< void(const BoundArgs &...)>>::value &&!std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, BoundArgs &&... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs>
unsigned int connect (std::initializer_list< std::string > signalNames, Func &&handler, BoundArgs &&... args)
 Connect a signal handler to multiple signals. More...
 
bool disconnect (unsigned int id)
 Disconnects a signal handler. More...
 
void disconnectAll (std::string signalName)
 Disconnects all signal handler from a certain signal. More...
 
void disconnectAll ()
 Disconnects all signal handlers from signals.
 

Static Public Member Functions

static TextBox::Ptr create ()
 Creates a new text box widget. More...
 
static TextBox::Ptr copy (TextBox::ConstPtr textBox)
 Makes a copy of another text box. More...
 

Public Attributes

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

Protected Member Functions

void draw (sf::RenderTarget &target, sf::RenderStates states) const override
 Draw the widget to a render target. More...
 
SignalgetSignal (std::string signalName) override
 Retrieves a signal based on its name. More...
 
void rendererChanged (const std::string &property) override
 Function called when one of the properties of the renderer is changed. 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 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 box widget.

A text box is a multi-line input box which supports word-wrap and a vertical scrollbar. If you are looking for a single line input field (with options like setting a password character or displaying a default text when it is empty) then check out the EditBox class.

Member Function Documentation

◆ addText()

void tgui::TextBox::addText ( const sf::String &  text)

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

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

◆ clone()

Widget::Ptr tgui::TextBox::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 TextBox::Ptr tgui::TextBox::copy ( TextBox::ConstPtr  textBox)
static

Makes a copy of another text box.

Parameters
textBoxThe other text box
Returns
The new text box

◆ create()

static TextBox::Ptr tgui::TextBox::create ( )
static

Creates a new text box widget.

Returns
The new text box

◆ draw()

void tgui::TextBox::draw ( sf::RenderTarget &  target,
sf::RenderStates  states 
) const
overrideprotectedvirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Implements tgui::Widget.

◆ getCaretPosition()

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

Returns after which character the blinking cursor is currently located.

Returns
Characters before the caret

Note that the position is from before word-wrap is aplied.

◆ getLinesCount()

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

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

Returns
Lines of text

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

◆ getMaximumCharacters()

std::size_t tgui::TextBox::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()

TextBoxRenderer* tgui::TextBox::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()

sf::String tgui::TextBox::getSelectedText ( ) const

Returns the text that you currently have selected.

Returns
The selected text of the text box

◆ getSharedRenderer()

TextBoxRenderer* tgui::TextBox::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::TextBox::getSignal ( std::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()

const sf::String& tgui::TextBox::getText ( ) const

Returns the text of the text box.

Returns
The text that is currently inside the text box

◆ getTextSize()

unsigned int tgui::TextBox::getTextSize ( ) const

Returns the character size of the text.

Returns
The current text size

◆ isReadOnly()

bool tgui::TextBox::isReadOnly ( ) const

Checks if the text box read-only or writable.

Returns
Is the text box read-only?

When the text box 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.

◆ isVerticalScrollbarPresent()

bool tgui::TextBox::isVerticalScrollbarPresent ( ) const

Returns whether the vertical scrollbar is present.

Returns
Is the vertical scrollbar present?
See also
setVerticalScrollbarPresent

◆ mouseOnWidget()

bool tgui::TextBox::mouseOnWidget ( sf::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.

◆ rendererChanged()

void tgui::TextBox::rendererChanged ( const std::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::TextBox::setCaretPosition ( std::size_t  charactersBeforeCaret)

Sets the blinking caret to after a specific character.

Parameters
charactersBeforeCaretThe new position

Note that the position is from before word-wrap is aplied.

◆ setMaximumCharacters()

void tgui::TextBox::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::TextBox::setReadOnly ( bool  readOnly = true)

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

Parameters
readOnlyShould the text box be read-only?

When the text box 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.

◆ setSize()

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

Changes the size of the text box.

This size does not include the borders.

Parameters
sizeThe new size of the text box

Reimplemented from tgui::Widget.

◆ setText()

void tgui::TextBox::setText ( const sf::String &  text)

Changes the text of the text box.

Parameters
textNew text

◆ setTextSize()

void tgui::TextBox::setTextSize ( unsigned int  size)

Changes the character size of the text.

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

◆ setVerticalScrollbarPresent()

void tgui::TextBox::setVerticalScrollbarPresent ( bool  present)

Sets whether the vertical scrollbar is present.

When present, the scrollbar will appear once the text takes more space than the text box. When not present, you will not be able to add text once the text box is full. The vertical scroll is present by default.

Parameters
presentShould the vertical scrollbar be present?

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