Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / tinyxml / 6179c01dffe833593897e996b5faef9b79b66eb1 / . / docs / classTiXmlText.html
blob: fe3115400449a0e8bbd63fa2ce970ab66c457f0b [file] [log] [blame]
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]5<title>TinyXml: TiXmlText Class Reference</title>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame]6<link href="tabs.css" rel="stylesheet" type="text/css"/>
7<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8</head>
9<body>
10<!-- Generated by Doxygen 1.6.2 -->
11<div class="navigation" id="top">
12 <div class="tabs">
13 <ul>
14 <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
15 <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
16 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
17 <li><a href="files.html"><span>Files</span></a></li>
18 </ul>
19 </div>
20 <div class="tabs">
21 <ul>
22 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
23 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
24 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
25 </ul>
26 </div>
27</div>
28<div class="contents">
29<h1>TiXmlText Class Reference</h1><!-- doxytag: class="TiXmlText" --><!-- doxytag: inherits="TiXmlNode" -->
30<p>XML text.
31<a href="#_details">More...</a></p>
32
33<p><code>#include &lt;<a class="el" href="tinyxml_8h_source.html">tinyxml.h</a>&gt;</code></p>
34<div class="dynheader">
35Inheritance diagram for TiXmlText:</div>
36<div class="dynsection">
37 <div class="center">
38 <img src="classTiXmlText.png" usemap="#TiXmlText_map" alt=""/>
39 <map id="TiXmlText_map" name="TiXmlText_map">
40<area href="classTiXmlNode.html" alt="TiXmlNode" shape="rect" coords="0,56,73,80"/>
41<area href="classTiXmlBase.html" alt="TiXmlBase" shape="rect" coords="0,0,73,24"/>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]42</map>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame]43 </div>
44</div>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]45
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame]46<p><a href="classTiXmlText-members.html">List of all members.</a></p>
47<table border="0" cellpadding="0" cellspacing="0">
48<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
49<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlText.html#af659e77c6b87d684827f35a8f4895960">TiXmlText</a> (const char *initValue)</td></tr>
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor for text element. <a href="#af659e77c6b87d684827f35a8f4895960"></a><br/></td></tr>
51<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a439792f6183a3d3fb6f2bc2b16fa5691"></a><!-- doxytag: member="TiXmlText::TiXmlText" ref="a439792f6183a3d3fb6f2bc2b16fa5691" args="(const std::string &amp;initValue)" -->
52&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlText.html#a439792f6183a3d3fb6f2bc2b16fa5691">TiXmlText</a> (const std::string &amp;initValue)</td></tr>
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br/></td></tr>
54<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlText.html#a0cafbf6f236c7f02d12b2bffc2b7976b">Print</a> (FILE *cfile, int depth) const </td></tr>
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode. <a href="#a0cafbf6f236c7f02d12b2bffc2b7976b"></a><br/></td></tr>
56<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad1a6a6b83fa2271022dd97c072a2b586"></a><!-- doxytag: member="TiXmlText::CDATA" ref="ad1a6a6b83fa2271022dd97c072a2b586" args="() const " -->
57bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlText.html#ad1a6a6b83fa2271022dd97c072a2b586">CDATA</a> () const </td></tr>
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Queries whether this represents text using a CDATA section. <br/></td></tr>
59<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acb17ff7c5d09b2c839393445a3de5ea9"></a><!-- doxytag: member="TiXmlText::SetCDATA" ref="acb17ff7c5d09b2c839393445a3de5ea9" args="(bool _cdata)" -->
60void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlText.html#acb17ff7c5d09b2c839393445a3de5ea9">SetCDATA</a> (bool _cdata)</td></tr>
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Turns on or off a CDATA representation of text. <br/></td></tr>
62<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a895bf34ffad17f7439ab2a52b9651648"></a><!-- doxytag: member="TiXmlText::ToText" ref="a895bf34ffad17f7439ab2a52b9651648" args="() const " -->
63virtual const <a class="el" href="classTiXmlText.html">TiXmlText</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlText.html#a895bf34ffad17f7439ab2a52b9651648">ToText</a> () const </td></tr>
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cast to a more defined type. Will return null not of the requested type. <br/></td></tr>
65<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae7c3a8fd3e4dbf6c0c4363a943d72f5b"></a><!-- doxytag: member="TiXmlText::ToText" ref="ae7c3a8fd3e4dbf6c0c4363a943d72f5b" args="()" -->
66virtual <a class="el" href="classTiXmlText.html">TiXmlText</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlText.html#ae7c3a8fd3e4dbf6c0c4363a943d72f5b">ToText</a> ()</td></tr>
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cast to a more defined type. Will return null not of the requested type. <br/></td></tr>
68<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8483d4415ce9de6c4fa8f63d067d5de6"></a><!-- doxytag: member="TiXmlText::Accept" ref="a8483d4415ce9de6c4fa8f63d067d5de6" args="(TiXmlVisitor *content) const " -->
69virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlText.html#a8483d4415ce9de6c4fa8f63d067d5de6">Accept</a> (<a class="el" href="classTiXmlVisitor.html">TiXmlVisitor</a> *content) const </td></tr>
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Walk the XML tree visiting this node and all of its children. <br/></td></tr>
71<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
72<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c411e93a27537369479d034cc82da3b"></a><!-- doxytag: member="TiXmlText::Clone" ref="a0c411e93a27537369479d034cc82da3b" args="() const " -->
73virtual <a class="el" href="classTiXmlNode.html">TiXmlNode</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlText.html#a0c411e93a27537369479d034cc82da3b">Clone</a> () const </td></tr>
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[internal use] Creates a new Element and returns it. <br/></td></tr>
75<tr><td colspan="2"><h2>Friends</h2></td></tr>
76<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6592e32cb9132be517cc12a70564c4b"></a><!-- doxytag: member="TiXmlText::TiXmlElement" ref="ab6592e32cb9132be517cc12a70564c4b" args="" -->
77class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlText.html#ab6592e32cb9132be517cc12a70564c4b">TiXmlElement</a></td></tr>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]78</table>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame]79<hr/><a name="_details"></a><h2>Detailed Description</h2>
80<p>XML text. </p>
81<p>A text node can have 2 ways to output the next. "normal" output and CDATA. It will default to the mode it was parsed from the XML file and you generally want to leave it alone, but you can change the output mode with <a class="el" href="classTiXmlText.html#acb17ff7c5d09b2c839393445a3de5ea9" title="Turns on or off a CDATA representation of text.">SetCDATA()</a> and query it with <a class="el" href="classTiXmlText.html#ad1a6a6b83fa2271022dd97c072a2b586" title="Queries whether this represents text using a CDATA section.">CDATA()</a>. </p>
82<hr/><h2>Constructor &amp; Destructor Documentation</h2>
83<a class="anchor" id="af659e77c6b87d684827f35a8f4895960"></a><!-- doxytag: member="TiXmlText::TiXmlText" ref="af659e77c6b87d684827f35a8f4895960" args="(const char *initValue)" -->
84<div class="memitem">
85<div class="memproto">
86 <table class="memname">
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]87 <tr>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame]88 <td class="memname">TiXmlText::TiXmlText </td>
89 <td>(</td>
90 <td class="paramtype">const char *&nbsp;</td>
91 <td class="paramname"> <em>initValue</em></td>
92 <td>&nbsp;)&nbsp;</td>
93 <td><code> [inline]</code></td>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]94 </tr>
95 </table>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame]96</div>
97<div class="memdoc">
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]98
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame]99<p>Constructor for text element. </p>
100<p>By default, it is treated as normal, encoded text. If you want it be output as a CDATA text element, set the parameter _cdata to 'true' </p>
101
102<p>References <a class="el" href="tinyxml_8h_source.html#l00508">TiXmlNode::SetValue()</a>.</p>
103
104</div>
105</div>
106<hr/><h2>Member Function Documentation</h2>
107<a class="anchor" id="a0cafbf6f236c7f02d12b2bffc2b7976b"></a><!-- doxytag: member="TiXmlText::Print" ref="a0cafbf6f236c7f02d12b2bffc2b7976b" args="(FILE *cfile, int depth) const " -->
108<div class="memitem">
109<div class="memproto">
110 <table class="memname">
111 <tr>
112 <td class="memname">virtual void TiXmlText::Print </td>
113 <td>(</td>
114 <td class="paramtype">FILE *&nbsp;</td>
115 <td class="paramname"> <em>cfile</em>, </td>
116 </tr>
117 <tr>
118 <td class="paramkey"></td>
119 <td></td>
120 <td class="paramtype">int&nbsp;</td>
121 <td class="paramname"> <em>depth</em></td><td>&nbsp;</td>
122 </tr>
123 <tr>
124 <td></td>
125 <td>)</td>
126 <td></td><td></td><td> const<code> [virtual]</code></td>
127 </tr>
128 </table>
129</div>
130<div class="memdoc">
131
132<p>All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode. </p>
133<p>) Either or both cfile and str can be null.</p>
134<p>This is a formatted print, and will insert tabs and newlines.</p>
135<p>(For an unformatted stream, use the &lt;&lt; operator.) </p>
136
137<p>Implements <a class="el" href="classTiXmlBase.html#a0de56b3f2ef14c65091a3b916437b512">TiXmlBase</a>.</p>
138
139</div>
140</div>
141<hr/>The documentation for this class was generated from the following file:<ul>
142<li><a class="el" href="tinyxml_8h_source.html">tinyxml.h</a></li>
143</ul>
144</div>
145<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]146<a href="http://www.doxygen.org/index.html">
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame]147<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]148</body>
149</html>