File: C:/Ruby27-x64/share/doc/ruby/html/REXML/CData.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class REXML::CData - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">Text
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-clone">#clone</a>
<li ><a href="#method-i-to_s">#to_s</a>
<li ><a href="#method-i-value">#value</a>
<li ><a href="#method-i-write">#write</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-REXML::CData">
<h1 id="class-REXML::CData" class="class">
class REXML::CData
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="ILLEGAL">ILLEGAL
<dd>
<dt id="START">START
<dd>
<dt id="STOP">STOP
<dd>
</dl>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">( first, whitespace=true, parent=nil )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<pre>Constructor. CData is data between <![CDATA[ ... ]]></pre>
<p><em>Examples</em></p>
<pre class="ruby"><span class="ruby-constant">CData</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">source</span> )
<span class="ruby-constant">CData</span>.<span class="ruby-identifier">new</span>( <span class="ruby-string">"Here is some CDATA"</span> )
<span class="ruby-constant">CData</span>.<span class="ruby-identifier">new</span>( <span class="ruby-string">"Some unprocessed data"</span>, <span class="ruby-identifier">respect_whitespace_TF</span>, <span class="ruby-identifier">parent_element</span> )
</pre>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rexml/cdata.rb, line 16</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>( <span class="ruby-identifier">first</span>, <span class="ruby-identifier">whitespace</span>=<span class="ruby-keyword">true</span>, <span class="ruby-identifier">parent</span>=<span class="ruby-keyword">nil</span> )
<span class="ruby-keyword">super</span>( <span class="ruby-identifier">first</span>, <span class="ruby-identifier">whitespace</span>, <span class="ruby-identifier">parent</span>, <span class="ruby-keyword">false</span>, <span class="ruby-keyword">true</span>, <span class="ruby-constant">ILLEGAL</span> )
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-clone" class="method-detail ">
<div class="method-heading">
<span class="method-name">clone</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Make a copy of this object</p>
<p><em>Examples</em></p>
<pre class="ruby"><span class="ruby-identifier">c</span> = <span class="ruby-constant">CData</span>.<span class="ruby-identifier">new</span>( <span class="ruby-string">"Some text"</span> )
<span class="ruby-identifier">d</span> = <span class="ruby-identifier">c</span>.<span class="ruby-identifier">clone</span>
<span class="ruby-identifier">d</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-comment"># -> "Some text"</span>
</pre>
<div class="method-source-code" id="clone-source">
<pre><span class="ruby-comment"># File lib/rexml/cdata.rb, line 26</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">clone</span>
<span class="ruby-constant">CData</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_s" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_s</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the content of this <a href="CData.html"><code>CData</code></a> object</p>
<p><em>Examples</em></p>
<pre class="ruby"><span class="ruby-identifier">c</span> = <span class="ruby-constant">CData</span>.<span class="ruby-identifier">new</span>( <span class="ruby-string">"Some text"</span> )
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-comment"># -> "Some text"</span>
</pre>
<div class="method-source-code" id="to_s-source">
<pre><span class="ruby-comment"># File lib/rexml/cdata.rb, line 35</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span>
<span class="ruby-ivar">@string</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-value" class="method-detail ">
<div class="method-heading">
<span class="method-name">value</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="value-source">
<pre><span class="ruby-comment"># File lib/rexml/cdata.rb, line 39</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">value</span>
<span class="ruby-ivar">@string</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-write" class="method-detail ">
<div class="method-heading">
<span class="method-name">write</span><span
class="method-args">( output=$stdout, indent=-1, transitive=false, ie_hack=false )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<h2 id="method-i-write-label-DEPRECATED">DEPRECATED<span><a href="#method-i-write-label-DEPRECATED">¶</a> <a href="#top">↑</a></span></h2>
<p>See the rexml/formatters package</p>
<p>Generates <a href="../XML.html"><code>XML</code></a> output of this object</p>
<dl class="rdoc-list note-list"><dt>output
<dd>
<p>Where to write the string. Defaults to $stdout</p>
</dd><dt>indent
<dd>
<p>The amount to indent this node by</p>
</dd><dt>transitive
<dd>
<p>Ignored</p>
</dd><dt>ie_hack
<dd>
<p>Ignored</p>
</dd></dl>
<p><em>Examples</em></p>
<pre class="ruby"><span class="ruby-identifier">c</span> = <span class="ruby-constant">CData</span>.<span class="ruby-identifier">new</span>( <span class="ruby-string">" Some text "</span> )
<span class="ruby-identifier">c</span>.<span class="ruby-identifier">write</span>( <span class="ruby-identifier">$stdout</span> ) <span class="ruby-comment">#-> <![CDATA[ Some text ]]></span>
</pre>
<div class="method-source-code" id="write-source">
<pre><span class="ruby-comment"># File lib/rexml/cdata.rb, line 60</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>( <span class="ruby-identifier">output</span>=<span class="ruby-identifier">$stdout</span>, <span class="ruby-identifier">indent</span>=<span class="ruby-value">-1</span>, <span class="ruby-identifier">transitive</span>=<span class="ruby-keyword">false</span>, <span class="ruby-identifier">ie_hack</span>=<span class="ruby-keyword">false</span> )
<span class="ruby-constant">Kernel</span>.<span class="ruby-identifier">warn</span>( <span class="ruby-node">"#{self.class.name}.write is deprecated"</span>, <span class="ruby-value">uplevel:</span> <span class="ruby-value">1</span>)
<span class="ruby-identifier">indent</span>( <span class="ruby-identifier">output</span>, <span class="ruby-identifier">indent</span> )
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">START</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@string</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">STOP</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>