EditBox.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_EDITBOX_INCLUDED_
#define _TGUI_EDITBOX_INCLUDED_



namespace tgui
{

    struct TGUI_API EditBox : public OBJECT, OBJECT_BORDERS, OBJECT_ANIMATION
    {
        struct Alignment
        {
            enum alignments
            {
                Left,

                Center,

                Right
            };
        };


        EditBox();


        EditBox(const EditBox& copy);


        virtual ~EditBox();


        EditBox& operator= (const EditBox& right);


        // This function is called when the object is created (when it is added to a group).
        virtual void initialize();


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


        virtual bool load(const std::string& pathname);


        virtual void setSize(float width, float height);


        virtual Vector2u getSize() const;


        virtual Vector2f getScaledSize() const;


        virtual std::string getLoadedPathname() const;


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


        virtual sf::String getText() const;


        virtual void setTextSize(unsigned int textSize);


        virtual unsigned int getTextSize() const;


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


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


        virtual void setPasswordChar(char passwordChar = '\0');


        virtual char getPasswordChar() 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& 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& selectionPointColor                  = sf::Color(110, 110, 255));

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

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

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


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

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

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


        virtual void limitTextWidth(bool limitWidth);


        virtual void setSelectionPointPosition(unsigned int charactersBeforeSelectionPoint);


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


        // 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 edit box on the render target.
        virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const;


    public:

        sf::Color     selectionPointColor;

        unsigned int  selectionPointWidth;

        Alignment::alignments textAlignment;

    protected:

        // Is the selection point visible or not?
        bool          m_SelectionPointVisible;

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

        // The text inside the edit box
        sf::String    m_DisplayedText;
        sf::String    m_Text;

        // This will store the size of the text ( 0 to auto size )
        unsigned int  m_TextSize;

        // The selection
        unsigned int  m_SelChars;
        unsigned int  m_SelStart;
        unsigned int  m_SelEnd;

        // The password character
        char          m_PasswordChar;

        // The maximum allowed characters.
        // Zero by default, meaning no limit.
        unsigned int  m_MaxChars;

        // If true then the image is split in three parts
        bool          m_SplitImage;

        // When the text width is not limited, you can scroll the edit box and only a part will be visible.
        unsigned int  m_TextCropPosition;

        // The rectangle behind the selected text will have this color
        sf::Color     m_SelectedTextBgrColor;

        // The size of the edit box
        Vector2f      m_Size;

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

        // The SFML textures
        sf::Texture*  m_TextureNormal_L;
        sf::Texture*  m_TextureNormal_M;
        sf::Texture*  m_TextureNormal_R;

        sf::Texture*  m_TextureHover_L;
        sf::Texture*  m_TextureHover_M;
        sf::Texture*  m_TextureHover_R;

        sf::Texture*  m_TextureFocused_L;
        sf::Texture*  m_TextureFocused_M;
        sf::Texture*  m_TextureFocused_R;

        // The SFML sprites
        sf::Sprite   m_SpriteNormal_L;
        sf::Sprite   m_SpriteNormal_M;
        sf::Sprite   m_SpriteNormal_R;

        sf::Sprite   m_SpriteHover_L;
        sf::Sprite   m_SpriteHover_M;
        sf::Sprite   m_SpriteHover_R;

        sf::Sprite   m_SpriteFocused_L;
        sf::Sprite   m_SpriteFocused_M;
        sf::Sprite   m_SpriteFocused_R;

        // The pathname used to load the edit box
        std::string m_LoadedPathname;

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


    };

}

#endif //_TGUI_EDITBOX_INCLUDED_