Crazy Eddies GUI System  0.7.2
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 "CEGUIFalComponentBase.h"
32 #include "../CEGUIRenderedString.h"
33 #include "../CEGUIRefCounted.h"
34 #include "../CEGUIFormattedRenderedString.h"
35 
36 #if defined(_MSC_VER)
37 # pragma warning(push)
38 # pragma warning(disable : 4251)
39 #endif
40 
41 // Start of CEGUI namespace section
42 namespace CEGUI
43 {
48  class CEGUIEXPORT TextComponent : public FalagardComponentBase
49  {
50  public:
55  TextComponent();
56 
58  ~TextComponent();
59 
61  TextComponent(const TextComponent& obj);
62 
64  TextComponent& operator=(const TextComponent& other);
65 
73  const String& getText() const;
74 
76  const String& getTextVisual() const;
77 
91  void setText(const String& text);
92 
100  const String& getFont() const;
101 
115  void setFont(const String& font);
116 
124  VerticalTextFormatting getVerticalFormatting() const;
125 
136  void setVerticalFormatting(VerticalTextFormatting fmt);
137 
145  HorizontalTextFormatting getHorizontalFormatting() const;
146 
157  void setHorizontalFormatting(HorizontalTextFormatting fmt);
158 
170  void writeXMLToStream(XMLSerializer& xml_stream) const;
171 
180  bool isTextFetchedFromProperty() const;
181 
190  const String& getTextPropertySource() const;
191 
203  void setTextPropertySource(const String& property);
204 
213  bool isFontFetchedFromProperty() const;
214 
223  const String& getFontPropertySource() const;
224 
236  void setFontPropertySource(const String& property);
237 
238  protected:
239  // implemets abstract from base
240  void render_impl(Window& srcWindow, Rect& destRect, const CEGUI::ColourRect* modColours, const Rect* clipper, bool clipToDisplay) const;
242  void setupStringFormatter(const Window& window,
243  const RenderedString& rendered_string) const;
244  private:
245  String d_textLogical;
246 
247  BiDiVisualMapping* d_bidiVisualMapping;
249  mutable bool d_bidiDataValid;
251  mutable RenderedString d_renderedString;
253  mutable RefCounted<FormattedRenderedString> d_formattedRenderedString;
255  mutable HorizontalTextFormatting d_lastHorzFormatting;
256 
257  String d_font;
258  VerticalTextFormatting d_vertFormatting;
259  HorizontalTextFormatting d_horzFormatting;
260  String d_textPropertyName;
261  String d_fontPropertyName;
262  };
263 
264 } // End of CEGUI namespace section
265 
266 #if defined(_MSC_VER)
267 # pragma warning(pop)
268 #endif
269 
270 #endif // end of guard _CEGUIFalTextComponent_h_