Crazy Eddies GUI System  0.7.8
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 #include "../CEGUIColourRect.h"
33 
34 
35 // Start of CEGUI namespace section
36 namespace CEGUI
37 {
38  // forward refs
39  class WidgetLookFeel;
40 
48  class CEGUIEXPORT SectionSpecification
49  {
50  public:
79  SectionSpecification(const String& owner, const String& sectionName,
80  const String& controlPropertySource,
81  const String& controlPropertyValue,
82  const String& controlPropertyWidget);
83 
115  SectionSpecification(const String& owner, const String& sectionName,
116  const String& controlPropertySource,
117  const String& controlPropertyValue,
118  const String& controlPropertyWidget,
119  const ColourRect& cols);
120 
131  void render(Window& srcWindow, const ColourRect* modcols = 0, const Rect* clipper = 0, bool clipToDisplay = false) const;
132 
146  void render(Window& srcWindow, const Rect& baseRect, const ColourRect* modcols = 0, const Rect* clipper = 0, bool clipToDisplay = false) const;
147 
155  const String& getOwnerWidgetLookFeel() const;
156 
164  const String& getSectionName() const;
165 
174  const ColourRect& getOverrideColours() const;
175 
186  void setOverrideColours(const ColourRect& cols);
187 
196  bool isUsingOverrideColours() const;
197 
209  void setUsingOverrideColours(bool setting = true);
210 
221  void setOverrideColoursPropertySource(const String& property);
222 
234  void setOverrideColoursPropertyIsColourRect(bool setting = true);
235 
247  void setRenderControlPropertySource(const String& property);
248 
260  void setRenderControlValue(const String& value);
261 
276  void setRenderControlWidget(const String& widget);
277 
289  void writeXMLToStream(XMLSerializer& xml_stream) const;
290 
291  protected:
302  void initColourRectForOverride(const Window& wnd, ColourRect& cr) const;
303 
307  bool shouldBeDrawn(const Window& wnd) const;
308 
309  private:
310  String d_owner;
311  String d_sectionName;
312  ColourRect d_coloursOverride;
313  bool d_usingColourOverride;
314  String d_colourPropertyName;
315  bool d_colourProperyIsRect;
316 
317  String d_renderControlProperty;
319  String d_renderControlValue;
321  String d_renderControlWidget;
322  };
323 
324 
325 } // End of CEGUI namespace section
326 
327 
328 #endif // end of guard _CEGUIFalSectionSpecification_h_