Mercurial > pymonkey
diff docs/src/pymonkey.txt @ 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/src/pymonkey.txt Sun Aug 16 22:48:50 2009 -0700 +++ b/docs/src/pymonkey.txt Mon Aug 17 03:02:51 2009 -0700 @@ -104,6 +104,29 @@ >>> cx.evaluate_script(obj, 'add(1, 1);', '<string>', 1) 2 + .. method:: define_property(object, name, value) + + Creates a new property on `object`, bypassing any JavaScript setters. + + .. method:: get_property(object, name) + + Finds the specified property on `object` and returns its value, + possibly invoking a JavaScript getter. + + Example: + + >>> cx = pymonkey.Runtime().new_context() + >>> obj = cx.new_object() + >>> cx.define_property(obj, 'beets', 'i like beets.') + >>> cx.get_property(obj, 'beets') + u'i like beets.' + + Note also that calling this function on undefined properties + yields :data:`undefined`: + + >>> cx.get_property(obj, 'carrots') + pymonkey.undefined + .. method:: get_object_private(object) Returns the ``private_obj`` passed to :meth:`new_object()`