CEGUIFalSectionSpecification.h

00001 /***********************************************************************
00002     filename:   CEGUIFalSectionSpecification.h
00003     created:    Mon Jun 13 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 _CEGUIFalSectionSpecification_h_
00029 #define _CEGUIFalSectionSpecification_h_
00030 
00031 #include "CEGUIWindow.h"
00032 
00033 
00034 // Start of CEGUI namespace section
00035 namespace CEGUI
00036 {
00037     // forward refs
00038     class WidgetLookFeel;
00039 
00047     class CEGUIEXPORT SectionSpecification
00048     {
00049     public:
00064         SectionSpecification(const String& owner, const String& sectionName, const String& controlPropertySource);
00065 
00083         SectionSpecification(const String& owner, const String& sectionName, const String& controlPropertySource, const ColourRect& cols);
00084 
00098         void render(Window& srcWindow, float base_z, const ColourRect* modcols = 0, const Rect* clipper = 0, bool clipToDisplay = false) const;
00099 
00116         void render(Window& srcWindow, const Rect& baseRect, float base_z, const ColourRect* modcols = 0, const Rect* clipper = 0, bool clipToDisplay = false) const;
00117 
00125         const String& getOwnerWidgetLookFeel() const;
00126 
00134         const String& getSectionName() const;
00135 
00144         const ColourRect& getOverrideColours() const;
00145 
00156         void setOverrideColours(const ColourRect& cols);
00157 
00166         bool isUsingOverrideColours() const;
00167 
00179         void setUsingOverrideColours(bool setting = true);
00180 
00191         void setOverrideColoursPropertySource(const String& property);
00192 
00204         void setOverrideColoursPropertyIsColourRect(bool setting = true);
00205 
00217         void setRenderControlPropertySource(const String& property);
00218 
00230         void writeXMLToStream(XMLSerializer& xml_stream) const;
00231 
00232     protected:
00243         void initColourRectForOverride(const Window& wnd, ColourRect& cr) const;
00244 
00245     private:
00246         String          d_owner;                
00247         String          d_sectionName;          
00248         ColourRect      d_coloursOverride;      
00249         bool            d_usingColourOverride;  
00250         String          d_colourPropertyName;   
00251         bool            d_colourProperyIsRect;  
00252         String          d_renderControlProperty;    
00253     };
00254 
00255 
00256 } // End of  CEGUI namespace section
00257 
00258 
00259 #endif  // end of guard _CEGUIFalSectionSpecification_h_

Generated on Sat Jun 28 14:35:44 2008 for Crazy Eddies GUI System by  doxygen 1.5.4