Mercurial > pymonkey
diff docs/rendered/pymonkey.html @ 79:228a56e7e793
Added docs for context.get_object_private().
author | Atul Varma <varmaa@toolness.com> |
---|---|
date | Fri, 07 Aug 2009 18:56:32 -0700 |
parents | c48b393f6461 |
children | e9f450d30c0e |
line wrap: on
line diff
--- a/docs/rendered/pymonkey.html Fri Aug 07 11:21:21 2009 -0700 +++ b/docs/rendered/pymonkey.html Fri Aug 07 18:56:32 2009 -0700 @@ -115,8 +115,21 @@ <dl class="method"> <dt id="pymonkey.Context.new_object"> -<tt class="descname">new_object</tt><big>(</big><big>)</big><a class="headerlink" href="#pymonkey.Context.new_object" title="Permalink to this definition">¶</a></dt> -<dd>Creates a new <a title="pymonkey.Object" class="reference" href="#pymonkey.Object"><tt class="xref docutils literal"><span class="pre">Object</span></tt></a> instance and returns it.</dd></dl> +<tt class="descname">new_object</tt><big>(</big><span class="optional">[</span><em>private_obj</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#pymonkey.Context.new_object" title="Permalink to this definition">¶</a></dt> +<dd>Creates a new <a title="pymonkey.Object" class="reference" href="#pymonkey.Object"><tt class="xref docutils literal"><span class="pre">Object</span></tt></a> instance and returns +it. <tt class="docutils literal"><span class="pre">private_obj</span></tt> is any Python object that is privately +stored within the new JS object; it can be retrieved using +<a title="pymonkey.Context.get_object_private" class="reference" href="#pymonkey.Context.get_object_private"><tt class="xref docutils literal"><span class="pre">get_object_private()</span></tt></a>.</dd></dl> + +<dl class="method"> +<dt id="pymonkey.Context.get_object_private"> +<tt class="descname">get_object_private</tt><big>(</big><em>object</em><big>)</big><a class="headerlink" href="#pymonkey.Context.get_object_private" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the <tt class="docutils literal"><span class="pre">private_obj</span></tt> passed to <a title="pymonkey.Context.new_object" class="reference" href="#pymonkey.Context.new_object"><tt class="xref docutils literal"><span class="pre">new_object()</span></tt></a> +when <cite>object</cite> was first created. If it doesn’t exist, <tt class="xref docutils literal"><span class="pre">None</span></tt> +is returned.</p> +<p>This functionality is useful if you want to represent Python +objects in JS-land.</p> +</dd></dl> <dl class="method"> <dt id="pymonkey.Context.init_standard_classes">