Crazy Eddies GUI System  0.7.2
CEGUIFalFrameComponent.h
1 /***********************************************************************
2  filename: CEGUIFalFrameComponent.h
3  created: Mon Jul 18 2005
4  author: Paul D Turner <paul@cegui.org.uk>
5 *************************************************************************/
6 /***************************************************************************
7  * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining
10  * a copy of this software and associated documentation files (the
11  * "Software"), to deal in the Software without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, sublicense, and/or sell copies of the Software, and to
14  * permit persons to whom the Software is furnished to do so, subject to
15  * the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
24  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26  * OTHER DEALINGS IN THE SOFTWARE.
27  ***************************************************************************/
28 #ifndef _CEGUIFalFrameComponent_h_
29 #define _CEGUIFalFrameComponent_h_
30 
31 #include "CEGUIFalComponentBase.h"
32 #include "../CEGUIXMLSerializer.h"
33 
34 // Start of CEGUI namespace section
35 namespace CEGUI
36 {
45  class CEGUIEXPORT FrameComponent : public FalagardComponentBase
46  {
47  public:
53 
61  VerticalFormatting getBackgroundVerticalFormatting() const;
62 
73  void setBackgroundVerticalFormatting(VerticalFormatting fmt);
74 
82  HorizontalFormatting getBackgroundHorizontalFormatting() const;
83 
94  void setBackgroundHorizontalFormatting(HorizontalFormatting fmt);
95 
106  const Image* getImage(FrameImageComponent part) const;
107 
121  void setImage(FrameImageComponent part, const Image* image);
122 
139  void setImage(FrameImageComponent part, const String& imageset, const String& image);
140 
152  void writeXMLToStream(XMLSerializer& xml_stream) const;
153 
154  protected:
155  // implemets abstract from base
156  void render_impl(Window& srcWindow, Rect& destRect, const CEGUI::ColourRect* modColours, const Rect* clipper, bool clipToDisplay) const;
157 
158  // renders the background image (basically a clone of render_impl from ImageryComponent - maybe we need a helper class?)
159  void doBackgroundRender(Window& srcWindow, Rect& destRect, const ColourRect& colours, const Rect* clipper, bool clipToDisplay) const;
160 
161  // formatting options for background
164  // images for the frame
165  const Image* d_frameImages[FIC_FRAME_IMAGE_COUNT];
166  };
167 
168 } // End of CEGUI namespace section
169 
170 
171 #endif // end of guard _CEGUIFalFrameComponent_h_