TextBox.hpp

//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012 Bruno Van de Velde (VDV_B@hotmail.com)
//
// 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_INCLUDED_
#define _TGUI_TEXT_BOX_INCLUDED_




namespace tgui
{

 struct TGUI_API TextBox : public OBJECT, OBJECT_BORDERS, OBJECT_ANIMATION
 {
 TextBox();


 TextBox(const TextBox& copy);


 virtual ~TextBox();


 TextBox& operator= (const TextBox& right);


 virtual void initialize();


 virtual TextBox* clone();


 virtual bool load(unsigned int width, unsigned int height, unsigned int textSize, const std::string& scrollbarPathname = "");


 virtual void setSize(float width, float height);


 virtual Vector2u getSize() const;


 virtual Vector2f getScaledSize() const;


 virtual std::string getLoadedScrollbarPathname() const;


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


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


 virtual sf::String getText() const;


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


 virtual const sf::Font* getTextFont() const;


 virtual void setTextSize(unsigned int size);


 virtual unsigned int getTextSize() const;


 virtual void setMaximumCharacters(unsigned int maxChars = 0);


 virtual unsigned int getMaximumCharacters() const;


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


 virtual 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));

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

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

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

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

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


 virtual const sf::Color& getBackgroundColor() const;

 virtual const sf::Color& getTextColor() const;

 virtual const sf::Color& getSelectedTextColor() const;

 virtual const sf::Color& getSelectedTextBackgroundColor() const;

 virtual const sf::Color& getBorderColor() const;


 virtual void setSelectionPointPosition(unsigned int charactersBeforeSelectionPoint);


 virtual bool setScrollbar(const std::string& scrollbarPathname);


 virtual void removeScrollbar();


 virtual void setSelectionPointWidth(unsigned int width = 2);


 // These functions are used to receive callback from the EventManager.
 // You normally don't need them, but you can use them to simulate an event.
 virtual bool mouseOnObject(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(sf::Keyboard::Key Key);
 virtual void textEntered(sf::Uint32 Key);
 virtual void mouseWheelMoved(int delta);
 virtual void mouseNotOnObject();
 virtual void mouseNoLongerDown();
 virtual void objectUnfocused();


 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.
 virtual 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.
 virtual void selectText(float posX, float posY);


 // 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, ...
 virtual void updateDisplayedText();


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


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


 // Because this struct is derived from sf::Drawable, you can just call the Draw function from your sf::RenderTarget.
 // This function will be called and it will draw the object on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const;


 public:

 sf::Color selectionPointColor;

 unsigned int selectionPointWidth;


 protected:

 // The size of the text box
 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;

 // 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 objects
 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;

 // The pathname used to load the scrollbar (if there is one)
 std::string m_LoadedScrollbarPathname;

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

 };

}


#endif //_TGUI_TEXT_BOX_INCLUDED_