ChildWindow.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_CHILD_WINDOW_INCLUDED_
#define _TGUI_CHILD_WINDOW_INCLUDED_


namespace tgui
{
    struct TGUI_API ChildWindow : public Panel, OBJECT_BORDERS
    {

        // Layouts
        enum Layout
        {
            LayoutLeft,
            LayoutRight
        };

        // Title alignments
        enum TitleAlignment
        {
            TitleAlignmentLeft,
            TitleAlignmentCentered,
            TitleAlignmentRight
        };


        ChildWindow();


        ChildWindow(const ChildWindow& copy);


        virtual ~ChildWindow();


        ChildWindow& operator= (const ChildWindow& right);


        virtual ChildWindow* clone();


        virtual bool load(float width, float height, const sf::Color& backgroundColor, const std::string& pathname);


        virtual std::string getLoadedPathname() const;


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


        virtual void setTitlebarHeight(unsigned int height);


        virtual unsigned int getTitleBarHeight() const;


        virtual void setTransparency(unsigned char transparency);


        virtual unsigned char getTransparency() const;


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


        // With this function, the child window will tell the EventManager if the mouse is on top of it or not.
        virtual bool mouseOnObject(float x, float y);


    protected:

        // Send the event to all underlying objects.
        virtual void handleEvent(sf::Event& event, float mouseX = 0, float mouseY = 0);


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


    public:

        Layout layout;

        TitleAlignment titleAlignment;

        unsigned int distanceToSide;

        sf::Color borderColor;

        sf::String title;

    protected:

        unsigned int  m_TitleBarHeight;
        std::string   m_LoadedPathname;
        bool          m_SplitImage;
        Vector2f      m_DraggingPosition;
        unsigned char m_Opacity;

        sf::Texture*  m_TextureTitleBar_L;
        sf::Texture*  m_TextureTitleBar_M;
        sf::Texture*  m_TextureTitleBar_R;

        sf::Sprite    m_SpriteTitleBar_L;
        sf::Sprite    m_SpriteTitleBar_M;
        sf::Sprite    m_SpriteTitleBar_R;

        tgui::Button* m_CloseButton;

    };

}


#endif //_TGUI_CHILD_WINDOW_INCLUDED_