TGUI  0.7.4

Edit box widget. More...

#include <EditBox.hpp>

Inheritance diagram for tgui::EditBox:
tgui::ClickableWidget tgui::Widget tgui::Transformable tgui::SignalWidgetBase

Classes

struct  Validator
 Predefined input validators. More...
 

Public Types

enum  Alignment { Alignment::Left, Alignment::Center, Alignment::Right }
 The text alignment. More...
 
typedef std::shared_ptr< EditBoxPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const EditBoxConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::ClickableWidget
typedef std::shared_ptr< ClickableWidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ClickableWidgetConstPtr
 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

std::shared_ptr< EditBoxRenderergetRenderer () 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...
 
void setSize (const Layout2d &size) override
 Changes the size of the edit box. More...
 
virtual sf::Vector2f getFullSize () const override
 Returns the full size of the edit 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 editbox. More...
 
sf::String getText () const
 Returns the text inside the edit box. This text is not affected by the password character. More...
 
void setDefaultText (const sf::String &text)
 Changes the default text of the editbox. This is the text drawn when the edit box is empty. More...
 
sf::String getDefaultText () const
 Returns the default text of the edit box. This is the text drawn when the edit box is empty. More...
 
sf::String getSelectedText () const
 Returns the text that you currently have selected. This text is not affected by the password character. More...
 
void setTextSize (unsigned int textSize)
 Changes the character size of the text. More...
 
unsigned int getTextSize () const
 Returns the character size of the text. More...
 
void setPasswordCharacter (char passwordChar)
 Sets a password character. More...
 
char getPasswordCharacter () const
 Returns the password character. More...
 
void setMaximumCharacters (unsigned int maxChars)
 Change the character limit. More...
 
unsigned int getMaximumCharacters () const
 Returns the character limit. More...
 
void setAlignment (Alignment alignment)
 Change the text alignment. More...
 
Alignment getAlignment ()
 Get the current text alignment. More...
 
void limitTextWidth (bool limitWidth=true)
 Should the text width be limited or should you be able to type even if the edit box is full? More...
 
bool isTextWidthLimited ()
 Check if the text width is limited to the size of the edit box. 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 setCaretWidth (float width)
 This will change the width of the caret. More...
 
float getCaretWidth ()
 Returns the width of the caret. More...
 
void setInputValidator (const std::string &regex=".*")
 Define how the text input should look like. More...
 
const std::string & getInputValidator ()
 Returns the regex to which the text is matched. More...
 
void selectText ()
 Selects the entire text in the edit box.
 
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::ClickableWidget
 ClickableWidget (const Layout2d &size={100, 100})
 Default constructor. More...
 
 ClickableWidget (const Layout &width, const Layout &height)
 Constructor. 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 EditBox::Ptr create ()
 Creates a new edit box widget. More...
 
static EditBox::Ptr copy (EditBox::ConstPtr editBox)
 Makes a copy of another edit box. More...
 
- Static Public Member Functions inherited from tgui::ClickableWidget
static ClickableWidget::Ptr create (Layout2d size={100, 100})
 Creates a new clickable widget. More...
 
static ClickableWidget::Ptr copy (ClickableWidget::ConstPtr widget)
 Makes a copy of another clickable widget. 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

Edit box widget.

Signals:

  • TextChanged
    • Optional parameter sf::String: current text in the edit box
    • Uses Callback member 'text'
  • ReturnKeyPressed (the return/enter key was pressed while the edit box was focused)
    • Optional parameter sf::String: current text in the edit box
    • Uses Callback member 'text'
  • Inherited signals from ClickableWidget

Member Enumeration Documentation

◆ Alignment

The text alignment.

Enumerator
Left 

Put the text on the left side (default)

Center 

Center the text.

Right 

Put the text on the right side (e.g. for numbers)

Member Function Documentation

◆ clone()

virtual Widget::Ptr tgui::EditBox::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

Reimplemented from tgui::ClickableWidget.

◆ copy()

static EditBox::Ptr tgui::EditBox::copy ( EditBox::ConstPtr  editBox)
static

Makes a copy of another edit box.

Parameters
editBoxThe other edit box
Returns
The new edit box

◆ create()

static EditBox::Ptr tgui::EditBox::create ( )
static

Creates a new edit box widget.

Returns
The new edit box

◆ getAlignment()

Alignment tgui::EditBox::getAlignment ( )
inline

Get the current text alignment.

Returns
Text alignment

◆ getCaretPosition()

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

Returns after which character the blinking cursor is currently located.

Returns
Characters before the caret

◆ getCaretWidth()

float tgui::EditBox::getCaretWidth ( )
inline

Returns the width of the caret.

Returns
Caret width

◆ getDefaultText()

sf::String tgui::EditBox::getDefaultText ( ) const
inline

Returns the default text of the edit box. This is the text drawn when the edit box is empty.

This text is not affected by the password character.

Returns
The default text of the edit box.

◆ getFullSize()

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

Returns the full size of the edit box.

The size returned by this function includes the borders.

Returns
Full size of the edit box

Reimplemented from tgui::Transformable.

◆ getInputValidator()

const std::string& tgui::EditBox::getInputValidator ( )

Returns the regex to which the text is matched.

Returns
Regex to match the text with on every text change

◆ getMaximumCharacters()

unsigned int tgui::EditBox::getMaximumCharacters ( ) const
inline

Returns the character limit.

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

There is no character limit by default.

◆ getPasswordCharacter()

char tgui::EditBox::getPasswordCharacter ( ) const
inline

Returns the password character.

Returns
The password character that is currently being used. When no password character is used then this function returns 0.

◆ getRenderer()

std::shared_ptr<EditBoxRenderer> tgui::EditBox::getRenderer ( ) const
inline

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

Returns
Reference to the renderer

◆ getSelectedText()

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

Returns the text that you currently have selected. This text is not affected by the password character.

Returns
The selected text of the edit box.

◆ getText()

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

Returns the text inside the edit box. This text is not affected by the password character.

Returns
The text of the edit box.

◆ getTextSize()

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

Returns the character size of the text.

Returns
The text size.

◆ getWidgetOffset()

virtual sf::Vector2f tgui::EditBox::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.

◆ isTextWidthLimited()

bool tgui::EditBox::isTextWidthLimited ( )
inline

Check if the text width is limited to the size of the edit box.

Returns
Is the text width limit or not.

◆ limitTextWidth()

void tgui::EditBox::limitTextWidth ( bool  limitWidth = true)

Should the text width be limited or should you be able to type even if the edit box is full?

Parameters
limitWidthShould there be a text width limit or not.

When set to true, you will no longer be able to add text when the edit box is full. The default value is false.

◆ reload()

virtual void tgui::EditBox::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.

◆ setAlignment()

void tgui::EditBox::setAlignment ( Alignment  alignment)

Change the text alignment.

Parameters
alignmentThe new text alignment

◆ setCaretPosition()

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

Sets the blinking caret to after a specific character.

Parameters
charactersBeforeCaretThe new position.

Normally you will not need this function.

◆ setCaretWidth()

void tgui::EditBox::setCaretWidth ( float  width)

This will change the width of the caret.

Parameters
widthNew width of the caret

◆ setDefaultText()

void tgui::EditBox::setDefaultText ( const sf::String &  text)

Changes the default text of the editbox. This is the text drawn when the edit box is empty.

This text is not affected by the password character.

Parameters
textThe new default text.

◆ setFont()

virtual void tgui::EditBox::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.

◆ setInputValidator()

void tgui::EditBox::setInputValidator ( const std::string &  regex = ".*")

Define how the text input should look like.

Parameters
regexValid regular expression for std::regex to match on text changes

When the regex does not match when calling the setText function then the edit box contents will be cleared. When it does not match when the user types a character in the edit box, then the input character is rejected.

Examples:

edit1->setInputValidator(EditBox::Validator::Int);
edit2->setInputValidator("[a-zA-Z][a-zA-Z0-9]*");

◆ setMaximumCharacters()

void tgui::EditBox::setMaximumCharacters ( unsigned int  maxChars)

Change the 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::EditBox::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.

◆ setPasswordCharacter()

void tgui::EditBox::setPasswordCharacter ( char  passwordChar)

Sets a password character.

Parameters
passwordCharThe new password character. If set to 0 then there is no password character.

When the text width is limited then this function might remove the last characters in the text if they no longer fit in the EditBox. You can avoid this by setting LimitTextWidth to false (which is the default).

See also
limitTextWidth

◆ setPosition()

virtual void tgui::EditBox::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.

◆ setSize()

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

Changes the size of the edit box.

Parameters
sizeThe new size of the edit box

Reimplemented from tgui::Widget.

◆ setText()

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

Changes the text of the editbox.

Parameters
textThe new text.

The last characters of the text might be removed in the following situations:

  • You have set a character limit and this text contains too much characters.
  • You have limited the text width and the text does not fit inside the EditBox.
See also
setMaximumCharacters
limitTextWidth

◆ setTextSize()

void tgui::EditBox::setTextSize ( unsigned int  textSize)

Changes the character size of the text.

Parameters
textSizeThe new size of the text. If the size is 0 (default) then the text will be scaled to fit in the edit box.

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