CEGUIFalImageryComponent.h

00001 /***********************************************************************
00002     filename:   CEGUIFalImageryComponent.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 _CEGUIFalImageryComponent_h_
00029 #define _CEGUIFalImageryComponent_h_
00030 
00031 #include "falagard/CEGUIFalComponentBase.h"
00032 #include "CEGUIXMLSerializer.h" 
00033 
00034 // Start of CEGUI namespace section
00035 namespace CEGUI
00036 {
00041     class CEGUIEXPORT ImageryComponent : public FalagardComponentBase
00042     {
00043     public:
00048         ImageryComponent();
00049 
00057         const Image* getImage() const;
00058 
00069         void setImage(const Image* image);
00070 
00084         void setImage(const String& imageset, const String& image);
00085 
00093         VerticalFormatting getVerticalFormatting() const;
00094 
00105         void setVerticalFormatting(VerticalFormatting fmt);
00106 
00114         HorizontalFormatting getHorizontalFormatting() const;
00115 
00126         void setHorizontalFormatting(HorizontalFormatting fmt);
00127 
00139         void writeXMLToStream(XMLSerializer& xml_stream) const;
00140 
00149         bool isImageFetchedFromProperty() const;
00150 
00158         const String& getImagePropertySource() const;
00159 
00170         void setImagePropertySource(const String& property);
00171 
00172     protected:
00173         // implemets abstract from base
00174         void render_impl(Window& srcWindow, Rect& destRect, float base_z, const CEGUI::ColourRect* modColours, const Rect* clipper, bool clipToDisplay) const;
00175 
00176         const Image*         d_image;           
00177         VerticalFormatting   d_vertFormatting;  
00178         HorizontalFormatting d_horzFormatting;  
00179         String  d_imagePropertyName;            
00180     };
00181 
00182 } // End of  CEGUI namespace section
00183 
00184 
00185 #endif  // end of guard _CEGUIFalImageryComponent_h_

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