Crazy Eddie's GUI System  0.8.4
ImageryComponent.h
00001 /***********************************************************************
00002     created:    Mon Jun 13 2005
00003     author:     Paul D Turner <paul@cegui.org.uk>
00004 *************************************************************************/
00005 /***************************************************************************
00006  *   Copyright (C) 2004 - 2006 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 _CEGUIFalImageryComponent_h_
00028 #define _CEGUIFalImageryComponent_h_
00029 
00030 #include "./ComponentBase.h"
00031 #include "../XMLSerializer.h"
00032 #include "CEGUI/falagard/FormattingSetting.h"
00033 
00034 #if defined(_MSC_VER)
00035 #   pragma warning(push)
00036 #   pragma warning(disable : 4251)
00037 #endif
00038 
00039 // Start of CEGUI namespace section
00040 namespace CEGUI
00041 {
00046     class CEGUIEXPORT ImageryComponent : public FalagardComponentBase
00047     {
00048     public:
00053         ImageryComponent();
00054 
00062         const Image* getImage() const;
00063 
00074         void setImage(const Image* image);
00075 
00086         void setImage(const String& name);
00087 
00095         VerticalFormatting getVerticalFormatting(const Window& wnd) const;
00096 
00107         void setVerticalFormatting(VerticalFormatting fmt);
00108 
00116         HorizontalFormatting getHorizontalFormatting(const Window& wnd) const;
00117 
00128         void setHorizontalFormatting(HorizontalFormatting fmt);
00129 
00135         void setHorizontalFormattingPropertySource(const String& property_name);
00136 
00142         void setVerticalFormattingPropertySource(const String& property_name);
00143 
00155         void writeXMLToStream(XMLSerializer& xml_stream) const;
00156 
00165         bool isImageFetchedFromProperty() const;
00166 
00174         const String& getImagePropertySource() const;
00175 
00186         void setImagePropertySource(const String& property);
00187 
00188     protected:
00189         // implemets abstract from base
00190         void render_impl(Window& srcWindow, Rectf& destRect, const CEGUI::ColourRect* modColours, const Rectf* clipper, bool clipToDisplay) const;
00191 
00192         const Image*         d_image;           
00193 
00194         FormattingSetting<VerticalFormatting> d_vertFormatting;
00196         FormattingSetting<HorizontalFormatting> d_horzFormatting;
00197         String  d_imagePropertyName;            
00198     };
00199 
00200 } // End of  CEGUI namespace section
00201 
00202 #if defined(_MSC_VER)
00203 #   pragma warning(pop)
00204 #endif
00205 
00206 #endif  // end of guard _CEGUIFalImageryComponent_h_
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends