TGUI  0.8-dev

Edit box widget. More...

#include <EditBox.hpp>

Inheritance diagram for tgui::EditBox:
tgui::ClickableWidget tgui::Widget 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

EditBoxRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
EditBoxRenderergetRenderer ()
 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 edit box. More...
 
void enable () override
 Enables the widget. More...
 
void disable () override
 Disables the widget. More...
 
void setText (const sf::String &text)
 Changes the text of the editbox. More...
 
const 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...
 
const sf::String & getDefaultText () const
 Returns the default text of the edit box. This is the text drawn when the edit box is empty. More...
 
void selectText (std::size_t start=0, std::size_t length=sf::String::InvalidPos)
 Selects text in the edit box. 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)
 Changes the character limit. More...
 
unsigned int getMaximumCharacters () const
 Returns the character limit. More...
 
void setAlignment (Alignment alignment)
 Changes the text alignment. More...
 
Alignment getAlignment () const
 Gets 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 () const
 Checks if the text width is limited to the size of the edit box. More...
 
void setReadOnly (bool readOnly=true)
 Makes the edit box read-only or make it writable again. More...
 
bool isReadOnly () const
 Checks if the edit box read-only or writable. 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 setInputValidator (const std::string &regex=".*")
 Defines how the text input should look like. More...
 
const std::string & getInputValidator () const
 Returns the regex to which the text is matched. More...
 
void draw (sf::RenderTarget &target, sf::RenderStates states) const override
 Draw the widget to a render target. More...
 
- Public Member Functions inherited from tgui::ClickableWidget
 ClickableWidget ()
 Default constructor.
 
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...
 
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 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...
 

Public Attributes

SignalString onTextChange = {"TextChanged"}
 The text was changed. Optional parameter: new text.
 
SignalString onReturnKeyPress = {"ReturnKeyPressed"}
 The return key was pressed. Optional parameter: text in the edit box.
 
- Public Attributes inherited from tgui::ClickableWidget
SignalVector2f onMousePress = {"MousePressed"}
 The mouse went down on the widget. Optional parameter: mouse position relative to widget.
 
SignalVector2f onMouseRelease = {"MouseReleased"}
 The mouse was released on top of the widget. Optional parameter: mouse position relative to widget.
 
SignalVector2f onClick = {"Clicked"}
 The widget was clicked. Optional parameter: mouse position relative to widget.
 
- 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

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

Edit box widget.

An edit box is a single line input field. It has options like setting a password character or displaying a default text. If you are looking for something with multiple lines, word-wrap and a scrollbar then check out the TextBox class.

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

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

◆ disable()

void tgui::EditBox::disable ( )
overridevirtual

Disables the widget.

The widget will no longer receive events and it will thus no longer send callbacks. All widgets are enabled by default.

Reimplemented from tgui::Widget.

◆ draw()

void tgui::EditBox::draw ( sf::RenderTarget &  target,
sf::RenderStates  states 
) const
overridevirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Reimplemented from tgui::ClickableWidget.

◆ enable()

void tgui::EditBox::enable ( )
overridevirtual

Enables the widget.

The widget will receive events and send callbacks again. All widgets are enabled by default.

Reimplemented from tgui::Widget.

◆ getAlignment()

Alignment tgui::EditBox::getAlignment ( ) const

Gets 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

◆ getDefaultText()

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

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

◆ getInputValidator()

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

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

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

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

EditBoxRenderer* tgui::EditBox::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::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

◆ getSharedRenderer()

EditBoxRenderer* tgui::EditBox::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::EditBox::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::ClickableWidget.

◆ getText()

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

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

Returns the character size of the text.

Returns
The text size

◆ isReadOnly()

bool tgui::EditBox::isReadOnly ( ) const

Checks if the edit box read-only or writable.

Returns
Is the edit box read-only?

When the edit 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.

◆ isTextWidthLimited()

bool tgui::EditBox::isTextWidthLimited ( ) const

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

◆ rendererChanged()

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

◆ selectText()

void tgui::EditBox::selectText ( std::size_t  start = 0,
std::size_t  length = sf::String::InvalidPos 
)

Selects text in the edit box.

Parameters
startThe index of the first character to select
lengthAmount of character to select

When no parameters are provided, the entire text is selected.

◆ setAlignment()

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

Changes 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

◆ 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

◆ setInputValidator()

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

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

Changes the character limit.

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

This character limit is disabled by default.

◆ 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

◆ setReadOnly()

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

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

Parameters
readOnlyShould the edit box be read-only?

When the edit 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::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: