ChatBox.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_CHAT_BOX_HPP
#define TGUI_CHAT_BOX_HPP


namespace tgui
{
    struct Panel;


    struct TGUI_API ChatBox : public OBJECT, public OBJECT_BORDERS
    {
        ChatBox();


        ChatBox(const ChatBox& copy);


        virtual ~ChatBox();


        ChatBox& operator= (const ChatBox& right);


        // This function is called when the object 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 ChatBox* clone();


        virtual bool load(float width, float 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 addLine(const sf::String& text, const sf::Color& color = sf::Color::Black);


        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 setBorders(unsigned int leftBorder   = 0,
                                unsigned int topBorder    = 0,
                                unsigned int rightBorder  = 0,
                                unsigned int bottomBorder = 0);


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


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


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


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


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


        virtual void removeScrollbar();


        // Used to communicate with EventManager.
        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 mouseWheelMoved(int delta);
        virtual void mouseNotOnObject();
        virtual void mouseNoLongerDown();


      protected:

        // Not all heights are valid in the chat box.
        // This function will take the requested height and returns the closest height that can be used.
        float calculateValidHeight(float requestedHeight);


        // Update the position of the labels.
        void updateDisplayedText();


        // Because this class 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;


      protected:

        unsigned int m_TextSize;
        sf::Color m_BorderColor;

        // The panel containing the labels
        Panel* m_Panel;

        // The scrollbar
        Scrollbar* m_Scroll;

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

    };

}


#endif // TGUI_TEXT_BOX_HPP