Crazy Eddies GUI System  0.7.2
CEGUIFalImageryComponent.h
1 /***********************************************************************
2  filename: CEGUIFalImageryComponent.h
3  created: Mon Jun 13 2005
4  author: Paul D Turner <paul@cegui.org.uk>
5 *************************************************************************/
6 /***************************************************************************
7  * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining
10  * a copy of this software and associated documentation files (the
11  * "Software"), to deal in the Software without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, sublicense, and/or sell copies of the Software, and to
14  * permit persons to whom the Software is furnished to do so, subject to
15  * the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
24  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26  * OTHER DEALINGS IN THE SOFTWARE.
27  ***************************************************************************/
28 #ifndef _CEGUIFalImageryComponent_h_
29 #define _CEGUIFalImageryComponent_h_
30 
31 #include "CEGUIFalComponentBase.h"
32 #include "../CEGUIXMLSerializer.h"
33 
34 // Start of CEGUI namespace section
35 namespace CEGUI
36 {
41  class CEGUIEXPORT ImageryComponent : public FalagardComponentBase
42  {
43  public:
49 
57  const Image* getImage() const;
58 
69  void setImage(const Image* image);
70 
84  void setImage(const String& imageset, const String& image);
85 
93  VerticalFormatting getVerticalFormatting() const;
94 
105  void setVerticalFormatting(VerticalFormatting fmt);
106 
114  HorizontalFormatting getHorizontalFormatting() const;
115 
126  void setHorizontalFormatting(HorizontalFormatting fmt);
127 
139  void writeXMLToStream(XMLSerializer& xml_stream) const;
140 
149  bool isImageFetchedFromProperty() const;
150 
158  const String& getImagePropertySource() const;
159 
170  void setImagePropertySource(const String& property);
171 
172  protected:
173  // implemets abstract from base
174  void render_impl(Window& srcWindow, Rect& destRect, const CEGUI::ColourRect* modColours, const Rect* clipper, bool clipToDisplay) const;
175 
176  const Image* d_image;
180  };
181 
182 } // End of CEGUI namespace section
183 
184 
185 #endif // end of guard _CEGUIFalImageryComponent_h_