25#ifndef TGUI_EDIT_BOX_HPP
26#define TGUI_EDIT_BOX_HPP
28#include <TGUI/Widgets/ClickableWidget.hpp>
29#include <TGUI/Renderers/EditBoxRenderer.hpp>
30#include <TGUI/Rect.hpp>
31#include <TGUI/Text.hpp>
33#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
39TGUI_MODULE_EXPORT
namespace tgui
51 using Ptr = std::shared_ptr<EditBox>;
52 using ConstPtr = std::shared_ptr<const EditBox>;
54 static constexpr const char StaticWidgetType[] =
"EditBox";
66 static TGUI_API
const char32_t*
All;
67 static TGUI_API
const char32_t*
Int;
68 static TGUI_API
const char32_t*
UInt;
69 static TGUI_API
const char32_t*
Float;
79 EditBox(
const char* typeName = StaticWidgetType,
bool initRenderer =
true);
104 TGUI_NODISCARD
const EditBoxRenderer* getSharedRenderer()
const override;
120 using Widget::setSize;
182 void selectText(std::size_t start = 0, std::size_t length = String::npos);
251#ifndef TGUI_REMOVE_DEPRECATED_CODE
261 TGUI_DEPRECATED(
"Use setTextWidthLimited instead") void limitTextWidth(
bool limitWidth = true);
388 void mouseMoved(
Vector2f pos)
override;
409 void textEntered(
char32_t key)
override;
445 TGUI_NODISCARD std::unique_ptr<DataIO::Node>
save(SavingRenderersMap& renderers)
const override;
450 void load(
const std::unique_ptr<DataIO::Node>& node,
const LoadingRenderersMap& renderers)
override;
460 TGUI_NODISCARD
float getFullTextWidth()
const;
465 TGUI_NODISCARD
Vector2f getInnerSize()
const;
470 TGUI_NODISCARD
float getVisibleEditBoxWidth()
const;
475 TGUI_NODISCARD std::size_t findCaretPosition(
float posX);
481 void deleteSelectedCharacters();
486 void recalculateTextPositions();
491 void updateSelection();
496 void updateTextColor();
501 bool updateTime(
Duration elapsedTime)
override;
512 void updateSelEnd(
const std::size_t newValue);
527 void backspaceKeyPressed();
532 void deleteKeyPressed();
537 void copySelectedTextToClipboard();
542 void cutSelectedTextToClipboard();
547 void pasteTextFromClipboard();
552 void moveCaretLeft(
bool shiftPressed);
557 void moveCaretRight(
bool shiftPressed);
562 void moveCaretWordBegin();
567 void moveCaretWordEnd();
581 bool m_caretVisible =
true;
586 bool m_limitTextWidth =
false;
588 bool m_readOnly =
false;
594 String m_regexString = U
".*";
601 std::size_t m_selChars = 0;
602 std::size_t m_selStart = 0;
603 std::size_t m_selEnd = 0;
606 char32_t m_passwordChar =
'\0';
610 unsigned int m_maxChars = 0;
613 unsigned int m_textCropPosition = 0;
622 bool m_possibleDoubleClick =
false;
625 Text m_textBeforeSelection;
626 Text m_textSelection;
627 Text m_textAfterSelection;
633 Sprite m_spriteHover;
634 Sprite m_spriteDisabled;
635 Sprite m_spriteFocused;
638 Borders m_bordersCached;
639 Padding m_paddingCached;
640 Color m_borderColorCached;
641 Color m_borderColorHoverCached;
642 Color m_borderColorDisabledCached;
643 Color m_borderColorFocusedCached;
644 Color m_backgroundColorCached;
645 Color m_backgroundColorHoverCached;
646 Color m_backgroundColorDisabledCached;
647 Color m_backgroundColorFocusedCached;
648 Color m_caretColorCached;
649 Color m_caretColorHoverCached;
650 Color m_caretColorFocusedCached;
651 Color m_selectedTextBackgroundColorCached;
657 bool m_onReturnOrUnfocusEmitted =
false;
Base class for render targets.
Definition BackendRenderTarget.hpp:48
Wrapper for durations.
Definition Duration.hpp:56
Edit box widget.
Definition EditBox.hpp:48
void setFocused(bool focused) override
Focus or unfocus the widget.
TGUI_NODISCARD char32_t getPasswordCharacter() const
Returns the password character.
void emitReturnOrUnfocus(const String &text)
Emits the onReturnOrUnfocus signal.
void setReadOnly(bool readOnly=true)
Makes the edit box read-only or make it writable again.
void selectText(std::size_t start=0, std::size_t length=String::npos)
Selects text in the edit box.
void setCaretPosition(std::size_t charactersBeforeCaret)
Sets the blinking caret to after a specific character.
void rendererChanged(const String &property) override
Function called when one of the properties of the renderer is changed.
void setMaximumCharacters(unsigned int maxChars)
Changes the character limit.
static TGUI_NODISCARD EditBox::Ptr create()
Creates a new edit box widget.
void updateTextSize() override
Called when the text size is changed (either by setTextSize or via the renderer)
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.
TGUI_NODISCARD const String & getInputValidator() const
Returns the regex to which the text is matched.
void setAlignment(HorizontalAlignment alignment)
Changes the text alignment.
void setText(const String &text)
Changes the text of the editbox.
TGUI_NODISCARD EditBoxRenderer * getSharedRenderer() override
Returns the renderer, which gives access to functions that determine how the widget is displayed.
void draw(BackendRenderTarget &target, RenderStates states) const override
Draw the widget to a render target.
bool setInputValidator(const String ®ex=U".*")
Defines how the text input should look like.
TGUI_NODISCARD EditBoxRenderer * getRenderer() override
Returns the renderer, which gives access to functions that determine how the widget is displayed.
TGUI_NODISCARD std::size_t getCaretPosition() const
Returns after which character the blinking cursor is currently located.
std::shared_ptr< const EditBox > ConstPtr
Shared constant widget pointer.
Definition EditBox.hpp:52
TGUI_NODISCARD unsigned int getMaximumCharacters() const
Returns the character limit.
TGUI_NODISCARD const String & getSuffix() const
Returns the suffix currently displayed on the right side of the edit box.
TGUI_NODISCARD Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
void setSuffix(const String &suffix)
Places a suffix at the right side of the edit box.
std::shared_ptr< EditBox > Ptr
Shared widget pointer.
Definition EditBox.hpp:51
TGUI_NODISCARD bool isReadOnly() const
Checks if the edit box read-only or writable.
TGUI_NODISCARD String getSelectedText() const
Returns the text that you currently have selected. This text is not affected by the password characte...
void setTextWidthLimited(bool limitWidth)
Should the text width be limited or should you be able to type even if the edit box is full?
void setEnabled(bool enabled) override
Enables or disables the widget.
void setSize(const Layout2d &size) override
Changes the size of the edit box.
TGUI_NODISCARD Signal & getSignal(String signalName) override
Retrieves a signal based on its name.
bool canHandleKeyPress(const Event::KeyEvent &event) override
Called by the parent of the widget to check if keyPressed would process the event.
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.
TGUI_NODISCARD bool isTextWidthLimited() const
Checks if the text width is limited to the size of the edit box.
void setPasswordCharacter(char32_t passwordChar)
Sets a password character.
static TGUI_NODISCARD EditBox::Ptr copy(const EditBox::ConstPtr &editBox)
Makes a copy of another edit box.
TGUI_NODISCARD HorizontalAlignment getAlignment() const
Gets the current text alignment.
TGUI_NODISCARD const String & getText() const
Returns the text inside the edit box. This text is not affected by the password character.
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...
void load(const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
Loads the widget from a tree of nodes.
bool leftMousePressed(Vector2f pos) override
Called by the parent when the left mouse button goes down on top of the widget.
void setDefaultText(const String &text)
Changes the default text of the editbox. This is the text drawn when the edit box is empty.
Definition EditBoxRenderer.hpp:37
Class to store the position or size of a widget.
Definition Layout.hpp:328
Signal to which the user can subscribe to get callbacks from.
Definition Signal.hpp:62
Wrapper class to store strings.
Definition String.hpp:101
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:39
HorizontalAlignment
The horizontal alignment.
Definition Layout.hpp:52
Predefined input validators.
Definition EditBox.hpp:65
static TGUI_API const char32_t * Int
Accept negative and positive integers.
Definition EditBox.hpp:67
static TGUI_API const char32_t * Float
Accept decimal numbers.
Definition EditBox.hpp:69
static TGUI_API const char32_t * UInt
Accept only positive integers.
Definition EditBox.hpp:68
static TGUI_API const char32_t * All
Accept any input.
Definition EditBox.hpp:66
KeyPressed event parameters.
Definition Event.hpp:169
States used for drawing.
Definition RenderStates.hpp:39