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
|
<!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::FormattedRenderedString Class 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 <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 Page</span></a></li>
<li><a href="pages.html"><span>Related 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 List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class 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_1FormattedRenderedString.html">FormattedRenderedString</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::FormattedRenderedString Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::FormattedRenderedString" -->
<p>Root of a class hierarchy that wrap <a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a> objects and render them with additional formatting.
<a href="classCEGUI_1_1FormattedRenderedString.html#details">More...</a></p>
<p>Inherited by <a class="el" href="classCEGUI_1_1CentredRenderedString.html">CEGUI::CentredRenderedString</a>, <a class="el" href="classCEGUI_1_1JustifiedRenderedString.html">CEGUI::JustifiedRenderedString</a>, <a class="el" href="classCEGUI_1_1LeftAlignedRenderedString.html">CEGUI::LeftAlignedRenderedString</a>, <a class="el" href="classCEGUI_1_1RenderedStringWordWrapper.html">CEGUI::RenderedStringWordWrapper< T ></a>, and <a class="el" href="classCEGUI_1_1RightAlignedRenderedString.html">CEGUI::RightAlignedRenderedString</a>.</p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Collaboration diagram for CEGUI::FormattedRenderedString:</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_1FormattedRenderedString__coll__graph.gif" border="0" usemap="#CEGUI_1_1FormattedRenderedString_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1FormattedRenderedString_coll__map" id="CEGUI_1_1FormattedRenderedString_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities." alt="" coords="35,5,197,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1FormattedRenderedString-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="a31bdeb6e9edccc9d45ea9a1bdee3fa08"></a><!-- doxytag: member="CEGUI::FormattedRenderedString::~FormattedRenderedString" ref="a31bdeb6e9edccc9d45ea9a1bdee3fa08" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FormattedRenderedString.html#a31bdeb6e9edccc9d45ea9a1bdee3fa08">~FormattedRenderedString</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a280b843c3f7c6f13f50d50f46c5cbb80"></a><!-- doxytag: member="CEGUI::FormattedRenderedString::format" ref="a280b843c3f7c6f13f50d50f46c5cbb80" args="(const Size &area_size)=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>format</b> (const <a class="el" href="classCEGUI_1_1Size.html">Size</a> &area_size)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63b196e5cee4b6dcb6750f3dfaaa5986"></a><!-- doxytag: member="CEGUI::FormattedRenderedString::draw" ref="a63b196e5cee4b6dcb6750f3dfaaa5986" args="(GeometryBuffer &buffer, const Vector2 &position, const ColourRect *mod_colours, const Rect *clip_rect) const =0" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>draw</b> (<a class="el" href="classCEGUI_1_1GeometryBuffer.html">GeometryBuffer</a> &buffer, const <a class="el" href="classCEGUI_1_1Vector2.html">Vector2</a> &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 =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03a98231f1503f12d1be3872ed0834e2"></a><!-- doxytag: member="CEGUI::FormattedRenderedString::getFormattedLineCount" ref="a03a98231f1503f12d1be3872ed0834e2" args="() const =0" -->
virtual size_t </td><td class="memItemRight" valign="bottom"><b>getFormattedLineCount</b> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8126fd6f7f7ff110e671865acc2773bc"></a><!-- doxytag: member="CEGUI::FormattedRenderedString::getHorizontalExtent" ref="a8126fd6f7f7ff110e671865acc2773bc" args="() const =0" -->
virtual float </td><td class="memItemRight" valign="bottom"><b>getHorizontalExtent</b> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f5dd5b6bacc74d560818e2ed1c050e7"></a><!-- doxytag: member="CEGUI::FormattedRenderedString::getVerticalExtent" ref="a3f5dd5b6bacc74d560818e2ed1c050e7" args="() const =0" -->
virtual float </td><td class="memItemRight" valign="bottom"><b>getVerticalExtent</b> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c8cb8e972cdc8c7cd35d0c9f6ba73f2"></a><!-- doxytag: member="CEGUI::FormattedRenderedString::setRenderedString" ref="a3c8cb8e972cdc8c7cd35d0c9f6ba73f2" args="(const RenderedString &string)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FormattedRenderedString.html#a3c8cb8e972cdc8c7cd35d0c9f6ba73f2">setRenderedString</a> (const <a class="el" href="classCEGUI_1_1RenderedString.html">RenderedString</a> &string)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set the <a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acde5dd1a1b722f6d45f9599a5139b043"></a><!-- doxytag: member="CEGUI::FormattedRenderedString::getRenderedString" ref="acde5dd1a1b722f6d45f9599a5139b043" args="() const " -->
const <a class="el" href="classCEGUI_1_1RenderedString.html">RenderedString</a> & </td><td class="memItemRight" valign="bottom"><b>getRenderedString</b> () const </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="a0b177cf8e21df6aeb3eb6c74a8b2f510"></a><!-- doxytag: member="CEGUI::FormattedRenderedString::FormattedRenderedString" ref="a0b177cf8e21df6aeb3eb6c74a8b2f510" args="(const RenderedString &string)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FormattedRenderedString.html#a0b177cf8e21df6aeb3eb6c74a8b2f510">FormattedRenderedString</a> (const <a class="el" href="classCEGUI_1_1RenderedString.html">RenderedString</a> &string)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <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="a90b10c92a45c5aff11341cfda8e07965"></a><!-- doxytag: member="CEGUI::FormattedRenderedString::d_renderedString" ref="a90b10c92a45c5aff11341cfda8e07965" args="" -->
const <a class="el" href="classCEGUI_1_1RenderedString.html">RenderedString</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FormattedRenderedString.html#a90b10c92a45c5aff11341cfda8e07965">d_renderedString</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a> that we handle formatting for. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Root of a class hierarchy that wrap <a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a> objects and render them with additional formatting. </p>
</div></div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:40 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|