File: classCEGUI_1_1RenderedStringWordWrapper.html

package info (click to toggle)
cegui-mk2 0.7.6-3.3
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 105,388 kB
  • ctags: 82,178
  • sloc: cpp: 142,729; ansic: 27,984; sh: 11,010; makefile: 2,275; python: 916; xml: 17
file content (166 lines) | stat: -rw-r--r-- 13,325 bytes parent folder | download | duplicates (2) 
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crazy Eddies GUI System: CEGUI::RenderedStringWordWrapper&lt; T &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
  return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}

function addClass(ele,cls) {
  if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}

function removeClass(ele,cls) {
  if (hasClass(ele,cls)) {
    var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
    ele.className=ele.className.replace(reg,' ');
  }
}

function toggleVisibility(linkObj) {
 var base = linkObj.getAttribute('id');
 var summary = document.getElementById(base + '-summary');
 var content = document.getElementById(base + '-content');
 var trigger = document.getElementById(base + '-trigger');
 if ( hasClass(linkObj,'closed') ) {
   summary.style.display = 'none';
   content.style.display = 'block';
   trigger.src = 'open.png';
   removeClass(linkObj,'closed');
   addClass(linkObj,'opened');
 } else if ( hasClass(linkObj,'opened') ) {
   summary.style.display = 'block';
   content.style.display = 'none';
   trigger.src = 'closed.png';
   removeClass(linkObj,'opened');
   addClass(linkObj,'closed');
 }
 return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Crazy Eddies GUI System&#160;<span id="projectnumber">0.7.6</span></div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a>      </li>
      <li class="navelem"><a class="el" href="classCEGUI_1_1RenderedStringWordWrapper.html">RenderedStringWordWrapper</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-types">Protected Types</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">CEGUI::RenderedStringWordWrapper&lt; T &gt; Class Template Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::RenderedStringWordWrapper" --><!-- doxytag: inherits="CEGUI::FormattedRenderedString" -->
<p>Class that handles wrapping of a rendered string into sub-strings. Each sub-string is rendered using the <a class="el" href="classCEGUI_1_1FormattedRenderedString.html" title="Root of a class hierarchy that wrap RenderedString objects and render them with additional formatting...">FormattedRenderedString</a> based class 'T'.  
 <a href="classCEGUI_1_1RenderedStringWordWrapper.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::RenderedStringWordWrapper&lt; T &gt;:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1RenderedStringWordWrapper__inherit__graph.gif" border="0" usemap="#CEGUI_1_1RenderedStringWordWrapper_3_01T_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1RenderedStringWordWrapper_3_01T_01_4_inherit__map" id="CEGUI_1_1RenderedStringWordWrapper_3_01T_01_4_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1FormattedRenderedString.html" title="Root of a class hierarchy that wrap RenderedString objects and render them with additional formatting..." alt="" coords="32,5,253,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::RenderedStringWordWrapper&lt; T &gt;:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1RenderedStringWordWrapper__coll__graph.gif" border="0" usemap="#CEGUI_1_1RenderedStringWordWrapper_3_01T_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1RenderedStringWordWrapper_3_01T_01_4_coll__map" id="CEGUI_1_1RenderedStringWordWrapper_3_01T_01_4_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1FormattedRenderedString.html" title="Root of a class hierarchy that wrap RenderedString objects and render them with additional formatting..." alt="" coords="32,101,253,131"/><area shape="rect" id="node4" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities." alt="" coords="61,5,224,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classCEGUI_1_1RenderedStringWordWrapper-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a303c4ef716afee11f97293aaf50319d8"></a><!-- doxytag: member="CEGUI::RenderedStringWordWrapper::RenderedStringWordWrapper" ref="a303c4ef716afee11f97293aaf50319d8" args="(const RenderedString &amp;string)" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedStringWordWrapper.html#a303c4ef716afee11f97293aaf50319d8">RenderedStringWordWrapper</a> (const <a class="el" href="classCEGUI_1_1RenderedString.html">RenderedString</a> &amp;string)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaae43e8e26a7e28cd349e3f6d0b06660"></a><!-- doxytag: member="CEGUI::RenderedStringWordWrapper::~RenderedStringWordWrapper" ref="aaae43e8e26a7e28cd349e3f6d0b06660" args="()" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedStringWordWrapper.html#aaae43e8e26a7e28cd349e3f6d0b06660">~RenderedStringWordWrapper</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa4435ae43dcbd8ed1acfd66e72a1a845"></a><!-- doxytag: member="CEGUI::RenderedStringWordWrapper::format" ref="aa4435ae43dcbd8ed1acfd66e72a1a845" args="(const Size &amp;area_size)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>format</b> (const <a class="el" href="classCEGUI_1_1Size.html">Size</a> &amp;area_size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a62b56b6d3bf8596b4cfffafaaa318b24"></a><!-- doxytag: member="CEGUI::RenderedStringWordWrapper::draw" ref="a62b56b6d3bf8596b4cfffafaaa318b24" args="(GeometryBuffer &amp;buffer, const Vector2 &amp;position, const ColourRect *mod_colours, const Rect *clip_rect) const " -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>draw</b> (<a class="el" href="classCEGUI_1_1GeometryBuffer.html">GeometryBuffer</a> &amp;buffer, const <a class="el" href="classCEGUI_1_1Vector2.html">Vector2</a> &amp;position, const <a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> *mod_colours, const <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> *clip_rect) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a69830c066d124c403791646f50925293"></a><!-- doxytag: member="CEGUI::RenderedStringWordWrapper::getFormattedLineCount" ref="a69830c066d124c403791646f50925293" args="() const " -->
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>getFormattedLineCount</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a046f17d75240577ea05b67da06a2ffd0"></a><!-- doxytag: member="CEGUI::RenderedStringWordWrapper::getHorizontalExtent" ref="a046f17d75240577ea05b67da06a2ffd0" args="() const " -->
float&#160;</td><td class="memItemRight" valign="bottom"><b>getHorizontalExtent</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8b8183b406c11be0e8447d0dc07b8ab2"></a><!-- doxytag: member="CEGUI::RenderedStringWordWrapper::getVerticalExtent" ref="a8b8183b406c11be0e8447d0dc07b8ab2" args="() const " -->
float&#160;</td><td class="memItemRight" valign="bottom"><b>getVerticalExtent</b> () const </td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="ae42e163d6fed1342e07e2eab91f954ae"></a><!-- doxytag: member="CEGUI::RenderedStringWordWrapper::format" ref="ae42e163d6fed1342e07e2eab91f954ae" args="(const Size &amp;area_size)" -->
template&lt;&gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">CEGUIEXPORT void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>format</b> (const <a class="el" href="classCEGUI_1_1Size.html">Size</a> &amp;area_size)</td></tr>
<tr><td colspan="2"><h2><a name="pro-types"></a>
Protected Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad467b13993e0f42d4a4eb568fcad5b60"></a><!-- doxytag: member="CEGUI::RenderedStringWordWrapper::LineList" ref="ad467b13993e0f42d4a4eb568fcad5b60" args="" -->
typedef std::vector<br class="typebreak"/>
&lt; <a class="el" href="classCEGUI_1_1FormattedRenderedString.html">FormattedRenderedString</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedStringWordWrapper.html#ad467b13993e0f42d4a4eb568fcad5b60">LineList</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">type of collection used to track the formatted lines. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aacbd3e1b7b1cf03554e9ca2503a92bc6"></a><!-- doxytag: member="CEGUI::RenderedStringWordWrapper::deleteFormatters" ref="aacbd3e1b7b1cf03554e9ca2503a92bc6" args="()" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedStringWordWrapper.html#aacbd3e1b7b1cf03554e9ca2503a92bc6">deleteFormatters</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete the current formatters and associated RenderedStrings. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afc265fb219bc4d9cc8bc82adcb152d71"></a><!-- doxytag: member="CEGUI::RenderedStringWordWrapper::d_lines" ref="afc265fb219bc4d9cc8bc82adcb152d71" args="" -->
<a class="el" href="classCEGUI_1_1RenderedStringWordWrapper.html#ad467b13993e0f42d4a4eb568fcad5b60">LineList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderedStringWordWrapper.html#afc265fb219bc4d9cc8bc82adcb152d71">d_lines</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">collection of lines. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename T&gt;<br/>
class CEGUI::RenderedStringWordWrapper&lt; T &gt;</h3>

<p>Class that handles wrapping of a rendered string into sub-strings. Each sub-string is rendered using the <a class="el" href="classCEGUI_1_1FormattedRenderedString.html" title="Root of a class hierarchy that wrap RenderedString objects and render them with additional formatting...">FormattedRenderedString</a> based class 'T'. </p>
</div></div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:41 for Crazy Eddies GUI System by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>