ppapi/api/private/ppb_instance_private.idl

   1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2  * Use of this source code is governed by a BSD-style license that can be
   3  * found in the LICENSE file.
   4  */
   5
   6 /**
   7  * This file defines the PPB_Instance_Private interface implemented by the
   8  * browser and containing pointers to functions available only to trusted plugin
   9  * instances.
  10  */
  11
  12 label Chrome {
  13   M13 = 0.1
  14 };
  15
  16 /**
  17  * The PPB_Instance_Private interface contains functions available only to
  18  * trusted plugin instances.
  19  *
  20  */
  21 interface PPB_Instance_Private {
  22   /**
  23    * GetWindowObject is a pointer to a function that determines
  24    * the DOM window containing this module instance.
  25    *
  26    * @param[in] instance A PP_Instance whose WindowObject should be retrieved.
  27    * @return A PP_Var containing window object on success.
  28    */
  29   PP_Var GetWindowObject([in] PP_Instance instance);
  30
  31   /**
  32    * GetOwnerElementObject is a pointer to a function that determines
  33    * the DOM element containing this module instance.
  34    *
  35    * @param[in] instance A PP_Instance whose WindowObject should be retrieved.
  36    * @return A PP_Var containing DOM element on success.
  37    */
  38   PP_Var GetOwnerElementObject([in] PP_Instance instance);
  39
  40   /**
  41    * ExecuteScript is a pointer to a function that executes the given
  42    * script in the context of the frame containing the module.
  43    *
  44    * The exception, if any, will be returned in *exception. As with the PPB_Var
  45    * interface, the exception parameter, if non-NULL, must be initialized
  46    * to a "void" var or the function will immediately return. On success,
  47    * the exception parameter will be set to a "void" var. On failure, the
  48    * return value will be a "void" var.
  49    *
  50    * @param[in] script A string containing the JavaScript to execute.
  51    * @param[in/out] exception PP_Var containing the exception. Initialize
  52    * this to NULL if you don't want exception info; initialize this to a void
  53    * exception if want exception info.
  54    *
  55    * @return The result of the script execution, or a "void" var
  56    * if execution failed.
  57    */
  58   PP_Var ExecuteScript([in] PP_Instance instance,
  59                        [in] PP_Var script,
  60                        [out] PP_Var exception);
  61 };