25#ifndef TGUI_EDIT_BOX_HPP
26#define TGUI_EDIT_BOX_HPP
29#include <TGUI/Widgets/ClickableWidget.hpp>
30#include <TGUI/Renderers/EditBoxRenderer.hpp>
31#include <TGUI/Rect.hpp>
32#include <TGUI/Text.hpp>
49 typedef std::shared_ptr<EditBox>
Ptr;
50 typedef std::shared_ptr<const EditBox>
ConstPtr;
74 static TGUI_API
const char*
All;
75 static TGUI_API
const char*
Int;
76 static TGUI_API
const char*
UInt;
77 static TGUI_API
const char*
Float;
88 EditBox(
const char* typeName =
"EditBox",
bool initRenderer =
true);
203 void selectText(std::size_t start = 0, std::size_t length = String::npos);
411 void leftMousePressed(
Vector2f pos)
override;
416 void mouseMoved(
Vector2f pos)
override;
426 void textEntered(
char32_t key)
override;
466 std::unique_ptr<DataIO::Node>
save(SavingRenderersMap& renderers)
const override;
472 void load(
const std::unique_ptr<DataIO::Node>& node,
const LoadingRenderersMap& renderers)
override;
484 float getFullTextWidth()
const;
496 float getVisibleEditBoxWidth()
const;
502 std::size_t findCaretPosition(
float posX);
509 void deleteSelectedCharacters();
515 void recalculateTextPositions();
521 void updateSelection();
527 void updateTextColor();
533 bool updateTime(
Duration elapsedTime)
override;
548 void backspaceKeyPressed();
553 void deleteKeyPressed();
558 void copySelectedTextToClipboard();
563 void cutSelectedTextToClipboard();
568 void pasteTextFromClipboard();
573 void moveCaretLeft(
bool shiftPressed);
578 void moveCaretRight(
bool shiftPressed);
583 void moveCaretWordBegin();
588 void moveCaretWordEnd();
603 bool m_caretVisible =
true;
608 bool m_limitTextWidth =
false;
610 bool m_readOnly =
false;
616 String m_regexString = U
".*";
620 Alignment m_textAlignment = Alignment::Left;
623 std::size_t m_selChars = 0;
624 std::size_t m_selStart = 0;
625 std::size_t m_selEnd = 0;
628 char32_t m_passwordChar =
'\0';
632 unsigned int m_maxChars = 0;
635 unsigned int m_textCropPosition = 0;
644 bool m_possibleDoubleClick =
false;
647 Text m_textBeforeSelection;
648 Text m_textSelection;
649 Text m_textAfterSelection;
655 Sprite m_spriteHover;
656 Sprite m_spriteDisabled;
657 Sprite m_spriteFocused;
660 Borders m_bordersCached;
661 Padding m_paddingCached;
662 Color m_borderColorCached;
663 Color m_borderColorHoverCached;
664 Color m_borderColorDisabledCached;
665 Color m_borderColorFocusedCached;
666 Color m_backgroundColorCached;
667 Color m_backgroundColorHoverCached;
668 Color m_backgroundColorDisabledCached;
669 Color m_backgroundColorFocusedCached;
670 Color m_caretColorCached;
671 Color m_caretColorHoverCached;
672 Color m_caretColorFocusedCached;
673 Color m_selectedTextBackgroundColorCached;
Base class for render targets.
Definition: BackendRenderTarget.hpp:48
Wrapper for durations.
Definition: Duration.hpp:52
Definition: EditBoxRenderer.hpp:37
Edit box widget.
Definition: EditBox.hpp:46
void setFocused(bool focused) override
Focus or unfocus the widget.
static EditBox::Ptr create()
Creates a new edit box widget.
void setReadOnly(bool readOnly=true)
Makes the edit box read-only or make it writable again.
const String & getText() const
Returns the text inside the edit box. This text is not affected by the password character.
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.
bool isMouseOnWidget(Vector2f pos) const override
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget...
Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
void rendererChanged(const String &property) override
Function called when one of the properties of the renderer is changed.
Alignment
The text alignment.
Definition: EditBox.hpp:57
bool isTextWidthLimited() const
Checks if the text width is limited to the size of the edit box.
void setMaximumCharacters(unsigned int maxChars)
Changes the character limit.
void updateTextSize() override
Called when the text size is changed (either by setTextSize or via the renderer)
char32_t getPasswordCharacter() const
Returns the password character.
void setText(const String &text)
Changes the text of the editbox.
const String & getInputValidator() const
Returns the regex to which the text is matched.
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?
std::size_t getCaretPosition() const
Returns after which character the blinking cursor is currently located.
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.
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 setAlignment(Alignment alignment)
Changes the text alignment.
unsigned int getMaximumCharacters() const
Returns the character limit.
std::shared_ptr< const EditBox > ConstPtr
Shared constant widget pointer.
Definition: EditBox.hpp:50
static EditBox::Ptr copy(EditBox::ConstPtr editBox)
Makes a copy of another edit box.
void setSuffix(const String &suffix)
Places a suffix at the right side of the edit box.
String getSelectedText() const
Returns the text that you currently have selected. This text is not affected by the password characte...
Alignment getAlignment() const
Gets the current text alignment.
const String & getSuffix() const
Returns the suffix currently displayed on the right side of the edit box.
void setEnabled(bool enabled) override
Enables or disables the widget.
void setSize(const Layout2d &size) override
Changes the size of the edit box.
const String & getDefaultText() const
Returns the default text of the edit box. This is the text drawn when the edit box is empty.
Signal & getSignal(String signalName) override
Retrieves a signal based on its name.
EditBoxRenderer * getSharedRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
EditBoxRenderer * getRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
std::shared_ptr< EditBox > Ptr
Shared widget pointer.
Definition: EditBox.hpp:49
void setPasswordCharacter(char32_t passwordChar)
Sets a password character.
bool isReadOnly() const
Checks if the edit box read-only or writable.
void load(const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
Loads the widget from a tree of nodes.
void setDefaultText(const String &text)
Changes the default text of the editbox. This is the text drawn when the edit box is empty.
Class to store the position or size of a widget.
Definition: Layout.hpp:284
Signal to which the user can subscribe to get callbacks from.
Definition: Signal.hpp:58
Wrapper class to store strings.
Definition: String.hpp:79
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:36
Predefined input validators.
Definition: EditBox.hpp:73
static TGUI_API const char * All
Accept any input.
Definition: EditBox.hpp:74
static TGUI_API const char * Float
Accept decimal numbers.
Definition: EditBox.hpp:77
static TGUI_API const char * Int
Accept negative and positive integers.
Definition: EditBox.hpp:75
static TGUI_API const char * UInt
Accept only positive integers.
Definition: EditBox.hpp:76
KeyPressed event parameters.
Definition: Event.hpp:167
States used for drawing.
Definition: RenderStates.hpp:39