TGUI  v0.7.5

Text box widget. More...

#include <TextBox.hpp>

Inheritance diagram for tgui::TextBox:
tgui::Widget tgui::Transformable 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

 TextBox (const TextBox &copy)
 Copy constructor. More...
 
TextBoxoperator= (const TextBox &right)
 Overload of assignment operator. More...
 
std::shared_ptr< TextBoxRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setPosition (const Layout2d &position) override
 Set the position of the widget. More...
 
virtual void setSize (const Layout2d &size) override
 Changes the size of the text box. More...
 
virtual sf::Vector2f getFullSize () const override
 Returns the full size of the text box. More...
 
virtual void setFont (const Font &font) override
 Changes the font of the text in the widget. 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...
 
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 setScrollbar (Scrollbar::Ptr scrollbar)
 Changes the scrollbar of the text box. More...
 
Scrollbar::Ptr getScrollbar ()
 Access the scrollbar of the text box. More...
 
void setReadOnly (bool readOnly=true)
 Make the text box read-only or make it writable again. More...
 
bool isReadOnly () const
 Check if the text box read-only or writable. More...
 
virtual void setOpacity (float opacity) override
 Changes the opacity of the widget. More...
 
virtual sf::Vector2f getWidgetOffset () const override
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &copy)
 Copy constructor. More...
 
 ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &right)
 Overload of assignment operator. More...
 
std::shared_ptr< WidgetRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual sf::Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. 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 (bool blockMouseEvents=true)
 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...
 
float getOpacity () const
 Returns the opacity of the widget. More...
 
virtual void moveToFront ()
 Places the widget before all other widgets.
 
virtual void moveToBack ()
 Places the widget behind all other widgets.
 
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...
 
std::shared_ptr< sf::Font > getFont () const
 Returns the font associated with the widget (if any) More...
 
void detachTheme ()
 Detach the theme from the widget. More...
 
std::shared_ptr< BaseThemegetTheme () const
 Returns the theme to which the widget is currently connected. More...
 
std::string getPrimaryLoadingParameter () const
 Returns the primary parameter that was passed to the loader to load this widget. More...
 
std::string getSecondaryLoadingParameter () const
 Returns the secondary parameter that was passed to the loader to load this widget. More...
 
- Public Member Functions inherited from tgui::Transformable
virtual ~Transformable ()=default
 Virtual destructor.
 
void setPosition (const Layout &x, const Layout &y)
 set the position of the widget More...
 
sf::Vector2f getPosition () const
 get the position of the widget More...
 
void move (const Layout2d &offset)
 Move the widget by a given offset. More...
 
void move (const Layout &x, const Layout &y)
 Move the widget by a given offset. More...
 
void setSize (const Layout &width, const Layout &height)
 Changes the size of the widget. More...
 
virtual sf::Vector2f getSize () const
 Returns the size of the widget. More...
 
void scale (const Layout2d &factors)
 Scale the widget. More...
 
void scale (const Layout &x, const Layout &y)
 Scale the widget. More...
 
- Public Member Functions inherited from tgui::SignalWidgetBase
 SignalWidgetBase ()=default
 Default constructor.
 
 SignalWidgetBase (const SignalWidgetBase &copy)
 Copy constructor. More...
 
SignalWidgetBaseoperator= (const SignalWidgetBase &right)
 Overload of assignment operator. More...
 
template<typename Func , typename... Args>
unsigned int connect (const std::string &signalNames, Func func, Args... args)
 Connects a signal handler function to one or more signals. More...
 
template<typename Func , typename... Args>
unsigned int connectEx (const std::string &signalName, Func func, Args... args)
 Connects a signal handler function to one or more signals. More...
 
void disconnect (unsigned int id)
 Disconnects a connection. More...
 
void disconnectAll (const std::string &signalName)
 Disconnect all connections from a certain signal. More...
 
void disconnectAll ()
 Disconnect all connections from a all 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...
 

Protected Member Functions

virtual void reload (const std::string &primary="", const std::string &secondary="", bool force=false) override
 Reload the widget. More...
 
virtual 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
void attachTheme (std::shared_ptr< BaseTheme > theme)
 Attach a theme to the widget. More...
 

Detailed Description

Text box widget.

Signals:

  • TextChanged
    • Optional parameter sf::String: current text in the text box
    • Uses Callback member 'text'
  • Inherited signals from Widget

Constructor & Destructor Documentation

◆ TextBox()

tgui::TextBox::TextBox ( const TextBox copy)

Copy constructor.

Parameters
copyInstance to copy

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

virtual 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

◆ getFullSize()

virtual sf::Vector2f tgui::TextBox::getFullSize ( ) const
overridevirtual

Returns the full size of the text box.

This is the size including the borders.

Returns
Full size of the text box

Reimplemented from tgui::Transformable.

◆ getMaximumCharacters()

std::size_t tgui::TextBox::getMaximumCharacters ( ) const
inline

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

std::shared_ptr<TextBoxRenderer> tgui::TextBox::getRenderer ( ) const
inline

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns
Reference to the renderer

◆ getScrollbar()

Scrollbar::Ptr tgui::TextBox::getScrollbar ( )

Access the scrollbar of the text box.

Returns
scrollbar in the text box

You should not change the scrollbar yourself

◆ getSelectedText()

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

Returns the text that you currently have selected.

Returns
The selected text of the text box.

◆ getText()

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

Returns the text of the text box.

Returns
The text that is currently inside the text box

◆ getTextSize()

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

Returns the character size of the text.

Returns
The current text size.

◆ getWidgetOffset()

virtual sf::Vector2f tgui::TextBox::getWidgetOffset ( ) const
overridevirtual

Returns the distance between the position where the widget is drawn and where the widget is placed.

This is basically the width and height of the optional borders drawn around widgets.

Returns
Offset of the widget

Reimplemented from tgui::Widget.

◆ isReadOnly()

bool tgui::TextBox::isReadOnly ( ) const

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

◆ operator=()

TextBox& tgui::TextBox::operator= ( const TextBox right)

Overload of assignment operator.

Parameters
rightInstance to assign
Returns
Reference to itself

◆ reload()

virtual void tgui::TextBox::reload ( const std::string &  primary = "",
const std::string &  secondary = "",
bool  force = false 
)
overrideprotectedvirtual

Reload the widget.

Parameters
primaryPrimary parameter for the loader
secondarySecondary parameter for the loader
forceTry to only change the looks of the widget and not alter the widget itself when false
Exceptions
Exceptionwhen the connected theme could not create the widget

When primary is an empty string the built-in white theme will be used.

Reimplemented from tgui::Widget.

◆ setFont()

virtual void tgui::TextBox::setFont ( const Font font)
overridevirtual

Changes the font of the text in the widget.

Parameters
fontThe new font.

When you don't call this function then the font from the parent widget will be used.

Reimplemented from tgui::Widget.

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

◆ setOpacity()

virtual void tgui::TextBox::setOpacity ( float  opacity)
overridevirtual

Changes the opacity of the widget.

Parameters
opacityThe opacity of the widget. 0 means completely transparent, while 1 (default) means fully opaque.

Reimplemented from tgui::Widget.

◆ setPosition()

virtual void tgui::TextBox::setPosition ( const Layout2d position)
overridevirtual

Set the position of the widget.

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters
positionNew position
See also
move, getPosition

Reimplemented from tgui::Widget.

◆ setReadOnly()

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

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

◆ setScrollbar()

void tgui::TextBox::setScrollbar ( Scrollbar::Ptr  scrollbar)

Changes the scrollbar of the text box.

Parameters
scrollbarThe new scrollbar to use in the text box

Pass a nullptr to remove the scrollbar. Note that when removing the scrollbar while there are too many items to fit in the text box then the excess items will be removed.

The scrollbar should have no parent and you should not change it yourself. The function is meant to be used like this:

textBox->setScrollbar(theme->load("scrollbar"));

◆ setSize()

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

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