FreeWRL / FreeX3D 4.3.0
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#include "nsISupports.idl"
39#include "nspluginroot.idl"
40
41%{C++
42#include "nsplugindefs.h"
43
44enum nsPluginTagType {
45 nsPluginTagType_Unknown,
46 nsPluginTagType_Embed,
47 nsPluginTagType_Object,
48 nsPluginTagType_Applet
49};
50%}
51
52native nsPluginTagType(nsPluginTagType);
53
54interface nsIDOMElement;
55
62[uuid(6D827DF5-B5CD-416C-85CB-3CDD05C7AED1)]
63interface nsIPluginTagInfo : nsISupports
64{
74 void getAttributes(in PRUint16Ref aCount,
75 in constCharStarConstStar aNames,
76 in constCharStarConstStar aValues);
77
87 void getAttribute(in string aName, out constCharPtr aResult);
88
93 readonly attribute nsPluginTagType tagType;
94
98 void getTagText(out constCharPtr aTagText);
99
106 void getParameters(in PRUint16Ref aCount,
107 in constCharStarConstStar aNames,
108 in constCharStarConstStar aValues);
109
118 void getParameter(in string aName, out constCharPtr aResult);
119
123 void getDocumentBase(out constCharPtr aDocumentBase);
124
129 void getDocumentEncoding(out constCharPtr aDocumentEncoding);
130
134 void getAlignment(out constCharPtr aElignment);
135
139 readonly attribute unsigned long width;
140
144 readonly attribute unsigned long height;
145
149 readonly attribute unsigned long borderVertSpace;
150
154 readonly attribute unsigned long borderHorizSpace;
155
159 readonly attribute unsigned long uniqueID;
160
168 readonly attribute nsIDOMElement DOMElement;
169};
Plugin Tag Info Interface This interface provides information about the HTML tag on the page.
readonly attribute nsPluginTagType tagType
Get the type of the HTML tag that was used ot instantiate this plugin.
void getDocumentEncoding(out constCharPtr aDocumentEncoding)
Return an encoding whose name is specified in: http://java.sun.com/products/jdk/1....
readonly attribute unsigned long borderHorizSpace
Get border horizontal space.
void getAlignment(out constCharPtr aElignment)
Get object alignment.
readonly attribute unsigned long borderVertSpace
Get border vertical space.
void getDocumentBase(out constCharPtr aDocumentBase)
Get the document base.
void getAttributes(in PRUint16Ref aCount, in constCharStarConstStar aNames, in constCharStarConstStar aValues)
QueryInterface on nsIPluginInstancePeer to get this.
readonly attribute unsigned long height
Get object height.
void getParameters(in PRUint16Ref aCount, in constCharStarConstStar aNames, in constCharStarConstStar aValues)
Get a ptr to the paired list of parameter names and values, returns the length of the array.
readonly attribute unsigned long uniqueID
Returns a unique id for the current document containing plugin.
void getAttribute(in string aName, out constCharPtr aResult)
Gets the value for the named attribute.
readonly attribute nsIDOMElement DOMElement
Returns the DOM element corresponding to the tag which references this plugin in the document.
readonly attribute unsigned long width
Get object width.
void getParameter(in string aName, out constCharPtr aResult)
Get the value for the named parameter.
void getTagText(out constCharPtr aTagText)
Get the complete text of the HTML tag that was used to instantiate this plugin.