Edit box widget. More...

#include <TGUI/Widgets/EditBox.hpp>

Inheritance diagram for tgui::EditBox:

Classes
struct	Validator
	Predefined input validators. More...

Public Types
enum class	Alignment { Left , Center , Right }
	The text alignment. More...

typedef std::shared_ptr< EditBox >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const EditBox >	ConstPtr
	Shared constant widget pointer.

Public Types inherited from tgui::ClickableWidget
typedef std::shared_ptr< ClickableWidget >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const ClickableWidget >	ConstPtr
	Shared constant widget pointer.

Public Types inherited from tgui::Widget
typedef std::shared_ptr< Widget >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const Widget >	ConstPtr
	Shared constant widget pointer.

Public Member Functions
EditBoxRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

EditBoxRenderer *	getRenderer ()
	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	setEnabled (bool enabled) override
	Enables or 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) override
	Changes the character size of the text. More...

unsigned int	getTextSize () const override
	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...

bool	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	setSuffix (const sf::String &suffix)
	Places a suffix at the right side of the edit box. More...

const sf::String &	getSuffix () const
	Returns the suffix currently displayed on the right side of the edit box. More...

void	setFocused (bool focused) override
	Focus or unfocus the widget. More...

bool	mouseOnWidget (Vector2f pos) const override
	Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...

void	draw (sf::RenderTarget &target, sf::RenderStates states) const override
	Draw the widget to a render target. 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::ClickableWidget
	ClickableWidget ()
	Default constructor.

Public Member Functions inherited from tgui::Widget
	Widget ()
	Default constructor.

	Widget (const Widget &)
	Copy constructor.

	Widget (Widget &&)
	Move constructor.

	~Widget ()
	Destructor.

Widget &	operator= (const Widget &)
	Overload of copy assignment operator.

Widget &	operator= (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...

WidgetRenderer *	getSharedRenderer ()
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

WidgetRenderer *	getRenderer ()
	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...

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

virtual void	showWithEffect (ShowAnimationType type, sf::Time duration)
	Shows the widget by introducing it with an animation. More...

virtual void	hideWithEffect (ShowAnimationType type, sf::Time 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...

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 std::string &	getWidgetType () const
	Returns the type of the widget. More...

Container *	getParent () const
	Returns a pointer to the parent widget. More...

bool	isAnimationPlaying () const
	Returns whether there is an active animation (started with showWithEffect or hideWithEffect) More...

virtual void	moveToFront ()
	Places the widget before all other widgets. More...

virtual void	moveToBack ()
	Places the widget behind all other widgets. More...

void	setUserData (std::any userData)
	Stores some data into the widget. More...

template<typename T >
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 Font &	getInheritedFont () 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 () const
	Returns the tool tip that is displayed when hovering over the widget. More...

void	setWidgetName (const sf::String &name)
	Changes the name of a widget. More...

sf::String	getWidgetName () const
	Returns the name of a 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...

template<typename WidgetType >
std::shared_ptr< const WidgetType >	cast () const
	Downcast const widget.

template<typename WidgetType >
std::shared_ptr< WidgetType >	cast ()
	Downcast widget.

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 &...)> >::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, 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.

SignalVector2f	onRightMousePress = {"RightMousePressed"}
	The right mouse button went down on the widget. Optional parameter: mouse position relative to widget.

SignalVector2f	onRightMouseRelease = {"RightMouseReleased"}
	The right mouse button was released on top of the widget. Optional parameter: mouse position relative to widget.

SignalVector2f	onRightClick = {"RightClicked"}
	The widget was right 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.

SignalAnimation	onAnimationFinished = {"AnimationFinished"}
	A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.

Protected Member Functions
Signal &	getSignal (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...

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

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

enum class tgui::EditBox::Alignment

strong

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

editBox The 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

◆ draw()

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

overridevirtual

Draw the widget to a render target.

Parameters

target	Render target to draw to
states	Current render states

Reimplemented from tgui::ClickableWidget.

◆ 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

signalName Name of the signal

Returns: Signal that corresponds to the name

Exceptions

Exception when the name does not match any signal

Reimplemented from tgui::ClickableWidget.

◆ getSuffix()

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

Returns the suffix currently displayed on the right side of the edit box.

Returns: Text shown on right side of edit box

◆ 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

overridevirtual

Returns the character size of the text.

Returns: The text size

Reimplemented from tgui::Widget.

◆ 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

limitWidth Should 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.

◆ mouseOnWidget()

bool tgui::EditBox::mouseOnWidget ( 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?

Reimplemented from tgui::ClickableWidget.

◆ rendererChanged()

void tgui::EditBox::rendererChanged ( const std::string & property )

overrideprotectedvirtual

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

Parameters

property Lowercase 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

start	The index of the first character to select
length	Amount 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

alignment The new text alignment

◆ setCaretPosition()

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

Sets the blinking caret to after a specific character.

Parameters

charactersBeforeCaret The 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

text	The new default text

◆ setEnabled()

void tgui::EditBox::setEnabled ( bool enabled )

overridevirtual

Enables or disables the widget.

Parameters

enabled Is the widget enabled?

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

Reimplemented from tgui::Widget.

◆ setFocused()

void tgui::EditBox::setFocused ( bool focused )

overridevirtual

Focus or unfocus the widget.

Parameters

focused Is 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.

◆ setInputValidator()

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

Defines how the text input should look like.

Parameters

regex Valid regular expression for std::regex to match on text changes

Returns: True when validator was changed, false when std::regex_error was thrown internally.

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]*");

tgui::EditBox::Validator::Int

static const std::string Int

Accept negative and positive integers.

Definition: EditBox.hpp:76

◆ setMaximumCharacters()

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

Changes the character limit.

Parameters

maxChars The 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

passwordChar The 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

readOnly Should 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() [1/3]

virtual void tgui::Widget::setSize ( const Layout2d & size )

virtual

Changes the size of the widget.

Parameters

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

Reimplemented from tgui::Widget.

◆ setSize() [2/3]

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

overridevirtual

Changes the size of the edit box.

Parameters

size	The new size of the edit box

Reimplemented from tgui::Widget.

◆ setSize() [3/3]

void tgui::Widget::setSize	(	Layout	width,
		Layout	height
	)

inline

Changes the size of the widget.

Parameters

width	Width of the widget
height	Height of the widget

Warning: This setSize overload must never be used from internal TGUI code or by custom widget implementations

◆ setSuffix()

void tgui::EditBox::setSuffix ( const sf::String & suffix )

Places a suffix at the right side of the edit box.

Parameters

suffix Text to show on right side of edit box

Setting a suffix can be useful for inputting numbers where you want to unit to be displayed inside the edit box.

◆ setText()

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

Changes the text of the editbox.

Parameters

text	The 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 )

overridevirtual

Changes the character size of the text.

Parameters

textSize The new size of the text If the size is 0 then the text will be scaled to fit in the edit box.

Reimplemented from tgui::Widget.

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

include/TGUI/Widgets/EditBox.hpp

TGUI

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ Alignment

Member Function Documentation

◆ clone()

◆ copy()

◆ create()

◆ draw()

◆ getAlignment()

◆ getCaretPosition()

◆ getDefaultText()

◆ getInputValidator()

◆ getMaximumCharacters()

◆ getPasswordCharacter()

◆ getRenderer()

◆ getSelectedText()

◆ getSharedRenderer()

◆ getSignal()

◆ getSuffix()

◆ getText()

◆ getTextSize()

◆ isReadOnly()

◆ isTextWidthLimited()

◆ limitTextWidth()

◆ mouseOnWidget()

◆ rendererChanged()

◆ selectText()

◆ setAlignment()

◆ setCaretPosition()

◆ setDefaultText()

◆ setEnabled()

◆ setFocused()

◆ setInputValidator()

◆ setMaximumCharacters()

◆ setPasswordCharacter()

◆ setReadOnly()

◆ setSize() [1/3]

◆ setSize() [2/3]

◆ setSize() [3/3]

◆ setSuffix()

◆ setText()

◆ setTextSize()