Crazy Eddies GUI System  0.7.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
CEGUIFormattedRenderedString.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 "CEGUIRenderedString.h"
32 
33 // Start of CEGUI namespace section
34 namespace CEGUI
35 {
41 class CEGUIEXPORT FormattedRenderedString
42 {
43 public:
45  virtual ~FormattedRenderedString();
46 
47  virtual void format(const Size& area_size) = 0;
48  virtual void draw(GeometryBuffer& buffer, const Vector2& position,
49  const ColourRect* mod_colours,
50  const Rect* clip_rect) const = 0;
51  virtual size_t getFormattedLineCount() const = 0;
52  virtual float getHorizontalExtent() const = 0;
53  virtual float getVerticalExtent() const = 0;
54 
56  void setRenderedString(const RenderedString& string);
57 
58  const RenderedString& getRenderedString() const;
59 
60 protected:
63 
66 };
67 
68 } // End of CEGUI namespace section
69 
70 #endif // end of guard _CEGUIFormattedRenderedString_h_
Class used as a two dimensional vector (aka a Point)
Definition: CEGUIVector.h:45
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: CEGUIGeometryBuffer.h:42
Class that holds the size (width & height) of something.
Definition: CEGUISize.h:43
Class that holds details of colours for the four corners of a rectangle.
Definition: CEGUIColourRect.h:44
Root of a class hierarchy that wrap RenderedString objects and render them with additional formatting...
Definition: CEGUIFormattedRenderedString.h:41
Class representing a rendered string of entities.
Definition: CEGUIRenderedString.h:50
Class encapsulating operations on a Rectangle.
Definition: CEGUIRect.h:44
const RenderedString * d_renderedString
RenderedString that we handle formatting for.
Definition: CEGUIFormattedRenderedString.h:65