1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
/***********************************************************************
filename: CEGUIRenderedStringComponent.h
created: 24/05/2009
author: Paul Turner
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _CEGUIRenderedStringComponent_h_
#define _CEGUIRenderedStringComponent_h_
#include "CEGUISize.h"
#include "CEGUIRect.h"
#include "falagard/CEGUIFalEnums.h"
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Base class representing a part of a rendered string. The 'part' represented
may be a text string, an image or some other entity.
*/
class CEGUIEXPORT RenderedStringComponent
{
public:
//! Destructor.
virtual ~RenderedStringComponent();
//! Set the VerticalFormatting option for this component.
void setVerticalFormatting(VerticalFormatting fmt);
//! return the current VerticalFormatting option.
VerticalFormatting getVerticalFormatting() const;
//! set the padding values.
void setPadding(const Rect& padding);
//! set the left padding value.
void setLeftPadding(const float padding);
//! set the right padding value.
void setRightPadding(const float padding);
//! set the top padding value.
void setTopPadding(const float padding);
//! set the Bottom padding value.
void setBottomPadding(const float padding);
//! return the current padding value Rect.
const Rect& getPadding() const;
//! return the left padding value.
float getLeftPadding() const;
//! return the right padding value.
float getRightPadding() const;
//! return the top padding value.
float getTopPadding() const;
//! return the bottom padding value.
float getBottomPadding() const;
//! set the aspect-lock state
void setAspectLock(const bool setting);
//! return the aspect-lock state
bool getAspectLock() const;
//! draw the component.
virtual void draw(GeometryBuffer& buffer, const Vector2& position,
const ColourRect* mod_colours,
const Rect* clip_rect,
const float vertical_space,
const float space_extra) const = 0;
//! return the pixel size of the rendered component.
virtual Size getPixelSize() const = 0;
//! return whether the component can be split
virtual bool canSplit() const = 0;
/*!
\brief
split the component as close to split_point as possible, returning a
new RenderedStringComponent of the same type as '*this' holding the
left side of the split, and leaving the right side of the split in
this object.
\exception InvalidRequestException
thrown if the RenderedStringComponent does not support being split.
*/
virtual RenderedStringComponent* split(float split_point,
bool first_component) = 0;
//! clone this component.
virtual RenderedStringComponent* clone() const = 0;
//! return the total number of spacing characters in the string.
virtual size_t getSpaceCount() const = 0;
protected:
//! Protected constructor.
RenderedStringComponent();
//! Rect object holding the padding values for this component.
Rect d_padding;
//! Vertical formatting to be used for this component.
VerticalFormatting d_verticalFormatting;
//! true if the aspect ratio should be maintained where possible.
bool d_aspectLock;
};
} // End of CEGUI namespace section
#endif // end of guard _CEGUIRenderedStringComponent_h_
|
