CEGUIGridLayoutContainer.h

/***********************************************************************
    filename:   CEGUIGridLayoutContainer.h
    created:    01/8/2010
    author:     Martin Preisler

    purpose:    Interface to a vertical layout container
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIGridLayoutContainer_h_
#define _CEGUIGridLayoutContainer_h_

#include "CEGUILayoutContainer.h"
#include "../CEGUIWindowFactory.h"
#include "CEGUIGridLayoutContainerProperties.h"

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

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT GridLayoutContainer : public LayoutContainer
{
public:
    enum AutoPositioning
    {
        AP_Disabled,
        AP_LeftToRight,
        AP_TopToBottom
    };

    /*************************************************************************
        Constants
    *************************************************************************/
    static const String WidgetTypeName;

    /*************************************************************************
        Child Widget name suffix constants
    *************************************************************************/
    static const String DummyNameSuffix;

    /*************************************************************************
        Event name constants
    *************************************************************************/
    static const String EventNamespace;

    static const String EventChildWindowOrderChanged;

    /*************************************************************************
        Construction and Destruction
    *************************************************************************/
    GridLayoutContainer(const String& type, const String& name);

    virtual ~GridLayoutContainer(void);

    void setGridDimensions(size_t width, size_t height);

    size_t getGridWidth() const;

    size_t getGridHeight() const;

    void setAutoPositioning(AutoPositioning positioning);

    AutoPositioning getAutoPositioning() const;

    void setNextAutoPositioningIdx(size_t idx);

    size_t getNextAutoPositioningIdx() const;

    void autoPositioningSkipCells(size_t cells);

    void addChildWindowToPosition(Window* window, size_t gridX, size_t gridY);

    void addChildWindowToPosition(const String& name, size_t gridX, size_t gridY);

    Window* getChildWindowAtPosition(size_t gridX, size_t gridY);

    void removeChildWindowFromPosition(size_t gridX, size_t gridY);

    virtual void swapChildWindowPositions(size_t wnd1, size_t wnd2);

    void swapChildWindowPositions(size_t gridX1, size_t gridY1,
                                  size_t gridX2, size_t gridY2);

    void swapChildWindows(Window* wnd1, Window* wnd2);

    void swapChildWindows(Window* wnd1, const String& wnd2);

    void swapChildWindows(const String& wnd1, Window* wnd2);

    void moveChildWindowToPosition(Window* wnd, size_t gridX, size_t gridY);

    void moveChildWindowToPosition(const String& wnd,
                                   size_t gridX, size_t gridY);

    virtual void layout();

protected:
    virtual void onChildWindowOrderChanged(WindowEventArgs& e);

    size_t mapFromGridToIdx(size_t gridX, size_t gridY,
                            size_t gridWidth, size_t gridHeight) const;
    void mapFromIdxToGrid(size_t idx, size_t& gridX, size_t& gridY,
                          size_t gridWidth, size_t gridHeight) const;

    UVector2 getGridCellOffset(const std::vector<UDim>& colSizes,
                               const std::vector<UDim>& rowSizes,
                               size_t gridX, size_t gridY) const;
    UVector2 getGridSize(const std::vector<UDim>& colSizes,
                         const std::vector<UDim>& rowSizes) const;

    size_t translateAPToGridIdx(size_t APIdx) const;

    size_t d_gridWidth;
    size_t d_gridHeight;

    AutoPositioning d_autoPositioning;
    size_t d_nextAutoPositioningIdx;

    size_t d_nextGridX;
    size_t d_nextGridY;

    size_t d_nextDummyIdx;

    Window* createDummy();
    bool isDummy(Window* wnd) const;

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

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

        return LayoutContainer::testClassName_impl(class_name);
    }

private:
    /*************************************************************************
        Properties for GridLayoutContainer class
    *************************************************************************/
    static GridLayoutContainerProperties::GridSize d_gridSizeProperty;
    static GridLayoutContainerProperties::AutoPositioning d_autoPositioningProperty;

    void addGridLayoutContainerProperties(void);
};

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIGridLayoutContainer_h_