TextBox.hpp

 
//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012-2017 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/Widget.hpp>
 
 
namespace tgui
{
 class Scrollbar;
 class TextBoxRenderer;
 
 class TGUI_API TextBox : public Widget
 {
 public:
 
 typedef std::shared_ptr<TextBox> Ptr; 
 typedef std::shared_ptr<const TextBox> ConstPtr; 
 
 
 // Default constructor
 TextBox();
 
 
 TextBox(const TextBox& copy);
 
 
 TextBox& operator= (const TextBox& right);
 
 
 static TextBox::Ptr create();
 
 
 static TextBox::Ptr copy(TextBox::ConstPtr textBox);
 
 
 std::shared_ptr<TextBoxRenderer> getRenderer() const
 {
 return std::static_pointer_cast<TextBoxRenderer>(m_renderer);
 }
 
 
 virtual void setPosition(const Layout2d& position) override;
 using Transformable::setPosition;
 
 
 virtual void setSize(const Layout2d& size) override;
 using Transformable::setSize;
 
 
 virtual sf::Vector2f getFullSize() const override;
 
 
 virtual void setFont(const Font& font) override;
 
 
 void setText(const sf::String& text);
 
 
 void addText(const sf::String& text);
 
 
 sf::String getText() const
 {
 return m_text;
 }
 
 
 sf::String getSelectedText() const;
 
 
 void setTextSize(unsigned int size);
 
 
 unsigned int getTextSize() const
 {
 return m_textSize;
 }
 
 
 void setMaximumCharacters(std::size_t maxChars = 0);
 
 
 std::size_t getMaximumCharacters() const
 {
 return m_maxChars;
 }
 
 
 void setScrollbar(Scrollbar::Ptr scrollbar);
 
 
 Scrollbar::Ptr getScrollbar();
 
 
 void setReadOnly(bool readOnly = true);
 
 
 bool isReadOnly() const;
 
 
 virtual void setOpacity(float opacity) override;
 
 
 virtual sf::Vector2f getWidgetOffset() const override;
 
 
 virtual bool mouseOnWidget(float x, float y) const override;
 
 virtual void leftMousePressed(float x, float y) override;
 
 virtual void leftMouseReleased(float x, float y) override;
 
 virtual void mouseMoved(float x, float y) override;
 
 virtual void keyPressed(const sf::Event::KeyEvent& event) override;
 
 virtual void textEntered(sf::Uint32 Key) override;
 
 virtual void mouseWheelMoved(int delta, int x, int y) override;
 
 virtual void mouseNoLongerOnWidget() override;
 
 virtual void mouseNoLongerDown() override;
 
 virtual void widgetFocused() override;
 
 virtual void widgetUnfocused() 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(sf::Vector2f position);
 
 
 // Converts the two dimensional caret positions into a one dimensional position in the text.
 std::pair<std::size_t, std::size_t> findTextCaretPosition();
 
 
 // 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);
 
 
 // This function will split the text into five pieces so that the text can be easily drawn.
 void updateSelectionTexts();
 
 
 protected:
 
 // This function is called every frame with the time passed since the last frame.
 virtual void update(sf::Time elapsedTime) override;
 
 
 virtual void reload(const std::string& primary = "", const std::string& secondary = "", bool force = false) override;
 
 
 // Makes a copy of the widget
 virtual Widget::Ptr clone() const override
 {
 return std::make_shared<TextBox>(*this);
 }
 
 
 // Draws the widget on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
 
 protected:
 
 sf::String m_text;
 unsigned int m_textSize = 18;
 unsigned int m_lineHeight = 24;
 
 std::vector<sf::String> m_lines = std::vector<sf::String>{""}; // Did not compile in VS2013 with just braces
 
 // 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;
 
 // Information about the caret
 sf::Vector2f m_caretPosition;
 bool m_caretVisible = true;
 
 sf::Text m_textBeforeSelection;
 sf::Text m_textSelection1;
 sf::Text m_textSelection2;
 sf::Text m_textAfterSelection1;
 sf::Text m_textAfterSelection2;
 
 std::vector<sf::FloatRect> m_selectionRects;
 
 // The scrollbar
 Scrollbar::Ptr m_scroll = std::make_shared<Scrollbar>();
 
 // Is there a possibility that the user is going to double click?
 bool m_possibleDoubleClick = false;
 
 bool m_readOnly = false;
 
 friend class TextBoxRenderer;
 
 };
 
 
 
 class TGUI_API TextBoxRenderer : public WidgetRenderer, public WidgetBorders, public WidgetPadding
 {
 public:
 
 TextBoxRenderer(TextBox* textBox) : m_textBox{textBox} {}
 
 
 virtual void setProperty(std::string property, const std::string& value) override;
 
 
 virtual void setProperty(std::string property, ObjectConverter&& value) override;
 
 
 virtual ObjectConverter getProperty(std::string property) const override;
 
 
 virtual std::map<std::string, ObjectConverter> getPropertyValuePairs() const override;
 
 
 void setBackgroundColor(const Color& backgroundColor);
 
 
 void setTextColor(const Color& textColor);
 
 
 void setSelectedTextColor(const Color& selectedTextColor);
 
 
 void setSelectedTextBackgroundColor(const Color& selectedTextBackgroundColor);
 
 
 void setBorderColor(const Color& borderColor);
 
 
 void setCaretColor(const Color& caretColor);
 
 
 void setCaretWidth(float width);
 
 
 void setBackgroundTexture(const Texture& texture);
 
 
 virtual void setPadding(const Padding& padding) override;
 using WidgetPadding::setPadding;
 
 
 // Draws the widget on the render target.
 void draw(sf::RenderTarget& target, sf::RenderStates states) const;
 
 
 private:
 
 // Returns the padding, which is possibly scaled with the background image.
 Padding getScaledPadding() const;
 
 
 // Makes a copy of the renderer
 virtual std::shared_ptr<WidgetRenderer> clone(Widget* widget) override;
 
 
 protected:
 
 TextBox* m_textBox;
 
 float m_caretWidth = 1;
 
 Texture m_backgroundTexture;
 
 sf::Color m_textColor;
 sf::Color m_selectedTextColor;
 sf::Color m_caretColor;
 sf::Color m_backgroundColor;
 sf::Color m_selectedTextBgrColor;
 sf::Color m_borderColor;
 
 friend class TextBox;
 
 };
 
}
 
 
#endif // TGUI_TEXT_BOX_HPP