modules/plugin/base/public/nsIPluginTagInfo2.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 /**
  39  * nsIPluginTagInfo2
  40  *
  41  * @status DEPRECATED
  42  *
  43  * Originally published XPCOM Plugin API is now deprecated
  44  * Developers are welcome to use NPAPI, please refer to:
  45  * http://mozilla.org/projects/plugins/
  46  */
  47
  48 #include "nsIPluginTagInfo.idl"
  49
  50 %{C++
  51 enum nsPluginTagType {
  52   nsPluginTagType_Unknown,
  53   nsPluginTagType_Embed,
  54   nsPluginTagType_Object,
  55   nsPluginTagType_Applet
  56 };
  57 %}
  58
  59 native nsPluginTagType(nsPluginTagType);
  60
  61 [uuid(6a49c9a0-019b-11d2-815b-006008119d7a)]
  62 interface nsIPluginTagInfo2 : nsIPluginTagInfo
  63 {
  64     /**
  65      * Get the type of the HTML tag that was used ot instantiate this
  66      * plugin.  Currently supported tags are EMBED, OBJECT and APPLET.
  67      */
  68   readonly attribute nsPluginTagType tagType;
  69
  70     /**
  71    * Get the complete text of the HTML tag that was used to instantiate this plugin.
  72      */
  73   void getTagText(out constCharPtr aTagText);
  74
  75     /**
  76      * Get a ptr to the paired list of parameter names and values,
  77      * returns the length of the array.
  78      *
  79      * Each name or value is a null-terminated string.
  80      */
  81   void getParameters(in PRUint16Ref aCount,
  82                      in constCharStarConstStar aNames,
  83                      in constCharStarConstStar aValues);
  84
  85     /**
  86      * Get the value for the named parameter.  Returns null
  87      * if the parameter was not set.
  88    *
  89    * @param aName   - name of the parameter
  90    * @param aResult - parameter value
  91    * @result        - NS_OK if this operation was successful
  92      */
  93   void getParameter(in string aName, out constCharPtr aResult);
  94
  95   /**
  96    * Get the document base
  97    */
  98   void getDocumentBase(out constCharPtr aDocumentBase);
  99
 100     /**
 101      * Return an encoding whose name is specified in:
 102      * http://java.sun.com/products/jdk/1.1/docs/guide/intl/intl.doc.html#25303
 103      */
 104   void getDocumentEncoding(out constCharPtr aDocumentEncoding);
 105
 106   /**
 107    * Get object alignment
 108    */
 109   void getAlignment(out constCharPtr aElignment);
 110
 111   /**
 112    * Get object width
 113    */
 114     readonly attribute unsigned long width;
 115
 116   /**
 117    * Get object height
 118    */
 119     readonly attribute unsigned long height;
 120
 121   /**
 122    * Get border vertical space
 123    */
 124     readonly attribute unsigned long borderVertSpace;
 125
 126   /**
 127    * Get border horizontal space
 128    */
 129     readonly attribute unsigned long borderHorizSpace;
 130
 131     /**
 132    * Returns a unique id for the current document containing plugin
 133      */
 134     readonly attribute unsigned long uniqueID;
 135
 136     /**
 137      * Returns the DOM element corresponding to the tag which references
 138      * this plugin in the document.
 139      *
 140    * @param aDOMElement - resulting DOM element
 141      * @result - NS_OK if this operation was successful
 142      */
 143     readonly attribute nsIDOMElement DOMElement;
 144 };