Crazy Eddie's GUI System  0.8.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
FormattedRenderedString.h
1 /***********************************************************************
2  filename: CEGUIFormattedRenderedString.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 _CEGUIFormattedRenderedString_h_
29 #define _CEGUIFormattedRenderedString_h_
30 
31 #include "CEGUI/RenderedString.h"
32 
33 // Start of CEGUI namespace section
34 namespace CEGUI
35 {
41 class CEGUIEXPORT FormattedRenderedString :
42  public AllocatedObject<FormattedRenderedString>
43 {
44 public:
46  virtual ~FormattedRenderedString();
47 
48  virtual void format(const Window* ref_wnd, const Sizef& area_size) = 0;
49  virtual void draw(const Window* ref_wnd, GeometryBuffer& buffer,
50  const Vector2f& position, const ColourRect* mod_colours,
51  const Rectf* clip_rect) const = 0;
52  virtual size_t getFormattedLineCount() const = 0;
53  virtual float getHorizontalExtent(const Window* ref_wnd) const = 0;
54  virtual float getVerticalExtent(const Window* ref_wnd) const = 0;
55 
57  void setRenderedString(const RenderedString& string);
58 
59  const RenderedString& getRenderedString() const;
60 
61 protected:
64 
67 };
68 
69 } // End of CEGUI namespace section
70 
71 #endif // end of guard _CEGUIFormattedRenderedString_h_