Crazy Eddie's GUI System  0.8.7
FormattedRenderedString.h
1 /***********************************************************************
2  created: 25/05/2009
3  author: Paul Turner
4  *************************************************************************/
5 /***************************************************************************
6  * Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining
9  * a copy of this software and associated documentation files (the
10  * "Software"), to deal in the Software without restriction, including
11  * without limitation the rights to use, copy, modify, merge, publish,
12  * distribute, sublicense, and/or sell copies of the Software, and to
13  * permit persons to whom the Software is furnished to do so, subject to
14  * the following conditions:
15  *
16  * The above copyright notice and this permission notice shall be
17  * included in all copies or substantial portions of the Software.
18  *
19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25  * OTHER DEALINGS IN THE SOFTWARE.
26  ***************************************************************************/
27 #ifndef _CEGUIFormattedRenderedString_h_
28 #define _CEGUIFormattedRenderedString_h_
29 
30 #include "CEGUI/RenderedString.h"
31 
32 // Start of CEGUI namespace section
33 namespace CEGUI
34 {
40 class CEGUIEXPORT FormattedRenderedString :
41  public AllocatedObject<FormattedRenderedString>
42 {
43 public:
45  virtual ~FormattedRenderedString();
46 
47  virtual void format(const Window* ref_wnd, const Sizef& area_size) = 0;
48  virtual void draw(const Window* ref_wnd, GeometryBuffer& buffer,
49  const Vector2f& position, const ColourRect* mod_colours,
50  const Rectf* clip_rect) const = 0;
51  virtual size_t getFormattedLineCount() const = 0;
52  virtual float getHorizontalExtent(const Window* ref_wnd) const = 0;
53  virtual float getVerticalExtent(const Window* ref_wnd) 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_
Definition: MemoryAllocatedObject.h:109
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: GeometryBuffer.h:42
Class that holds details of colours for the four corners of a rectangle.
Definition: ColourRect.h:43
Root of a class hierarchy that wrap RenderedString objects and render them with additional formatting...
Definition: FormattedRenderedString.h:40
Class representing a rendered string of entities.
Definition: RenderedString.h:50
An abstract base class providing common functionality and specifying the required interface for deriv...
Definition: Window.h:149
const RenderedString * d_renderedString
RenderedString that we handle formatting for.
Definition: FormattedRenderedString.h:65