Crazy Eddie's GUI System  0.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
RenderedString.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 "CEGUI/Size.h"
32 #include "CEGUI/Rect.h"
33 #include <vector>
34 #include <utility>
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 {
51 class CEGUIEXPORT RenderedString :
52  public AllocatedObject<RenderedString>
53 {
54 public:
57 
59  virtual ~RenderedString();
60 
97  void draw(const Window* ref_wnd,
98  const size_t line, GeometryBuffer& buffer,
99  const Vector2f& position, const ColourRect* mod_colours,
100  const Rectf* clip_rect, const float space_extra) const;
101 
116  Sizef getPixelSize(const Window* ref_wnd, const size_t line) const;
117 
119  float getHorizontalExtent(const Window* ref_wnd) const;
120 
122  float getVerticalExtent(const Window* ref_wnd) const;
123 
125  void appendComponent(const RenderedStringComponent& component);
126 
128  void clearComponents();
129 
131  size_t getComponentCount() const;
132 
156  void split(const Window* ref_wnd,
157  const size_t line, float split_point, RenderedString& left);
158 
160  size_t getSpaceCount(const size_t line) const;
161 
163  void appendLineBreak();
164 
166  size_t getLineCount() const;
167 
169  void setSelection(const Window* ref_wnd, float start, float end);
170 
172  RenderedString(const RenderedString& other);
174  RenderedString& operator=(const RenderedString& rhs);
175 
176 protected:
178  typedef std::vector<RenderedStringComponent*
179  CEGUI_VECTOR_ALLOC(RenderedStringComponent*)> ComponentList;
183  typedef std::pair<size_t, size_t> LineInfo;
185  typedef std::vector<LineInfo
186  CEGUI_VECTOR_ALLOC(LineInfo)> LineList;
190  void cloneComponentList(const ComponentList& list);
192  static void clearComponentList(ComponentList& list);
193 };
194 
195 } // End of CEGUI namespace section
196 
197 #if defined(_MSC_VER)
198 # pragma warning(pop)
199 #endif
200 
201 #endif // end of guard _CEGUIRenderedString_h_