Group.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_GROUP_INCLUDED_
#define _TGUI_GROUP_INCLUDED_

#include <list>


namespace tgui
{
    struct TGUI_API Group
    {
        Group();


        Group(const Group& copy);


        virtual ~Group();


        Group& operator= (const Group& right);


        template <typename T>
        T* add(const sf::String& objectName = "")
        {
            T* newObject = new T();
            newObject->m_Parent = this;
            m_EventManager.m_Objects.push_back(newObject);
            m_ObjName.push_back(objectName);

            newObject->initialize();

            return newObject;
        }


        template <typename T>
        T* get(const sf::String& objectName) const
        {
            for (unsigned int i=0; i<m_ObjName.size(); ++i)
            {
                if (m_ObjName[i].toWideString().compare(objectName) == 0)
                    return static_cast<T*>(m_EventManager.m_Objects[i]);
            }

            return NULL;
        }


        template <typename T>
        T* copy(T* oldObject, const sf::String& newObjectName = "")
        {
            T* newObject = new T(*oldObject);

            m_EventManager.m_Objects.push_back(newObject);
            m_ObjName.push_back(newObjectName);

            return newObject;
        }


        template <typename T>
        T* copy(const sf::String& oldObjectName, const sf::String& newObjectName = "")
        {
            for (unsigned int i=0; i<m_ObjName.size(); ++i)
            {
                if (m_ObjName[i].toWideString().compare(oldObjectName) == 0)
                {
                    T* newObject = new T(*static_cast<T*>(m_EventManager.m_Objects[i]));

                    m_EventManager.m_Objects.push_back(newObject);
                    m_ObjName.push_back(newObjectName);

                    return newObject;
                }
            }

            return NULL;
        }


        virtual bool loadObjectsFromFile(const std::string& filename);


        virtual std::vector<OBJECT*>& getObjects();


        virtual std::vector<sf::String>& getObjectNames();


        virtual void remove(const sf::String& objectName);


        virtual void remove(OBJECT* object);


        virtual void removeAllObjects();


        virtual void focusObject(OBJECT* const object);


        virtual void unfocusObject(OBJECT* const object);


        virtual void unfocusAllObjects();


        virtual void uncheckRadioButtons();


        virtual void addCallback(const Callback& callback) = 0;


        virtual void updateTime(const sf::Time& elapsedTime);


        virtual void moveObjectToFront(OBJECT* object);


        virtual void moveObjectToBack(OBJECT* object);


    protected:

        // This function will call the draw function from all the objects in the correct order.
        virtual void drawObjectGroup(sf::RenderTarget* target, const sf::RenderStates& states = sf::RenderStates::Default) const;


    public:

        sf::Font globalFont;


    protected:

        std::vector<sf::String>  m_ObjName;

        // The internal event manager
        EventManager m_EventManager;

        // Is the group focused? If so, then one of the objects inside the group may be focused
        bool m_GroupFocused;


    };

}


#endif //_TGUI_GROUP_INCLUDED_