EditBox.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_EDIT_BOX_HPP
#define TGUI_EDIT_BOX_HPP
 
 
#include <TGUI/Widgets/ClickableWidget.hpp>
 
#include <regex>
 
 
namespace tgui
{
 class EditBoxRenderer;
 
 class TGUI_API EditBox : public ClickableWidget
 {
 public:
 
 typedef std::shared_ptr<EditBox> Ptr; 
 typedef std::shared_ptr<const EditBox> ConstPtr; 
 
 
 enum class Alignment
 {
 Left,
 
 Center,
 
 Right
 };
 
 
 struct Validator
 {
 static TGUI_API std::string Int; 
 static TGUI_API std::string UInt; 
 static TGUI_API std::string Float; 
 };
 
 
 // Default constructor
 EditBox();
 
 
 static EditBox::Ptr create();
 
 
 static EditBox::Ptr copy(EditBox::ConstPtr editBox);
 
 
 std::shared_ptr<EditBoxRenderer> getRenderer() const
 {
 return std::static_pointer_cast<EditBoxRenderer>(m_renderer);
 }
 
 
 virtual void setPosition(const Layout2d& position) override;
 using Transformable::setPosition;
 
 
 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);
 
 
 sf::String getText() const
 {
 return m_text;
 }
 
 
 void setDefaultText(const sf::String& text);
 
 
 sf::String getDefaultText() const
 {
 return m_defaultText.getString();
 }
 
 
 sf::String getSelectedText() const;
 
 
 void setTextSize(unsigned int textSize);
 
 
 unsigned int getTextSize() const
 {
 return m_textFull.getCharacterSize();
 }
 
 
 void setPasswordCharacter(char passwordChar);
 
 
 char getPasswordCharacter() const
 {
 return m_passwordChar;
 }
 
 
 void setMaximumCharacters(unsigned int maxChars);
 
 
 unsigned int getMaximumCharacters() const
 {
 return m_maxChars;
 }
 
 
 void setAlignment(Alignment alignment);
 
 
 Alignment getAlignment()
 {
 return m_textAlignment;
 }
 
 
 void limitTextWidth(bool limitWidth = true);
 
 
 bool isTextWidthLimited()
 {
 return m_limitTextWidth;
 }
 
 
 void setCaretPosition(std::size_t charactersBeforeCaret);
 
 
 std::size_t getCaretPosition() const;
 
 
 void setCaretWidth(float width);
 
 
 float getCaretWidth()
 {
 return m_caret.getSize().x;
 }
 
 
 void setInputValidator(const std::string& regex = ".*");
 
 
 const std::string& getInputValidator();
 
 
 void selectText();
 
 
 virtual void setOpacity(float opacity) override;
 
 
 virtual sf::Vector2f getWidgetOffset() const override;
 
 
 virtual void leftMousePressed(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 widgetFocused() override;
 
 virtual void widgetUnfocused() override;
 
 
 protected:
 
 virtual void reload(const std::string& primary = "", const std::string& secondary = "", bool force = false) override;
 
 
 // Returns the width of the edit box minus the padding.
 float getVisibleEditBoxWidth();
 
 
 // This function will search after which character the caret should be placed. It will not change the caret position.
 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();
 
 
 // Makes a copy of the widget
 virtual Widget::Ptr clone() const override
 {
 return std::make_shared<EditBox>(*this);
 }
 
 
 // This function is called every frame with the time passed since the last frame.
 virtual void update(sf::Time elapsedTime) override;
 
 
 // Draws the widget on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
 
 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;
 
 // The text inside the edit box
 sf::String m_displayedText;
 sf::String m_text;
 
 std::string m_regexString = ".*";
 std::regex m_regex = std::regex{m_regexString};
 
 // This will store the size of the text ( 0 to auto size )
 unsigned int m_textSize = 0;
 
 // 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
 char 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
 sf::RectangleShape m_selectedTextBackground;
 
 // The blinking caret
 sf::RectangleShape m_caret;
 
 // We need three SFML texts to draw our text, and one more for calculations.
 sf::Text m_textBeforeSelection;
 sf::Text m_textSelection;
 sf::Text m_textAfterSelection;
 sf::Text m_textFull;
 sf::Text m_defaultText;
 
 // Is there a possibility that the user is going to double click?
 bool m_possibleDoubleClick = false;
 
 
 friend class EditBoxRenderer;
 
 
 };
 
 
 
 class TGUI_API EditBoxRenderer : public WidgetRenderer, public WidgetBorders, public WidgetPadding
 {
 public:
 
 EditBoxRenderer(EditBox* editBox) : m_editBox{editBox} {}
 
 
 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;
 
 
 virtual void setPadding(const Padding& padding) override;
 using WidgetPadding::setPadding;
 
 
 void setCaretWidth(float width);
 
 
 void setTextColor(const Color& textColor);
 
 
 void setSelectedTextColor(const Color& selectedTextColor);
 
 
 void setSelectedTextBackgroundColor(const Color& selectedTextBackgroundColor);
 
 
 void setDefaultTextColor(const Color& defaultTextColor);
 
 
 void setBackgroundColor(const Color& color);
 
 
 void setBackgroundColorNormal(const Color& color);
 
 
 void setBackgroundColorHover(const Color& color);
 
 
 void setCaretColor(const Color& caretColor);
 
 
 void setBorderColor(const Color& color);
 
 
 void setNormalTexture(const Texture& texture);
 
 
 void setHoverTexture(const Texture& texture);
 
 
 void setFocusTexture(const Texture& texture);
 
 
 void setDefaultTextStyle(sf::Uint32 style);
 
 
 // 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:
 
 EditBox* m_editBox;
 
 sf::Color m_textColor;
 sf::Color m_selectedTextColor;
 sf::Color m_selectedTextBackgroundColor;
 sf::Color m_defaultTextColor;
 sf::Color m_backgroundColorNormal;
 sf::Color m_backgroundColorHover;
 sf::Color m_caretColor;
 sf::Color m_borderColor;
 
 Texture m_textureNormal;
 Texture m_textureHover;
 Texture m_textureFocused;
 
 friend class EditBox;
 
 };
 
 
}
 
#endif // TGUI_EDIT_BOX_HPP