modules/plugin/base/public/nsIPluginTagInfo.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  * nsIPluginTagInfo
  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 "nsISupports.idl"
  49 #include "nspluginroot.idl"
  50
  51 %{C++
  52 #include "nsplugindefs.h"
  53 %}
  54
  55 interface nsIDOMElement;
  56
  57 /**
  58  * Plugin Tag Info Interface
  59  * This interface provides information about the HTML tag on the page.
  60  * Some day this might get superseded by a DOM API.
  61  */
  62
  63 [uuid(5f1ec1d0-019b-11d2-815b-006008119d7a)]
  64 interface nsIPluginTagInfo : nsISupports
  65 {
  66   /**
  67    * QueryInterface on nsIPluginInstancePeer to get this.
  68    *
  69    * (Corresponds to NPP_New's argc, argn, and argv arguments.)
  70    * Get a ptr to the paired list of attribute names and values,
  71    * returns the length of the array.
  72    *
  73    * Each name or value is a null-terminated string.
  74    */
  75   void getAttributes(in PRUint16Ref aCount,
  76                      in constCharStarConstStar aNames,
  77                      in constCharStarConstStar aValues);
  78
  79     /**
  80      * Gets the value for the named attribute.
  81      *
  82    * @param aName   - the name of the attribute to find
  83    * @param aResult - the resulting attribute
  84      * @result - NS_OK if this operation was successful, NS_ERROR_FAILURE if
  85      * this operation failed. result is set to NULL if the attribute is not found
  86      * else to the found value.
  87      */
  88   void getAttribute(in string aName, out constCharPtr aResult);
  89 };