TextBox.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2020 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_TEXT_BOX_HPP
#define TGUI_TEXT_BOX_HPP
 
 
#include <TGUI/CopiedSharedPtr.hpp>
#include <TGUI/Widgets/Scrollbar.hpp>
#include <TGUI/Renderers/TextBoxRenderer.hpp>
#include <TGUI/Text.hpp>
 
 
namespace tgui
{
    class TGUI_API TextBox : public Widget
    {
    public:
 
        typedef std::shared_ptr<TextBox> Ptr; 
        typedef std::shared_ptr<const TextBox> ConstPtr; 
 
 
        // Default constructor
        TextBox();
 
 
        static TextBox::Ptr create();
 
 
        static TextBox::Ptr copy(TextBox::ConstPtr textBox);
 
 
        TextBoxRenderer* getSharedRenderer();
        const TextBoxRenderer* getSharedRenderer() const;
 
        TextBoxRenderer* getRenderer();
        const TextBoxRenderer* getRenderer() const;
 
 
        void setSize(const Layout2d& size) override;
        using Widget::setSize;
 
 
        void setText(const sf::String& text, bool triggerTextChangedSignal = false);
 
 
        void addText(const sf::String& text);
 
 
        const sf::String& getText() const;
 
 
        void setDefaultText(const sf::String& text);
 
 
        const sf::String& getDefaultText() const;
 
 
        void setSelectedText(std::size_t selectionStartIndex, std::size_t selectionEndIndex);
 
 
        sf::String getSelectedText() const;
 
 
        std::size_t getSelectionStart() const;
 
 
        std::size_t getSelectionEnd() const;
 
 
        void setTextSize(unsigned int size) override;
 
 
        void setMaximumCharacters(std::size_t maxChars = 0);
 
 
        std::size_t getMaximumCharacters() const;
 
 
        void setCaretPosition(std::size_t charactersBeforeCaret);
 
 
        std::size_t getCaretPosition() const;
 
 
        void setReadOnly(bool readOnly = true);
 
 
        bool isReadOnly() const;
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
        TGUI_DEPRECATED("Use setHorizontalScrollbarPolicy instead") void setHorizontalScrollbarPresent(bool present);
 
 
        TGUI_DEPRECATED("Use getHorizontalScrollbarPolicy instead") bool isHorizontalScrollbarPresent() const;
 
 
        TGUI_DEPRECATED("Use setVerticalScrollbarPolicy instead") void setVerticalScrollbarPresent(bool present);
 
 
        TGUI_DEPRECATED("Use getVerticalScrollbarPolicy instead") bool isVerticalScrollbarPresent() const;
#endif
 
        void setVerticalScrollbarPolicy(Scrollbar::Policy policy);
 
 
        Scrollbar::Policy getVerticalScrollbarPolicy() const;
 
 
        void setHorizontalScrollbarPolicy(Scrollbar::Policy policy);
 
 
        Scrollbar::Policy getHorizontalScrollbarPolicy() const;
 
 
        std::size_t getLinesCount() const;
 
 
        void setFocused(bool focused) override;
 
 
        void enableMonospacedFontOptimization(bool enable = true);
 
 
        void setVerticalScrollbarValue(unsigned int value);
 
 
        unsigned int getVerticalScrollbarValue() const;
 
 
        void setHorizontalScrollbarValue(unsigned int value);
 
 
        unsigned int getHorizontalScrollbarValue() const;
 
 
        bool mouseOnWidget(Vector2f pos) const override;
 
        void leftMousePressed(Vector2f pos) override;
 
        void leftMouseReleased(Vector2f pos) override;
 
        void mouseMoved(Vector2f pos) override;
 
        void keyPressed(const sf::Event::KeyEvent& event) override;
 
        void textEntered(std::uint32_t Key) override;
 
        bool mouseWheelScrolled(float delta, Vector2f pos) override;
 
        void mouseNoLongerOnWidget() override;
 
        void leftMouseButtonNoLongerDown() override;
 
 
    protected:
 
 
        // This function will search after which character the caret should be placed. It will not change the caret position.
        sf::Vector2<std::size_t> findCaretPosition(Vector2f position) const;
 
 
        // Gets the index of either m_selStart or m_selEnd
        std::size_t getIndexOfSelectionPos(sf::Vector2<std::size_t> selectionPos) const;
 
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
        // Converts the two dimensional selection positions into one dimensional positions in the text.
        // The first element of the pair is the selection start and the second one is the selection end.
        TGUI_DEPRECATED("Use getSelectionStart and getSelectionEnd instead") std::pair<std::size_t, std::size_t> findTextSelectionPositions() const;
#endif
 
        // This function is called when you are selecting text.
        // It will find out which part of the text is selected.
        void selectText(float posX, float posY);
 
 
        // Removes the selected characters. This function is called when pressing backspace, delete or a letter while there were
        // some characters selected.
        void deleteSelectedCharacters();
 
 
        // Rearrange the text inside the text box (by using word wrap).
        void rearrangeText(bool keepSelection);
 
        // Updates the physical size of the scrollbars, as well as the viewport size.
        void updateScrollbars();
 
        // This function will split the text into five pieces so that the text can be easily drawn.
        void updateSelectionTexts();
 
 
        // 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 "Ctrl+A" key press (or equivalent on macOS)
        void selectAllText();
 
        // Handles "PageUp" key press
        void moveCaretPageUp();
 
        // Handles "PageDown" key press
        void moveCaretPageDown();
 
        // 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();
 
 
        void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
 
    protected:
 
        // Returns the size without the borders
        Vector2f getInnerSize() const;
 
 
        // This function is called every frame with the time passed since the last frame.
        bool update(sf::Time elapsedTime) override;
 
 
        // Recalculates the positions of the contents of the text box.
        void recalculatePositions();
 
 
        // Recalculates which lines are currently visible.
        void recalculateVisibleLines();
 
 
        Signal& getSignal(std::string signalName) override;
 
 
        void rendererChanged(const std::string& property) override;
 
 
        std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
 
 
        void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
 
 
        // Makes a copy of the widget
        Widget::Ptr clone() const override
        {
            return std::make_shared<TextBox>(*this);
        }
 
 
    public:
 
        SignalString onTextChange = {"TextChanged"};     
        Signal onSelectionChange = {"SelectionChanged"}; 
 
 
    protected:
 
        sf::String   m_text;
        unsigned int m_lineHeight = 24;
 
        // The width of the largest line
        float m_maxLineWidth;
 
        std::vector<sf::String> m_lines;
 
        // The maximum characters (0 by default, which means no limit)
        std::size_t m_maxChars = 0;
 
        // What is known about the visible lines?
        std::size_t m_topLine = 1;
        std::size_t m_visibleLines = 1;
 
        // Information about the selection
        sf::Vector2<std::size_t> m_selStart;
        sf::Vector2<std::size_t> m_selEnd;
        std::pair<sf::Vector2<std::size_t>, sf::Vector2<std::size_t>> m_lastSelection;
 
        // Information about the caret
        Vector2f m_caretPosition;
        bool m_caretVisible = true;
 
        Text m_textBeforeSelection;
        Text m_textSelection1;
        Text m_textSelection2;
        Text m_textAfterSelection1;
        Text m_textAfterSelection2;
        Text m_defaultText;
 
        std::vector<FloatRect> m_selectionRects;
 
        // The scrollbars
        CopiedSharedPtr<ScrollbarChildWidget> m_verticalScrollbar;
        CopiedSharedPtr<ScrollbarChildWidget> m_horizontalScrollbar;
        Scrollbar::Policy m_verticalScrollbarPolicy = Scrollbar::Policy::Automatic;
        Scrollbar::Policy m_horizontalScrollbarPolicy = Scrollbar::Policy::Never;
 
        // Is there a possibility that the user is going to double click?
        bool m_possibleDoubleClick = false;
 
        bool m_readOnly = false;
 
        bool m_monospacedFontOptimizationEnabled = false;
 
        Sprite m_spriteBackground;
 
        // Cached renderer properties
        Borders m_bordersCached;
        Padding m_paddingCached;
        Color   m_borderColorCached;
        Color   m_backgroundColorCached;
        Color   m_caretColorCached;
        Color   m_selectedTextBackgroundColorCached;
        float   m_caretWidthCached = 1;
 
    };
 
}
 
 
#endif // TGUI_TEXT_BOX_HPP