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 167 168 169 170 171 172 173 174
|
<!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::DefaultRenderedStringParser 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_1DefaultRenderedStringParser.html">DefaultRenderedStringParser</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::DefaultRenderedStringParser Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::DefaultRenderedStringParser" --><!-- doxytag: inherits="CEGUI::RenderedStringParser" -->
<p>Effectively a 'null' parser that returns a <a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a> representation that will draw the input text verbatim.
<a href="classCEGUI_1_1DefaultRenderedStringParser.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::DefaultRenderedStringParser:</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_1DefaultRenderedStringParser__inherit__graph.gif" border="0" usemap="#CEGUI_1_1DefaultRenderedStringParser_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1DefaultRenderedStringParser_inherit__map" id="CEGUI_1_1DefaultRenderedStringParser_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1RenderedStringParser.html" title="Specifies interface for classes that parse text into RenderedString objects." alt="" coords="27,5,227,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::DefaultRenderedStringParser:</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_1DefaultRenderedStringParser__coll__graph.gif" border="0" usemap="#CEGUI_1_1DefaultRenderedStringParser_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1DefaultRenderedStringParser_coll__map" id="CEGUI_1_1DefaultRenderedStringParser_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1RenderedStringParser.html" title="Specifies interface for classes that parse text into RenderedString objects." alt="" coords="27,5,227,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1DefaultRenderedStringParser-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="el" href="classCEGUI_1_1RenderedString.html">RenderedString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1DefaultRenderedStringParser.html#a024921297e8afd049cebdd15f2c6fd09">parse</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &input_string, <a class="el" href="classCEGUI_1_1Font.html">Font</a> *initial_font, const <a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> *initial_colours)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">parse a text string and return a <a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a> representation. <a href="#a024921297e8afd049cebdd15f2c6fd09"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Effectively a 'null' parser that returns a <a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a> representation that will draw the input text verbatim. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a024921297e8afd049cebdd15f2c6fd09"></a><!-- doxytag: member="CEGUI::DefaultRenderedStringParser::parse" ref="a024921297e8afd049cebdd15f2c6fd09" args="(const String &input_string, Font *initial_font, const ColourRect *initial_colours)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1RenderedString.html">RenderedString</a> CEGUI::DefaultRenderedStringParser::parse </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>input_string</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1Font.html">Font</a> * </td>
<td class="paramname"><em>initial_font</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1ColourRect.html">ColourRect</a> * </td>
<td class="paramname"><em>initial_colours</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>parse a text string and return a <a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a> representation. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">input_string</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the text that is to be parsed.</td></tr>
<tr><td class="paramname">initial_font</td><td>Pointer to the initial font to be used for text (0 for system default).</td></tr>
<tr><td class="paramname">initial_colours</td><td>Pointer to the initial colours to be used (0 for default).</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1RenderedString.html" title="Class representing a rendered string of entities.">RenderedString</a> object holding the result of the parse operation. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1RenderedStringParser.html#aa1951863d9a7184a08f1efc5b4c8b61d">CEGUI::RenderedStringParser</a>.</p>
</div>
</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>
|