Crazy Eddies GUI System  0.7.2
CEGUIFalComponentBase.h
1 /***********************************************************************
2  filename: CEGUIFalComponentBase.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 _CEGUIFalComponentBase_h_
29 #define _CEGUIFalComponentBase_h_
30 
31 #include "CEGUIFalDimensions.h"
32 #include "../CEGUIWindow.h"
33 #include "../CEGUIColourRect.h"
34 
35 // Start of CEGUI namespace section
36 namespace CEGUI
37 {
42  class CEGUIEXPORT FalagardComponentBase
43  {
44  public:
50 
55  virtual ~FalagardComponentBase();
56 
71  void render(Window& srcWindow, const CEGUI::ColourRect* modColours = 0, const Rect* clipper = 0, bool clipToDisplay = false) const;
72 
90  void render(Window& srcWindow, const Rect& baseRect, const CEGUI::ColourRect* modColours = 0, const Rect* clipper = 0, bool clipToDisplay = false) const;
91 
99  const ComponentArea& getComponentArea() const;
100 
111  void setComponentArea(const ComponentArea& area);
112 
120  const ColourRect& getColours() const;
121 
129  void setColours(const ColourRect& cols);
130 
141  void setColoursPropertySource(const String& property);
142 
154  void setColoursPropertyIsColourRect(bool setting = true);
155 
166  void setVertFormattingPropertySource(const String& property);
167 
178  void setHorzFormattingPropertySource(const String& property);
179 
180  protected:
190  void initColoursRect(const Window& wnd, const ColourRect* modCols, ColourRect& cr) const;
191 
196  virtual void render_impl(Window& srcWindow, Rect& destRect, const CEGUI::ColourRect* modColours, const Rect* clipper, bool clipToDisplay) const = 0;
197 
210  bool writeColoursXML(XMLSerializer& xml_stream) const;
211 
224  bool writeVertFormatXML(XMLSerializer& xml_stream) const;
225 
238  bool writeHorzFormatXML(XMLSerializer& xml_stream) const;
239 
240 
241  // data fields
248  };
249 } // End of CEGUI namespace section
250 
251 
252 #endif // end of guard _CEGUIFalComponentBase_h_