Edit box widget. More...

#include <TGUI/Widgets/EditBox.hpp>

Inheritance diagram for tgui::EditBox:

Classes
struct	Validator
	Predefined input validators. More...

Public Types
using	Ptr = std::shared_ptr<EditBox>
	Shared widget pointer.

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

using	Alignment = HorizontalAlignment
	The text alignment.

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

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

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

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

Public Member Functions
	EditBox (const char *typeName=StaticWidgetType, bool initRenderer=true)

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

TGUI_NODISCARD const EditBoxRenderer *	getSharedRenderer () const override

TGUI_NODISCARD EditBoxRenderer *	getRenderer () override
	Returns the renderer, which gives access to functions that determine how the widget is displayed.

void	setSize (const Layout2d &size) override
	Changes the size of the edit box.

void	setEnabled (bool enabled) override
	Enables or disables the widget.

void	setText (const String &text)
	Changes the text of the editbox.

TGUI_NODISCARD const String &	getText () const
	Returns the text inside the edit box. This text is not affected by the password character.

void	setDefaultText (const String &text)
	Changes the default text of the editbox. This is the text drawn when the edit box is empty.

TGUI_NODISCARD const String &	getDefaultText () const
	Returns the default text of the edit box. This is the text drawn when the edit box is empty.

void	selectText (std::size_t start=0, std::size_t length=String::npos)
	Selects text in the edit box.

TGUI_NODISCARD String	getSelectedText () const
	Returns the text that you currently have selected. This text is not affected by the password character.

void	setPasswordCharacter (char32_t passwordChar)
	Sets a password character.

TGUI_NODISCARD char32_t	getPasswordCharacter () const
	Returns the password character.

void	setMaximumCharacters (unsigned int maxChars)
	Changes the character limit.

TGUI_NODISCARD unsigned int	getMaximumCharacters () const
	Returns the character limit.

void	setAlignment (HorizontalAlignment alignment)
	Changes the text alignment.

TGUI_NODISCARD HorizontalAlignment	getAlignment () const
	Gets the current text alignment.

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?

void	setTextWidthLimited (bool limitWidth)
	Should the text width be limited or should you be able to type even if the edit box is full?

TGUI_NODISCARD bool	isTextWidthLimited () const
	Checks if the text width is limited to the size of the edit box.

void	setReadOnly (bool readOnly=true)
	Makes the edit box read-only or make it writable again.

TGUI_NODISCARD bool	isReadOnly () const
	Checks if the edit box read-only or writable.

void	setCaretPosition (std::size_t charactersBeforeCaret)
	Sets the blinking caret to after a specific character.

TGUI_NODISCARD std::size_t	getCaretPosition () const
	Returns after which character the blinking cursor is currently located.

bool	setInputValidator (const String &regex=U".*")
	Defines how the text input should look like.

TGUI_NODISCARD const String &	getInputValidator () const
	Returns the regex to which the text is matched.

void	setSuffix (const String &suffix)
	Places a suffix at the right side of the edit box.

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

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

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

bool	leftMousePressed (Vector2f pos) override
	Called by the parent when the left mouse button goes down on top of the widget.

void	mouseMoved (Vector2f pos) override

void	keyPressed (const Event::KeyEvent &event) override

bool	canHandleKeyPress (const Event::KeyEvent &event) override
	Called by the parent of the widget to check if keyPressed would process the event.

void	textEntered (char32_t key) override

void	draw (BackendRenderTarget &target, RenderStates states) const override
	Draw the widget to a render target.

void	setSize (Layout width, Layout height)
	Changes the size of the widget.

Public Member Functions inherited from tgui::ClickableWidget
	ClickableWidget (const char *typeName=StaticWidgetType, bool initRenderer=true)

void	leftMouseReleased (Vector2f pos) override

void	rightMousePressed (Vector2f pos) override

void	rightMouseReleased (Vector2f pos) override

void	rightMouseButtonNoLongerDown () override

Public Member Functions inherited from tgui::Widget
	Widget (const char *typeName, bool initRenderer)

	Widget (const Widget &)
	Copy constructor.

	Widget (Widget &&) noexcept
	Move constructor.

virtual	~Widget ()
	Destructor.

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

Widget &	operator= (Widget &&) noexcept
	Move assignment.

void	setRenderer (std::shared_ptr< RendererData > rendererData)
	Sets a new renderer for the widget. The renderer determines how the widget looks.

virtual void	setPosition (const Layout2d &position)
	sets the position of the widget

void	setPosition (Layout x, Layout y)
	Sets the position of the widget.

TGUI_NODISCARD Vector2f	getPosition () const
	Gets the position of the widget.

void	setSize (Layout width, Layout height)
	Changes the size of the widget.

void	setWidth (Layout width)
	Changes the width of the widget.

void	setHeight (Layout height)
	Changes the height of the widget.

TGUI_NODISCARD Vector2f	getSize () const
	Returns the size of the widget.

virtual TGUI_NODISCARD Vector2f	getFullSize () const
	Returns the entire size that the widget is using.

virtual TGUI_NODISCARD Vector2f	getAbsolutePosition (Vector2f offset={}) const
	Get the absolute position of the widget instead of the relative position to its parent.

virtual TGUI_NODISCARD Vector2f	getWidgetOffset () const
	Returns the distance between the position where the widget is drawn and where the widget is placed.

void	setAutoLayout (AutoLayout layout)
	Sets how the position is determined compared to the other widgets in the parent.

TGUI_NODISCARD AutoLayout	getAutoLayout () const
	Returns how the position is determined compared to the other widgets in the parent.

void	setOrigin (float x, float y)
	Sets the origin point on which the position, scale and rotation is based.

void	setOrigin (Vector2f origin)
	Sets the origin point on which the position, scale and rotation is based.

TGUI_NODISCARD Vector2f	getOrigin () const
	Returns the relative origin point on which the position, scale and rotation is based.

void	setScale (Vector2f scaleFactors)
	Sets the scaling to be applied to the widget.

void	setScale (Vector2f scaleFactors, Vector2f origin)
	Sets the scaling to be applied to the widget.

void	setScale (float scaleFactor)
	Sets the scaling to be applied to the widget.

void	setScale (float scaleFactor, Vector2f origin)
	Sets the scaling to be applied to the widget.

TGUI_NODISCARD Vector2f	getScale () const
	Returns the scaling to be applied to the widget.

TGUI_NODISCARD Vector2f	getScaleOrigin () const
	Returns the origin used for scaling.

void	setRotation (float angle)
	Sets the rotation to be applied to the widget.

void	setRotation (float angle, Vector2f origin)
	Sets the rotation to be applied to the widget.

TGUI_NODISCARD float	getRotation () const
	Returns the rotation to be applied to the widget.

TGUI_NODISCARD Vector2f	getRotationOrigin () const
	Returns the origin used for rotations.

void	showWithEffect (ShowEffectType type, Duration duration)
	Shows the widget by introducing it with an animation.

void	hideWithEffect (ShowEffectType type, Duration duration)
	Hides the widget by making it leave with an animation.

void	moveWithAnimation (Layout2d position, Duration duration)
	Moves the widget from its current position to the given position, over a given duration.

void	resizeWithAnimation (Layout2d size, Duration duration)
	Resizes the widget from its current size to the given size, over a given duration.

virtual void	setVisible (bool visible)
	Shows or hides a widget.

TGUI_NODISCARD bool	isVisible () const
	Returns true when the widget is visible.

TGUI_NODISCARD bool	isEnabled () const
	Returns true when the widget is enabled.

TGUI_NODISCARD bool	isFocused () const
	Returns true when the widget is focused and false otherwise.

TGUI_NODISCARD const String &	getWidgetType () const
	Returns the type of the widget.

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

TGUI_NODISCARD BackendGui *	getParentGui () const
	Returns a pointer to the gui to which this widget belongs.

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

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

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

void	setUserData (Any userData)
	Stores some data into the widget.

template<typename DataType >
TGUI_NODISCARD DataType	getUserData () const
	Returns data stored in the widget.

TGUI_NODISCARD bool	hasUserData () const
	Returns whether data stored in the widget.

void	setInheritedFont (const Font &font)
	Sets the font of the widget that is used when no font is set in the renderer.

TGUI_NODISCARD const Font &	getInheritedFont () const
	Returns the font of the widget that is used when no font is set in the renderer.

void	setInheritedOpacity (float opacity)
	Sets the opacity of the widget that will be multiplied with the opacity set in the renderer.

TGUI_NODISCARD float	getInheritedOpacity () const
	Returns the opacity of the widget that is multiplied with the opacity set in the renderer.

void	setTextSize (unsigned int size)
	Changes the character size of text in this widget if it uses text.

TGUI_NODISCARD unsigned int	getTextSize () const
	Returns the character size of text in this widget.

void	setToolTip (Widget::Ptr toolTip)
	Sets the tool tip that should be displayed when hovering over the widget.

TGUI_NODISCARD Widget::Ptr	getToolTip () const
	Returns the tool tip that is displayed when hovering over the widget.

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

TGUI_NODISCARD String	getWidgetName () const
	Returns the name of a widget.

void	setMouseCursor (Cursor::Type cursor)
	Changes which mouse cursor is shown when hovering over the widget.

TGUI_NODISCARD Cursor::Type	getMouseCursor () const
	Returns which mouse cursor is shown when hovering over the widget.

void	setFocusable (bool focusable)
	Changes whether a widget could be focused.

TGUI_NODISCARD bool	isFocusable () const
	Returns whether a widget could be focused.

void	setNavigationUp (const Widget::Ptr &widgetAbove)
	Changes which widget should become focused when navigating upwards from this widget.

TGUI_NODISCARD Widget::Ptr	getNavigationUp () const
	Returns which widget would become focused when navigating upwards from this widget.

void	setNavigationDown (const Widget::Ptr &widgetBelow)
	Changes which widget should become focused when navigating downwards from this widget.

TGUI_NODISCARD Widget::Ptr	getNavigationDown () const
	Returns which widget would become focused when navigating downwards from this widget.

void	setNavigationLeft (const Widget::Ptr &widgetLeft)
	Changes which widget should become focused when navigating to the left from this widget.

TGUI_NODISCARD Widget::Ptr	getNavigationLeft () const
	Returns which widget would become focused when navigating to the left from this widget.

void	setNavigationRight (const Widget::Ptr &widgetRight)
	Changes which widget should become focused when navigating to the right from this widget.

TGUI_NODISCARD Widget::Ptr	getNavigationRight () const
	Returns which widget would become focused when navigating to the right from this widget.

void	setIgnoreMouseEvents (bool ignore)
	Sets whether the widget should completely ignore mouse events and let them pass to the widgets behind it.

TGUI_NODISCARD bool	getIgnoreMouseEvents () const
	Returns whether the widget is ignoring mouse events and letting them pass to the widgets behind it.

void	finishAllAnimations ()
	Makes all animations of the widget finish immediately.

virtual TGUI_NODISCARD bool	canGainFocus () const
	Returns whether the widget can currently gain focus.

TGUI_NODISCARD bool	isContainer () const
	Returns whether the widget is a container widget or not.

TGUI_NODISCARD bool	isMouseDown () const
	Returns whether the left mouse button has been pressed on top of the widget.

virtual void	setParent (Container *parent)

void	setAutoLayoutUpdateEnabled (bool enabled)

virtual void	mouseReleased (Event::MouseButton button, Vector2f pos)

virtual bool	scrolled (float delta, Vector2f pos, bool touch)
	Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)

virtual void	mouseNoLongerOnWidget ()

virtual void	leftMouseButtonNoLongerDown ()

virtual TGUI_NODISCARD Widget::Ptr	askToolTip (Vector2f mousePos)

TGUI_NODISCARD const Layout2d &	getPositionLayout () const

TGUI_NODISCARD const Layout2d &	getSizeLayout () const

void	bindPositionLayout (Layout *layout)

void	unbindPositionLayout (Layout *layout)

void	bindSizeLayout (Layout *layout)

void	unbindSizeLayout (Layout *layout)

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

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

void	rendererChangedCallback (const String &property)

Static Public Member Functions
static TGUI_NODISCARD EditBox::Ptr	create ()
	Creates a new edit box widget.

static TGUI_NODISCARD EditBox::Ptr	copy (const EditBox::ConstPtr &editBox)
	Makes a copy of another edit box.

Static Public Member Functions inherited from tgui::ClickableWidget
static TGUI_NODISCARD ClickableWidget::Ptr	create (const Layout2d &size={"100%", "100%"})
	Creates a new clickable widget.

static TGUI_NODISCARD ClickableWidget::Ptr	copy (const ClickableWidget::ConstPtr &widget)
	Makes a copy of another clickable widget.

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.

SignalString	onReturnOrUnfocus = {"ReturnOrUnfocused"}
	The return key was pressed or the edit box was unfocused. Optional parameter: text in the edit box.

SignalTyped< std::size_t >	onCaretPositionChange = {"CaretPositionChanged"}
	The caret's position was changed. Optional parameter: new caret position.

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.

SignalShowEffect	onShowEffectFinish = {"ShowEffectFinished"}
	A show or hide effect finished. Optional parameters: effect type, new widget visibility or both.

SignalAnimationType	onAnimationFinish = {"AnimationFinished"}
	An animation has finished.

Static Public Attributes
static constexpr const char	StaticWidgetType [] = "EditBox"
	Type name of the widget.

Static Public Attributes inherited from tgui::ClickableWidget
static constexpr const char	StaticWidgetType [] = "ClickableWidget"
	Type name of the widget.

Protected Member Functions
TGUI_NODISCARD Signal &	getSignal (String signalName) override
	Retrieves a signal based on its name.

void	rendererChanged (const String &property) override
	Function called when one of the properties of the renderer is changed.

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

void	updateTextSize () override
	Called when the text size is changed (either by setTextSize or via the renderer)

TGUI_NODISCARD float	getFullTextWidth () const

TGUI_NODISCARD Vector2f	getInnerSize () const

TGUI_NODISCARD float	getVisibleEditBoxWidth () const

TGUI_NODISCARD std::size_t	findCaretPosition (float posX)

void	deleteSelectedCharacters ()

void	recalculateTextPositions ()

void	updateSelection ()

void	updateTextColor ()

bool	updateTime (Duration elapsedTime) override

TGUI_NODISCARD Widget::Ptr	clone () const override
	Makes a copy of the widget if you don't know its exact type.

void	updateSelEnd (const std::size_t newValue)

void	emitReturnOrUnfocus (const String &text)
	Emits the onReturnOrUnfocus signal.

Protected Member Functions inherited from tgui::ClickableWidget
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.

void	recalculateBoundPositionLayouts ()
	Calls recalculateValue() on each layout in m_boundPositionLayouts.

void	recalculateBoundSizeLayouts ()
	Calls recalculateValue() on each layout in m_boundSizeLayouts.

Protected Attributes
bool	m_caretVisible = true

bool	m_limitTextWidth = false

bool	m_readOnly = false

String	m_text

String	m_displayedText

String	m_regexString = U".*"

std::wregex	m_regex

HorizontalAlignment	m_textAlignment = HorizontalAlignment::Left

std::size_t	m_selChars = 0

std::size_t	m_selStart = 0

std::size_t	m_selEnd = 0

char32_t	m_passwordChar = '\0'

unsigned int	m_maxChars = 0

unsigned int	m_textCropPosition = 0

FloatRect	m_selectedTextBackground

FloatRect	m_caret = {0, 0, 1, 0}

bool	m_possibleDoubleClick = false

Text	m_textBeforeSelection

Text	m_textSelection

Text	m_textAfterSelection

Text	m_defaultText

Text	m_textFull

Text	m_textSuffix

Sprite	m_sprite

Sprite	m_spriteHover

Sprite	m_spriteDisabled

Sprite	m_spriteFocused

Borders	m_bordersCached

Padding	m_paddingCached

Color	m_borderColorCached

Color	m_borderColorHoverCached

Color	m_borderColorDisabledCached

Color	m_borderColorFocusedCached

Color	m_backgroundColorCached

Color	m_backgroundColorHoverCached

Color	m_backgroundColorDisabledCached

Color	m_backgroundColorFocusedCached

Color	m_caretColorCached

Color	m_caretColorHoverCached

Color	m_caretColorFocusedCached

Color	m_selectedTextBackgroundColorCached

Protected Attributes inherited from tgui::Widget
String	m_type

String	m_name

Layout2d	m_position
	Stores the position of this widget.

Layout2d	m_size
	Stores the size of this widget.

unsigned int	m_textSize = 0

Vector2f	m_origin

Optional< Vector2f >	m_rotationOrigin

Optional< Vector2f >	m_scaleOrigin

Vector2f	m_scaleFactors = {1, 1}

float	m_rotationDeg = 0

Vector2f	m_prevPosition

Vector2f	m_prevSize

std::unordered_set< Layout * >	m_boundPositionLayouts

std::unordered_set< Layout * >	m_boundSizeLayouts

bool	m_enabled = true
	Stores the flag indicating whether this widget is enabled.

bool	m_visible = true
	Stores the flag indicating whether this widget is visible.

Container *	m_parent = nullptr

BackendGui *	m_parentGui = nullptr

bool	m_mouseHover = false

bool	m_mouseDown = false

bool	m_focused = false

bool	m_focusable = true

std::weak_ptr< Widget >	m_navWidgetUp

std::weak_ptr< Widget >	m_navWidgetDown

std::weak_ptr< Widget >	m_navWidgetRight

std::weak_ptr< Widget >	m_navWidgetLeft

Duration	m_animationTimeElapsed

bool	m_containerWidget = false

Widget::Ptr	m_toolTip = nullptr

aurora::CopiedPtr< WidgetRenderer >	m_renderer = nullptr

std::vector< std::unique_ptr< priv::Animation > >	m_showAnimations

Font	m_inheritedFont

float	m_inheritedOpacity = 1

Any	m_userData

Cursor::Type	m_mouseCursor = Cursor::Type::Arrow

AutoLayout	m_autoLayout = AutoLayout::Manual

bool	m_autoLayoutUpdateEnabled = true

bool	m_ignoreMouseEvents = false

Font	m_fontCached = Font::getGlobalFont()

float	m_opacityCached = 1

bool	m_transparentTextureCached = false

unsigned int	m_textSizeCached = 0

Additional Inherited Members
Protected Types inherited from tgui::Widget
using	SavingRenderersMap = std::map<const Widget*, std::pair<std::unique_ptr<DataIO::Node>, String>>

using	LoadingRenderersMap = std::map<String, std::shared_ptr<RendererData>>

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

Member Function Documentation

◆ canHandleKeyPress()

bool tgui::EditBox::canHandleKeyPress ( const Event::KeyEvent & event )

overridevirtual

Called by the parent of the widget to check if keyPressed would process the event.

Parameters

event Key event that took place

Returns: True if the event would be handled by the widget, false if the key event doesn't affect the widget

Since: TGUI 1.1

Reimplemented from tgui::Widget.

◆ clone()

TGUI_NODISCARD Widget::Ptr tgui::EditBox::clone ( ) const

overrideprotectedvirtual

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 TGUI_NODISCARD EditBox::Ptr tgui::EditBox::copy ( const EditBox::ConstPtr & editBox )

static

Makes a copy of another edit box.

Parameters

editBox The other edit box

Returns: The new edit box

◆ create()

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

static

Creates a new edit box widget.

Returns: The new edit box

◆ draw()

void tgui::EditBox::draw	(	BackendRenderTarget &	target,
		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.

◆ emitReturnOrUnfocus()

void tgui::EditBox::emitReturnOrUnfocus ( const String & text )

protected

Emits the onReturnOrUnfocus signal.

Parameters

text	The text to emit with the signal.

◆ getAlignment()

TGUI_NODISCARD HorizontalAlignment tgui::EditBox::getAlignment ( ) const

Gets the current text alignment.

Returns: Text alignment

◆ getCaretPosition()

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

Returns after which character the blinking cursor is currently located.

Returns: Characters before the caret

◆ getDefaultText()

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

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

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

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

TGUI_NODISCARD EditBoxRenderer * tgui::EditBox::getRenderer ( )

overridevirtual

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.

Reimplemented from tgui::Widget.

◆ getSelectedText()

TGUI_NODISCARD 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() [1/2]

TGUI_NODISCARD const EditBoxRenderer * tgui::EditBox::getSharedRenderer ( ) const

overridevirtual

Reimplemented from tgui::Widget.

◆ getSharedRenderer() [2/2]

TGUI_NODISCARD EditBoxRenderer * tgui::EditBox::getSharedRenderer ( )

overridevirtual

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

Reimplemented from tgui::Widget.

◆ getSignal()

TGUI_NODISCARD Signal & tgui::EditBox::getSignal ( 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()

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

TGUI_NODISCARD const 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

◆ isMouseOnWidget()

TGUI_NODISCARD bool tgui::EditBox::isMouseOnWidget ( 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.

◆ isReadOnly()

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

TGUI_NODISCARD 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

◆ keyPressed()

void tgui::EditBox::keyPressed ( const Event::KeyEvent & event )

overridevirtual

Reimplemented from tgui::Widget.

◆ leftMousePressed()

bool tgui::EditBox::leftMousePressed ( Vector2f pos )

overridevirtual

Called by the parent when the left mouse button goes down on top of the widget.

Parameters

pos	Mouse position in view coordinates relative to the parent widget

Returns: True if the clicked part of the widget is draggable, i.e. if the widget should continue to receive mouse move events until the mouse is released, even when the mouse leaves the widget. When false is returned, the mouse move events will only be sent to the widget as long as the mouse is on top of the widget.

Reimplemented from tgui::ClickableWidget.

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

◆ load()

void tgui::EditBox::load	(	const std::unique_ptr< DataIO::Node > &	node,
		const LoadingRenderersMap &	renderers )

overrideprotectedvirtual

Loads the widget from a tree of nodes.

Reimplemented from tgui::Widget.

◆ mouseMoved()

void tgui::EditBox::mouseMoved ( Vector2f pos )

overridevirtual

Reimplemented from tgui::Widget.

◆ rendererChanged()

void tgui::EditBox::rendererChanged ( const String & property )

overrideprotectedvirtual

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

Parameters

property Name of the property that was changed

Reimplemented from tgui::Widget.

◆ save()

TGUI_NODISCARD std::unique_ptr< DataIO::Node > tgui::EditBox::save ( SavingRenderersMap & renderers ) const

overrideprotectedvirtual

Saves the widget as a tree node in order to save it to a file.

Reimplemented from tgui::Widget.

◆ selectText()

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

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 ( HorizontalAlignment 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 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 String & regex = U".*" )

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 TGUI_API const char32_t * Int

Accept negative and positive integers.

Definition EditBox.hpp:67

◆ 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 ( char32_t 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 TextWidthLimited to false (which is the default).

See also: setTextWidthLimited

◆ 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/2]

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() [2/2]

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 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 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; setTextWidthLimited

◆ setTextWidthLimited()

void tgui::EditBox::setTextWidthLimited ( bool limitWidth )

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.

Since: TGUI 1.3

◆ textEntered()

void tgui::EditBox::textEntered ( char32_t key )

overridevirtual

Reimplemented from tgui::Widget.

◆ updateTextSize()

void tgui::EditBox::updateTextSize ( )

overrideprotectedvirtual

Called when the text size is changed (either by setTextSize or via the renderer)

Reimplemented from tgui::Widget.

◆ updateTime()

bool tgui::EditBox::updateTime ( Duration elapsedTime )

overrideprotectedvirtual

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

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ canHandleKeyPress()

◆ clone()

◆ copy()

◆ create()

◆ draw()

◆ emitReturnOrUnfocus()

◆ getAlignment()

◆ getCaretPosition()

◆ getDefaultText()

◆ getInputValidator()

◆ getMaximumCharacters()

◆ getPasswordCharacter()

◆ getRenderer()

◆ getSelectedText()

◆ getSharedRenderer() [1/2]

◆ getSharedRenderer() [2/2]

◆ getSignal()

◆ getSuffix()

◆ getText()

◆ isMouseOnWidget()

◆ isReadOnly()

◆ isTextWidthLimited()

◆ keyPressed()

◆ leftMousePressed()

◆ limitTextWidth()

◆ load()

◆ mouseMoved()

◆ rendererChanged()

◆ save()

◆ selectText()

◆ setAlignment()

◆ setCaretPosition()

◆ setDefaultText()

◆ setEnabled()

◆ setFocused()

◆ setInputValidator()

◆ setMaximumCharacters()

◆ setPasswordCharacter()

◆ setReadOnly()

◆ setSize() [1/2]

◆ setSize() [2/2]

◆ setSuffix()

◆ setText()

◆ setTextWidthLimited()

◆ textEntered()

◆ updateTextSize()

◆ updateTime()