Mercurial > pymonkey
diff docs/rendered/pymonkey.html @ 114:87147faa031a
Added docs for define_property() and get_property().
author | Atul Varma <varmaa@toolness.com> |
---|---|
date | Mon, 17 Aug 2009 03:02:51 -0700 |
parents | e616b4605db0 |
children | f4c550369332 |
line wrap: on
line diff
--- a/docs/rendered/pymonkey.html Sun Aug 16 22:48:50 2009 -0700 +++ b/docs/rendered/pymonkey.html Mon Aug 17 03:02:51 2009 -0700 @@ -155,6 +155,32 @@ </dd></dl> <dl class="method"> +<dt id="pymonkey.Context.define_property"> +<tt class="descname">define_property</tt><big>(</big><em>object</em>, <em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#pymonkey.Context.define_property" title="Permalink to this definition">¶</a></dt> +<dd>Creates a new property on <cite>object</cite>, bypassing any JavaScript setters.</dd></dl> + +<dl class="method"> +<dt id="pymonkey.Context.get_property"> +<tt class="descname">get_property</tt><big>(</big><em>object</em>, <em>name</em><big>)</big><a class="headerlink" href="#pymonkey.Context.get_property" title="Permalink to this definition">¶</a></dt> +<dd><p>Finds the specified property on <cite>object</cite> and returns its value, +possibly invoking a JavaScript getter.</p> +<p>Example:</p> +<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">cx</span> <span class="o">=</span> <span class="n">pymonkey</span><span class="o">.</span><span class="n">Runtime</span><span class="p">()</span><span class="o">.</span><span class="n">new_context</span><span class="p">()</span> +<span class="gp">>>> </span><span class="n">obj</span> <span class="o">=</span> <span class="n">cx</span><span class="o">.</span><span class="n">new_object</span><span class="p">()</span> +<span class="gp">>>> </span><span class="n">cx</span><span class="o">.</span><span class="n">define_property</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s">'beets'</span><span class="p">,</span> <span class="s">'i like beets.'</span><span class="p">)</span> +<span class="gp">>>> </span><span class="n">cx</span><span class="o">.</span><span class="n">get_property</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s">'beets'</span><span class="p">)</span> +<span class="go">u'i like beets.'</span> +</pre></div> +</div> +<p>Note also that calling this function on undefined properties +yields <a title="pymonkey.undefined" class="reference" href="#pymonkey.undefined"><tt class="xref docutils literal"><span class="pre">undefined</span></tt></a>:</p> +<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">cx</span><span class="o">.</span><span class="n">get_property</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s">'carrots'</span><span class="p">)</span> +<span class="go">pymonkey.undefined</span> +</pre></div> +</div> +</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>