comparison 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
comparison
equal deleted inserted replaced
78:c48b393f6461 79:228a56e7e793
113 <tt class="descname">get_runtime</tt><big>(</big><big>)</big><a class="headerlink" href="#pymonkey.Context.get_runtime" title="Permalink to this definition">¶</a></dt> 113 <tt class="descname">get_runtime</tt><big>(</big><big>)</big><a class="headerlink" href="#pymonkey.Context.get_runtime" title="Permalink to this definition">¶</a></dt>
114 <dd>Returns the <a title="pymonkey.Runtime" class="reference" href="#pymonkey.Runtime"><tt class="xref docutils literal"><span class="pre">Runtime</span></tt></a> that the context belongs to.</dd></dl> 114 <dd>Returns the <a title="pymonkey.Runtime" class="reference" href="#pymonkey.Runtime"><tt class="xref docutils literal"><span class="pre">Runtime</span></tt></a> that the context belongs to.</dd></dl>
115 115
116 <dl class="method"> 116 <dl class="method">
117 <dt id="pymonkey.Context.new_object"> 117 <dt id="pymonkey.Context.new_object">
118 <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> 118 <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>
119 <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> 119 <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
120 it. <tt class="docutils literal"><span class="pre">private_obj</span></tt> is any Python object that is privately
121 stored within the new JS object; it can be retrieved using
122 <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>
123
124 <dl class="method">
125 <dt id="pymonkey.Context.get_object_private">
126 <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>
127 <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>
128 when <cite>object</cite> was first created. If it doesn&#8217;t exist, <tt class="xref docutils literal"><span class="pre">None</span></tt>
129 is returned.</p>
130 <p>This functionality is useful if you want to represent Python
131 objects in JS-land.</p>
132 </dd></dl>
120 133
121 <dl class="method"> 134 <dl class="method">
122 <dt id="pymonkey.Context.init_standard_classes"> 135 <dt id="pymonkey.Context.init_standard_classes">
123 <tt class="descname">init_standard_classes</tt><big>(</big><em>object</em><big>)</big><a class="headerlink" href="#pymonkey.Context.init_standard_classes" title="Permalink to this definition">¶</a></dt> 136 <tt class="descname">init_standard_classes</tt><big>(</big><em>object</em><big>)</big><a class="headerlink" href="#pymonkey.Context.init_standard_classes" title="Permalink to this definition">¶</a></dt>
124 <dd>Defines the standard JavaScript classes on the given 137 <dd>Defines the standard JavaScript classes on the given