Crazy Eddie's GUI System  0.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
RenderedStringComponent.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 "CEGUI/Size.h"
32 #include "CEGUI/Rect.h"
33 #include "CEGUI/falagard/Enums.h"
34 
35 #if defined(_MSC_VER)
36 # pragma warning(push)
37 # pragma warning(disable : 4251)
38 #endif
39 
40 // Start of CEGUI namespace section
41 namespace CEGUI
42 {
48 class CEGUIEXPORT RenderedStringComponent :
49  public AllocatedObject<RenderedStringComponent>
50 {
51 public:
53  virtual ~RenderedStringComponent();
54 
56  void setVerticalFormatting(VerticalFormatting fmt);
58  VerticalFormatting getVerticalFormatting() const;
60  void setPadding(const Rectf& padding);
62  void setLeftPadding(const float padding);
64  void setRightPadding(const float padding);
66  void setTopPadding(const float padding);
68  void setBottomPadding(const float padding);
70  const Rectf& getPadding() const;
72  float getLeftPadding() const;
74  float getRightPadding() const;
76  float getTopPadding() const;
78  float getBottomPadding() const;
80  void setAspectLock(const bool setting);
82  bool getAspectLock() const;
83 
85  virtual void draw(const Window* ref_wnd, GeometryBuffer& buffer,
86  const Vector2f& position, const ColourRect* mod_colours,
87  const Rectf* clip_rect, const float vertical_space,
88  const float space_extra) const = 0;
89 
91  virtual Sizef getPixelSize(const Window* ref_wnd) const = 0;
92 
94  virtual bool canSplit() const = 0;
95 
106  virtual RenderedStringComponent* split(const Window* ref_wnd,
107  float split_point,
108  bool first_component) = 0;
109 
111  virtual RenderedStringComponent* clone() const = 0;
112 
114  virtual size_t getSpaceCount() const = 0;
115 
117  virtual void setSelection(const Window* ref_wnd,
118  const float start, const float end) = 0;
119 
120 protected:
122  RenderedStringComponent();
123 
125  Rectf d_padding;
127  VerticalFormatting d_verticalFormatting;
129  bool d_aspectLock;
131  const Image* d_selectionImage;
132 };
133 
134 } // End of CEGUI namespace section
135 
136 #if defined(_MSC_VER)
137 # pragma warning(pop)
138 #endif
139 
140 #endif // end of guard _CEGUIRenderedStringComponent_h_