Crazy Eddies GUI System
0.7.6
|
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 "CEGUIFalDimensions.h" 00032 #include "../CEGUIWindow.h" 00033 #include "../CEGUIColourRect.h" 00034 00035 // Start of CEGUI namespace section 00036 namespace CEGUI 00037 { 00042 class CEGUIEXPORT FalagardComponentBase 00043 { 00044 public: 00049 FalagardComponentBase(); 00050 00055 virtual ~FalagardComponentBase(); 00056 00071 void render(Window& srcWindow, const CEGUI::ColourRect* modColours = 0, const Rect* clipper = 0, bool clipToDisplay = false) const; 00072 00090 void render(Window& srcWindow, const Rect& baseRect, const CEGUI::ColourRect* modColours = 0, const Rect* clipper = 0, bool clipToDisplay = false) const; 00091 00099 const ComponentArea& getComponentArea() const; 00100 00111 void setComponentArea(const ComponentArea& area); 00112 00120 const ColourRect& getColours() const; 00121 00129 void setColours(const ColourRect& cols); 00130 00141 void setColoursPropertySource(const String& property); 00142 00154 void setColoursPropertyIsColourRect(bool setting = true); 00155 00166 void setVertFormattingPropertySource(const String& property); 00167 00178 void setHorzFormattingPropertySource(const String& property); 00179 00180 protected: 00190 void initColoursRect(const Window& wnd, const ColourRect* modCols, ColourRect& cr) const; 00191 00196 virtual void render_impl(Window& srcWindow, Rect& destRect, const CEGUI::ColourRect* modColours, const Rect* clipper, bool clipToDisplay) const = 0; 00197 00210 bool writeColoursXML(XMLSerializer& xml_stream) const; 00211 00224 bool writeVertFormatXML(XMLSerializer& xml_stream) const; 00225 00238 bool writeHorzFormatXML(XMLSerializer& xml_stream) const; 00239 00240 00241 // data fields 00242 ComponentArea d_area; 00243 ColourRect d_colours; 00244 String d_colourPropertyName; 00245 bool d_colourProperyIsRect; 00246 String d_vertFormatPropertyName; 00247 String d_horzFormatPropertyName; 00248 }; 00249 } // End of CEGUI namespace section 00250 00251 00252 #endif // end of guard _CEGUIFalComponentBase_h_