TextBox.hpp

//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012-2015 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 TGUI_API TextBox : public Widget, public WidgetBorders
 {
 public:

 typedef SharedWidgetPtr<TextBox> Ptr;


 TextBox();


 TextBox(const TextBox& copy);


 virtual ~TextBox();


 TextBox& operator= (const TextBox& right);


 // Makes a copy of the widget by calling the copy constructor.
 // This function calls new and if you use this function then you are responsible for calling delete.
 virtual TextBox* clone();


 bool load(const std::string& configFileFilename, const std::string& sectionName = "TextBox");


 const std::string& getLoadedConfigFile() const;


 virtual void setSize(float width, float height);


 virtual sf::Vector2f getSize() const;


 virtual sf::Vector2f getFullSize() const;


 void setText(const sf::String& text);


 void addText(const sf::String& text);


 sf::String getText() const;


 void setTextFont(const sf::Font& font);


 const sf::Font* getTextFont() const;


 void setTextSize(unsigned int size);


 unsigned int getTextSize() const;


 void setMaximumCharacters(unsigned int maxChars = 0);


 unsigned int getMaximumCharacters() const;


 virtual void setBorders(unsigned int leftBorder = 0,
 unsigned int topBorder = 0,
 unsigned int rightBorder = 0,
 unsigned int bottomBorder = 0);


 void changeColors(const sf::Color& backgroundColor = sf::Color( 50, 50, 50),
 const sf::Color& textColor = sf::Color( 0, 0, 0),
 const sf::Color& selectedTextColor = sf::Color(255, 255, 255),
 const sf::Color& selectedTextBackgroundColor = sf::Color( 10, 110, 255),
 const sf::Color& borderColor = sf::Color( 0, 0, 0),
 const sf::Color& selectionPointColor = sf::Color(110, 110, 255));


 void setBackgroundColor(const sf::Color& backgroundColor);


 void setTextColor(const sf::Color& textColor);


 void setSelectedTextColor(const sf::Color& selectedTextColor);


 void setSelectedTextBackgroundColor(const sf::Color& selectedTextBackgroundColor);


 void setBorderColor(const sf::Color& borderColor);


 void setSelectionPointColor(const sf::Color& selectionPointColor);


 const sf::Color& getBackgroundColor() const;


 const sf::Color& getTextColor() const;


 const sf::Color& getSelectedTextColor() const;


 const sf::Color& getSelectedTextBackgroundColor() const;


 const sf::Color& getBorderColor() const;


 const sf::Color& getSelectionPointColor() const;


 void setSelectionPointPosition(unsigned int charactersBeforeSelectionPoint);


 bool setScrollbar(const std::string& scrollbarConfigFileFilename);


 void removeScrollbar();


 void setSelectionPointWidth(unsigned int width = 2);


 unsigned int getSelectionPointWidth() const;


 void setReadOnly(bool readOnly = true);


 virtual void setTransparency(unsigned char transparency);


 virtual bool mouseOnWidget(float x, float y);

 virtual void leftMousePressed(float x, float y);

 virtual void leftMouseReleased(float x, float y);

 virtual void mouseMoved(float x, float y);

 virtual void keyPressed(const sf::Event::KeyEvent& event);

 virtual void textEntered(sf::Uint32 Key);

 virtual void mouseWheelMoved(int delta, int x, int y);

 virtual void mouseNotOnWidget();

 virtual void mouseNoLongerDown();

 virtual void widgetUnfocused();


 // This function is a (slow) way to set properties on the widget, no matter what type it is.
 // When the requested property doesn't exist in the widget then the functions will return false.
 virtual bool setProperty(std::string property, const std::string& value);

 // This function is a (slow) way to get properties of the widget, no matter what type it is.
 // When the requested property doesn't exist in the widget then the functions will return false.
 virtual bool getProperty(std::string property, std::string& value) const;


 // Returns a list of all properties that can be used in setProperty and getProperty.
 // The second value in the pair is the type of the property (e.g. int, uint, string, ...).
 virtual std::list< std::pair<std::string, std::string> > getPropertyList() const;


 protected:


 // This function will search where the selection point should be. It will not change the selection point.
 // It will return after which character the selection point should be.
 unsigned int findSelectionPointPosition(float posX, float posY);


 // 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();


 // To keep the drawing as fast as possible, all the calculation are done in front by this function.
 // It is called when the text changes, when scrolling, ...
 void updateDisplayedText();


 // This function is called by updateDisplayedText and will split the text into five pieces so that the text can
 // be easily drawn.
 void updateSelectionTexts(float maxLineWidth);


 // This function is called when the widget is added to a container.
 virtual void initialize(Container *const container);


 // When AnimationManager changes the elapsed time then this function is called.
 virtual void update();


 // Draws the widget on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const;


 public:

 enum TextBoxCallbacks
 {
 TextChanged = WidgetCallbacksCount * 1, 
 AllTextBoxCallbacks = WidgetCallbacksCount * 2 - 1, 
 TextBoxCallbacksCount = WidgetCallbacksCount * 2
 };


 protected:

 std::string m_LoadedConfigFile;

 // The size of the text box
 sf::Vector2u m_Size;

 // Some information about the text
 sf::String m_Text;
 sf::String m_DisplayedText;
 unsigned int m_TextSize;
 unsigned int m_LineHeight;
 unsigned int m_Lines;

 // The maximum characters (0 by default, which means no limit)
 unsigned int m_MaxChars;

 // What is known about the visible lines?
 unsigned int m_TopLine;
 unsigned int m_VisibleLines;

 // Information about the selection
 unsigned int m_SelChars;
 unsigned int m_SelStart;
 unsigned int m_SelEnd;

 // Information about the selection pointer
 sf::Vector2u m_SelectionPointPosition;
 bool m_SelectionPointVisible;

 // The color of the flickering selection pointer
 sf::Color m_SelectionPointColor;

 // The width in pixels of the flickering selection pointer
 unsigned int m_SelectionPointWidth;

 // Should the text be resplit into the five texts?
 bool m_SelectionTextsNeedUpdate;

 // The colors that are used by the text box
 sf::Color m_BackgroundColor;
 sf::Color m_SelectedTextBgrColor;
 sf::Color m_BorderColor;

 // The sfml Text widgets
 sf::Text m_TextBeforeSelection;
 sf::Text m_TextSelection1;
 sf::Text m_TextSelection2;
 sf::Text m_TextAfterSelection1;
 sf::Text m_TextAfterSelection2;

 std::vector<float> m_MultilineSelectionRectWidth;

 // The scrollbar
 Scrollbar* m_Scroll;

 // Is there a possibility that the user is going to double click?
 bool m_PossibleDoubleClick;

 bool m_readOnly;

 };

}


#endif // TGUI_TEXT_BOX_HPP