Crazy Eddies GUI System  0.7.1
CEGUIRenderedStringComponent.h
1 /***********************************************************************
2  filename: CEGUIRenderedStringComponent.h
3  created: 24/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 _CEGUIRenderedStringComponent_h_
29 #define _CEGUIRenderedStringComponent_h_
30 
31 #include "CEGUISize.h"
32 #include "CEGUIRect.h"
33 #include "falagard/CEGUIFalEnums.h"
34 
35 // Start of CEGUI namespace section
36 namespace CEGUI
37 {
43 class CEGUIEXPORT RenderedStringComponent
44 {
45 public:
47  virtual ~RenderedStringComponent();
48 
50  void setVerticalFormatting(VerticalFormatting fmt);
52  VerticalFormatting getVerticalFormatting() const;
54  void setPadding(const Rect& padding);
56  void setLeftPadding(const float padding);
58  void setRightPadding(const float padding);
60  void setTopPadding(const float padding);
62  void setBottomPadding(const float padding);
64  const Rect& getPadding() const;
66  float getLeftPadding() const;
68  float getRightPadding() const;
70  float getTopPadding() const;
72  float getBottomPadding() const;
74  void setAspectLock(const bool setting);
76  bool getAspectLock() const;
77 
79  virtual void draw(GeometryBuffer& buffer, const Vector2& position,
80  const ColourRect* mod_colours,
81  const Rect* clip_rect,
82  const float vertical_space,
83  const float space_extra) const = 0;
84 
86  virtual Size getPixelSize() const = 0;
87 
89  virtual bool canSplit() const = 0;
90 
101  virtual RenderedStringComponent* split(float split_point,
102  bool first_component) = 0;
103 
105  virtual RenderedStringComponent* clone() const = 0;
106 
108  virtual size_t getSpaceCount() const = 0;
109 
110 protected:
112  RenderedStringComponent();
113 
115  Rect d_padding;
117  VerticalFormatting d_verticalFormatting;
119  bool d_aspectLock;
120 };
121 
122 } // End of CEGUI namespace section
123 
124 #endif // end of guard _CEGUIRenderedStringComponent_h_
Generated by   doxygen 1.8.3.1