ChildWindow.hpp

//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012-2015 Bruno Van de Velde (vdv_b@tgui.eu)
//
// 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_HPP
#define TGUI_CHILD_WINDOW_HPP


#include <TGUI/Container.hpp>


namespace tgui
{
    class Button;

    class TGUI_API ChildWindow : public Container, public WidgetBorders
    {
      public:

        typedef SharedWidgetPtr<ChildWindow> Ptr;


        enum TitleAlignment
        {
            TitleAlignmentLeft,

            TitleAlignmentCentered,

            TitleAlignmentRight
        };


        ChildWindow();


        ChildWindow(const ChildWindow& copy);


        virtual ~ChildWindow();


        ChildWindow& operator= (const ChildWindow& right);


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


        virtual bool load(const std::string& configFileFilename, const std::string& sectionName = "ChildWindow");


        const std::string& getLoadedConfigFile() const;


        void setSize(float width, float height);


        virtual sf::Vector2f getSize() const;


        virtual sf::Vector2f getFullSize() const;


        void setBackgroundTexture(sf::Texture *const texture = nullptr);


        sf::Texture* getBackgroundTexture();


        void setTitleBarHeight(unsigned int height);


        unsigned int getTitleBarHeight() const;


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


        const sf::Color& getBackgroundColor() const;


        virtual void setTransparency(unsigned char transparency);


        void setTitle(const sf::String& title);


        const sf::String& getTitle() const;


        void setTitleColor(const sf::Color& color);


        const sf::Color& getTitleColor() const;


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


        const sf::Color& getBorderColor() const;


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


        void setDistanceToSide(unsigned int distanceToSide);


        unsigned int getDistanceToSide() const;


        void setTitleAlignment(TitleAlignment alignment);


        TitleAlignment getTitleAlignment() const;


        void setIcon(const std::string& filename);


        void removeIcon();


        void destroy();


        void keepInParent(bool enabled);


        bool isKeptInParent() const;


        virtual sf::Vector2f getWidgetsOffset() const;


        void setPosition(float x, float y);
        using Transformable::setPosition;


        virtual bool mouseOnWidget(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, int x, int y);

        virtual void mouseNoLongerDown();


        // This function is a (slow) way to set properties on the widget, no matter what type it is.
        // When the requested property doesn't exist in the widget then the functions will return false.
        virtual bool setProperty(std::string property, const std::string& value);

        // This function is a (slow) way to get properties of the widget, no matter what type it is.
        // When the requested property doesn't exist in the widget then the functions will return false.
        virtual bool getProperty(std::string property, std::string& value) const;


        // Returns a list of all properties that can be used in setProperty and getProperty.
        // The second value in the pair is the type of the property (e.g. int, uint, string, ...).
        virtual std::list< std::pair<std::string, std::string> > getPropertyList() const;


      protected:

        // This function is called when the widget is added to a container.
        virtual void initialize(Container *const container);


        // Draws the widget on the render target.
        virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const;


      public:

        enum ChildWindowCallbacks
        {
            LeftMousePressed = WidgetCallbacksCount * 1,             
            Closed = WidgetCallbacksCount * 2,                       
            Moved = WidgetCallbacksCount * 4,                        
//            Resized = WidgetCallbacksCount * 8,
            AllChildWindowCallbacks = WidgetCallbacksCount * 16 - 1, 
            ChildWindowCallbacksCount = WidgetCallbacksCount * 16
        };


      protected:

        std::string    m_LoadedConfigFile;

        sf::Vector2f   m_Size;

        sf::Color      m_BackgroundColor;
        sf::Texture*   m_BackgroundTexture;
        sf::Sprite     m_BackgroundSprite;

        Texture        m_IconTexture;

        sf::Text       m_TitleText;
        unsigned int   m_TitleBarHeight;
        bool           m_SplitImage;
        sf::Vector2f   m_DraggingPosition;
        unsigned int   m_DistanceToSide;
        TitleAlignment m_TitleAlignment;
        sf::Color      m_BorderColor;
        bool           m_MouseDownOnTitleBar;

        Texture   m_TextureTitleBar_L;
        Texture   m_TextureTitleBar_M;
        Texture   m_TextureTitleBar_R;

        Button*  m_CloseButton;

        bool m_KeepInParent;

    };

}


#endif // TGUI_CHILD_WINDOW_HPP