FrameComponent.h

/***********************************************************************
    filename:   CEGUIFrameComponent.h
    created:    Mon Jul 18 2005
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2012 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 _CEGUIFalFrameComponent_h_
#define _CEGUIFalFrameComponent_h_

#include "CEGUI/falagard/ComponentBase.h"
#include "CEGUI/XMLSerializer.h"
#include "CEGUI/falagard/FormattingSetting.h"

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

namespace CEGUI
{
class CEGUIEXPORT FrameComponent : public FalagardComponentBase
{
public:
    FrameComponent();

    void setLeftEdgeFormatting(VerticalFormatting fmt);

    void setRightEdgeFormatting(VerticalFormatting fmt);

    void setTopEdgeFormatting(HorizontalFormatting fmt);

    void setBottomEdgeFormatting(HorizontalFormatting fmt);

    void setBackgroundVerticalFormatting(VerticalFormatting fmt);

    void setBackgroundHorizontalFormatting(HorizontalFormatting fmt);

    void setLeftEdgeFormattingPropertySource(const String& property_name);

    void setRightEdgeFormattingPropertySource(const String& property_name);

    void setTopEdgeFormattingPropertySource(const String& property_name);

    void setBottomEdgeFormattingPropertySource(const String& property_name);

    void setBackgroundVerticalFormattingPropertySource(const String& property_name);

    void setBackgroundHorizontalFormattingPropertySource(const String& property_name);

    VerticalFormatting getLeftEdgeFormatting(const Window& wnd) const;

    VerticalFormatting getRightEdgeFormatting(const Window& wnd) const;

    HorizontalFormatting getTopEdgeFormatting(const Window& wnd) const;

    HorizontalFormatting getBottomEdgeFormatting(const Window& wnd) const;

    VerticalFormatting getBackgroundVerticalFormatting(const Window& wnd) const;

    HorizontalFormatting getBackgroundHorizontalFormatting(const Window& wnd) const;

    const Image* getImage(FrameImageComponent part,
                          const Window& wnd) const;

    void setImage(FrameImageComponent part, const Image* image);

    void setImage(FrameImageComponent part, const String& name);

    void setImagePropertySource(FrameImageComponent part, const String& name);

    bool isImageSpecified(FrameImageComponent part) const;

    bool isImageFetchedFromProperty(FrameImageComponent part) const;

    const String& getImagePropertySource(FrameImageComponent part) const;

    void writeXMLToStream(XMLSerializer& xml_stream) const;

    bool operator==(const FrameComponent& rhs) const;

protected:
    struct FrameImageSource
    {
        FrameImageSource() :
            d_specified(false),
            d_image(0)
        {}

        bool operator==(const FrameImageSource& rhs) const
        {
            return d_specified == rhs.d_specified &&
                   d_image == rhs.d_image &&
                   d_propertyName == rhs.d_propertyName;
        }

        bool operator!=(const FrameImageSource& rhs) const
        {
            return !operator==(rhs);
        }
        
        bool d_specified;
        const Image* d_image;
        String d_propertyName;
    };

    // implemets abstract from base
    void render_impl(Window& srcWindow, Rectf& destRect,
                     const CEGUI::ColourRect* modColours,
                     const Rectf* clipper, bool clipToDisplay) const;

    void renderImage(GeometryBuffer& buffer, const Image* image,
                            VerticalFormatting vertFmt,
                            HorizontalFormatting horzFmt,
                            Rectf& destRect, const ColourRect& colours,
                            const Rectf* clipper, bool clipToDisplay) const;

    FormattingSetting<VerticalFormatting>   d_leftEdgeFormatting;
    FormattingSetting<VerticalFormatting>   d_rightEdgeFormatting;
    FormattingSetting<HorizontalFormatting> d_topEdgeFormatting;
    FormattingSetting<HorizontalFormatting> d_bottomEdgeFormatting;
    FormattingSetting<VerticalFormatting>   d_backgroundVertFormatting;
    FormattingSetting<HorizontalFormatting> d_backgroundHorzFormatting;

    FrameImageSource d_frameImages[FIC_FRAME_IMAGE_COUNT];
};

}

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

#endif