summaryrefslogtreecommitdiffstats
path: root/ppapi/api/ppb_instance.idl
diff options
context:
space:
mode:
authornoelallen@google.com <noelallen@google.com@0039d316-1c4b-4281-b951-d872f2087c98>2011-07-16 23:53:22 +0000
committernoelallen@google.com <noelallen@google.com@0039d316-1c4b-4281-b951-d872f2087c98>2011-07-16 23:53:22 +0000
commit745b0d43a1f129f008ec1cdf50cb7afedeba1f02 (patch)
treebc84c5f95a643f85ce5d70967e1075a577dc999f /ppapi/api/ppb_instance.idl
parent63e26829823d96127ad24eabbca69e4d6008d7aa (diff)
downloadchromium_src-745b0d43a1f129f008ec1cdf50cb7afedeba1f02.zip
chromium_src-745b0d43a1f129f008ec1cdf50cb7afedeba1f02.tar.gz
chromium_src-745b0d43a1f129f008ec1cdf50cb7afedeba1f02.tar.bz2
Update the IDL
Final update of the IDL so that we can switch to using generated code for ppapi/c/ and ppapi/c/trusted. BUG= http://code.google.com/p/chromium/issues/detail?id=74634 TEST= tryserver TBR= dmichael@chromium.org Review URL: http://codereview.chromium.org/7390023 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@92805 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'ppapi/api/ppb_instance.idl')
-rw-r--r--ppapi/api/ppb_instance.idl80
1 files changed, 54 insertions, 26 deletions
diff --git a/ppapi/api/ppb_instance.idl b/ppapi/api/ppb_instance.idl
index f237edb..fefc785 100644
--- a/ppapi/api/ppb_instance.idl
+++ b/ppapi/api/ppb_instance.idl
@@ -3,53 +3,81 @@
* found in the LICENSE file.
*/
-/* This file defines the PPB_Instance interface implemented by the
+/**
+ * This file defines the PPB_Instance interface implemented by the
* browser and containing pointers to functions related to
* the module instance on a web page.
*/
-/* The PPB_Instance interface contains pointers to functions
+label Chrome {
+ M13 = 0.5,
+ M14 = 1.0
+ };
+
+/**
+ * The PPB_Instance interface contains pointers to functions
* related to the module instance on a web page.
*/
-interface PPB_Instance_0_5 {
- /* BindGraphics is a pointer to a function that binds the given
- * graphics as the current drawing surface. The
- * contents of this device is what will be displayed in the plugin's area
- * on the web page. The device must be a 2D or a 3D device.
+interface PPB_Instance {
+ /** Deprecated in 1.0 */
+ [deprecate=1.0]
+ PP_Var GetWindowObject([in] PP_Instance instance);
+
+ /** Deprecated in 1.0 */
+ [deprecate=1.0]
+ PP_Var GetOwnerElementObject([in] PP_Instance instance);
+
+ /**
+ * BindGraphics() binds the given graphics as the current drawing surface.
+ * The contents of this device is what will be displayed in the module's
+ * area on the web page. The device must be a 2D or a 3D device.
*
- * You can pass a NULL resource as the device parameter to unbind all
- * devices from the given instance. The instance will then appear
- * transparent. Re-binding the same device will return PP_TRUE and will do
- * nothing. Unbinding a device will drop any pending flush callbacks.
+ * You can pass a <code>NULL</code> resource as the device parameter to
+ * unbind all devices from the given instance. The instance will then appear
+ * transparent. Re-binding the same device will return <code>PP_TRUE</code>
+ * and will do nothing. Unbinding a device will drop any pending flush
+ * callbacks.
*
- * Any previously-bound device will be Release()d. It is an error to bind
- * a device when it is already bound to another plugin instance. If you want
+ * Any previously-bound device will be released. It is an error to bind
+ * a device when it is already bound to another instance. If you want
* to move a device between instances, first unbind it from the old one, and
* then rebind it to the new one.
*
* Binding a device will invalidate that portion of the web page to flush the
* contents of the new device to the screen.
*
- * Returns PP_Bool containing PP_TRUE if bind was successful or PP_FALSE if
- * the device was not the correct type. On success, a reference to the
- * device will be held by the plugin instance, so the caller can release
- * its reference if it chooses.
+ * @param[in] instance A PP_Instance indentifying one instance of a module.
+ * @param[in] device A PP_Resource representing the graphics device.
+ *
+ * @return <code>PP_Bool</code> containing <code>PP_TRUE</code> if bind was
+ * successful or <code>PP_FALSE</code> if the device was not the correct
+ * type. On success, a reference to the device will be held by the
+ * instance, so the caller can release its reference if it chooses.
*/
PP_Bool BindGraphics(
- /* A PP_Instance indentifying one instance of a module. */
[in] PP_Instance instance,
- /* A PP_Resourse representing the graphics device. */
[in] PP_Resource device);
- /* IsFullFrame is a pointer to a function that determines if the
- * module instance is full-frame (repr). Such a module represents
- * the entire document in a frame rather than an embedded resource. This can
- * happen if the user does a top level navigation or the page specifies an
- * iframe to a resource with a MIME type registered by the plugin.
+ /**
+ * IsFullFrame() determines if the module instance is full-frame (repr).
+ * Such a module represents the entire document in a frame rather than an
+ * embedded resource. This can happen if the user does a top-level
+ * navigation or the page specifies an iframe to a resource with a MIME
+ * type registered by the module.
*
- * Returns a PP_Bool containing PP_TRUE if the instance is full-frame.
+ * @param[in] instance A <code>PP_Instance</code> indentifying one instance
+ * of a module.
+ *
+ * @return A <code>PP_Bool</code> containing <code>PP_TRUE<code> if the
+ * instance is full-frame.
*/
PP_Bool IsFullFrame(
- /* A PP_Instance indentifying one instance of a module. */
[in] PP_Instance instance);
+
+ /** Deprecated in 0.5 */
+ [deprecate=0.5]
+ PP_Var ExecuteScript([in] PP_Instance instance,
+ [in] PP_Var script,
+ [out] PP_Var exception);
};
+