Crazy Eddies GUI System  0.6.0
CEGUIFalTextComponent.h
1 /***********************************************************************
2  filename: CEGUIFalTextComponent.h
3  created: Sun Jun 19 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 _CEGUIFalTextComponent_h_
29 #define _CEGUIFalTextComponent_h_
30 
31 #include "falagard/CEGUIFalComponentBase.h"
32 
33 // Start of CEGUI namespace section
34 namespace CEGUI
35 {
40  class CEGUIEXPORT TextComponent : public FalagardComponentBase
41  {
42  public:
47  TextComponent();
48 
56  const String& getText() const;
57 
71  void setText(const String& text);
72 
80  const String& getFont() const;
81 
95  void setFont(const String& font);
96 
104  VerticalTextFormatting getVerticalFormatting() const;
105 
116  void setVerticalFormatting(VerticalTextFormatting fmt);
117 
125  HorizontalTextFormatting getHorizontalFormatting() const;
126 
137  void setHorizontalFormatting(HorizontalTextFormatting fmt);
138 
150  void writeXMLToStream(XMLSerializer& xml_stream) const;
151 
160  bool isTextFetchedFromProperty() const;
161 
170  const String& getTextPropertySource() const;
171 
183  void setTextPropertySource(const String& property);
184 
193  bool isFontFetchedFromProperty() const;
194 
203  const String& getFontPropertySource() const;
204 
216  void setFontPropertySource(const String& property);
217 
218  protected:
219  // implemets abstract from base
220  void render_impl(Window& srcWindow, Rect& destRect, float base_z, const CEGUI::ColourRect* modColours, const Rect* clipper, bool clipToDisplay) const;
221 
222  private:
223  String d_text;
224  String d_font;
225  VerticalTextFormatting d_vertFormatting;
226  HorizontalTextFormatting d_horzFormatting;
227  String d_textPropertyName;
228  String d_fontPropertyName;
229  };
230 
231 } // End of CEGUI namespace section
232 
233 
234 #endif // end of guard _CEGUIFalTextComponent_h_