Form.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_FORM_INCLUDED_
#define _TGUI_FORM_INCLUDED_


namespace tgui
{

    struct TGUI_API Form : public Group, sf::NonCopyable
    {
        Form(sf::RenderWindow& window);


        virtual ~Form();


        virtual void handleEvent(sf::Event event);


        virtual void draw();


        virtual bool getCallback(Callback& callback);


        // This function is used internally to handle object callbacks.
        // When you allow an object to pass callbacks then this function is called to tell the window about the callback.
        // You can use this function to fake an object callback.
        virtual void addCallback(const Callback& callback);


    protected:

        // The pointer to the render window
        sf::RenderWindow* m_Window;

        // This will store all object callbacks until you pop them with getCallback
        std::queue<Callback> m_Callback;

        // The internal clock which is used for animation of objects
        sf::Clock m_Clock;

    };


}


#endif //_TGUI_FORM_INCLUDED_