Crazy Eddie's GUI System  0.8.7
JustifiedRenderedString.h
1 /***********************************************************************
2  created: Mon Jul 6 2009
3  author: Paul D Turner <paul@cegui.org.uk>
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 _CEGUIJustifiedRenderedString_h_
28 #define _CEGUIJustifiedRenderedString_h_
29 
30 #include "CEGUI/FormattedRenderedString.h"
31 #include <vector>
32 
33 #if defined (_MSC_VER)
34 # pragma warning(push)
35 # pragma warning(disable : 4251)
36 #endif
37 
38 // Start of CEGUI namespace section
39 namespace CEGUI
40 {
47 {
48 public:
51 
52  // implementation of base interface
53  void format(const Window* ref_wnd, const Sizef& area_size);
54  void draw(const Window* ref_wnd, GeometryBuffer& buffer,
55  const Vector2f& position, const ColourRect* mod_colours,
56  const Rectf* clip_rect) const;
57  size_t getFormattedLineCount() const;
58  float getHorizontalExtent(const Window* ref_wnd) const;
59  float getVerticalExtent(const Window* ref_wnd) const;
60 
61 protected:
63  std::vector<float
64  CEGUI_VECTOR_ALLOC(float)> d_spaceExtras;
65 };
66 
67 } // End of CEGUI namespace section
68 
69 #if defined (_MSC_VER)
70 # pragma warning(pop)
71 #endif
72 
73 #endif // end of guard _CEGUIJustifiedRenderedString_h_
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
FormattedRenderedString implementation that renders the RenderedString with justified formatting...
Definition: JustifiedRenderedString.h:46
std::vector< float CEGUI_VECTOR_ALLOC(float)> d_spaceExtras
space extra size for each line to achieve justified formatting.
Definition: JustifiedRenderedString.h:64