CEGUIFalFrameComponent.h

/***********************************************************************
    filename:   CEGUIFalFrameComponent.h
    created:    Mon Jul 18 2005
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 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 "CEGUIFalComponentBase.h"
#include "../CEGUIXMLSerializer.h"

// Start of CEGUI namespace section
namespace CEGUI
{
    class CEGUIEXPORT FrameComponent : public FalagardComponentBase
    {
    public:
        FrameComponent();

        VerticalFormatting getBackgroundVerticalFormatting() const;

        void setBackgroundVerticalFormatting(VerticalFormatting fmt);

        HorizontalFormatting getBackgroundHorizontalFormatting() const;

        void setBackgroundHorizontalFormatting(HorizontalFormatting fmt);

        const Image* getImage(FrameImageComponent part) const;

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

        void setImage(FrameImageComponent part, const String& imageset, const String& image);

        void writeXMLToStream(XMLSerializer& xml_stream) const;

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

        // renders the background image (basically a clone of render_impl from ImageryComponent - maybe we need a helper class?)
        void doBackgroundRender(Window& srcWindow, Rect& destRect, const ColourRect& colours, const Rect* clipper, bool clipToDisplay) const;

        // formatting options for background
        VerticalFormatting   d_vertFormatting;  
        HorizontalFormatting d_horzFormatting;  
        // images for the frame
        const Image* d_frameImages[FIC_FRAME_IMAGE_COUNT];  
    };

} // End of  CEGUI namespace section


#endif  // end of guard _CEGUIFalFrameComponent_h_