Crazy Eddies GUI System  0.6.0
CEGUIFalSectionSpecification.h
1 /***********************************************************************
2  filename: CEGUIFalSectionSpecification.h
3  created: Mon Jun 13 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 _CEGUIFalSectionSpecification_h_
29 #define _CEGUIFalSectionSpecification_h_
30 
31 #include "CEGUIWindow.h"
32 
33 
34 // Start of CEGUI namespace section
35 namespace CEGUI
36 {
37  // forward refs
38  class WidgetLookFeel;
39 
47  class CEGUIEXPORT SectionSpecification
48  {
49  public:
64  SectionSpecification(const String& owner, const String& sectionName, const String& controlPropertySource);
65 
83  SectionSpecification(const String& owner, const String& sectionName, const String& controlPropertySource, const ColourRect& cols);
84 
98  void render(Window& srcWindow, float base_z, const ColourRect* modcols = 0, const Rect* clipper = 0, bool clipToDisplay = false) const;
99 
116  void render(Window& srcWindow, const Rect& baseRect, float base_z, const ColourRect* modcols = 0, const Rect* clipper = 0, bool clipToDisplay = false) const;
117 
125  const String& getOwnerWidgetLookFeel() const;
126 
134  const String& getSectionName() const;
135 
144  const ColourRect& getOverrideColours() const;
145 
156  void setOverrideColours(const ColourRect& cols);
157 
166  bool isUsingOverrideColours() const;
167 
179  void setUsingOverrideColours(bool setting = true);
180 
191  void setOverrideColoursPropertySource(const String& property);
192 
204  void setOverrideColoursPropertyIsColourRect(bool setting = true);
205 
217  void setRenderControlPropertySource(const String& property);
218 
230  void writeXMLToStream(XMLSerializer& xml_stream) const;
231 
232  protected:
243  void initColourRectForOverride(const Window& wnd, ColourRect& cr) const;
244 
245  private:
246  String d_owner;
247  String d_sectionName;
248  ColourRect d_coloursOverride;
249  bool d_usingColourOverride;
250  String d_colourPropertyName;
251  bool d_colourProperyIsRect;
252  String d_renderControlProperty;
253  };
254 
255 
256 } // End of CEGUI namespace section
257 
258 
259 #endif // end of guard _CEGUIFalSectionSpecification_h_