EditBox.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2024 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
// you must not claim that you wrote the original software.
// If you use this software in a product, an acknowledgment
// in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
// and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef TGUI_EDIT_BOX_HPP
#define TGUI_EDIT_BOX_HPP
 
 
#include <TGUI/Widgets/ClickableWidget.hpp>
#include <TGUI/Renderers/EditBoxRenderer.hpp>
#include <TGUI/Rect.hpp>
#include <TGUI/Text.hpp>
 
#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
 #include <regex>
#endif
 
 
TGUI_MODULE_EXPORT namespace tgui
{
 class TGUI_API EditBox : public ClickableWidget
 {
 public:
 
 using Ptr = std::shared_ptr<EditBox>; 
 using ConstPtr = std::shared_ptr<const EditBox>; 
 
 static constexpr const char StaticWidgetType[] = "EditBox"; 
 
 
 enum class Alignment
 {
 Left,
 
 Center,
 
 Right
 };
 
 
 struct Validator
 {
 static TGUI_API const char32_t* All; 
 static TGUI_API const char32_t* Int; 
 static TGUI_API const char32_t* UInt; 
 static TGUI_API const char32_t* Float; 
 };
 
 
 EditBox(const char* typeName = StaticWidgetType, bool initRenderer = true);
 
 
 TGUI_NODISCARD static EditBox::Ptr create();
 
 
 TGUI_NODISCARD static EditBox::Ptr copy(const EditBox::ConstPtr& editBox);
 
 
 TGUI_NODISCARD EditBoxRenderer* getSharedRenderer() override;
 TGUI_NODISCARD const EditBoxRenderer* getSharedRenderer() const override;
 
 TGUI_NODISCARD EditBoxRenderer* getRenderer() override;
 
 
 void setSize(const Layout2d& size) override;
 using Widget::setSize;
 
 
 void setEnabled(bool enabled) override;
 
 
 void setText(const String& text);
 
 
 TGUI_NODISCARD const String& getText() const;
 
 
 void setDefaultText(const String& text);
 
 
 TGUI_NODISCARD const String& getDefaultText() const;
 
 
 void selectText(std::size_t start = 0, std::size_t length = String::npos);
 
 
 TGUI_NODISCARD String getSelectedText() const;
 
 
 void setPasswordCharacter(char32_t passwordChar);
 
 
 TGUI_NODISCARD char32_t getPasswordCharacter() const;
 
 
 void setMaximumCharacters(unsigned int maxChars);
 
 
 TGUI_NODISCARD unsigned int getMaximumCharacters() const;
 
 
 void setAlignment(Alignment alignment);
 
 
 TGUI_NODISCARD Alignment getAlignment() const;
 
 
 void limitTextWidth(bool limitWidth = true);
 
 
 TGUI_NODISCARD bool isTextWidthLimited() const;
 
 
 void setReadOnly(bool readOnly = true);
 
 
 TGUI_NODISCARD bool isReadOnly() const;
 
 
 void setCaretPosition(std::size_t charactersBeforeCaret);
 
 
 TGUI_NODISCARD std::size_t getCaretPosition() const;
 
 
 bool setInputValidator(const String& regex = U".*");
 
 
 TGUI_NODISCARD const String& getInputValidator() const;
 
 
 void setSuffix(const String& suffix);
 
 
 TGUI_NODISCARD const String& getSuffix() const;
 
 
 void setFocused(bool focused) override;
 
 
 TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;
 
 
 bool leftMousePressed(Vector2f pos) override;
 
 void mouseMoved(Vector2f pos) override;
 
 void keyPressed(const Event::KeyEvent& event) override;
 
 bool canHandleKeyPress(const Event::KeyEvent& event) override;
 
 void textEntered(char32_t key) override;
 
 
 void draw(BackendRenderTarget& target, RenderStates states) const override;
 
 
 protected:
 
 TGUI_NODISCARD Signal& getSignal(String signalName) override;
 
 
 void rendererChanged(const String& property) override;
 
 
 TGUI_NODISCARD std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
 
 
 void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
 
 
 void updateTextSize() override;
 
 
 // Returns the total width that the text is going to take
 TGUI_NODISCARD float getFullTextWidth() const;
 
 
 // Returns the size without the borders
 TGUI_NODISCARD Vector2f getInnerSize() const;
 
 
 // Returns the width of the edit box minus the padding.
 TGUI_NODISCARD float getVisibleEditBoxWidth() const;
 
 
 // This function will search after which character the caret should be placed. It will not change the caret position.
 TGUI_NODISCARD std::size_t findCaretPosition(float posX);
 
 
 // Removes the selected characters. This function is called when pressing backspace, delete or a letter while there were
 // some characters selected.
 void deleteSelectedCharacters();
 
 
 // Recalculates the position of the texts.
 void recalculateTextPositions();
 
 
 // Updates the internal texts after SelStart or SelEnd changed.
 void updateSelection();
 
 
 // Update the color of the Text objects
 void updateTextColor();
 
 
 // This function is called every frame with the time passed since the last frame.
 bool updateTime(Duration elapsedTime) override;
 
 
 // Makes a copy of the widget
 TGUI_NODISCARD Widget::Ptr clone() const override;
 
 
 // Updates m_selEnd with a new value and emits the onCaretPositionChange signal
 // @param newValue the value to assign to m_selEnd.
 void updateSelEnd(const std::size_t newValue);
 
 
 void emitReturnOrUnfocus(const String& text);
 
 
 private:
 
 // Handles "Backspace" key press
 void backspaceKeyPressed();
 
 // Handles "Delete" key press
 void deleteKeyPressed();
 
 // Handles "Ctrl+C" key press (or equivalent on macOS)
 void copySelectedTextToClipboard();
 
 // Handles "Ctrl+X" key press (or equivalent on macOS)
 void cutSelectedTextToClipboard();
 
 // Handles "Ctrl+V" key press (or equivalent on macOS)
 void pasteTextFromClipboard();
 
 // Handles "ArrowLeft" key press
 void moveCaretLeft(bool shiftPressed);
 
 // Handles "ArrowRight" key press
 void moveCaretRight(bool shiftPressed);
 
 // Handles "Ctrl+ArrowLeft" key press (or equivalent on macOS)
 void moveCaretWordBegin();
 
 // Handles "Ctrl+ArrowRight" key press (or equivalent on macOS)
 void moveCaretWordEnd();
 
 
 public:
 
 SignalString onTextChange = {"TextChanged"}; 
 SignalString onReturnKeyPress = {"ReturnKeyPressed"}; 
 SignalString onReturnOrUnfocus = {"ReturnOrUnfocused"}; 
 SignalTyped<std::size_t> onCaretPositionChange = {"CaretPositionChanged"}; 
 
 
 protected:
 
 // Is the caret visible or not?
 bool m_caretVisible = true;
 
 // When this boolean is true then you can no longer add text when the EditBox is full.
 // Changing it to false will allow you to scroll the text (default).
 // You can change the boolean with the limitTextWidth(bool) function.
 bool m_limitTextWidth = false;
 
 bool m_readOnly = false;
 
 // The text inside the edit box
 String m_text;
 String m_displayedText; // Same as m_text unless a password char is set
 
 String m_regexString = U".*";
 std::wregex m_regex;
 
 // The text alignment
 Alignment m_textAlignment = Alignment::Left;
 
 // The selection
 std::size_t m_selChars = 0;
 std::size_t m_selStart = 0;
 std::size_t m_selEnd = 0;
 
 // The password character
 char32_t m_passwordChar = '\0';
 
 // The maximum allowed characters.
 // Zero by default, meaning no limit.
 unsigned int m_maxChars = 0;
 
 // When the text width is not limited, you can scroll the edit box and only a part will be visible.
 unsigned int m_textCropPosition = 0;
 
 // The rectangle behind the selected text
 FloatRect m_selectedTextBackground;
 
 // The blinking caret
 FloatRect m_caret = {0, 0, 1, 0};
 
 // Is there a possibility that the user is going to double click?
 bool m_possibleDoubleClick = false;
 
 // We need three texts for drawing + one for the default text + one more for calculations.
 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;
 
 // Cached renderer properties
 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;
 
 
 private:
 
 // Used to prevent emitting onReturnOrUnfocus twice when unfocusing the edit box inside the callback function.
 bool m_onReturnOrUnfocusEmitted = false;
 
 
 };
 
}
 
 
#endif // TGUI_EDIT_BOX_HPP