Plugin Tag Info Interface This interface provides information about the HTML tag on the page. More...
import"nsIPluginTagInfo.idl";
Public Member Functions | |
| void | getAttributes (in PRUint16Ref aCount, in constCharStarConstStar aNames, in constCharStarConstStar aValues) |
| QueryInterface on nsIPluginInstancePeer to get this. More... | |
| void | getAttribute (in string aName, out constCharPtr aResult) |
| Gets the value for the named attribute. More... | |
| void | getTagText (out constCharPtr aTagText) |
| Get the complete text of the HTML tag that was used to instantiate this plugin. | |
| 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. More... | |
| void | getParameter (in string aName, out constCharPtr aResult) |
| Get the value for the named parameter. More... | |
| void | getDocumentBase (out constCharPtr aDocumentBase) |
| Get the document base. | |
| void | getDocumentEncoding (out constCharPtr aDocumentEncoding) |
| Return an encoding whose name is specified in: http://java.sun.com/products/jdk/1.1/docs/guide/intl/intl.doc.html#25303. | |
| void | getAlignment (out constCharPtr aElignment) |
| Get object alignment. | |
Data Fields | |
| readonly attribute nsPluginTagType | tagType |
| Get the type of the HTML tag that was used ot instantiate this plugin. More... | |
| readonly attribute unsigned long | width |
| Get object width. | |
| readonly attribute unsigned long | height |
| Get object height. | |
| readonly attribute unsigned long | borderVertSpace |
| Get border vertical space. | |
| readonly attribute unsigned long | borderHorizSpace |
| Get border horizontal space. | |
| readonly attribute unsigned long | uniqueID |
| Returns a unique id for the current document containing plugin. | |
| readonly attribute nsIDOMElement | DOMElement |
| Returns the DOM element corresponding to the tag which references this plugin in the document. More... | |
Detailed Description
Plugin Tag Info Interface This interface provides information about the HTML tag on the page.
Some day this might get superseded by a DOM API.
Definition at line 63 of file nsIPluginTagInfo.idl.
Member Function Documentation
| void nsIPluginTagInfo::getAttribute | ( | in string | aName, |
| out constCharPtr | aResult | ||
| ) |
Gets the value for the named attribute.
- Parameters
-
aName - the name of the attribute to find aResult - the resulting attribute
- Returns
- - NS_OK if this operation was successful, NS_ERROR_FAILURE if this operation failed. result is set to NULL if the attribute is not found else to the found value.
| void nsIPluginTagInfo::getAttributes | ( | in PRUint16Ref | aCount, |
| in constCharStarConstStar | aNames, | ||
| in constCharStarConstStar | aValues | ||
| ) |
QueryInterface on nsIPluginInstancePeer to get this.
(Corresponds to NPP_New's argc, argn, and argv arguments.) Get a ptr to the paired list of attribute names and values, returns the length of the array.
Each name or value is a null-terminated string.
| void nsIPluginTagInfo::getParameter | ( | in string | aName, |
| out constCharPtr | aResult | ||
| ) |
Get the value for the named parameter.
Returns null if the parameter was not set.
- Parameters
-
aName - name of the parameter aResult - parameter value
- Returns
- - NS_OK if this operation was successful
| void nsIPluginTagInfo::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.
Each name or value is a null-terminated string.
Field Documentation
| readonly attribute nsIDOMElement nsIPluginTagInfo::DOMElement |
Returns the DOM element corresponding to the tag which references this plugin in the document.
- Parameters
-
aDOMElement - resulting DOM element
- Returns
- - NS_OK if this operation was successful
Definition at line 168 of file nsIPluginTagInfo.idl.
| readonly attribute nsPluginTagType nsIPluginTagInfo::tagType |
Get the type of the HTML tag that was used ot instantiate this plugin.
Currently supported tags are EMBED, OBJECT and APPLET.
Definition at line 93 of file nsIPluginTagInfo.idl.
The documentation for this interface was generated from the following file:
- src/plugin_win32/include/nsIPluginTagInfo.idl
