Crazy Eddie's GUI System  0.8.4
ComponentBase.h
00001 /***********************************************************************
00002     created:    Mon Jul 18 2005
00003     author:     Paul D Turner <paul@cegui.org.uk>
00004 *************************************************************************/
00005 /***************************************************************************
00006  *   Copyright (C) 2004 - 2012 Paul D Turner & The CEGUI Development Team
00007  *
00008  *   Permission is hereby granted, free of charge, to any person obtaining
00009  *   a copy of this software and associated documentation files (the
00010  *   "Software"), to deal in the Software without restriction, including
00011  *   without limitation the rights to use, copy, modify, merge, publish,
00012  *   distribute, sublicense, and/or sell copies of the Software, and to
00013  *   permit persons to whom the Software is furnished to do so, subject to
00014  *   the following conditions:
00015  *
00016  *   The above copyright notice and this permission notice shall be
00017  *   included in all copies or substantial portions of the Software.
00018  *
00019  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00020  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00021  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00022  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00023  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00024  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00025  *   OTHER DEALINGS IN THE SOFTWARE.
00026  ***************************************************************************/
00027 #ifndef _CEGUIFalComponentBase_h_
00028 #define _CEGUIFalComponentBase_h_
00029 
00030 #include "CEGUI/falagard/Dimensions.h"
00031 #include "CEGUI/Window.h"
00032 #include "CEGUI/ColourRect.h"
00033 
00034 namespace CEGUI
00035 {
00037 class CEGUIEXPORT FalagardComponentBase :
00038     public AllocatedObject<FalagardComponentBase>
00039 {
00040 public:
00041     FalagardComponentBase();
00042     virtual ~FalagardComponentBase();
00043 
00058     void render(Window& srcWindow, const CEGUI::ColourRect* modColours = 0,
00059                 const Rectf* clipper = 0, bool clipToDisplay = false) const;
00060 
00079     void render(Window& srcWindow, const Rectf& baseRect,
00080                 const CEGUI::ColourRect* modColours = 0,
00081                 const Rectf* clipper = 0, bool clipToDisplay = false) const;
00082 
00090     const ComponentArea& getComponentArea() const;
00091 
00099     void setComponentArea(const ComponentArea& area);
00100 
00109     const ColourRect& getColours() const;
00110 
00118     void setColours(const ColourRect& cols);
00119 
00127     void setColoursPropertySource(const String& property);
00128 
00130     virtual bool handleFontRenderSizeChange(Window& window,
00131                                             const Font* font) const;
00132 
00133 protected:
00143     void initColoursRect(const Window& wnd,
00144                          const ColourRect* modCols,
00145                          ColourRect& cr) const;
00146 
00148     virtual void render_impl(Window& srcWindow, Rectf& destRect,
00149                              const CEGUI::ColourRect* modColours,
00150                              const Rectf* clipper, bool clipToDisplay) const = 0;
00151 
00166     bool writeColoursXML(XMLSerializer& xml_stream) const;
00167 
00169     ComponentArea d_area;
00171     ColourRect d_colours;
00173     String d_colourPropertyName;
00174 };
00175 
00176 }
00177 
00178 #endif
00179 
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends