Crazy Eddies GUI System  0.7.2
CEGUIRenderedString.h
1 /***********************************************************************
2  filename: CEGUIRenderedString.h
3  created: 25/05/2009
4  author: Paul Turner
5  *************************************************************************/
6 /***************************************************************************
7  * Copyright (C) 2004 - 2009 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 _CEGUIRenderedString_h_
29 #define _CEGUIRenderedString_h_
30 
31 #include "CEGUISize.h"
32 #include <vector>
33 #include <utility>
34 
35 #if defined(_MSC_VER)
36 # pragma warning(push)
37 # pragma warning(disable : 4251)
38 #endif
39 
40 // Start of CEGUI namespace section
41 namespace CEGUI
42 {
50 class CEGUIEXPORT RenderedString
51 {
52 public:
55 
57  virtual ~RenderedString();
58 
95  void draw(const size_t line, GeometryBuffer& buffer, const Vector2& position,
96  const ColourRect* mod_colours, const Rect* clip_rect,
97  const float space_extra) const;
98 
100 
114  Size getPixelSize(const size_t line) const;
115 
117  void appendComponent(const RenderedStringComponent& component);
118 
120  void clearComponents();
121 
123  size_t getComponentCount() const;
124 
148  void split(const size_t line, float split_point, RenderedString& left);
149 
151  size_t getSpaceCount(const size_t line) const;
152 
154  void appendLineBreak();
155 
157  size_t getLineCount() const;
158 
160  RenderedString(const RenderedString& other);
162  RenderedString& operator=(const RenderedString& rhs);
163 
164 protected:
166  typedef std::vector<RenderedStringComponent*> ComponentList;
170  typedef std::pair<size_t, size_t> LineInfo;
172  typedef std::vector<LineInfo> LineList;
176  void cloneComponentList(const ComponentList& list);
178  static void clearComponentList(ComponentList& list);
179 };
180 
181 } // End of CEGUI namespace section
182 
183 #if defined(_MSC_VER)
184 # pragma warning(pop)
185 #endif
186 
187 #endif // end of guard _CEGUIRenderedString_h_