CEGUILayoutContainer.h

/***********************************************************************
    filename:   CEGUILayoutContainer.h
    created:    29/7/2010
    author:     Martin Preisler

    purpose:    Defines abstract base class for layout containers
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2010 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUILayoutContainer_h_
#define _CEGUILayoutContainer_h_

#include "../CEGUIWindow.h"

#include <map>

#if defined(_MSC_VER)
#   pragma warning(push)
#   pragma warning(disable : 4251)
#endif

// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUIEXPORT LayoutContainer : public Window
{
public:
    /*************************************************************************
        Event name constants
    *************************************************************************/
    static const String EventNamespace;

    LayoutContainer(const String& type, const String& name);

    virtual ~LayoutContainer(void);

    void markNeedsLayouting();

    bool needsLayouting() const;

    virtual void layout() = 0;

    virtual void layoutIfNecessary();

    virtual Rect getUnclippedInnerRect_impl(void) const;

    virtual void update(float elapsed);

protected:
    virtual Rect getClientChildWindowContentArea_impl() const;

    virtual bool    testClassName_impl(const String& class_name) const
    {
        if (class_name == "LayoutContainer")  return true;

        return Window::testClassName_impl(class_name);
    }

    size_t getIdxOfChildWindow(Window* wnd) const;

    virtual void addChild_impl(Window* wnd);
    virtual void removeChild_impl(Window* wnd);

    /*************************************************************************
        Event trigger methods
    *************************************************************************/
    virtual bool handleChildSized(const EventArgs& e);

    virtual bool handleChildMarginChanged(const EventArgs& e);

    virtual bool handleChildAdded(const EventArgs& e);

    virtual bool handleChildRemoved(const EventArgs& e);

    virtual UVector2 getOffsetForWindow(Window* window) const;

    virtual UVector2 getBoundingSizeForWindow(Window* window) const;

    /*************************************************************************
        Implementation Data
    *************************************************************************/
    // if true, we will relayout before rendering of this window starts
    bool d_needsLayouting;

    typedef std::multimap<Window*, Event::Connection>  ConnectionTracker;
    ConnectionTracker d_eventConnections;
};

} // End of  CEGUI namespace section

#if defined(_MSC_VER)
#   pragma warning(pop)
#endif

#endif  // end of guard _CEGUILayoutContainer_h_