Mercurial > pymonkey
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 113:e616b4605db0 | 114:87147faa031a |
|---|---|
| 148 <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> | 148 <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> |
| 149 <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> | 149 <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> |
| 150 <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">'add'</span><span class="p">,</span> <span class="n">cx</span><span class="o">.</span><span class="n">new_function</span><span class="p">(</span><span class="n">add</span><span class="p">,</span> <span class="s">'add'</span><span class="p">))</span> | 150 <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">'add'</span><span class="p">,</span> <span class="n">cx</span><span class="o">.</span><span class="n">new_function</span><span class="p">(</span><span class="n">add</span><span class="p">,</span> <span class="s">'add'</span><span class="p">))</span> |
| 151 <span class="gp">>>> </span><span class="n">cx</span><span class="o">.</span><span class="n">evaluate_script</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s">'add(1, 1);'</span><span class="p">,</span> <span class="s">'<string>'</span><span class="p">,</span> <span class="mf">1</span><span class="p">)</span> | 151 <span class="gp">>>> </span><span class="n">cx</span><span class="o">.</span><span class="n">evaluate_script</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s">'add(1, 1);'</span><span class="p">,</span> <span class="s">'<string>'</span><span class="p">,</span> <span class="mf">1</span><span class="p">)</span> |
| 152 <span class="go">2</span> | 152 <span class="go">2</span> |
| 153 </pre></div> | |
| 154 </div> | |
| 155 </dd></dl> | |
| 156 | |
| 157 <dl class="method"> | |
| 158 <dt id="pymonkey.Context.define_property"> | |
| 159 <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> | |
| 160 <dd>Creates a new property on <cite>object</cite>, bypassing any JavaScript setters.</dd></dl> | |
| 161 | |
| 162 <dl class="method"> | |
| 163 <dt id="pymonkey.Context.get_property"> | |
| 164 <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> | |
| 165 <dd><p>Finds the specified property on <cite>object</cite> and returns its value, | |
| 166 possibly invoking a JavaScript getter.</p> | |
| 167 <p>Example:</p> | |
| 168 <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> | |
| 169 <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> | |
| 170 <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> | |
| 171 <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> | |
| 172 <span class="go">u'i like beets.'</span> | |
| 173 </pre></div> | |
| 174 </div> | |
| 175 <p>Note also that calling this function on undefined properties | |
| 176 yields <a title="pymonkey.undefined" class="reference" href="#pymonkey.undefined"><tt class="xref docutils literal"><span class="pre">undefined</span></tt></a>:</p> | |
| 177 <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> | |
| 178 <span class="go">pymonkey.undefined</span> | |
| 153 </pre></div> | 179 </pre></div> |
| 154 </div> | 180 </div> |
| 155 </dd></dl> | 181 </dd></dl> |
| 156 | 182 |
| 157 <dl class="method"> | 183 <dl class="method"> |