CEGUIFalComponentBase.h

00001 /***********************************************************************
00002     filename:   CEGUIFalComponentBase.h
00003     created:    Mon Jul 18 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 _CEGUIFalComponentBase_h_
00029 #define _CEGUIFalComponentBase_h_
00030 
00031 #include "falagard/CEGUIFalDimensions.h"
00032 #include "CEGUIWindow.h"
00033 
00034 // Start of CEGUI namespace section
00035 namespace CEGUI
00036 {
00041     class CEGUIEXPORT FalagardComponentBase
00042     {
00043     public:
00048         FalagardComponentBase();
00049 
00054         virtual ~FalagardComponentBase();
00055 
00074         void render(Window& srcWindow, float base_z, const CEGUI::ColourRect* modColours = 0, const Rect* clipper = 0, bool clipToDisplay = false) const;
00075 
00097         void render(Window& srcWindow, const Rect& baseRect, float base_z, const CEGUI::ColourRect* modColours = 0, const Rect* clipper = 0, bool clipToDisplay = false) const;
00098 
00106         const ComponentArea& getComponentArea() const;
00107 
00118         void setComponentArea(const ComponentArea& area);
00119 
00127         const ColourRect& getColours() const;
00128 
00136         void setColours(const ColourRect& cols);
00137 
00148         void setColoursPropertySource(const String& property);
00149 
00161         void setColoursPropertyIsColourRect(bool setting = true);
00162 
00173         void setVertFormattingPropertySource(const String& property);
00174 
00185         void setHorzFormattingPropertySource(const String& property);
00186 
00187     protected:
00197         void initColoursRect(const Window& wnd, const ColourRect* modCols, ColourRect& cr) const;
00198 
00203         virtual void render_impl(Window& srcWindow, Rect& destRect, float base_z, const CEGUI::ColourRect* modColours, const Rect* clipper, bool clipToDisplay) const = 0;
00204 
00217         bool writeColoursXML(XMLSerializer& xml_stream) const;
00218 
00231         bool writeVertFormatXML(XMLSerializer& xml_stream) const;
00232 
00245         bool writeHorzFormatXML(XMLSerializer& xml_stream) const;
00246 
00247 
00248         // data fields
00249         ComponentArea   d_area;                 
00250         ColourRect      d_colours;              
00251         String          d_colourPropertyName;   
00252         bool            d_colourProperyIsRect;  
00253         String          d_vertFormatPropertyName;   
00254         String          d_horzFormatPropertyName;   
00255     };
00256 } // End of  CEGUI namespace section
00257 
00258 
00259 #endif  // end of guard _CEGUIFalComponentBase_h_

Generated on Sun Nov 5 14:35:28 2006 for Crazy Eddies GUI System by  doxygen 1.4.7