Panel.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_PANEL_INCLUDED_
#define _TGUI_PANEL_INCLUDED_


namespace tgui
{
    struct TGUI_API Panel : public GroupObject
    {
        Panel();


        Panel(const Panel& copy);


        virtual ~Panel();


        Panel& operator= (const Panel& right);


        virtual Panel* clone();


        virtual bool load(float width, float height, const sf::Color& backgroundColor = sf::Color::Transparent, const std::string& backgroundImageFilename = "");


        virtual void setSize(float width, float height);


        virtual Vector2u getSize() const;


        virtual Vector2f getScaledSize() const;


        virtual bool setBackgroundImage(const std::string& filename = "");


        virtual std::string getLoadedBackgroundImageFilename() const;


        // These functions are used to receive callback from EventManager.
        // These events are send to the childs of the panel by it's own EventManager.
        // You normally don't need them, but you can use these functions to simulate an event.
        virtual bool mouseOnObject(float x, float y);
        virtual void objectFocused();
        virtual void objectUnfocused();


        // The objects inside the panel use this function to send their callbacks.
        // This function will alert the window (or any other parent of this panel) about the callback.
        virtual void addCallback(const Callback& callback);


    protected:


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


    public:

        sf::Color backgroundColor;


    protected:

        Vector2f     m_Size;

        sf::Texture* m_Texture;
        sf::Sprite   m_Sprite;

        std::string  m_LoadedBackgroundImageFilename;



        friend struct Group;

    };

}


#endif //_TGUI_PANEL_INCLUDED_