CEGUIFalFrameComponent.h

00001 /***********************************************************************
00002     filename:   CEGUIFalFrameComponent.h
00003     created:    Mon Jul 18 2005
00004     author:     Paul D Turner <paul@cegui.org.uk>
00005 *************************************************************************/
00006 /***************************************************************************
00007  *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
00008  *
00009  *   Permission is hereby granted, free of charge, to any person obtaining
00010  *   a copy of this software and associated documentation files (the
00011  *   "Software"), to deal in the Software without restriction, including
00012  *   without limitation the rights to use, copy, modify, merge, publish,
00013  *   distribute, sublicense, and/or sell copies of the Software, and to
00014  *   permit persons to whom the Software is furnished to do so, subject to
00015  *   the following conditions:
00016  *
00017  *   The above copyright notice and this permission notice shall be
00018  *   included in all copies or substantial portions of the Software.
00019  *
00020  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00021  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00022  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00023  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00024  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00025  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00026  *   OTHER DEALINGS IN THE SOFTWARE.
00027  ***************************************************************************/
00028 #ifndef _CEGUIFalFrameComponent_h_
00029 #define _CEGUIFalFrameComponent_h_
00030 
00031 #include "falagard/CEGUIFalComponentBase.h"
00032 #include "CEGUIXMLSerializer.h"
00033 
00034 // Start of CEGUI namespace section
00035 namespace CEGUI
00036 {
00045     class CEGUIEXPORT FrameComponent : public FalagardComponentBase
00046     {
00047     public:
00052         FrameComponent();
00053 
00061         VerticalFormatting getBackgroundVerticalFormatting() const;
00062 
00073         void setBackgroundVerticalFormatting(VerticalFormatting fmt);
00074 
00082         HorizontalFormatting getBackgroundHorizontalFormatting() const;
00083 
00094         void setBackgroundHorizontalFormatting(HorizontalFormatting fmt);
00095 
00106         const Image* getImage(FrameImageComponent part) const;
00107 
00121         void setImage(FrameImageComponent part, const Image* image);
00122 
00139         void setImage(FrameImageComponent part, const String& imageset, const String& image);
00140 
00152         void writeXMLToStream(XMLSerializer& xml_stream) const;
00153 
00154     protected:
00155         // implemets abstract from base
00156         void render_impl(Window& srcWindow, Rect& destRect, float base_z, const CEGUI::ColourRect* modColours, const Rect* clipper, bool clipToDisplay) const;
00157 
00158         // renders the background image (basically a clone of render_impl from ImageryComponent - maybe we need a helper class?)
00159         void doBackgroundRender(Window& srcWindow, Rect& destRect, float base_z, const ColourRect& colours, const Rect* clipper, bool clipToDisplay) const;
00160 
00161         // formatting options for background
00162         VerticalFormatting   d_vertFormatting;  
00163         HorizontalFormatting d_horzFormatting;  
00164         // images for the frame
00165         const Image* d_frameImages[FIC_FRAME_IMAGE_COUNT];  
00166     };
00167 
00168 } // End of  CEGUI namespace section
00169 
00170 
00171 #endif  // end of guard _CEGUIFalFrameComponent_h_

Generated on Sun Nov 5 14:35:28 2006 for Crazy Eddies GUI System by  doxygen 1.4.7