1. Stewart Mackenzie
  2. cappuccino-docs

Source

cappuccino-docs / cappuccino docs / cappuccino.org / learn / documentation / class_c_p_value.html

<!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">

<!-- Mirrored from cappuccino.org/learn/documentation/class_c_p_value.html by HTTrack Website Copier/3.x [XR&CO'2006], Mon, 20 Sep 2010 02:18:25 GMT -->
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Cappuccino API: CPValue 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.6.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</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 class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>CPValue Class Reference<br/>
<small>
[<a class="el" href="group__foundation.html">Foundation</a>]</small>
</h1><!-- doxytag: class="CPValue" -->
<p>A generic "value". Can be subclassed to hold specific data types.  
<a href="#_details">More...</a></p>

<p><a href="class_c_p_value-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_value.html#afbfc727457083c349db5fd99249cf83b">encodeWithCoder:</a><code> [implementation]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(id)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_value.html#a535a4833f922fd6f3dd7f647928e7ede">initWithCoder:</a><code> [implementation]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(id)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_value.html#a6b4a8497ed71eae1a49bc9214db1421a">initWithJSObject:</a><code> [implementation]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(JSObject)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_value.html#ad5734bc649fbf94262f3b2b32052093a">JSObject</a><code> [implementation]</code></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(id)&nbsp;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="class_c_p_value.html#a469a2250da862906c848e571a508e645">valueWithJSObject:</a><code> [implementation]</code></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A generic "value". Can be subclassed to hold specific data types. </p>
<p>The class can be subclassed to hold different types of scalar values. </p>

<p>Definition at line <a class="el" href="_c_p_value_8j_source.html#l00034">34</a> of file <a class="el" href="_c_p_value_8j_source.html">CPValue.j</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afbfc727457083c349db5fd99249cf83b"></a><!-- doxytag: member="CPValue::encodeWithCoder:" ref="afbfc727457083c349db5fd99249cf83b" args="(CPCoder aCoder)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) encodeWithCoder: </td>
          <td></td>
          <td class="paramtype">(<a class="el" href="class_c_p_coder.html">CPCoder</a>)&nbsp;</td>
          <td class="paramname"> <em>aCoder</em></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Encodes the data into the specified coder. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>the</em>&nbsp;</td><td>coder into which the data will be written. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_c_p_value_8j_source.html#l00097">97</a> of file <a class="el" href="_c_p_value_8j_source.html">CPValue.j</a>.</p>

</div>
</div>
<a class="anchor" id="a535a4833f922fd6f3dd7f647928e7ede"></a><!-- doxytag: member="CPValue::initWithCoder:" ref="a535a4833f922fd6f3dd7f647928e7ede" args="(CPCoder aCoder)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (id) initWithCoder: </td>
          <td></td>
          <td class="paramtype">(<a class="el" href="class_c_p_coder.html">CPCoder</a>)&nbsp;</td>
          <td class="paramname"> <em>aCoder</em></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Initializes the value from a coder. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aCoder</em>&nbsp;</td><td>the coder from which to initialize </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the initialized <a class="el" href="class_c_p_value.html" title="A generic &quot;value&quot;. Can be subclassed to hold specific data types.">CPValue</a> </dd></dl>

<p>Definition at line <a class="el" href="_c_p_value_8j_source.html#l00083">83</a> of file <a class="el" href="_c_p_value_8j_source.html">CPValue.j</a>.</p>

</div>
</div>
<a class="anchor" id="a6b4a8497ed71eae1a49bc9214db1421a"></a><!-- doxytag: member="CPValue::initWithJSObject:" ref="a6b4a8497ed71eae1a49bc9214db1421a" args="(JSObject aJSObject)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (id) initWithJSObject: </td>
          <td></td>
          <td class="paramtype">(JSObject)&nbsp;</td>
          <td class="paramname"> <em>aJSObject</em></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Initializes the value from a JavaScript object </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aJSObject</em>&nbsp;</td><td>the object to get data from </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the initialized <a class="el" href="class_c_p_value.html" title="A generic &quot;value&quot;. Can be subclassed to hold specific data types.">CPValue</a> </dd></dl>

<p>Definition at line <a class="el" href="_c_p_value_8j_source.html#l00054">54</a> of file <a class="el" href="_c_p_value_8j_source.html">CPValue.j</a>.</p>

</div>
</div>
<a class="anchor" id="ad5734bc649fbf94262f3b2b32052093a"></a><!-- doxytag: member="CPValue::JSObject" ref="ad5734bc649fbf94262f3b2b32052093a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (JSObject) JSObject </td>
          <td></td>
          <td class="paramname"></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the JavaScript object backing this value. </p>

<p>Definition at line <a class="el" href="_c_p_value_8j_source.html#l00067">67</a> of file <a class="el" href="_c_p_value_8j_source.html">CPValue.j</a>.</p>

</div>
</div>
<a class="anchor" id="a469a2250da862906c848e571a508e645"></a><!-- doxytag: member="CPValue::valueWithJSObject:" ref="a469a2250da862906c848e571a508e645" args="(JSObject aJSObject)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">+ (id) valueWithJSObject: </td>
          <td></td>
          <td class="paramtype">(JSObject)&nbsp;</td>
          <td class="paramname"> <em>aJSObject</em></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates a value from the specified JavaScript object </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aJSObject</em>&nbsp;</td><td>a JavaScript object containing a value </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the converted <a class="el" href="class_c_p_value.html" title="A generic &quot;value&quot;. Can be subclassed to hold specific data types.">CPValue</a> </dd></dl>

<p>Definition at line <a class="el" href="_c_p_value_8j_source.html#l00044">44</a> of file <a class="el" href="_c_p_value_8j_source.html">CPValue.j</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Foundation/<a class="el" href="_c_p_value_8j_source.html">CPValue.j</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Apr 6 10:33:07 2010 for Cappuccino API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>

<!-- Mirrored from cappuccino.org/learn/documentation/class_c_p_value.html by HTTrack Website Copier/3.x [XR&CO'2006], Mon, 20 Sep 2010 02:18:26 GMT -->
</html>