modules/plugin/base/public/nsIPluginInstanceOwner.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39 #include "nspluginroot.idl"
  40
  41 %{C++
  42 #include "nsplugin.h"
  43 %}
  44
  45 interface nsIPluginInstance;
  46 interface nsIDocument;
  47
  48 [ref] native nsIPluginInstanceRef(nsIPluginInstance *);
  49
  50 [uuid(2e6cc23b-7d4e-4b0a-ad45-f2281c937f5c)]
  51 interface nsIPluginInstanceOwner : nsISupports
  52 {
  53   /**
  54    * Let the owner know that an instance has been created
  55    */
  56   void setInstance(in nsIPluginInstance aInstance);
  57
  58   /**
  59    * Get the instance associated with this owner.
  60    */
  61   void getInstance(in nsIPluginInstanceRef aInstance);
  62
  63   /**
  64    * Get a handle to the window structure of the owner.
  65    * This pointer cannot be made persistent by the caller.
  66    */
  67   void getWindow(in nsPluginWindowStarRef aWindow);
  68
  69   /**
  70    * Get the display mode for the plugin instance.
  71    */
  72   //void getMode(nsPluginMode *aMode);
  73   readonly attribute nsPluginMode mode;
  74
  75   /**
  76    * Create a place for the plugin to live in the owner's
  77    * environment. this may or may not create a window
  78    * depending on the windowless state of the plugin instance.
  79    */
  80   void createWidget();
  81
  82 %{C++
  83   /**
  84    * Called when there is a valid target so that the proper
  85    * frame can be updated with new content. will not be called
  86    * with nsnull aTarget.
  87    */
  88   NS_IMETHOD
  89   GetURL(const char *aURL, const char *aTarget,
  90          void *aPostData, PRUint32 aPostDataLen,
  91          void *aHeadersData, PRUint32 aHeadersDataLen,
  92          PRBool aIsFile = PR_FALSE) = 0;
  93
  94 %}
  95   /**
  96    * Show a status message in the host environment.
  97    */
  98   void showStatus(in string aStatusMsg);
  99
 100 %{C++
 101   NS_IMETHOD
 102   ShowStatus(const PRUnichar *aStatusMsg) = 0;
 103
 104 %}
 105
 106   /**
 107    * Get the associated document.
 108    */
 109   //void getDocument(nsIDocument* *aDocument);
 110   readonly attribute nsIDocument document;
 111
 112   /**
 113    * Invalidate the rectangle
 114    */
 115   void invalidateRect(in nsPluginRectPtr aRect);
 116
 117   /**
 118    * Invalidate the region
 119    */
 120   void invalidateRegion(in nsPluginRegion aRegion);
 121
 122   /**
 123    * Force a redraw
 124    */
 125   void forceRedraw();
 126
 127   /**
 128    * Get the specified variable
 129    */
 130   void getValue(in nsPluginInstancePeerVariable aVariable, in voidPtr aValue);
 131 };