diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 14:29:10 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 14:29:10 +0000 |
commit | 2aa4a82499d4becd2284cdb482213d541b8804dd (patch) | |
tree | b80bf8bf13c3766139fbacc530efd0dd9d54394c /dom/base/nsIObjectLoadingContent.idl | |
parent | Initial commit. (diff) | |
download | firefox-2aa4a82499d4becd2284cdb482213d541b8804dd.tar.xz firefox-2aa4a82499d4becd2284cdb482213d541b8804dd.zip |
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'dom/base/nsIObjectLoadingContent.idl')
-rw-r--r-- | dom/base/nsIObjectLoadingContent.idl | 179 |
1 files changed, 179 insertions, 0 deletions
diff --git a/dom/base/nsIObjectLoadingContent.idl b/dom/base/nsIObjectLoadingContent.idl new file mode 100644 index 0000000000..82fcfa8559 --- /dev/null +++ b/dom/base/nsIObjectLoadingContent.idl @@ -0,0 +1,179 @@ +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +#include "nsISupports.idl" + +interface nsIChannel; +interface nsIRequest; +interface nsIFrame; +interface nsIObjectFrame; +interface nsIPluginTag; +interface nsIURI; + +webidl BrowsingContext; + +%{C++ +class nsNPAPIPluginInstance; +%} +[ptr] native nsNPAPIPluginInstancePtr(nsNPAPIPluginInstance); + +/** + * This interface represents a content node that loads objects. + * + * Please make sure to update the MozObjectLoadingContent WebIDL + * mixin to mirror this interface when changing it. + */ + +[scriptable, builtinclass, uuid(2eb3195e-3eea-4083-bb1d-d2d70fa35ccb)] +interface nsIObjectLoadingContent : nsISupports +{ + /** + * See notes in nsObjectLoadingContent.h + */ + const unsigned long TYPE_LOADING = 0; + const unsigned long TYPE_IMAGE = 1; + const unsigned long TYPE_PLUGIN = 2; + const unsigned long TYPE_FAKE_PLUGIN = 3; + const unsigned long TYPE_DOCUMENT = 4; + const unsigned long TYPE_NULL = 5; + + const unsigned long PLUGIN_ACTIVE = 0xFF; + + // The content type is not supported (e.g. plugin not installed) + const unsigned long PLUGIN_UNSUPPORTED = 0; + // Showing alternate content + const unsigned long PLUGIN_ALTERNATE = 1; + // The plugin exists, but is disabled + const unsigned long PLUGIN_DISABLED = 2; + // The plugin is blocklisted and disabled + const unsigned long PLUGIN_BLOCKLISTED = 3; + // The plugin is considered outdated, but not disabled + const unsigned long PLUGIN_OUTDATED = 4; + // The plugin has crashed + const unsigned long PLUGIN_CRASHED = 5; + /// ** All values >= PLUGIN_CLICK_TO_PLAY are plugin placeholder types that + /// would be replaced by a real plugin if activated (playPlugin()) + /// ** Furthermore, values >= PLUGIN_CLICK_TO_PLAY and + /// <= PLUGIN_CLICK_TO_PLAY_QUIET are click-to-play types. + // The plugin is disabled until the user clicks on it + const unsigned long PLUGIN_CLICK_TO_PLAY = 8; + // The plugin is vulnerable (update available) + const unsigned long PLUGIN_VULNERABLE_UPDATABLE = 9; + // The plugin is vulnerable (no update available) + const unsigned long PLUGIN_VULNERABLE_NO_UPDATE = 10; + // The plugin is click-to-play, but the user won't see overlays + const unsigned long PLUGIN_CLICK_TO_PLAY_QUIET = 11; + // Plugins are no longer supported. The plugin should not load and should + // be represented by a transparent element. + const unsigned long PLUGIN_BLOCK_ALL = 12; + + // Plugins-specific permission indicating that we want to prompt the user + // to decide whether they want to allow a plugin, but to do so in a less + // intrusive way than PROMPT_ACTION would entail. At the time of writing, + // this means hiding all in-content plugin overlays, but still showing the + // plugin badge in the URL bar. + const unsigned long PLUGIN_PERMISSION_PROMPT_ACTION_QUIET = 8; + + /** + * The actual mime type (the one we got back from the network + * request) for the element. + */ + readonly attribute ACString actualType; + + /** + * Gets the type of the content that's currently loaded. See + * the constants above for the list of possible values. + */ + readonly attribute unsigned long displayedType; + + /** + * Gets the content type that corresponds to the give MIME type. See the + * constants above for the list of possible values. If nothing else fits, + * TYPE_NULL will be returned. + */ + unsigned long getContentTypeForMIMEType(in AUTF8String aMimeType); + + /** + * Returns the plugin instance if it has already been instantiated. This + * will never instantiate the plugin and so is safe to call even when + * content script must not execute. + */ + [notxpcom,nostdcall] readonly attribute nsNPAPIPluginInstancePtr pluginInstance; + + /** + * Tells the content about an associated object frame. + * This can be called multiple times for different frames. + * + * This is noscript because this is an internal method that will go away, and + * because nsIObjectFrame is unscriptable. + */ + [noscript] void hasNewFrame(in nsIObjectFrame aFrame); + + /** + * If this object is in going to be printed, this method + * returns the nsIObjectFrame object which should be used when + * printing the plugin. The returned nsIFrame is in the original document, + * not in the static clone. + */ + [noscript] nsIFrame getPrintFrame(); + + /* + * Notifications from pluginhost that our instance crashed or was destroyed. + */ + [noscript] void pluginDestroyed(); + [noscript] void pluginCrashed(in nsIPluginTag pluginTag, + in AString pluginDumpID, + in boolean submittedCrashReport); + + /** + * Forces a re-evaluation and reload of the tag, optionally invalidating its + * click-to-play state. This can be used when the MIME type that provides a + * type has changed, for instance, to force the tag to re-evalulate the + * handler to use. + */ + void reload(in boolean aClearActivation); + + /** + * This attribute will return true if the current content type has been + * activated, either explicitly or by passing checks that would have it be + * click-to-play. + */ + readonly attribute boolean activated; + + [noscript] void stopPluginInstance(); + + [noscript] void syncStartPluginInstance(); + [noscript] void asyncStartPluginInstance(); + + /** + * Puts the tag in the "waiting on a channel" state and adopts this + * channel. This does not override the normal logic of examining attributes + * and the channel type, so the load may cancel this channel if it decides not + * to use one. + * + * This assumes: + * - This tag has not begun loading yet + * - This channel has not yet hit OnStartRequest + * - The caller will continue to pass channel events to us as a listener + */ + [noscript] void initializeFromChannel(in nsIRequest request); + + /** + * The URL of the data/src loaded in the object. This may be null (i.e. + * an <embed> with no src). + */ + readonly attribute nsIURI srcURI; + + /** + * Disable the use of fake plugins and reload the tag if necessary. + */ + void skipFakePlugins(); + + /** + * Switch the tag into the TYPE_DOCUMENT state, and returns the + * BrowsingContext which the load should complete in. + */ + [noscript] BrowsingContext upgradeLoadToDocument(in nsIChannel channel); +}; |