/*
This file was created based on the content available at
https://developer.mozilla.org/en-US/docs/XPCOM_Interface_Reference
The content is licensed under
Creative Commons Attribution-ShareAlike license (CC-BY-SA),
v2.5 or any later version.
The content was created by the following users:
trevorh, alispivak, Sheppy, kscarfone, Neil, jdm, Georgmaass, Nsertzen, PWeilbacher, Nickolay, fscholz, Sebastianz, harth, MKaply, jwilde, ethertank, Laurentj, Editmonkey, DavidAdler, One, mnoorenberghe, Cheba, Marsf, LouCypher, MarkFinkle, Briprowe, satyr, gabybosetti, Brettz9, CrazyEyE, Aconbere, Varmaa, kmaglione, kiteroa, vladimir.dzhuvinov, tessarakt4, Dikrib, sdwilsh, Boo, unfocused, jswisher, flx, wesj, Yoric, philikon, Arehman4, Ancestor, sathi, madarche, Jürgen Jeka, Wjjohnst, Eff2k5, Dria, tomotaka, stoyanster, Waldo, darktrojan, atte, khuey, Noitidart, Kglee, Surkov.alexander, Ayhfung, Davidb, Nc15, Kris.shannon, Rob W, Ctd1500, mkato, Ted_Mielczarek, Wladimir_Palant, Jminta, Mak77, Liuche, WPWoodJr, Smi, EricYChu, mreid@mozilla.com, Archaeopteryx, Mook, aceman-bugzilla, michal.novotny, GavinSharp, sachin.hosmani, Zhouweikuan, roel, Bzbarsky, gew, DaveG, Mossop, woby, Swiney, V thunder, ajcrews, didizingo, Jimbeau, kokorozashi, DarinFisher, Morac, Zwol, evilpie, pde, Mook_sb, Torisugari, Kennyluck, rnewman, ziyunfei, akari no ryu, Marienz, Chris Chittleborough, mattflaschen, Benjamin Smedberg, Grubshka, MatthewKastor, Hashem, Johnjbarton, Fredchat, Marcoos, Gomita, Np, Callek, Philip Chee, fixanoid, mihailogazda, jsamuel, erikvold, Mgalli, mgertner, Kohei, MykMelez, KyleHamilton, JacobBramley, Ehsan, TomC, Jorge.villalobos, ericjung, Natch, snoedel, dstaudigel, Dwitte, YuanXulei, Taken, CN, Erdogduemlak, fryn, vbguyny, GijsKruitbosch, Dongdong, Sunil Mohan, Masayuki, Yanmorin, Yoshino, fiveinchpixie, ScottGoci, Steffen, ddahl, sorinelpusti, willyaguirre, Sonnyp, Sephr, mressler, Gerv, Ms2ger, acperez, Overfaded, teoli, Potappo, Dao, bhackett, rmkn85, automatedtester, Ann_Yiming, Simon Lindholm, P.A., Graememcc, H2g2bob, Cripmom, Wrongloop, KaiRo, Snotling, Cdolivei, aavindraa, Zeroe, Enn, Dadatis, LJR, anna.radzicka@gmail.com, Yuan.Xulei, Cancerbero sgx, Havarhen, Aqualon, balah, Sevenspade, JorisW, doudehou, SamB, Typischdenis, lmorchard, Planche, mcomella, VincentN, milimetr88, Dbs, Allanbonadio, Docwhat, Jshin, skomorokh, bbondy@mozilla.com, Pmash, simonster, Ramachandra, Oeekker, jukbot, Piratepenguin, Anant, Dylan.star, freaktechnik, nikhilm, sashko-shb, rocky110, ariakerry, Brahmana, umair.amin, Johnath, Btipling, Leandro Mercês Xavier, Mvent2, hanyuxinting, theallseeingeye, jhammel, Kirschkern, Sri krishnan, Okome, JSlim180, BenB, jackieku, Hfmanson, ckocagil, Avarma, Andreas Wuest, Kliu0x52, Ptak82, jgriffin, jik, Toddw, Dolske, Standard8, TheBits, nnethercote, saneyuki, Dietrich, Nicoulas, Jesse, Erwan, Ecmanaut, adw, stevefox, Bomfog, Spanglerco, Bedi, Biesi, gregg.lind, Lduivenbode, MatrixFrog, Stevie-O, Amertner, KampfCaspar, yecril71pl, paa, The Hunter, chrisdavidmills, smontagu, firefogg, Imphil, Jomel, MattBrubeck, NoahY, Petea, damien.flament, D.dawg.fresh, Mozboy, leuqarte, zorkzero, Jiaofeng, rufus, diegocr, lovelywcm, dbruant, Mimecuvalo, JaredWein, 20after4, karthikin, zalun, Hsivonen, freddyb, AxelGrude, Mw22, serge, Cykesiopka, Jorend, mcpherrinm, cbakgly, David.humphrey, fhusson1, Freebendy, gsvelto, just_coding, ch.ey, Vladan, Tglek, markd, ioncube, Mh512, l-hedgehog, victorporof, d2mw, syssgx, k.art, ilya.bobyr, Sys, textshell, kewisch, Ale2010, novotnyr, bsmozilla, Soupdragon, ttaubert, Ghostheaven, jreschke, Max1million, hle.ogr, weelillad, theazureshadow, Dafi, michaelweghorn, Ruddiger, pospec4444, DimaVidmich, Aengus, JohnJBarton1, Rcampbell, saneyuki_s, Bmjaanes, the_felis_leo, Shoot, DRice, Tsahi, Markh, pwalton, Ynniv, Beaufour, Phreed, BenoitL, jhatlak, Milly, julienfabre, Harobed, Mook(as), anubina, berkerpeksag, Wolfgang Germund, Miksago,
This collection was compiled by Hans Schmucker and is likewise made
available under the terms of the CC-BY-SA lincense, v2.5 or any later version.
*/
var Components = {};
Components.interfaces = {};
/**
* A callback function that web pages can implement to be notified when triggered installs complete.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.amIInstallCallback=function(){};
/**
* Called when an install completes or fails.
*
* @param {String} aUrl in AString aUrl, The url of the add-on being installed.
* @param {Number} aStatus in PRInt32 aStatus 0 if the install was successful or negative if not.
*/
Components.interfaces.amIInstallCallback.prototype.onInstallEnded=function(aUrl, aStatus){};
/**
* Called when an install completes or fails.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.amIInstallTrigger=function(){};
/**
* @constant
*/
Components.interfaces.amIInstallTrigger.prototype.SKIN=1;
/**
* @constant
*/
Components.interfaces.amIInstallTrigger.prototype.LOCALE=2;
/**
* @constant
*/
Components.interfaces.amIInstallTrigger.prototype.CONTENT=4;
/**
* @constant
*/
Components.interfaces.amIInstallTrigger.prototype.PACKAGE=7;
/**
* Tests if installation is enabled.
*
*/
Components.interfaces.amIInstallTrigger.prototype.enabled=function(){};
/**
* Starts a new installation of a set of add-ons.
*
* @param {Components.interfaces.nsIVariant} aArgs in nsIVariant aArgs, The add-ons to install. This should be a JS object, each property is the name of an add-on to be installed. The value of the property should either be a string URL, or an object with the following properties: URL for the add-on's URL IconURL for an icon for the add-on Hash for a hash of the add-on.
* @param {Components.interfaces.amIInstallCallback aCallback} Optional in amIInstallCallback aCallback Optional A callback to call as each installation succeeds or fails.
*/
Components.interfaces.amIInstallTrigger.prototype.install=function(aArgs, Optional){};
/**
* This interface is used to allow web pages to start installing add-ons.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.amIWebInstaller=function(){};
/**
* Installs an array of add-ons at the request of a webpage.
*
* @param {String} aMimetype in AString aMimetype, The mimetype for the add-ons.
* @param {Components.interfaces.nsIDOMWindow} aWindow in nsIDOMWindow aWindow, The window installing the add-ons.
* @param {Components.interfaces.nsIURI} aReferer in nsIURI aReferer, The URI for the web page installing the add-ons.
* @param {String} aUris [array, size_is(aInstallCount] in wstring aUris, The URIs of add-ons to be installed.
* @param {String} aHashes [array, size_is(aInstallCount] in wstring aHashes, The hashes for the add-ons to be installed.
* @param {String} aNames [array, size_is(aInstallCount] in wstring aNames, The names for the add-ons to be installed.
* @param {String} aIcons [array, size_is(aInstallCount] in wstring aIcons, The icons for the add-ons to be installed.
* @param {Components.interfaces.amIInstallCallback aCallback} Optional in amIInstallCallback aCallback, Optional An optional callback to notify about installation success and failure.
* @param {Components.interfaces.PRUint32 aInstallCount} Optional in PRUint32 aInstallCount Optional An optional argument including the number of add-ons to install.
*/
Components.interfaces.amIWebInstaller.prototype.installAddonsFromWebpage=function(aMimetype, aWindow, aReferer, aUris, aHashes, aNames, aIcons, Optional, Optional){};
/**
* Checks if installation is enabled for a web page.
*
* @param {String} aMimetype in AString aMimetype, The MIME type for the add-on to be installed.
* @param {Components.interfaces.nsIURI} aReferer in nsIURI aReferer The URI of the web page for which to see if installation is allowed.
*/
Components.interfaces.amIWebInstaller.prototype.isInstallEnabled=function(aMimetype, aReferer){};
/**
* This interface is used by the default implementation of amIWebInstallListener to communicate with the running application and allow it to warn the user about blocked installs and start the installs running.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.amIWebInstallInfo=function(){};
/**
* An array of AddonInstall objects. Read only.
*
* @type {Components.interfaces.nsIVariant}
*/
Components.interfaces.amIWebInstallInfo.prototype.installs=new Components.interfaces.nsIVariant();
/**
* The URI that started the installs. For example, the referring page for a link to an XPI download. Read only.
*
* @type {Components.interfaces.nsIURI}
*/
Components.interfaces.amIWebInstallInfo.prototype.originatingURI=new Components.interfaces.nsIURI();
/**
* The window that started the installs. Read only.
* Note: Prior to Gecko 8.0 (Firefox 8.0 / Thunderbird 8.0 / SeaMonkey 2.5), this was an nsIDOMWindowInternal.
*
* @type {Components.interfaces.nsIDOMWindow}
*/
Components.interfaces.amIWebInstallInfo.prototype.originatingWindow=new Components.interfaces.nsIDOMWindow();
/**
* Starts all installs.
*
*/
Components.interfaces.amIWebInstallInfo.prototype.install=function(){};
/**
* Starts all installs. The registered amIWebInstallListener is used to notify about new installs triggered by websites. The default implementation displays a confirmation dialog when add-ons are ready to install and uses the observer service to notify when installations are blocked.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.amIWebInstallListener=function(){};
/**
* Called when the website is not allowed to directly prompt the user to install add-ons.
*
* @param {Components.interfaces.nsIDOMWindow} aWindow in nsIDOMWindow aWindow, The window that triggered the installs.
* @param {Components.interfaces.nsIURI} aUri in nsIURI aUri, The URI of the site that triggered the installs.
* @param {Components.interfaces.nsIVariant} aInstalls [array, size_is(aCount] in nsIVariant aInstalls, The AddonInstalls that were blocked.
* @param {Components.interfaces.PRUint32 aCount} Optional in PRUint32 aCount Optional The number of AddonInstalls.
*/
Components.interfaces.amIWebInstallListener.prototype.onWebInstallBlocked=function(aWindow, aUri, aInstalls, Optional){};
/**
* Called when installation by websites is currently disabled.
*
* @param {Components.interfaces.nsIDOMWindow} aWindow in nsIDOMWindow aWindow, The window that triggered the installs.
* @param {Components.interfaces.nsIURI} aUri in nsIURI aUri, The URI of the site that triggered the installs.
* @param {Components.interfaces.nsIVariant} aInstalls [array, size_is(aCount] in nsIVariant aInstalls, The AddonInstalls that were blocked.
* @param {Components.interfaces.PRUint32 aCount} Optional in PRUint32 aCount Optional The number of AddonInstalls.
*/
Components.interfaces.amIWebInstallListener.prototype.onWebInstallDisabled=function(aWindow, aUri, aInstalls, Optional){};
/**
* Called when a website wants to ask the user to install add-ons.
*
* @param {Components.interfaces.nsIDOMWindow} aWindow in nsIDOMWindow aWindow, The window that triggered the installs.
* @param {Components.interfaces.nsIURI} aUri in nsIURI aUri, The URI of the site that triggered the installs.
* @param {Components.interfaces.nsIVariant} aInstalls [array, size_is(aCount] in nsIVariant aInstalls, The AddonInstalls that were requested.
* @param {Components.interfaces.PRUint32 aCount} Optional in PRUint32 aCount Optional The number of AddonInstalls.
*/
Components.interfaces.amIWebInstallListener.prototype.onWebInstallRequested=function(aWindow, aUri, aInstalls, Optional){};
/**
* Called when installation by websites is currently disabled.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.amIWebInstallPrompt=function(){};
/**
* Gets a confirmation that the user wants to start the installs.
*
* @param {Components.interfaces.nsIDOMWindow} aWindow in nsIDOMWindow aWindow, The window that triggered the installs.
* @param {Components.interfaces.nsIURI} aUri in nsIURI aUri, The URI of the site that triggered the installs.
* @param {Components.interfaces.nsIVariant} aInstalls [array, size_is(aCount] in nsIVariant aInstalls, The AddonInstalls that were requested.
* @param {Components.interfaces.PRUint32 aCount} Optional in PRUint32 aCount Optional The number of AddonInstalls.
*/
Components.interfaces.amIWebInstallPrompt.prototype.confirm=function(aWindow, aUri, aInstalls, Optional){};
/**
* This interface is not to be used directly, it is to be used internally for XPConnect's IDispatch support.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.IDispatch=function(){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.imgICache=function(){};
/**
* Evict images from the cache.
*
* @param {Boolean} chrome in boolean chrome If true, evict only chrome images. If false, evict everything except chrome images.
*/
Components.interfaces.imgICache.prototype.clearCache=function(chrome){};
/**
* Evict images from the cache.
*
* @param {Components.interfaces.nsIURI} uri in nsIURI uri The URI to remove.
*/
Components.interfaces.imgICache.prototype.removeEntry=function(uri){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsIAsyncInputStream}
*/
Components.interfaces.imgIEncoder=function(){};
/**
* Input is RGB each pixel is represented by three bytes: R, G, and B (in that order, regardless of host endianness)
*
* @constant
*/
Components.interfaces.imgIEncoder.prototype.INPUT_FORMAT_RGB=0;
/**
* Input is RGB each pixel is represented by four bytes: R, G, and B (in that order, regardless of host endianness). POST-MULTIPLIED alpha us used (For example 50% transparent red is 0xff000080)
*
* @constant
*/
Components.interfaces.imgIEncoder.prototype.INPUT_FORMAT_RGBA=1;
/**
* Input is host-endian ARGB: On big-endian machines each pixel is therefore ARGB, and for little-endian machiens (Intel) each pixel is BGRA (This is used by canvas to match it's internal representation) PRE-MULTIPLIED alpha is used (That is, 50% transparent red is 0x80800000, not 0x80ff0000)
*
* @constant
*/
Components.interfaces.imgIEncoder.prototype.INPUT_FORMAT_HOSTARGB=2;
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.imgILoader=function(){};
/**
* @constant
*/
Components.interfaces.imgILoader.prototype.LOAD_CORS_ANONYMOUS=1 << 16;
/**
* @constant
*/
Components.interfaces.imgILoader.prototype.LOAD_CORS_USE_CREDENTIALS=1 << 17;
/**
* Start the load and decode of an image.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI to load.
* @param {Components.interfaces.nsIURI} aInitialDocumentURL in nsIURI aInitialDocumentURL,
* @param {Components.interfaces.nsIURI} aReferrerURI in nsIURI aReferrerURI, The 'referring' URI.
* @param {Components.interfaces.nsIPrincipal} aLoadingPrincipal in nsIPrincipal aLoadingPrincipal, The principal of the loading document.
* @param {Components.interfaces.nsILoadGroup} aLoadGroup in nsILoadGroup aLoadGroup, Loadgroup to put the image load into.
* @param {Components.interfaces.imgIDecoderObserver} aObserver in imgIDecoderObserver aObserver, The observer (may be null)
* @param {Components.interfaces.nsISupports} aCX in nsISupports aCX, Some random data.
* @param {Components.interfaces.nsLoadFlags} aLoadFlags in nsLoadFlags aLoadFlags, Load flags for the request.
* @param {Components.interfaces.nsISupports} cacheKey in nsISupports cacheKey,
* @param {Components.interfaces.imgIRequest} aRequest in imgIRequest aRequest, A newly created, unused imgIRequest object or null for one to be created for you. libpr0n does NOT keep a strong ref to the observer; this prevents reference cycles. This means that callers of loadImage should make sure to Cancel() the resulting request before the observer goes away.
* @param {Components.interfaces.nsIChannelPolicy} channelPolicy in nsIChannelPolicy channelPolicy
*/
Components.interfaces.imgILoader.prototype.loadImage=function(aURI, aInitialDocumentURL, aReferrerURI, aLoadingPrincipal, aLoadGroup, aObserver, aCX, aLoadFlags, cacheKey, aRequest, channelPolicy){};
/**
* Start the load and decode of an image.libpr0n does NOT keep a strong ref to the observer; this prevents reference cycles. This means that callers of loadImageWithChannel should make sure to Cancel() the resulting request before the observer goes away.
*
* @param {Components.interfaces.nsIChannel} aChannel in nsIChannel aChannel, The channel to load the image from. This must already be opened before this method is called, and there must have been no OnDataAvailable calls for it yet.
* @param {Components.interfaces.imgIDecoderObserver} aObserver in imgIDecoderObserver aObserver, The observer (may be null)
* @param {Components.interfaces.nsISupports} cx in nsISupports cx, Some random data.
* @param {Components.interfaces.nsIStreamListener} aListener out nsIStreamListener aListener A listener that you must send the channel's notifications and data to. Can be null, in which case imagelib has found a cached image and is not interested in the data. aChannel will be canceled for you in this case.
*/
Components.interfaces.imgILoader.prototype.loadImageWithChannel=function(aChannel, aObserver, cx, aListener){};
/**
* Checks if a decoder for the an image with the given mime type is available.
*
* @param {String} mimeType in string mimeType The type to find a decoder for.
*/
Components.interfaces.imgILoader.prototype.supportImageWithMimeType=function(mimeType){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsIRequest}
*/
Components.interfaces.imgIRequest=function(){};
/**
* Nothing to report.
*
* @constant
*/
Components.interfaces.imgIRequest.prototype.STATUS_NONE=0x0;
/**
* We received enough image data from the network or filesystem that we know the width and height of the image, and have thus called SetSize() on the container.
*
* @constant
*/
Components.interfaces.imgIRequest.prototype.STATUS_SIZE_AVAILABLE=0x1;
/**
* Used internally by imgRequest to flag that a request is being cancelled as a result of a failure of a proxy holder and not an internal failure. At least I think that's what it does. Regardless, there's no reason for this flag to be public, and it should either go away or become a private state flag within imgRequest. Do not rely on it.
*
* @constant
*/
Components.interfaces.imgIRequest.prototype.STATUS_LOAD_PARTIAL=0x2;
/**
* The data has been fully loaded to memory, but not necessarily fully decoded.
*
* @constant
*/
Components.interfaces.imgIRequest.prototype.STATUS_LOAD_COMPLETE=0x4;
/**
* An error occurred loading the image.
*
* @constant
*/
Components.interfaces.imgIRequest.prototype.STATUS_ERROR=0x8;
/**
* The first frame has been completely decoded.
*
* @constant
*/
Components.interfaces.imgIRequest.prototype.STATUS_FRAME_COMPLETE=0x10;
/**
* The whole image has been decoded.
*
* @constant
*/
Components.interfaces.imgIRequest.prototype.STATUS_DECODE_COMPLETE=0x20;
/**
* CORS modes images can be loaded with. By default, all images are loaded with CORS_NONE and cannot be used cross-origin in context like WebGL. If an HTML img element has the crossorigin attribute set, the imgIRequest will be validated for cross-origin usage with CORS, and, if successful, will have its CORS mode set to the relevant type.
*
* @constant
*/
Components.interfaces.imgIRequest.prototype.CORS_NONE=1;
/**
* @constant
*/
Components.interfaces.imgIRequest.prototype.CORS_ANONYMOUS=2;
/**
* @constant
*/
Components.interfaces.imgIRequest.prototype.CORS_USE_CREDENTIALS=3;
/**
* The CORS mode that this image was loaded with. Read only.
*
* @type {Number}
*/
Components.interfaces.imgIRequest.prototype.CORSMode=0;
/**
* Read only.
*
* @type {Components.interfaces.imgIDecoderObserver}
*/
Components.interfaces.imgIRequest.prototype.decoderObserver=new Components.interfaces.imgIDecoderObserver();
/**
* The image container. Read only.
*
* @type {Components.interfaces.imgIContainer}
*/
Components.interfaces.imgIRequest.prototype.image=new Components.interfaces.imgIContainer();
/**
* The principal gotten from the channel the image was loaded from. Read only.
*
* @type {Components.interfaces.nsIPrincipal}
*/
Components.interfaces.imgIRequest.prototype.imagePrincipal=new Components.interfaces.nsIPrincipal();
/**
* Status flags of the STATUS_* variety. Read only.
*
* @type {Number}
*/
Components.interfaces.imgIRequest.prototype.imageStatus=0;
/**
* Read only.
*
* @type {String}
*/
Components.interfaces.imgIRequest.prototype.mimeType="";
/**
* The URI the image load was started with. Note that this might not be the actual URI for the image (for example if HTTP redirects happened during the load). Read only.
*
* @type {Components.interfaces.nsIURI}
*/
Components.interfaces.imgIRequest.prototype.URI=new Components.interfaces.nsIURI();
/**
* Clone this request; the returned request will have aObserver as the observer. aObserver will be notified synchronously (before the clone call returns) with all the notifications that have already been dispatched for this image load.
*
* @param {Components.interfaces.imgIDecoderObserver} aObserver in imgIDecoderObserver aObserver
*/
Components.interfaces.imgIRequest.prototype.clone=function(aObserver){};
/**
* DOM utility functions.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.inIDOMUtils=function(){};
/**
* Requires Gecko 22.0
*
* @constant
*/
Components.interfaces.inIDOMUtils.prototype.EXCLUDE_SHORTHANDS=(1<<0);
/**
* Requires Gecko 22.0
*
* @constant
*/
Components.interfaces.inIDOMUtils.prototype.INCLUDE_ALIASES=(1<<1);
/**
* Returns an array of nsIURI objects representing the current XML binding for the specified element.
*
* @param {Components.interfaces.nsIDOMElement} aElement in nsIDOMElement aElement A DOM Element to retrieve the bindings of.
*/
Components.interfaces.inIDOMUtils.prototype.getBindingURLs=function(aElement){};
/**
* A bit mask of the supported content state flags, which are listed in Content state flags.
*
* @param {Components.interfaces.nsIDOMElement} aElement in nsIDOMElement aElement A DOM Element to retrieve the content states of.
*/
Components.interfaces.inIDOMUtils.prototype.getContentState=function(aElement){};
/**
* Returns an array of the CSS style rules on the specified element.
*
* @param {Components.interfaces.nsIDOMElement} aElement in nsIDOMElement aElement, A DOM element to retrieve the style rules of.
* @param {String} aPseudo in DOMString aPseudo A pseudo element, such as before.
*/
Components.interfaces.inIDOMUtils.prototype.getCSSStyleRules=function(aElement, aPseudo){};
/**
* Returns the parent of the specified node.
*
* @param {Components.interfaces.nsIDOMNode} aNode in nsIDOMNode aNode, The node to return the parent of.
* @param {Boolean} aShowingAnonymousContent in boolean aShowingAnonymousContent Whether you are interested in the XBL flattened tree.
*/
Components.interfaces.inIDOMUtils.prototype.getParentForNode=function(aNode, aShowingAnonymousContent){};
/**
* Returns the line number of the specified CSS style rule in its source file.
*
* @param {Components.interfaces.nsIDOMCSSStyleRule} aRule in nsIDOMCSSStyleRule aRule The style rule to retrieve the line number of.
*/
Components.interfaces.inIDOMUtils.prototype.getRuleLine=function(aRule){};
/**
* Returns the column number of the specified CSS style rule in its source file.
*
* @param {Components.interfaces.nsIDOMCSSStyleRule} aRule in nsIDOMCSSStyleRule aRule The style rule to retrieve the column number of.
*/
Components.interfaces.inIDOMUtils.prototype.getRuleColumn=function(aRule){};
/**
* Determines if the specified text node contains only ignorable whitespace characters.
*
* @param {Components.interfaces.nsIDOMCharacterData} aDataNode in nsIDOMCharacterData aDataNode A DOM CharacterData node; that is, a text node.
*/
Components.interfaces.inIDOMUtils.prototype.isIgnorableWhitespace=function(aDataNode){};
/**
* Determines if the specified string names a CSS property that is inherited by default.
*
* @param {String} aPropertyName in AString aPropertyName The name of the CSS property.
*/
Components.interfaces.inIDOMUtils.prototype.isInheritedProperty=function(aPropertyName){};
/**
* Sets the given element as the current owner of the specified state, and removes that state from the previous owner.
*
* @param {Components.interfaces.nsIDOMElement} aElement in nsIDOMElement aElement, The element to set the content state of.
* @param {Number} aState in unsigned long long aState The content state to set. This must be one (and only one) of the values listed in Content state flags.
*/
Components.interfaces.inIDOMUtils.prototype.setContentState=function(aElement, aState){};
/**
* Makes the element take on style properties that would apply if the element had the given pseudo-classes.
*
* @param {Components.interfaces.nsIDOMElement} aElement in nsIDOMElement aElement, The element to set the pseudo-class lock on.
* @param {String} aPseudoClass in DOMString aPseudoClass The pseudo-class to set. e.g. ":hover".
*/
Components.interfaces.inIDOMUtils.prototype.addPseudoClassLock=function(aElement, aPseudoClass){};
/**
* Removes a pseudo-class lock from the element.
*
* @param {Components.interfaces.nsIDOMElement} aElement in nsIDOMElement aElement, The element to remove the pseudo-class lock from.
* @param {String} aPseudoClass in DOMString aPseudoClass The pseudo-class to remove the lock of. e.g. ":hover".
*/
Components.interfaces.inIDOMUtils.prototype.removePseudoClassLock=function(aElement, aPseudoClass){};
/**
* Checks whether the element element has a particular pseudo-class lock applied.
*
* @param {Components.interfaces.nsIDOMElement} aElement in nsIDOMElement aElement, The element to test.
* @param {String} aPseudoClass in DOMString aPseudoClass The pseudo-class lock to test for existence, e.g. ":hover".
*/
Components.interfaces.inIDOMUtils.prototype.hasPseudoClassLock=function(aElement, aPseudoClass){};
/**
* Removes any pseudo-class locks from the element.
*
* @param {Components.interfaces.nsIDOMElement} aElement in nsIDOMElement aElement The element to remove the pseudo-class locks from.
*/
Components.interfaces.inIDOMUtils.prototype.clearPseudoClassLocks=function(aElement){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.jsdIEphemeral}
*/
Components.interfaces.jsdIStackFrame=function(){};
/**
* Function object running in this stack frame. Read only.
*
* @type {Components.interfaces.jsdIValue}
*/
Components.interfaces.jsdIStackFrame.prototype.callee=new Components.interfaces.jsdIValue();
/**
* Link to the caller's stack frame. Read only.
*
* @type {Components.interfaces.jsdIStackFrame}
*/
Components.interfaces.jsdIStackFrame.prototype.callingFrame=new Components.interfaces.jsdIStackFrame();
/**
* Executon context. Read only.
*
* @type {Components.interfaces.jsdIContext}
*/
Components.interfaces.jsdIStackFrame.prototype.executionContext=new Components.interfaces.jsdIContext();
/**
* Function name executing in this stack frame. Read only.
*
* @type {String}
*/
Components.interfaces.jsdIStackFrame.prototype.functionName="";
/**
* True if stack frame is constructing a new object. Read only.
*
* @type {Boolean}
*/
Components.interfaces.jsdIStackFrame.prototype.isConstructing=false;
/**
* True if stack frame represents a frame created as a result of a debugger evaluation. Read only.
*
* @type {Boolean}
*/
Components.interfaces.jsdIStackFrame.prototype.isDebugger=false;
/**
* True if stack frame represents a native frame. Read only. Obsolete since Gecko 2.0
*
* @type {Boolean}
*/
Components.interfaces.jsdIStackFrame.prototype.isNative=false;
/**
* Internal use only. Read only. Native code only!
*
* @type {Object}
*/
Components.interfaces.jsdIStackFrame.prototype.JSDContext={};
/**
* Internal use only. Read only. Native code only!
*
* @type {Components.interfaces.JSDStackFrameInfo}
*/
Components.interfaces.jsdIStackFrame.prototype.JSDStackFrameInfo=new Components.interfaces.JSDStackFrameInfo();
/**
* Internal use only. Read only. Native code only!
*
* @type {Number}
*/
Components.interfaces.jsdIStackFrame.prototype.JSDThreadState=0;
/**
* Current line number (using the script's pc to line map.) Read only.
*
* @type {Number}
*/
Components.interfaces.jsdIStackFrame.prototype.line=0;
/**
* Current program counter in this stack frame. Read only.
*
* @type {Number}
*/
Components.interfaces.jsdIStackFrame.prototype.pc=0;
/**
* Top object in the scope chain. Read only.
*
* @type {Components.interfaces.jsdIValue}
*/
Components.interfaces.jsdIStackFrame.prototype.scope=new Components.interfaces.jsdIValue();
/**
* Script running in this stack frame, null for native frames. Read only.
*
* @type {Components.interfaces.jsdIScript}
*/
Components.interfaces.jsdIStackFrame.prototype.script=new Components.interfaces.jsdIScript();
/**
* |this| object for this stack frame. Read only.
*
* @type {Components.interfaces.jsdIValue}
*/
Components.interfaces.jsdIStackFrame.prototype.thisValue=new Components.interfaces.jsdIValue();
/**
* Evaluate arbitrary JavaScript in this stack frame.
*
* @param {String} bytes in AString bytes, Script to be evaluated.
* @param {String} fileName in AUTF8String fileName, Filename to compile this script under. This is the filename you'll see in error messages, and so on.
* @param {Number} line in unsigned long line,
* @param {Components.interfaces.jsdIValue} result out jsdIValue result
*/
Components.interfaces.jsdIStackFrame.prototype.eval=function(bytes, fileName, line, result){};
/**
* Interface for accessing the favicon service asynchronously.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozIAsyncFavicons=function(){};
/**
* Retrieve the URL of the favicon for the given page.
*
* @param {Components.interfaces.nsIURI} aPageURI in nsIURI aPageURI, URI of the page whose favicon's URL we're looking up.
* @param {Components.interfaces.nsIFaviconDataCallback} aCallback in nsIFaviconDataCallback aCallback Once we have found the favicon's URL, we invoke this callback. Note that the callback's aDataLen will be 0, aData will be null, and aMimeType will be empty -- only aURI will be non-zero/null/empty.
*/
Components.interfaces.mozIAsyncFavicons.prototype.getFaviconURLForPage=function(aPageURI, aCallback){};
/**
* Retrieves the favicon URI and data associated to the given page, if any.
*
* @param {Components.interfaces.nsIURI} aPageURI in nsIURI aPageURI, undefined
* @param {Components.interfaces.nsIFaviconDataCallback} aCallback in nsIFaviconDataCallback aCallback undefined
*/
Components.interfaces.mozIAsyncFavicons.prototype.getFaviconURLForPage=function(aPageURI, aCallback){};
/**
* Declares that a given page uses a favicon with the given URI and attempts to fetch and save the icon data by loading the favicon URI through a asynchronous network request.If the icon data already exists, we will not try to reload the icon unless aForceReload is true. Similarly, if the icon is in the failed favicon cache we will not do anything unless aForceReload is true, in which case we'll try to reload the favicon.This function will only save favicons for "good" URIs, as defined by what gets added to history or is a bookmark. For "bad" URIs, this function will succeed but do nothing. This function will also ignore the error page favicon URI (see FAVICON_ERRORPAGE_URL in nsIFaviconService.idl).Icons that fail to load will automatically be added to the failed favicon cache, and this function will not save favicons for non-bookmarked URIs when history is disabled.
* Note: This function is identical to nsIFaviconService.setAndLoadFaviconForPage()
*
* @param {Components.interfaces.nsIURI} aPageURI in nsIURI aPageURI, URI of the page whose favicon is being set.
* @param {Components.interfaces.nsIURI} aFaviconURI in nsIURI aFaviconURI, URI of the favicon to associate with the page.
* @param {Boolean} aForceReload in boolean aForceReload, If false, we try to reload the favicon only if we do not have it or it has expired from the cache. Setting to true causes us to reload the favicon even if we have a usable copy.
* @param {Number} aFaviconLoadType in unsigned long aFaviconLoadType, Requires Gecko 18.0 Set to nsIFaviconService.FAVICON_LOAD_PRIVATE if the favicon is loaded from a private browsing window. Set to nsIFaviconService.FAVICON_LOAD_NON_PRIVATE otherwise
* @param {Components.interfaces.nsIFaviconDataCallback aCallback} Optional in nsIFaviconDataCallback aCallback Optional Once we're done setting and/or fetching the favicon, we invoke this callback.
*/
Components.interfaces.mozIAsyncFavicons.prototype.setAndFetchFaviconForPage=function(aPageURI, aFaviconURI, aForceReload, aFaviconLoadType, Optional){};
/**
* Sets the data for a given favicon URI either by replacing existing data in the database or taking the place of otherwise fetched icon data when calling setAndFetchFaviconForPage later.Favicon data for favicon URIs that are not associated with a page URI via setAndFetchFaviconForPage will be stored in memory, but may be expired at any time, so you should make an effort to associate favicon URIs with page URIs as soon as possible.It's better to not use this function for chrome: icon URIs since you can reference the chrome image yourself. getFaviconLinkForIcon/Page will ignore any associated data if the favicon URI is "chrome:" and just return the same chrome URI.This function does NOT send out notifications that the data has changed. Pages using this favicons that are visible in history or bookmarks views will keep the old icon until they have been refreshed by other means.
*
* @param {Components.interfaces.nsIURI} aFaviconURI in nsIURI aFaviconURI, URI of the favicon whose data is being set.
* @param {Number} aData [const,array,size_is(aDataLen] in octet aData, Binary contents of the favicon to save.
* @param {Number} aDataLen in unsigned long aDataLen, Length of binary data
* @param {String} aMimeType in AUTF8String aMimeType, MIME type of the data to store. This is important so that we know what to report when the favicon is used. You should always set this param unless you are clearing an icon.
* @param {Number} aExpiration [optional] in PRTime aExpiration Time in microseconds since the epoch when this favicon expires. Until this time, we won't try to load it again.
*/
Components.interfaces.mozIAsyncFavicons.prototype.replaceFaviconData=function(aFaviconURI, aData, aDataLen, aMimeType, aExpiration){};
/**
* Same as replaceFaviconData() but the data is provided by a string containing a data URL.Favicon data for favicon URIs that are not associated with a page URI via setAndFetchFaviconForPage will be stored in memory, but may be expired at any time, so you should make an effort to associate favicon URIs with page URIs as soon as possible.It's better to not use this function for chrome: icon URIs since you can reference the chrome image yourself. getFaviconLinkForIcon/Page will ignore any associated data if the favicon URI is "chrome:" and just return the same chrome URI.This function does NOT send out notifications that the data has changed. Pages using this favicons that are visible in history or bookmarks views will keep the old icon until they have been refreshed by other means.
*
* @param {Components.interfaces.nsIURI} aFaviconURI in nsIURI aFaviconURI, URI of the favicon whose data is being set.
* @param {String} aDataURL in AString aDataURL, String containing a data URL that represents the contents of the favicon to save.
* @param {Number} aExpiration [optional] in PRTime aExpiration Time in microseconds since the epoch when this favicon expires. Until this time, we won't try to load it again./dd>
*/
Components.interfaces.mozIAsyncFavicons.prototype.replaceFaviconDataFromDataURL=function(aFaviconURI, aDataURL, aExpiration){};
/**
* This interface allows you to add multiple visits to a single URL in a batch.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozIAsyncHistory=function(){};
/**
* Adds a set of visits for one or more mozIPlaceInfo objects, and updates each mozIPlaceInfo's title or GUID. Note that this lets you add to history even in Private Browsing mode; if that's not desired you can first check whether the window is in Private Browsing mode.
*
* @param {Components.interfaces.mozIPlaceInfo} aPlaceInfo in mozIPlaceInfo aPlaceInfo, The mozIPlaceInfo object[s] containing the information to store or update. This can be a single object, or an array of objects.
* @param {Components.interfaces.mozIVisitInfoCallback aCallback} Optional in mozIVisitInfoCallback aCallback Optional A mozIVisitInfoCallback object to be notified for each visit addition, title change, GUID change, or error. If more than one operation is performed for a given visit, only one callback will be given (i.e. title change and add visit).
*/
Components.interfaces.mozIAsyncHistory.prototype.updatePlaces=function(aPlaceInfo, Optional){};
/**
* Provides methods to analyze colors in an image
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozIColorAnalyzer=function(){};
/**
* This interface can be used from privileged JavaScript to load and run JavaScript code from the given URL at runtime.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozIJSSubScriptLoader=function(){};
/**
* Synchronously loads and executes the script from the specified URL. As of Gecko 8.0, scripts are loaded from the startup cache where possible.The loaded script is executed with the principal associated with the target object. Any variables created by the loaded script are created as properties of the targetObj target object. Additionally, properties of the targetObj target object can be referred to as variables in the loaded script.Note: This method must only be called from JavaScript!
*
* @param {String} url in wstring url, undefined
* @param {Components.interfaces.targetObj} Optional in targetObj Optional, undefined
* @param {Components.interfaces.charset} Optional in charset Optional, undefined
*/
Components.interfaces.mozIJSSubScriptLoader.prototype.loadSubScript=function(url, Optional, Optional){};
/**
* This interface represents a personal dictionary.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozIPersonalDictionary=function(){};
/**
* Get the (lexicographically sorted) list of words. Read only.
*
* @type {Components.interfaces.nsIStringEnumerator}
*/
Components.interfaces.mozIPersonalDictionary.prototype.wordList=new Components.interfaces.nsIStringEnumerator();
/**
* Adds a misspelling to the list of corrections. Note that this method is not currently implemented.
*
* @param {String} word in wstring word, The incorrect spelling of the word to add to the list of corrections.
* @param {String} correction in wstring correction, The correct spelling of the word.
* @param {String} lang in wstring lang The language of the word.
*/
Components.interfaces.mozIPersonalDictionary.prototype.addCorrection=function(word, correction, lang){};
/**
* Add a word to the personal dictionary.
*
* @param {String} word in wstring word, The word to add to the dictionary.
* @param {String} lang in wstring lang The language of the word. Note that this parameter is currently unused.
*/
Components.interfaces.mozIPersonalDictionary.prototype.addWord=function(word, lang){};
/**
* Checks a Unicode string.
*
* @param {String} word in wstring word, The word to check.
* @param {String} lang in wstring lang The language of the word. Note that this parameter is currently ignored.
*/
Components.interfaces.mozIPersonalDictionary.prototype.check=function(word, lang){};
/**
* Clears the ignore list.
*
*/
Components.interfaces.mozIPersonalDictionary.prototype.endSession=function(){};
/**
* Gets a list of previous corrections for the word.
*
* @param {String} word in wstring word, The word to get the list of corrections for.
* @param {String} words [array, size_is(count] out wstring words, The list of corrections.
* @param {Number} count out PRUint32 count The number of corrections in the list.
*/
Components.interfaces.mozIPersonalDictionary.prototype.getCorrection=function(word, words, count){};
/**
* Adds a word to the ignore all list.
*
* @param {String} word in wstring word The word to add to the ignore list.
*/
Components.interfaces.mozIPersonalDictionary.prototype.ignoreWord=function(word){};
/**
* Loads the dictionary.
*
*/
Components.interfaces.mozIPersonalDictionary.prototype.load=function(){};
/**
* Removes a misspelling from the list of corrections. This removes a single misspelling and correction pair from the list.
*
* @param {String} word in wstring word, The incorrect spelling of the word to remove from the list of corrections.
* @param {String} correction in wstring correction, The correct spelling of the word.
* @param {String} lang in wstring lang The language of the word.
*/
Components.interfaces.mozIPersonalDictionary.prototype.removeCorrection=function(word, correction, lang){};
/**
* Removes a word from the personal dictionary.
*
* @param {String} word in wstring word, The word to remove.
* @param {String} lang in wstring lang The language of the word. Note that this parameter is currently ignored.
*/
Components.interfaces.mozIPersonalDictionary.prototype.removeWord=function(word, lang){};
/**
* Saves the dictionary.
*
*/
Components.interfaces.mozIPersonalDictionary.prototype.save=function(){};
/**
* This interface provides additional info for a Places entry
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozIPlaceInfo=function(){};
/**
* Read only: The frecency of the place.
*
* @type {Number}
*/
Components.interfaces.mozIPlaceInfo.prototype.frecency=0;
/**
* Read only: The globally unique id of the place.
*
* @type {String}
*/
Components.interfaces.mozIPlaceInfo.prototype.guid="";
/**
* Read only: The machine-local (internal) id of the place.
*
* @type {Number}
*/
Components.interfaces.mozIPlaceInfo.prototype.placeId=0;
/**
* Read only: The title associated with the place.
*
* @type {String}
*/
Components.interfaces.mozIPlaceInfo.prototype.title="";
/**
* Read only: The URI of the place.
*
* @type {Components.interfaces.nsIURI}
*/
Components.interfaces.mozIPlaceInfo.prototype.uri=new Components.interfaces.nsIURI();
/**
* Read only: An array of mozIVisitInfo objects for the place.
*
* @type {Array}
*/
Components.interfaces.mozIPlaceInfo.prototype.visits=[];
/**
* This interface provides some constants used by the Places AutoComplete search provider as well as methods to track opened pages for AutoComplete purposes.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozIPlacesAutoComplete=function(){};
/**
* Match anywhere in each searchable term.
*
* @constant
*/
Components.interfaces.mozIPlacesAutoComplete.prototype.MATCH_ANYWHERE=0;
/**
* Match first on word boundaries, and if we do not get enough results, then match anywhere in each searchable term.
*
* @constant
*/
Components.interfaces.mozIPlacesAutoComplete.prototype.MATCH_BOUNDARY_ANYWHERE=1;
/**
* Match on word boundaries in each searchable term.
*
* @constant
*/
Components.interfaces.mozIPlacesAutoComplete.prototype.MATCH_BOUNDARY=2;
/**
* Match only the beginning of each search term.
*
* @constant
*/
Components.interfaces.mozIPlacesAutoComplete.prototype.MATCH_BEGINNING=3;
/**
* Search through history.
*
* @constant
*/
Components.interfaces.mozIPlacesAutoComplete.prototype.BEHAVIOR_HISTORY=1 << 0;
/**
* Search though bookmarks.
*
* @constant
*/
Components.interfaces.mozIPlacesAutoComplete.prototype.BEHAVIOR_BOOKMARK=1 << 1;
/**
* Search through tags.
*
* @constant
*/
Components.interfaces.mozIPlacesAutoComplete.prototype.BEHAVIOR_TAG=1 << 2;
/**
* Search the title of pages.
*
* @constant
*/
Components.interfaces.mozIPlacesAutoComplete.prototype.BEHAVIOR_TITLE=1 << 3;
/**
* Search the URL of pages.
*
* @constant
*/
Components.interfaces.mozIPlacesAutoComplete.prototype.BEHAVIOR_URL=1 << 4;
/**
* Search for typed pages.
*
* @constant
*/
Components.interfaces.mozIPlacesAutoComplete.prototype.BEHAVIOR_TYPED=1 << 5;
/**
* Search javascript: URLs.
*
* @constant
*/
Components.interfaces.mozIPlacesAutoComplete.prototype.BEHAVIOR_JAVASCRIPT=1 << 6;
/**
* Search for pages that have been marked as being opened, such as a tab in a tabbrowser.
*
* @constant
*/
Components.interfaces.mozIPlacesAutoComplete.prototype.BEHAVIOR_OPENPAGE=1 << 7;
/**
* Provides callback methods for mozIColorAnalyzer
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozIRepresentativeColorCallback=function(){};
/**
* This interface represents a spelling checker. Implement this interface to add support for a new spell checking engine.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozISpellCheckingEngine=function(){};
/**
* A string indicating the copyright of the engine. Not currently used. Read only.
*
* @type {String}
*/
Components.interfaces.mozISpellCheckingEngine.prototype.copyright="";
/**
* The name of the current dictionary used by check() and suggest(). This will be either element from the array returned by getDictionaryList() or an empty string if no dictionary is selected.
* Note: Setting this value to a value that doesn't match an existing dictionary throws a NS_ERROR_FILE_NOT_FOUND exception.
* When this attribute's value is changed, a "spellcheck-dictionary-update" notification is sent. If the dictionary was set to "no dictionary" (that is, by specifying an empty string), the observer may select another dictionary before returning.
*
* @type {String}
*/
Components.interfaces.mozISpellCheckingEngine.prototype.dictionary="";
/**
* The language this spell checker is using when checking. This is the language of dictionary. Read only.
* When this changes, the spell checker sends a "spellcheck-dictionary-update" notification.
*
* @type {String}
*/
Components.interfaces.mozISpellCheckingEngine.prototype.language="";
/**
* The name of the engine. Not currently used. Read only.
*
* @type {String}
*/
Components.interfaces.mozISpellCheckingEngine.prototype.name="";
/**
* The personal dictionary.
*
* @type {Components.interfaces.mozIPersonalDictionary}
*/
Components.interfaces.mozISpellCheckingEngine.prototype.personalDictionary=new Components.interfaces.mozIPersonalDictionary();
/**
* Does the engine provide its own personalDictionary? Read only.
*
* @type {Boolean}
*/
Components.interfaces.mozISpellCheckingEngine.prototype.providesPersonalDictionary=false;
/**
* Does the engine provide its own word utilities? Read only.
*
* @type {Boolean}
*/
Components.interfaces.mozISpellCheckingEngine.prototype.providesWordUtils=false;
/**
* Checks a word to determine if it's spelled correctly.When this changes, the spell checker sends a "spellcheck-dictionary-update" notification.
*
* @param {String} word in wstring word A word to check for correct spelling.
*/
Components.interfaces.mozISpellCheckingEngine.prototype.check=function(word){};
/**
* Gets the list of dictionaries.
*
* @param {String} dictionaries [array, size_is(count] out wstring dictionaries, A list of dictionaries supported by this spell checker. The dictionary attribute can be set to one of these. Each dictionary name is typically but not always a locale code.
* @param {Number} count out PRUint32 count The length of dictionaries.
*/
Components.interfaces.mozISpellCheckingEngine.prototype.getDictionaryList=function(dictionaries, count){};
/**
* Gets a list of suggestions for a misspelled word.When this changes, the spell checker sends a "spellcheck-dictionary-update" notification.
*
* @param {String} word in wstring word, A word, which is misspelled according to check.
* @param {String} suggestions [array, size_is(count] out wstring suggestions, A list of words suggested instead of word.
* @param {Number} count out PRUint32 count The length of suggestions.
*/
Components.interfaces.mozISpellCheckingEngine.prototype.suggest=function(word, suggestions, count){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozIStorageBindingParamsArray=function(){};
/**
* Adds the specified set of parameters to the end of the array. The appended parameters will be used when mozIStorageStatement.executeAsync() is called.
*
* @param {Components.interfaces.mozIStorageBindingParams} aParameters in mozIStorageBindingParams aParameters The mozIStorageBindingParams object containing the parameters to append to the array.
*/
Components.interfaces.mozIStorageBindingParamsArray.prototype.addParams=function(aParameters){};
/**
* Creates and returns a new, empty, mozIStorageBindingParams object to which you can add parameters and their values for binding.
*
*/
Components.interfaces.mozIStorageBindingParamsArray.prototype.newBindingParams=function(){};
/**
* This interface represents a database connection attached to a specific file or an in-memory database. It is the primary interface for interacting with a database, including creating prepared statements, executing SQL, and examining database errors.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozIStorageConnection=function(){};
/**
* No database lock is obtained until the first statement is run.
*
* @constant
*/
Components.interfaces.mozIStorageConnection.prototype.TRANSACTION_DEFERRED=0;
/**
* A reserved lock is obtained on the database.
*
* @constant
*/
Components.interfaces.mozIStorageConnection.prototype.TRANSACTION_IMMEDIATE=1;
/**
* An exclusive lock is obtained on the database.
*
* @constant
*/
Components.interfaces.mozIStorageConnection.prototype.TRANSACTION_EXCLUSIVE=2;
/**
* The default size for SQLite database pages. This is used by the Storage API when creating new databases, and must match the SQLITE_DEFAULT_PAGE_SIZE configured in db/sqlite3/src/Makefile.in.
*
* @constant
*/
Components.interfaces.mozIStorageConnection.prototype.DEFAULT_PAGE_SIZE=32768;
/**
* Indicates if the connection is open and ready to use. This will be false if the connection failed to open, or it has been closed. Read only.
*
* @type {Boolean}
*/
Components.interfaces.mozIStorageConnection.prototype.connectionReady=false;
/**
* The current database nsIFile. null if the database connection refers to an in-memory database. Read only.
*
* @type {Components.interfaces.nsIFile}
*/
Components.interfaces.mozIStorageConnection.prototype.databaseFile=new Components.interfaces.nsIFile();
/**
* The last SQLite error code that occurred. Read only.
* Note: This is not reliable if you are using asynchronous statements or if you are using the connection on multiple threads.
*
* @type {Number}
*/
Components.interfaces.mozIStorageConnection.prototype.lastError=0;
/**
* The English error string reported by the SQLite library for the last SQLite operation. Read only.
* Note: This is not reliable if you are using asynchronous statements or if you are using the connection on multiple threads.
*
* @type {String}
*/
Components.interfaces.mozIStorageConnection.prototype.lastErrorString="";
/**
* The row ID from the last SQL INSERT operation. Read only.
* Note: This is not reliable if you are using asynchronous statements or if you are using the connection on multiple threads.
*
* @type {Number}
*/
Components.interfaces.mozIStorageConnection.prototype.lastInsertRowID=0;
/**
* The schema version of the database. This should not be used until the database is ready. The version will be reported as 0 if it is not set.
*
* @type {Number}
*/
Components.interfaces.mozIStorageConnection.prototype.schemaVersion=0;
/**
* Returns true if there is a transaction in progress on the database. Otherwise returns false. Read only.
*
* @type {Boolean}
*/
Components.interfaces.mozIStorageConnection.prototype.transactionInProgress=false;
/**
* Starts a new transaction DEFERRED transaction. This is the same as calling mozIStorageConnection with mozIStorageConnection.TRANSACTION_DEFERRED.
*
*/
Components.interfaces.mozIStorageConnection.prototype.beginTransaction=function(){};
/**
* This method starts a new transaction of the given transaction type. See the SQLite documentation on transactions for more details.In JavaScript, managing transactions can be difficult when you are using the same connection on different threads, or are using a combination of asynchronous and synchronous statement execution. The best way to deal with this is to only execute your statements asynchronously using mozIStorageConnection.executeAsync(). This method will manage the transactions for you, so you don't have to worry about them.Note: The database engine does not support nested transactions, so attempting to start a transaction when one is already active will throw an exception.
*
* @param {Number} transactionType in PRInt32 transactionType One of the transaction constants (mozIStorageConnection.TRANSACTION_DEFERRED, mozIStorageConnection.TRANSACTION_IMMEDIATE, mozIStorageConnection.TRANSACTION_EXCLUSIVE)
*/
Components.interfaces.mozIStorageConnection.prototype.beginTransactionAs=function(transactionType){};
/**
* This method commits the current transaction.
*
*/
Components.interfaces.mozIStorageConnection.prototype.commitTransaction=function(){};
/**
* Creates a new function that can be used in SQL. See mozIStorageFunction for sample code and more details.If you use your connection on multiple threads, your function needs to be threadsafe, or it should only be called on one thread.
*
* @param {String} aFunctionName in AUTF8String aFunctionName, The name of function to create, as seen in SQL.
* @param {Number} aNumArguments in long aNumArguments, The number of arguments the function takes. Pass -1 for variable-argument functions.
* @param {Components.interfaces.mozIStorageFunction} aFunction in mozIStorageFunction aFunction The instance of mozIStorageFunction that implements the function.
*/
Components.interfaces.mozIStorageConnection.prototype.createFunction=function(aFunctionName, aNumArguments, aFunction){};
/**
* Creates a mozIStorageStatement for the given SQL expression. The expression may use "?#" to indicate sequentially numbered parameters (?1, ?2, etc) or ":name" to indicate named parameters. JavaScript callers should use named parameters.
*
* @param {String} aSQLStatement in AUTF8String aSQLStatement The SQL statement to execute.
*/
Components.interfaces.mozIStorageConnection.prototype.createStatement=function(aSQLStatement){};
/**
* This method creates a table with the given table name and schema.
*
* @param {String} aTableName in string aTableName, The name of the table to create; table names may consist of the letters A-Z in either upper or lower case, the underscore, and the digits 0-9. The first character must be a letter.
* @param {String} aTableSchema in string aTableSchema The table's schema. This should be specified using the same syntax the CREATE TABLE statement uses. For example: "foo INTEGER, bar STRING".
*/
Components.interfaces.mozIStorageConnection.prototype.createTable=function(aTableName, aTableSchema){};
/**
* Executes an SQL expression that has no bound parameters.
* Warning: Performing synchronous IO on the main thread can cause serious performance problems. As a result, this method of modifying the database is strongly discouraged!
*
* @param {String} aSQLStatement in AUTF8String aSQLStatement The SQL statement to execute.
*/
Components.interfaces.mozIStorageConnection.prototype.executeSimpleSQL=function(aSQLStatement){};
/**
* This method determines whether or not the given index exists.
*
* @param {String} aIndexName in AUTF8String aIndexName The index to check.
*/
Components.interfaces.mozIStorageConnection.prototype.indexExists=function(aIndexName){};
/**
* This method rolls back the current transaction. This is essentially an "undo," and returns the database to the state it was in before the transaction began.
*
*/
Components.interfaces.mozIStorageConnection.prototype.rollbackTransaction=function(){};
/**
* Determines if there exists a table with the given name.
*
* @param {String} aTableName in AUTF8String aTableName The SQL table whose existence should be checked.
*/
Components.interfaces.mozIStorageConnection.prototype.tableExists=function(aTableName){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozIStorageError=function(){};
/**
* General SQL error, or missing database
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.ERROR=1;
/**
* A disk I/O error occurred.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.IOERR=10;
/**
* The database on disk is malformed.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.CORRUPT=11;
/**
* An insertion failed because the database is full.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.FULL=13;
/**
* Unable to open the database file.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.CANTOPEN=14;
/**
* The database is empty.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.EMPTY=16;
/**
* The database schema changed.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.SCHEMA=17;
/**
* A string or blob exceeds the size limit.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.TOOBIG=18;
/**
* Aborted due to a constraint violation.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.CONSTRAINT=19;
/**
* An internal logic error occurred.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.INTERNAL=2;
/**
* A data type mismatch occurred.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.MISMATCH=20;
/**
* Library used incorrectly.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.MISUSE=21;
/**
* Attempted to use OS features not supported on the host system.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.NOLFS=22;
/**
* Authorization denied.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.AUTH=23;
/**
* Auxiliary database format error.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.FORMAT=24;
/**
* The opened file is not a database.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.NOTADB=26;
/**
* Access permission denied.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.PERM=3;
/**
* A callback routine requested an abort.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.ABORT=4;
/**
* The database file is locked.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.BUSY=5;
/**
* A table in the database is locked.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.LOCKED=6;
/**
* A memory allocation failed.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.NOMEM=7;
/**
* Attempted to write to a read-only database.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.READONLY=8;
/**
* The operation was terminated by an interrupt.
*
* @constant
*/
Components.interfaces.mozIStorageError.prototype.INTERRUPT=9;
/**
* A human readable error string with details; this may be null if no details are available. Read only.
*
* @type {String}
*/
Components.interfaces.mozIStorageError.prototype.message="";
/**
* One of the error code values listed under Constants on this page.
*
* @type {Number}
*/
Components.interfaces.mozIStorageError.prototype.result=0;
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozIStorageFunction=function(){};
/**
* The implementation of the function. This is called by the database engine when the function registered with mozIStorageConnection.createFunction() is used in an executing SQL statement or trigger.
* Warning: This callback is executed on the thread that the statement or trigger is executing on. If you use mozIStorageConnection.executeAsync() or mozIStorageStatement.executeAsync(), this callback will run on a different thread from the rest of your code. Likewise, if you execute SQL on a different thread, this callback will be executed on that thread. This callback should be reentrant if any of the above applies to your use of the storage APIs!
*
* @param {Components.interfaces.mozIStorageValueArray} aFunctionArguments in mozIStorageValueArray aFunctionArguments A mozIStorageValueArray holding the arguments passed in to the function.
*/
Components.interfaces.mozIStorageFunction.prototype.onFunctionCall=function(aFunctionArguments){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozIStoragePendingStatement=function(){};
/**
* Cancels the pending statement. Fails only if you attempt to cancel the operation more than once.Note: For read statements, such as SELECT, once you cancel the statement, you will receive no further notifications about results.
*
*/
Components.interfaces.mozIStoragePendingStatement.prototype.cancel=function(){};
/**
* Please add a summary to this article.
*
* @constructor
*/
Components.interfaces.mozIStorageProgressHandler=function(){};
/**
* The onProgress() method is called periodically while an sqlite operation is ongoing. This allows you to monitor the progress and possibly display status information to the user.
*
* @param {Components.interfaces.mozIStorageConnection} aConnection in mozIStorageConnection aConnection A mozIStorageConnection connection indicating the connection for which the callback was invoked.
*/
Components.interfaces.mozIStorageProgressHandler.prototype.onProgress=function(aConnection){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozIStorageResultSet=function(){};
/**
* Returns the next row from the result set.
*
*/
Components.interfaces.mozIStorageResultSet.prototype.getNextRow=function(){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.mozIStorageValueArray}
*/
Components.interfaces.mozIStorageRow=function(){};
/**
* Returns the value from a specific column in the row, using a zero-based index to identify the column.
*
* @param {Number} aIndex in unsigned long aIndex The zero-based index of the column number whose value is to be returned.
*/
Components.interfaces.mozIStorageRow.prototype.getResultByIndex=function(aIndex){};
/**
* Returns the value from a specific column in the row, identifying the column by name.
*
* @param {String} aName in AUTF8String aName The name of the column whose value is to be returned.
*/
Components.interfaces.mozIStorageRow.prototype.getResultByName=function(aName){};
/**
* This interface lets you open a mozIStorageConnection to a database file, as well as create backups of an unopened database file. This is the only way to open a database connection.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozIStorageService=function(){};
/**
* Opens a database connection to the specified file. The specified file is created if it does not already exist. If this method throws NS_ERROR_FILE_CORRUPTED, it's recommended that you call mozIStorageService.backupDatabaseFile() to back up the database so that user data is not lost (although we have no way of recovering this data yet).Consumers should check mozIStorageConnection.connectionReady to ensure that they can use the database. If this value is false, it is strongly recommended that the database be backed up with mozIStorageConnection.backupDB() so user data is not lost. And then the database can be opened again with the mozIStorageService.openDatabase() method.
* Warning: If you have more than one connection to a file, you must use the exact same name for the file each time, including case. The sqlite code uses a simple string comparison to see if there is already a connection. Opening a connection to "Foo.sqlite" and "foo.sqlite" will corrupt your database.
* If your database contains virtual tables (for example, for full-text indexes), you must use mozIStorageService.openUnsharedDatabase() to open it, since those tables are not compatible with a shared cache. If you use this method to open a database containing virtual tables, it will think the database is corrupted and throw NS_ERROR_FILE_CORRUPTED.Note: The connection object returned by this function is not threadsafe. You must use it only from the thread you created it from.
*
* @param {Components.interfaces.nsIFile} aDatabaseFile in nsIFile aDatabaseFile An nsIFile indicating the database file to open.
*/
Components.interfaces.mozIStorageService.prototype.openDatabase=function(aDatabaseFile){};
/**
* Opens a connection to a named special database storage that identifies the type of storage requested.Note: You should only access the profile database from the main thread since other callers may also be using it.
*
* @param {String} aStorageKey in string aStorageKey A string key identifying the type of storage requested. Valid values are "profile" and "memory".
*/
Components.interfaces.mozIStorageService.prototype.openSpecialDatabase=function(aStorageKey){};
/**
* This interface lets you create and execute SQL statements on a mozIStorageConnection.
*
* @constructor
* @inherits {Components.interfaces.mozIStorageValueArray}
*/
Components.interfaces.mozIStorageStatement=function(){};
/**
* Number of columns returned. Read only.
*
* @type {Number}
*/
Components.interfaces.mozIStorageStatement.prototype.columnCount=0;
/**
* Number of parameters. Read only.
*
* @type {Number}
*/
Components.interfaces.mozIStorageStatement.prototype.parameterCount=0;
/**
* The current list of named parameters, which may be set. Only available to JavaScript code. Read only.
*
* @type {Components.interfaces.mozIStorageStatementParams}
*/
Components.interfaces.mozIStorageStatement.prototype.params=new Components.interfaces.mozIStorageStatementParams();
/**
* The current row, with access to all data members by name. Available only to JavaScript code. Read only.
*
* @type {Components.interfaces.mozIStorageStatementRow}
*/
Components.interfaces.mozIStorageStatement.prototype.row=new Components.interfaces.mozIStorageStatementRow();
/**
* The current state defined by mozIStorageStatement.MOZ_STORAGE_STATEMENT_INVALID, mozIStorageStatement.MOZ_STORAGE_STATEMENT_READY, or mozIStorageStatement.MOZ_STORAGE_STATEMENT_EXECUTING. Read only.
*
* @type {Number}
*/
Components.interfaces.mozIStorageStatement.prototype.state=0;
/**
* Finalizes a statement which releases all resources that were allocated for it. You must call this method on every active statement before you try to call mozIStorageConnection.close().
*
*/
Components.interfaces.mozIStorageStatement.prototype.finalize=function(){};
/**
* Creates a copy of the statement whose state will be mozIStorageStatement.MOZ_STORAGE_STATEMENT_READY.
*
*/
Components.interfaces.mozIStorageStatement.prototype.clone=function(){};
/**
* Obtains the name of the parameter for the specified index.
*
* @param {Number} aParamIndex in unsigned long aParamIndex The zero-based numerical index for the parameter to be bound. This will be one less than the number used in the SQL (?1 maps to 0, and so on).
*/
Components.interfaces.mozIStorageStatement.prototype.getParameterName=function(aParamIndex){};
/**
* Obtains the index of the parameter with the specified name. This method was added in 1.9.0. In 1.8.1 you had to use getParameterIndexes(). See bug 388048 for details.
*
* @param {String} aName in AUTF8String aName Name of the parameter to get the index for. For parameter 'foo', name's format is ':foo' in 1.9.0 and 1.9.1. In 1.9.2 the ':' was dropped and name's value should be just 'foo'. See bug 528166 for details.
*/
Components.interfaces.mozIStorageStatement.prototype.getParameterIndex=function(aName){};
/**
* Obtains the name of the column for the specified index.
*
* @param {Number} aColumnIndex in unsigned long aColumnIndex The zero-based numerical index for the column to get data from.
*/
Components.interfaces.mozIStorageStatement.prototype.getColumnName=function(aColumnIndex){};
/**
* Obtains the index of the column with the specified name.
*
* @param {String} aName in AUTF8String aName Name of the column.
*/
Components.interfaces.mozIStorageStatement.prototype.getColumnIndex=function(aName){};
/**
* Resets the bound parameters and statement execution state. This must be called before reusing the statement.Note: JavaScript callers should always wrap their execution in a try block, and have a reset statement in a finally block.See the overview document on storage for more details.
*
*/
Components.interfaces.mozIStorageStatement.prototype.reset=function(){};
/**
* Escapes a string for SQL LIKE search.Note: Consumers will have to use same escape char when doing statements such as: ...LIKE '?1' ESCAPE '/'.... See the sample code for more details.
*
* @param {String} aValue in AString aValue, String to escape for SQL LIKE.
* @param {Components.interfaces.wchar} aEscapeChar in wchar aEscapeChar The escape character to use. Generally, / will be sufficient.
*/
Components.interfaces.mozIStorageStatement.prototype.escapeStringForLIKE=function(aValue, aEscapeChar){};
/**
* These functions are discussed in more detail with sample code in the overview document.
* Requires Gecko 1.9.2 (Firefox 3.6 / Thunderbird 3.1 / Fennec 1.0)
* newBindingParamsArray()()
* Creates and returns a new mozIStorageBindingParamsArray object that can be used to bind multiple values to parameters in preparation for calling executeAsync().
*
*/
Components.interfaces.mozIStorageStatement.prototype.newBindingParamsArray=function(){};
/**
* These functions are discussed in more detail with sample code in the overview document.
* Requires Gecko 1.9.1 (Firefox 3.5 / Thunderbird 3.0 / SeaMonkey 2.0)
* executeAsync()()
* Starts the execution of a query asynchronously using the currently bound parameters. The optional callback routine receives notifications about the progress of the query. For sample code and more details, see the overview document.Note: The statement does not have to be reset before being reused.
*
* @param {Components.interfaces.mozIStorageStatementCallback} aCallback [optional] mozIStorageStatementCallback aCallback A callback object that will be notified of progress, errors, and query completion. This parameter is optional.
*/
Components.interfaces.mozIStorageStatement.prototype.executeAsync=function(aCallback){};
/**
* Components can implement this interface to provide information to allow a database to be periodically vacuumed by the Storage service.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozIStorageVacuumParticipant=function(){};
/**
* A connection to the database file to be vacuumed.
*
* @type {Components.interfaces.mozIStorageConnection}
*/
Components.interfaces.mozIStorageVacuumParticipant.prototype.databaseConnection=new Components.interfaces.mozIStorageConnection();
/**
* The expected page size, in bytes, for the database. The vacuum manager will try to correct the page size when the browser is idle, using this value as a target. Valid page sizes are in the range 512 to 65,536. The recommended value is mozIStorageConnection::DEFAULT_PAGE_SIZE. Note: If the database is using the WAL journal node and the current page size is not the expected one, the journal node will be changed to TRUNCATE because WAL doesn't allow page size changes. The vacuum manager will try to restore WAL mode, but this will only work reliably if the participant properly resets statements. If the attempt to restore the journal node fails, it will remain TRUNCATE.
*
* @type {Number}
*/
Components.interfaces.mozIStorageVacuumParticipant.prototype.expectedDatabasePageSize=0;
/**
* Called when a vacuum operation begins. Once you receive this notification, you should avoid using the database until onEndVacuum() is called.
*
*/
Components.interfaces.mozIStorageVacuumParticipant.prototype.onBeginVacuum=function(){};
/**
* Utility functions for determining whether a given URI, channel, or window hierarchy is third party with respect to a known URI.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozIThirdPartyUtil=function(){};
/**
* Determine whether the given channel and its content window hierarchy is third party. This is done as follows: If aChannel is an nsIHttpChannel and has the 'forceAllowThirdPartyCookie' property set, then: If aURI is null, return false. Otherwise, find the URI of the channel, determine whether it is foreign with respect to aURI, and return. Find the URI of the channel and determine whether it is third party with respect to the URI of the channel. If so, return. Obtain the bottommost nsIDOMWindow, and its same-type parent if it exists, from the channel's notification callbacks. Then: If the parent is the same as the bottommost window, and the channel has the LOAD_DOCUMENT_URI flag set, return false. This represents the case where a toplevel load is occurring and the window's URI has not yet been updated. (We have already checked that aURI is not foreign with respect to the channel URI.) Otherwise, return the result of isThirdPartyWindow() with arguments of the channel's bottommost window and the channel URI, respectively.
* Therefore, both the channel's URI and each level in the window hierarchy associated with the channel is tested.For example, if aURI is "http://mail.google.com/", aChannel has a URI of "http://google.com/", and its parent is the topmost content window with a URI of "http://mozilla.com", the result will be true.
*
* @param {Components.interfaces.nsIChannel} aChannel in nsIChannel aChannel, The channel associated with the load.
* @param {Components.interfaces.nsIURI aURI} Optional in nsIURI aURI Optional A URI to test against. If null, the URI of the channel will be used.
*/
Components.interfaces.mozIThirdPartyUtil.prototype.isThirdPartyChannel=function(aChannel, Optional){};
/**
* Determine whether two URIs are third party with respect to each other. This is determined by computing the base domain for both URIs. If they can be determined, and the base domains match, the request is defined as first party. If it cannot be determined because one or both URIs do not have a base domain (for instance, in the case of IP addresses, host aliases such as 'localhost', or a file:// URI), an exact string comparison on host is performed.For example, the URI "http://mail.google.com/" is not third party with respect to "http://images.google.com/", but "http://mail.yahoo.com/" and "http://192.168.1.1/" are.
*
* @param {Components.interfaces.nsIURI} aFirstURI in nsIURI aFirstURI, Missing Description
* @param {Components.interfaces.nsIURI} aSecondURI in nsIURI aSecondURI Missing Description
*/
Components.interfaces.mozIThirdPartyUtil.prototype.isThirdPartyURI=function(aFirstURI, aSecondURI){};
/**
* Determine whether the given window hierarchy is third party. This is done as follows: Obtain the URI of the principal associated with aWindow. Call this the 'bottom URI'. If aURI is provided, determine if it is third party with respect to the bottom URI. If so, return. Find the same-type parent window, if there is one, and its URI. Determine whether it is third party with respect to the bottom URI. If so, return.
* Therefore, each level in the window hierarchy is tested. (This means that nested iframes with different base domains, even though the bottommost and topmost URIs might be equal, will be considered third party.)For example, if aURI is "http://mail.google.com/", 'aWindow' has a URI of "http://google.com/", and its parent is the topmost content window with a URI of "http://mozilla.com", the result will be true.
*
* @param {Components.interfaces.nsIDOMWindow} aWindow in nsIDOMWindow aWindow, The bottommost window in the hierarchy.
* @param {Components.interfaces.nsIURI aURI} Optional in nsIURI aURI Optional A URI to test against. If null, the URI of the principal associated with aWindow will be used.
*/
Components.interfaces.mozIThirdPartyUtil.prototype.isThirdPartyWindow=function(aWindow, Optional){};
/**
* This interface provides additional info for a visit.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozIVisitInfo=function(){};
/**
* Read only: The referring URI of this visit. This may be null.
*
* @type {Components.interfaces.nsIURI}
*/
Components.interfaces.mozIVisitInfo.prototype.referrerURI=new Components.interfaces.nsIURI();
/**
* Read only: The sessionId of this visit.
*
* @type {Number}
*/
Components.interfaces.mozIVisitInfo.prototype.sessionId=0;
/**
* Read only: The transition type used to get to this visit. One of the nsINavBookmarksService.Constants on nsINavHistory.
*
* @type {Number}
*/
Components.interfaces.mozIVisitInfo.prototype.transitionType=0;
/**
* Read only: The time the visit occurred.
*
* @type {Number}
*/
Components.interfaces.mozIVisitInfo.prototype.visitDate=0;
/**
* Read only: The machine-local (internal) id of the visit.
*
* @type {Number}
*/
Components.interfaces.mozIVisitInfo.prototype.visitId=0;
/**
* This interface provides callback handling functionality for mozIAsyncHistory.updatePlaces()
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.mozIVisitInfoCallback=function(){};
/**
* This interface is implemented to add an 'about:' page. The contract id ends with a parameter that corresponds to the name of the about page.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAboutModule=function(){};
/**
* A flag that indicates whether a URI is safe for untrusted content. If it is, web pages and so forth will be allowed to link to this about: URI. Otherwise, only chrome will be able to link to it.
*
* @constant
*/
Components.interfaces.nsIAboutModule.prototype.URI_SAFE_FOR_UNTRUSTED_CONTENT=(1 << 0);
/**
* A flag that indicates whether script should be enabled for the given about: URI even if it's disabled in general.
*
* @constant
*/
Components.interfaces.nsIAboutModule.prototype.ALLOW_SCRIPT=(1 << 1);
/**
* A flag that indicates whether this about: URI doesn't want to be listed in about:about, especially if it's not useful without a query string.
*
* @constant
*/
Components.interfaces.nsIAboutModule.prototype.HIDE_FROM_ABOUTABOUT=(1 << 2);
/**
* This interface is an abstract interface used to implement the web workers architecture.
*
* @constructor
* @inherits {Components.interfaces.nsIDOMEventTarget}
*/
Components.interfaces.nsIAbstractWorker=function(){};
/**
* The error listener for the worker.
*
* @type {Components.interfaces.nsIDOMEventListener}
*/
Components.interfaces.nsIAbstractWorker.prototype.onerror=new Components.interfaces.nsIDOMEventListener();
/**
* Please add a summary to this article.
*
* @constructor
*/
Components.interfaces.nsIAccessibilityService=function(){};
/**
*
*
* @param {Components.interfaces.nsIAccessible} aRootAccessible in nsIAccessible aRootAccessible undefined
*/
Components.interfaces.nsIAccessibilityService.prototype.removeNativeRootAccessible=function(aRootAccessible){};
/**
* Invalidate the accessibility cache associated with aPresShell, for accessibles that were generated for aContainerContent and it's subtree. The container content node for the change is passed in, rather than the changed presentation for the content node itself.
*
* @param {Components.interfaces.nsIPresShell} aPresShell in nsIPresShell aPresShell, The presShell where changes occured.
* @param {Components.interfaces.nsIContent} aChangedContent in nsIContent aChangedContent, The affected DOM content.
* @param {Number} aEvent in PRUint32 aEvent The event from nsIAccessibleEvent that caused the change. Must be one of:
*/
Components.interfaces.nsIAccessibilityService.prototype.invalidateSubtreeFor=function(aPresShell, aChangedContent, aEvent){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleCaretMoveEvent=function(){};
/**
* Return caret offset. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleCaretMoveEvent.prototype.caretOffset=0;
/**
* These constants define which coordinate system a point is located in.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleCoordinateType=function(){};
/**
* The coordinates are relative to the screen.
*
* @constant
*/
Components.interfaces.nsIAccessibleCoordinateType.prototype.COORDTYPE_SCREEN_RELATIVE=0x00;
/**
* The coordinates are relative to the window.
*
* @constant
*/
Components.interfaces.nsIAccessibleCoordinateType.prototype.COORDTYPE_WINDOW_RELATIVE=0x01;
/**
* The coordinates are relative to the upper left corner of the bounding box of the immediate parent.
*
* @constant
*/
Components.interfaces.nsIAccessibleCoordinateType.prototype.COORDTYPE_PARENT_RELATIVE=0x02;
/**
* An interface for in-process accessibility clients that wish to retrieve information about a document. When accessibility is turned on in Gecko, there is an nsIAccessibleDocument for each document whether it is XUL, HTML or whatever.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleDocument=function(){};
/**
* Read only. Obsolete since Gecko 1.9
*
* @type {Components.interfaces.nsIAccessible}
*/
Components.interfaces.nsIAccessibleDocument.prototype.caretAccessible=new Components.interfaces.nsIAccessible();
/**
* The doc type of the document, as specified in the document. Read only.
*
* @type {String}
*/
Components.interfaces.nsIAccessibleDocument.prototype.docType="";
/**
* The nsIDOMDocument interface associated with this document. Read only. Renamed from document in Gecko 2.0
*
* @type {Components.interfaces.nsIDOMDocument}
*/
Components.interfaces.nsIAccessibleDocument.prototype.DOMDocument=new Components.interfaces.nsIDOMDocument();
/**
* True if the document is live in an editor. False if the document is being displayed but not edited. If a
is contentEditable, then it has its own document, with isEditable == true. Read only. Obsolete since Gecko 1.9
*
* @type {Boolean}
*/
Components.interfaces.nsIAccessibleDocument.prototype.isEditable=false;
/**
* The mime type of the document. Read only.
*
* @type {String}
*/
Components.interfaces.nsIAccessibleDocument.prototype.mimeType="";
/**
* The title of the document, as specified in the document. Read only.
*
* @type {String}
*/
Components.interfaces.nsIAccessibleDocument.prototype.title="";
/**
* The URL of the document Read only.
*
* @type {String}
*/
Components.interfaces.nsIAccessibleDocument.prototype.URL="";
/**
* The nsIDOMWindow that the document resides in. Read only.
*
* @type {Components.interfaces.nsIDOMWindow}
*/
Components.interfaces.nsIAccessibleDocument.prototype.window=new Components.interfaces.nsIDOMWindow();
/**
* The window handle for the OS window the document is being displayed in. For example, in Windows you can static cast it to an HWND. Read only. Native code only!
*
* @type {Object}
*/
Components.interfaces.nsIAccessibleDocument.prototype.windowHandle={};
/**
* The namespace for each ID that is handed back.
*
* @param {Number} nameSpaceID in short nameSpaceID The ID of the name space.
*/
Components.interfaces.nsIAccessibleDocument.prototype.getNameSpaceURIForID=function(nameSpaceID){};
/**
* An interface for editing text of an accessible object. The operations it supports includes setting text attributes and text contents while also replacing old text of an object with new text. It also includes and support basic operations such as, inserting text, copying text, cutting text, pasting text and deleting text at the specified position.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleEditableText=function(){};
/**
* Returns an editor associated with the accessible. Read only. Native code only!
*
* @type {Components.interfaces.nsIEditor}
*/
Components.interfaces.nsIAccessibleEditableText.prototype.associatedEditor=new Components.interfaces.nsIEditor();
/**
* Copies the text range into the clipboard.
*
* @param {Number} startPos in long startPos, Start offset of the text to be copied into the clipboard.
* @param {Number} endPos in long endPos End offset of the text to be copied into the clipboard.
*/
Components.interfaces.nsIAccessibleEditableText.prototype.copyText=function(startPos, endPos){};
/**
* Deletes a range of text and copies it to the clipboard.
*
* @param {Number} startPos in long startPos, Start offset of the text to be deleted and copied to clipboard.
* @param {Number} endPos in long endPos End offset of the text to be copied into the clipboard.
*/
Components.interfaces.nsIAccessibleEditableText.prototype.cutText=function(startPos, endPos){};
/**
* Deletes a range of text.
*
* @param {Number} startPos in long startPos, Start offset of the text to be deleted.
* @param {Number} endPos in long endPos End offset of the text to be deleted.
*/
Components.interfaces.nsIAccessibleEditableText.prototype.deleteText=function(startPos, endPos){};
/**
* Inserts text at the specified position.
*
* @param {String} text in AString text, Text to be inserted.
* @param {Number} position in long position The offset at which to insert the text.
*/
Components.interfaces.nsIAccessibleEditableText.prototype.insertText=function(text, position){};
/**
* Pastes text from the clipboard.
*
* @param {Number} position in long position The offset at which to insert the text from the system clipboard into the text represented by this object.
*/
Components.interfaces.nsIAccessibleEditableText.prototype.pasteText=function(position){};
/**
* Unimplemented
* Sets the attributes for the text between the two given indices. The old attributes are replaced by the new list of attributes. For example, sets font styles, such as italic, bold, and so on.
*
* @param {Number} startPos in long startPos, The start index of the text whose attributes are modified.
* @param {Number} endPos in long endPos, The end index of the text whose attributes are modified.
* @param {Components.interfaces.nsISupports} attributes in nsISupports attributes The set of attributes that replaces the old list of attributes of the specified text portion.
*/
Components.interfaces.nsIAccessibleEditableText.prototype.setAttributes=function(startPos, endPos, attributes){};
/**
* Replaces the text represented by this object with the given text.
*
* @param {String} text in AString text The text that will replace the old text.
*/
Components.interfaces.nsIAccessibleEditableText.prototype.setTextContents=function(text){};
/**
* An interface for accessibility events listened to by in-process accessibility clients, which can be used to find out how to get accessibility and DOM interfaces for the event and its target.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleEvent=function(){};
/**
* The nsIAccessible associated with the event. May return null if no accessible is available. Read only.
*
* @type {Components.interfaces.nsIAccessible}
*/
Components.interfaces.nsIAccessibleEvent.prototype.accessible=new Components.interfaces.nsIAccessible();
/**
* The nsIAccessibleDocument that the event target nsIAccessible resides in. This can be used to get the DOM window, the DOM document and the window handler, among other things. Read only.
*
* @type {Components.interfaces.nsIAccessibleDocument}
*/
Components.interfaces.nsIAccessibleEvent.prototype.accessibleDocument=new Components.interfaces.nsIAccessibleDocument();
/**
* The nsIDOMNode associated with the event. May return null if accessible for event has been shut down. Read only.
*
* @type {Components.interfaces.nsIDOMNode}
*/
Components.interfaces.nsIAccessibleEvent.prototype.DOMNode=new Components.interfaces.nsIDOMNode();
/**
* The type of event, based on the enumerated event values defined in this interface. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleEvent.prototype.eventType=0;
/**
* Returns true if the event was caused by explicit user input, as opposed to purely originating from a timer or mouse movement.
*
* @type {Boolean}
*/
Components.interfaces.nsIAccessibleEvent.prototype.isFromUserInput=false;
/**
* A cross-platform interface that supports hyperlink-specific properties and methods.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleHyperLink=function(){};
/**
* The number of anchors within this Hyperlink. Is normally 1 for anchors. This anchor is, for example, the visible output of the html:a tag. With an Image Map, reflects the actual areas within the map. Read only. Renamed from anchors in Gecko 1.9 Exceptions thrown NS_ERROR_FAILURE Indicates that the accessible is unattached from the accessible tree.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleHyperLink.prototype.anchorCount=0;
/**
* The end offset of the hyperlink accessible within the parent accessible. The returned value is related to the nsIAccessibleHyperLink interface of the object that owns this hyperlink. Read only. Note: The link itself is represented by one embedded character within the parent text, so the endIndex should be startIndex + 1. Exceptions thrown NS_ERROR_FAILURE Indicates that the accessible is unattached from the accessible tree.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleHyperLink.prototype.endIndex=0;
/**
* Determines whether the element currently has the focus, for example after returning from the destination page. Read only. Note: ARIA links can only be focused if they have the tabindex attribute set. Also, state_focused should then be set on the accessible for this link. Exceptions thrown NS_ERROR_FAILURE Indicates that the accessible is unattached from the accessible tree.
*
* @type {Boolean}
*/
Components.interfaces.nsIAccessibleHyperLink.prototype.selected=false;
/**
* The offset of the hyperlink accessible within the parent accessible. The returned value is related to the nsIAccessibleHyperLink interface of the object that owns this hyperlink. Read only. Exceptions thrown NS_ERROR_FAILURE Indicates that the accessible is unattached from the accessible tree.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleHyperLink.prototype.startIndex=0;
/**
* Determines whether the hyperlink is valid, for example points to a valid URL. Read only. Note: Currently only used with ARIA links, and the author has to specify that the link is invalid via the aria-invalid='true' attribute. In all other cases, true is returned. Exceptions thrown NS_ERROR_FAILURE Indicates that the accessible is unattached from the accessible tree.
*
* @type {Boolean}
*/
Components.interfaces.nsIAccessibleHyperLink.prototype.valid=false;
/**
* Returns the URI at the given index.Note: ARIA hyperlinks do not have an URI to point to, since clicks are processed via JavaScript. Therefore this property does not work on ARIA links.
*
* @param {Number} index in long index The 0-based index of the URI to be returned.
*/
Components.interfaces.nsIAccessibleHyperLink.prototype.getURI=function(index){};
/**
* This interface is the main interface to expose hyperlinks in a document, typically a text document, that are used to reference other documents. A typical implementation is to implement this interface on the small text object such as a paragraph of text.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleHyperText=function(){};
/**
* The number of links contained within this hypertext object. Read only. Renamed from links in Gecko 1.9
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleHyperText.prototype.linkCount=0;
/**
* Retrieves the nsIAccessibleHyperLink object at the given link index.
*
* @param {Number} linkIndex in long linkIndex 0-based index of the link that is to be retrieved. This can be retrieved via getLinkIndex().
*/
Components.interfaces.nsIAccessibleHyperText.prototype.getLink=function(linkIndex){};
/**
* The link index at the given offset (character index).
*
* @param {Number} charIndex in long charIndex The 0-based character index.
*/
Components.interfaces.nsIAccessibleHyperText.prototype.getLinkIndex=function(charIndex){};
/**
* This interface allows in-process accessibility clients to retrieve information about an image.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleImage=function(){};
/**
* Returns the coordinates of the image accessible.This method is the same as nsIAccessible.getBounds() excepting coordinate origin parameter.
*
* @param {Number} coordType in unsigned long coordType, Specifies coordinates origin (for available constants refer to nsIAccessibleCoordinateType).
* @param {Number} x out long x, The x coordinate of the image accessible position.
* @param {Number} y out long y The y coordinate of the image accessible position.
*/
Components.interfaces.nsIAccessibleImage.prototype.getImagePosition=function(coordType, x, y){};
/**
* Returns the size of the image accessible.This method is the same as nsIAccessible.getBounds().
*
* @param {Number} width out long width, The width of the image accessible.
* @param {Number} height out long height The height of the image accessible.
*/
Components.interfaces.nsIAccessibleImage.prototype.getImageSize=function(width, height){};
/**
* Used to link element and accessible object. For that XBL binding, element should implement the interface.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleProvider=function(){};
/**
* Do not create an accessible for this object This is useful if an ancestor binding already implements nsIAccessibleProvider, but no accessible is desired for the inheriting binding.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.NoAccessible=0;
/**
* For elements that spawn a new document. For example now it is used by
, and .
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.OuterDoc=0x00000001;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULAlert=0x00001001;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULButton=0x00001002;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULCheckbox=0x00001003;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULColorPicker=0x00001004;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULColorPickerTile=0x00001005;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULCombobox=0x00001006;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULDropmarker=0x00001007;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULGroupbox=0x00001008;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULImage=0x00001009;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULLink=0x0000100A;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULListbox=0x0000100B;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULListCell=0x00001026;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULListHead=0x00001024;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULListHeader=0x00001025;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULListitem=0x0000100C;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULMenubar=0x0000100D;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULMenuitem=0x0000100E;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULMenupopup=0x0000100F;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULMenuSeparator=0x00001010;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULPane=0x00001011;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULProgressMeter=0x00001012;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULScale=0x00001013;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULStatusBar=0x00001014;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULRadioButton=0x00001015;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULRadioGroup=0x00001016;
/**
* The single tab in a dialog or tabbrowser/editor interface.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULTab=0x00001017;
/**
* A combination of a tabs object and a tabpanels object.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULTabBox=0x00001018;
/**
* The collection of tab objects, usable in the TabBox and independent of as well.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULTabs=0x00001019;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULText=0x0000101A;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULTextBox=0x0000101B;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULThumb=0x0000101C;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULTree=0x0000101D;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULTreeColumns=0x0000101E;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULTreeColumnItem=0x0000101F;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULToolbar=0x00001020;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULToolbarSeparator=0x00001021;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULTooltip=0x00001022;
/**
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XULToolbarButton=0x00001023;
/**
* Used for xforms elements that provide accessible object for itself as well for anonymous content. This property is used for upload, input[type="xsd:gDay"] and input[type="xsd:gMonth"]
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XFormsContainer=0x00002000;
/**
* Used for label element.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XFormsLabel=0x00002001;
/**
* Used for output element.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XFormsOuput=0x00002002;
/**
* Used for trigger and submit elements.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XFormsTrigger=0x00002003;
/**
* Used for input and textarea elements.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XFormsInput=0x00002004;
/**
* Used for input[xsd:boolean] element.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XFormsInputBoolean=0x00002005;
/**
* Used for input[xsd:date] element.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XFormsInputDate=0x00002006;
/**
* Used for secret element.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XFormsSecret=0x00002007;
/**
* Used for range element represented by slider.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XFormsSliderRange=0x00002008;
/**
* Used for select and select1 that are implemented using host document's native widget. For example, a select1 in a xhtml document may be represented by the native html control html:select.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XFormsSelect=0x00002009;
/**
* Used for xforms choices element.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XFormsChoices=0x00002010;
/**
* Used for xforms full select/select1 elements that may be represented by group of checkboxes and radiogroup.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XFormsSelectFull=0x00002011;
/**
* Used for xforms item element that is used inside xforms select elements represented by group of checkboxes.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XFormsItemCheckgroup=0x00002012;
/**
* Used for xforms item element that is used inside xforms select1 elements represented by radio group.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XFormsItemRadiogroup=0x00002013;
/**
* Used for xforms select1 element that is represented by combobox.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XFormsSelectCombobox=0x00002014;
/**
* Used for xforms item element that is used inside xforms select1 elements represented by combobox.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XFormsItemCombobox=0x00002015;
/**
* Used for dropmarker widget that is used by xforms elements.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XFormsDropmarkerWidget=0x00002101;
/**
* Used for calendar widget that is used by xforms elements.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XFormsCalendarWidget=0x00002102;
/**
* Used for popup widget that is used by xforms minimal select1 elements.
*
* @constant
*/
Components.interfaces.nsIAccessibleProvider.prototype.XFormsComboboxPopupWidget=0x00002103;
/**
* Read only. Obsolete since Gecko 1.9
*
* @type {Components.interfaces.nsIAccessible}
*/
Components.interfaces.nsIAccessibleProvider.prototype.accessible=new Components.interfaces.nsIAccessible();
/**
* Value representing the type of accessible object. See constants for details. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleProvider.prototype.accessibleType=0;
/**
* This interface gives access to an accessibles set of relations.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleRelation=function(){};
/**
* @constant
*/
Components.interfaces.nsIAccessibleRelation.prototype.RELATION_NUL=0x00;
/**
* Some attribute of this object is affected by a target object.
*
* @constant
*/
Components.interfaces.nsIAccessibleRelation.prototype.RELATION_CONTROLLED_BY=0x01;
/**
* This object is interactive and controls some attribute of a target object.
*
* @constant
*/
Components.interfaces.nsIAccessibleRelation.prototype.RELATION_CONTROLLER_FOR=0x02;
/**
* This object is label for a target object.
*
* @constant
*/
Components.interfaces.nsIAccessibleRelation.prototype.RELATION_LABEL_FOR=0x03;
/**
* This object is labelled by a target object. If the accessible has an nsIAccessible.name() , you can get the nsIAccessible that it was labelled by in order to get more formatting information.
* Note: The label and description (see RELATION_DESCRIBED_BY) relations may be used to prevent redundant information from being presented by the screen reader, since the label and description can occur both on their own, and in the name or description fields of an nsIAccessible.
*
* @constant
*/
Components.interfaces.nsIAccessibleRelation.prototype.RELATION_LABELLED_BY=0x04;
/**
* This object is a member of a group of one or more objects. When there is more than one object in the group each member may have one and the same target, for example a grouping object. It is also possible that each member has multiple additional targets, for example one for every other member in the group.
*
* @constant
*/
Components.interfaces.nsIAccessibleRelation.prototype.RELATION_MEMBER_OF=0x05;
/**
* This object is a child of a target object.
*
* @constant
*/
Components.interfaces.nsIAccessibleRelation.prototype.RELATION_NODE_CHILD_OF=0x06;
/**
* Content flows from this object to a target object, that is has content that flows logically to another object in a sequential way, for example text flow.
*
* @constant
*/
Components.interfaces.nsIAccessibleRelation.prototype.RELATION_FLOWS_TO=0x07;
/**
* Content flows to this object from a target object, that is has content that flows logically from another object in a sequential way, for example text flow.
*
* @constant
*/
Components.interfaces.nsIAccessibleRelation.prototype.RELATION_FLOWS_FROM=0x08;
/**
* This object is a sub window of a target object.
*
* @constant
*/
Components.interfaces.nsIAccessibleRelation.prototype.RELATION_SUBWINDOW_OF=0x09;
/**
* This object embeds a target object. This relation can be used on the OBJID_CLIENT accessible for a top level window to show where the content areas are. It points to the accessible object corresponding to the root of content in that window. This relation is very useful for finding the content quickly, and is the proper method for finding content in Gecko 1.9 and beyond.
*
* @constant
*/
Components.interfaces.nsIAccessibleRelation.prototype.RELATION_EMBEDS=0x0a;
/**
* This object is embedded by a target object.
*
* @constant
*/
Components.interfaces.nsIAccessibleRelation.prototype.RELATION_EMBEDDED_BY=0x0b;
/**
* This object is a transient component related to the target object. When this object is activated the target object doesn't lose focus.
*
* @constant
*/
Components.interfaces.nsIAccessibleRelation.prototype.RELATION_POPUP_FOR=0x0c;
/**
* This object is a parent window of the target object.
*
* @constant
*/
Components.interfaces.nsIAccessibleRelation.prototype.RELATION_PARENT_WINDOW_OF=0x0d;
/**
* This object is described by the target object. If the accessible has an nsIAccessible.description() , you can get the nsIAccessible that it was described by in order to get more formatting information.
* Note: The label (see RELATION_LABELLED_BY) and description relations may be used to prevent redundant information from being presented by the screen reader, since the label and description can occur both on their own, and in the name or description fields of an nsIAccessible.
*
* @constant
*/
Components.interfaces.nsIAccessibleRelation.prototype.RELATION_DESCRIBED_BY=0x0e;
/**
* This object is describes the target object.
*
* @constant
*/
Components.interfaces.nsIAccessibleRelation.prototype.RELATION_DESCRIPTION_FOR=0x0f;
/**
* Part of a form/dialog with a related default button. It is used for MSAA only, no for IA2 nor ATK/AT-SPI.
*
* @constant
*/
Components.interfaces.nsIAccessibleRelation.prototype.RELATION_DEFAULT_BUTTON=0x4000;
/**
* Returns the type of the relation. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleRelation.prototype.relationType=0;
/**
* Returns the number of targets for this relation. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleRelation.prototype.targetsCount=0;
/**
* Returns accessible relation target at the given index.
*
* @param {Number} index in unsigned long index Zero-based index of relation target.
*/
Components.interfaces.nsIAccessibleRelation.prototype.getTarget=function(index){};
/**
* Returns an array of accessible relation targets.
*
*/
Components.interfaces.nsIAccessibleRelation.prototype.getTargets=function(){};
/**
* This interface defines cross platform (Gecko) roles.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleRole=function(){};
/**
* Used when accessible has no strong defined role.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_NOTHING=0;
/**
* Represents a title or caption bar for a window. It is used by MSAA only, supported automatically by MS Windows.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_TITLEBAR=1;
/**
* Represents the menu bar (positioned beneath the title bar of a window) from which menus are selected by the user. The role is used by xul:menubar or role="menubar".
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_MENUBAR=2;
/**
* Represents a vertical or horizontal scroll bar, which is part of the client area or used in a control.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_SCROLLBAR=3;
/**
* Represents a special mouse pointer, which allows a user to manipulate user interface elements such as windows. For example, a user clicks and drags a sizing grip in the lower-right corner of a window to resize it.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_GRIP=4;
/**
* Represents a system sound, which is associated with various system events.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_SOUND=5;
/**
* Represents the system mouse pointer.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_CURSOR=6;
/**
* Represents the system caret. The role is supported for caret.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_CARET=7;
/**
* Represents an alert or a condition that a user should be notified about. Assistive Technologies typically respond to the role by reading the entire on screen contents of containers advertising this role. Should be used for warning dialogs, etc. The role is used by xul:browsermessage, role="alert", xforms:message.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_ALERT=8;
/**
* Represents the window frame, which contains child objects such as a title bar, client, and other objects contained in a window. The role is supported automatically by MS Windows.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_WINDOW=9;
/**
* A sub-document or iframe.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_INTERNAL_FRAME=10;
/**
* Represents a menu, which presents a list of options from which the user can make a selection to perform an action. It is used for role="menu".
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_MENUPOPUP=11;
/**
* Represents a menu item, which is an entry in a menu that a user can choose to carry out a command, select an option. It is used for xul:menuitem, role="menuitem".
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_MENUITEM=12;
/**
* Represents a ToolTip that provides helpful hints.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_TOOLTIP=13;
/**
* Represents a main window for an application. It is used for role="application". Also refer to ROLE_APP_ROOT.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_APPLICATION=14;
/**
* Represents a document window. A document window is always contained within an application window. It is used for role="document".
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_DOCUMENT=15;
/**
* Represents a pane within a frame or document window. Users can navigate between panes and within the contents of the current pane, but cannot navigate between items in different panes. Thus, panes represent a level of grouping lower than frame windows or documents, but above individual controls. It is used for the first child of a or iframe.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_PANE=16;
/**
* Represents a graphical image used to represent data.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_CHART=17;
/**
* Represents a dialog box or message box. It is used for xul:dialog, role="dialog".
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_DIALOG=18;
/**
* Represents a window border.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_BORDER=19;
/**
* Logically groups other objects. There is not always a parent-child relationship between the grouping object and the objects it contains. It is used for html:textfield, xul:groupbox, role="group".
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_GROUPING=20;
/**
* Used to visually divide a space into two regions, such as a separator menu item or a bar that divides split panes within a window. It is used for xul:separator, html:hr, role="separator".
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_SEPARATOR=21;
/**
* Represents a toolbar, which is a grouping of controls (push buttons or toggle buttons) that provides easy access to frequently used features. It is used for xul:toolbar, role="toolbar".
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_TOOLBAR=22;
/**
* Represents a status bar, which is an area at the bottom of a window that displays information about the current operation, state of the application, or selected object. The status bar has multiple fields, which display different kinds of information. It is used for xul:statusbar.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_STATUSBAR=23;
/**
* Represents a table that contains rows and columns of cells, and optionally, row headers and column headers. It is used for html:table, role="grid". Also refer to the following roles: ROLE_COLUMNHEADER, ROLE_ROWHEADER, ROLE_COLUMN, ROLE_ROW, ROLE_CELL.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_TABLE=24;
/**
* Represents a column header, providing a visual label for a column in a table. It is used for XUL tree column headers, html:th, role="colheader". Also refer to ROLE_TABLE.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_COLUMNHEADER=25;
/**
* Represents a row header, which provides a visual label for a table row. It is used for role="rowheader". Also, see ROLE_TABLE.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_ROWHEADER=26;
/**
* Represents a column of cells within a table. Also, see ROLE_TABLE.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_COLUMN=27;
/**
* Represents a row of cells within a table. Also, see ROLE_TABLE.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_ROW=28;
/**
* Represents a cell within a table. It is used for html:td, xul:tree cell and xul:listcell. Also, see ROLE_TABLE.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_CELL=29;
/**
* Represents a link to something else. This object might look like text or a graphic, but it acts like a button. It is used for xul:label@class="text-link", html:a, html:area, xforms:trigger@appearance="minimal".
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_LINK=30;
/**
* Displays a Help topic in the form of a ToolTip or Help balloon.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_HELPBALLOON=31;
/**
* Represents a cartoon-like graphic object, such as Microsoft Office Assistant, which is displayed to provide help to users of an application.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_CHARACTER=32;
/**
* Represents a list box, allowing the user to select one or more items. It is used for xul:listbox, html:select@size, role="list". See also ROLE_LIST_ITEM.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_LIST=33;
/**
* Represents an item in a list. See also ROLE_LIST.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_LISTITEM=34;
/**
* Represents an outline or tree structure, such as a tree view control, that displays a hierarchical list and allows the user to expand and collapse branches. Is is used for role="tree".
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_OUTLINE=35;
/**
* Represents an item in an outline or tree structure. It is used for role="treeitem".
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_OUTLINEITEM=36;
/**
* Represents a page tab, it is a child of a page tab list. It is used for xul:tab, role="treeitem". Also refer to ROLE_PAGETABLIST.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_PAGETAB=37;
/**
* Represents a property sheet. It is used for xul:tabpanel, role="tabpanel".
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_PROPERTYPAGE=38;
/**
* Represents an indicator, such as a pointer graphic, that points to the current item.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_INDICATOR=39;
/**
* Represents a picture. Is is used for xul:image, html:img.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_GRAPHIC=40;
/**
* Represents read-only text, such as labels for other controls or instructions in a dialog box. Static text cannot be modified or selected. Is is used for xul:label, xul:description, html:label, role="label", or xforms:output.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_STATICTEXT=41;
/**
* Represents selectable text that allows edits or is designated read-only.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_TEXT_LEAF=42;
/**
* Represents a push button control. It is used for xul:button, html:button, role="button", xforms:trigger, xforms:submit.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_PUSHBUTTON=43;
/**
* Represents a check box control. It is used for xul:checkbox, html:input@type="checkbox", role="checkbox", boolean xforms:input.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_CHECKBUTTON=44;
/**
* Represents an option button, also called a radio button. It is one of a group of mutually exclusive options. All objects sharing a single parent that have this attribute are assumed to be part of single mutually exclusive group. It is used for xul:radio, html:input@type="radio", role="radio".
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_RADIOBUTTON=45;
/**
* Represents a combo box; an edit control with an associated list box that provides a set of predefined choices. It is used for html:select, xul:menulist, role="combobox".
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_COMBOBOX=46;
/**
* Represents the calendar control. It is used for date xforms:input.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_DROPLIST=47;
/**
* Represents a progress bar, dynamically showing the user the percent complete of an operation in progress. It is used for xul:progressmeter, role="progressbar".
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_PROGRESSBAR=48;
/**
* Represents a dial or knob whose purpose is to allow a user to set a value.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_DIAL=49;
/**
* Represents a hot-key field that allows the user to enter a combination or sequence of keystrokes.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_HOTKEYFIELD=50;
/**
* Represents a slider, which allows the user to adjust a setting in given increments between minimum and maximum values. It is used by xul:scale, role="slider", xforms:range.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_SLIDER=51;
/**
* Represents a spin box, which is a control that allows the user to increment or decrement the value displayed in a separate "buddy" control associated with the spin box. It is used for xul:spinbuttons.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_SPINBUTTON=52;
/**
* Represents a graphical image used to diagram data. It is used for svg:svg.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_DIAGRAM=53;
/**
* Represents an animation control, which contains content that changes over time, such as a control that displays a series of bitmap frames.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_ANIMATION=54;
/**
* Represents a mathematical equation. It is used by MATHML, where there is a rich DOM subtree for an equation. Use ROLE_FLAT_EQUATION for
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_EQUATION=55;
/**
* Represents a button that drops down a list of items.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_BUTTONDROPDOWN=56;
/**
* Represents a button that drops down a menu.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_BUTTONMENU=57;
/**
* Represents a button that drops down a grid. It is used for xul:colorpicker.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_BUTTONDROPDOWNGRID=58;
/**
* Represents blank space between other objects.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_WHITESPACE=59;
/**
* Represents a container of page tab controls. Is it used for xul:tabs, DHTML: role="tabs". Also refer to ROLE_PAGETAB.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_PAGETABLIST=60;
/**
* Represents a control that displays time.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_CLOCK=61;
/**
* Represents a button on a toolbar that has a drop-down list icon directly adjacent to the button.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_SPLITBUTTON=62;
/**
* Represents an edit control designed for an Internet Protocol (IP) address. The edit control is divided into sections for the different parts of the IP address.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_IPADDRESS=63;
/**
* Represents a label control that has an accelerator.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_ACCEL_LABEL=64;
/**
* Represents an arrow in one of the four cardinal directions.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_ARROW=65;
/**
* Represents a control that can be drawn into and is used to trap events. It is used for html:canvas.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_CANVAS=66;
/**
* Represents a menu item with a check box.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_CHECK_MENU_ITEM=67;
/**
* Represents a specialized dialog that lets the user choose a color.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_COLOR_CHOOSER=68;
/**
* Represents control whose purpose is to allow a user to edit a date.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_DATE_EDITOR=69;
/**
* An iconified internal frame in an ROLE_DESKTOP_PANE. Also refer to ROLE_INTERNAL_FRAME.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_DESKTOP_ICON=70;
/**
* A desktop pane. A pane that supports internal frames and iconified versions of those internal frames.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_DESKTOP_FRAME=71;
/**
* A directory pane. A pane that allows the user to navigate through and select the contents of a directory. May be used by a file chooser. Also refer to ROLE_FILE_CHOOSER.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_DIRECTORY_PANE=72;
/**
* A file chooser. A specialized dialog that displays the files in the directory and lets the user select a file, browse a different directory, or specify a filename. May use the directory pane to show the contents of a directory. Also refer to ROLE_DIRECTORY_PANE.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_FILE_CHOOSER=73;
/**
* A font chooser. A font chooser is a component that lets the user pick various attributes for fonts.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_FONT_CHOOSER=74;
/**
* Frame role. A top level window with a title bar, border, menu bar, etc. It is often used as the primary window for an application.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_CHROME_WINDOW=75;
/**
* A glass pane. A pane that is guaranteed to be painted on top of all panes beneath it. Also refer to ROLE_ROOT_PANE.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_GLASS_PANE=76;
/**
* A document container for HTML, whose children represent the document content.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_HTML_CONTAINER=77;
/**
* A small fixed size picture, typically used to decorate components.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_ICON=78;
/**
* Presents an icon or short string in an interface.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_LABEL=79;
/**
* A layered pane. A specialized pane that allows its children to be drawn in layers, providing a form of stacking order. This is usually the pane that holds the menu bar as well as the pane that contains most of the visual components in a window. Also refer to ROLE_GLASS_PANE and ROLE_ROOT_PANE.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_LAYERED_PANE=80;
/**
* A specialized pane whose primary use is inside a dialog.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_OPTION_PANE=81;
/**
* A text object uses for passwords, or other places where the text content is not shown visibly to the user.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_PASSWORD_TEXT=82;
/**
* A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_POPUP_MENU=83;
/**
* A radio button that is a menu item.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_RADIO_MENU_ITEM=84;
/**
* A root pane. A specialized pane that has a glass pane and a layered pane as its children. Also refer to ROLE_GLASS_PANE and ROLE_LAYERED_PANE.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_ROOT_PANE=85;
/**
* A scroll pane. An object that allows a user to incrementally view a large amount of information. Its children can include scroll bars and a viewport. Also refer to ROLE_VIEW_PORT.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_SCROLL_PANE=86;
/**
* A split pane. A specialized panel that presents two other panels at the same time. Between the two panels is a divider the user can manipulate to make one panel larger and the other panel smaller.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_SPLIT_PANE=87;
/**
* The header for a column of a table.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_TABLE_COLUMN_HEADER=88;
/**
* The header for a row of a table.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_TABLE_ROW_HEADER=89;
/**
* A menu item used to tear off and reattach its menu.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_TEAR_OFF_MENU_ITEM=90;
/**
* Represents an accessible terminal.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_TERMINAL=91;
/**
* Collection of objects that constitute a logical text entity.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_TEXT_CONTAINER=92;
/**
* A toggle button. A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_TOGGLE_BUTTON=93;
/**
* Representas a control that is capable of expanding and collapsing rows as well as showing multiple columns of data.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_TREE_TABLE=94;
/**
* A viewport. An object usually used in a scroll pane. It represents the portion of the entire data that the user can see. As the user manipulates the scroll bars, the contents of the viewport can change. Also refer to ROLE_SCROLL_PANE.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_VIEWPORT=95;
/**
* Header of a document page. Also refer to ROLE_FOOTER.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_HEADER=96;
/**
* Footer of a document page. Also refer to ROLE_HEADER.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_FOOTER=97;
/**
* A paragraph of text.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_PARAGRAPH=98;
/**
* A ruler such as those used in word processors.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_RULER=99;
/**
* A text entry having dialog or list containing items for insertion into an entry widget, for instance a list of words for completion of a text entry. It is used for xul:textbox@autocomplete.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_AUTOCOMPLETE=100;
/**
* An editable text object in a toolbar.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_EDITBAR=101;
/**
* An control whose textual content may be entered or modified by the user.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_ENTRY=102;
/**
* A caption describing another object.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_CAPTION=103;
/**
* A visual frame or container which contains a view of document content. Document frames may occur within another Document instance, in which case the second document may be said to be embedded in the containing instance. HTML frames are often ROLE_DOCUMENT_FRAME. Either this object, or a singleton descendant, should implement the Document interface.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_DOCUMENT_FRAME=104;
/**
* Heading.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_HEADING=105;
/**
* An object representing a page of document content. It is used in documents which are accessed by the user on a page by page basis.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_PAGE=106;
/**
* A container of document content. An example of the use of this role is to represent an html:div.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_SECTION=107;
/**
* An object which is redundant with another object in the accessible hierarchy. ATs typically ignore objects with this role.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_REDUNDANT_OBJECT=108;
/**
* A container of form controls. An example of the use of this role is to represent an html:form.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_FORM=109;
/**
* An object which is used to allow input of characters not found on a keyboard, such as the input of Chinese characters on a Western keyboard.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_IME=110;
/**
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_APP_ROOT=111;
/**
* Represents a menu item, which is an entry in a menu that a user can choose to display another menu.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_PARENT_MENUITEM=112;
/**
* A calendar that allows the user to select a date.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_CALENDAR=113;
/**
* A list of items that is shown by combobox.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_COMBOBOX_LIST=114;
/**
* A item of list that is shown by combobox;
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_COMBOBOX_OPTION=115;
/**
* An image map -- has child links representing the areas.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_IMAGE_MAP=116;
/**
* An option in a listbox.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_OPTION=117;
/**
* A rich option in a listbox, it can have other widgets as children.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_RICH_OPTION=118;
/**
* A list of options.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_LISTBOX=119;
/**
* Represents a mathematical equation in the accessible name.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_FLAT_EQUATION=120;
/**
* Represents a cell within a grid. It is used for role="gridcell". Unlike ROLE_CELL, it allows the calculation of the accessible name from subtree. Also, see ROLE_TABLE.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_GRID_CELL=121;
/**
* Represents an embedded object. It is used for html:object or html:embed.
*
* @constant
*/
Components.interfaces.nsIAccessibleRole.prototype.ROLE_EMBEDDED_OBJECT=122;
/**
* These constants control the scrolling of an object or substring into a window.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleScrollType=function(){};
/**
* Scroll the top left of the object or substring to the top left of the window (or as close as possible).
*
* @constant
*/
Components.interfaces.nsIAccessibleScrollType.prototype.SCROLL_TYPE_TOP_LEFT=0x00;
/**
* Scroll the bottom right of the object or substring to the bottom right of the window (or as close as possible).
*
* @constant
*/
Components.interfaces.nsIAccessibleScrollType.prototype.SCROLL_TYPE_BOTTOM_RIGHT=0x01;
/**
* Scroll the top edge of the object or substring to the top edge of the window (or as close as possible).
*
* @constant
*/
Components.interfaces.nsIAccessibleScrollType.prototype.SCROLL_TYPE_TOP_EDGE=0x02;
/**
* Scroll the bottom edge of the object or substring to the bottom edge of the window (or as close as possible).
*
* @constant
*/
Components.interfaces.nsIAccessibleScrollType.prototype.SCROLL_TYPE_BOTTOM_EDGE=0x03;
/**
* Scroll the left edge of the object or substring to the left edge of the window (or as close as possible).
*
* @constant
*/
Components.interfaces.nsIAccessibleScrollType.prototype.SCROLL_TYPE_LEFT_EDGE=0x04;
/**
* Scroll the right edge of the object or substring to the right edge of the window (or as close as possible).
*
* @constant
*/
Components.interfaces.nsIAccessibleScrollType.prototype.SCROLL_TYPE_RIGHT_EDGE=0x05;
/**
* Scroll an object the minimum amount necessary in order for the entire frame to be visible (if possible).
*
* @constant
*/
Components.interfaces.nsIAccessibleScrollType.prototype.SCROLL_TYPE_ANYWHERE=0x06;
/**
* An interface for the accessibility module and in-process accessibility clients for dealing with getting and changing the selection of accessible nodes.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleSelectable=function(){};
/**
* @constant
*/
Components.interfaces.nsIAccessibleSelectable.prototype.eSelection_Add=0;
/**
* @constant
*/
Components.interfaces.nsIAccessibleSelectable.prototype.eSelection_Remove=1;
/**
* @constant
*/
Components.interfaces.nsIAccessibleSelectable.prototype.eSelection_GetState=2;
/**
* The number of accessible children currently selected. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleSelectable.prototype.selectionCount=0;
/**
* Adds the specified accessible child of the object to the object's selection. If the specified object is already selected, then it does nothing.
*
* @param {Number} index in long index The zero-based accessible child index.
*/
Components.interfaces.nsIAccessibleSelectable.prototype.addChildToSelection=function(index){};
/**
* Clears the selection in the object so that no children in the object are selected.
*
*/
Components.interfaces.nsIAccessibleSelectable.prototype.clearSelection=function(){};
/**
* Returns an nsIArray of the selected nsIAccessible children.
*
*/
Components.interfaces.nsIAccessibleSelectable.prototype.GetSelectedChildren=function(){};
/**
* Determines if the current child of this object is selected.
*
* @param {Number} index in long index The zero-based accessible child index.
*/
Components.interfaces.nsIAccessibleSelectable.prototype.isChildSelected=function(index){};
/**
* Returns a reference to the accessible object representing the specified selected child of the object.
*
* @param {Number} index in long index Zero-based selected accessible child index.
*/
Components.interfaces.nsIAccessibleSelectable.prototype.refSelection=function(index){};
/**
* Removes the specified child of the object from the object's selection. If the specified object was not selected, then it does nothing.
*
* @param {Number} index in long index Zero-based accessible child index.
*/
Components.interfaces.nsIAccessibleSelectable.prototype.removeChildFromSelection=function(index){};
/**
* Select all children.
*
*/
Components.interfaces.nsIAccessibleSelectable.prototype.selectAllSelection=function(){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleStateChangeEvent=function(){};
/**
* Returns the state of accessible (see constants declared in nsIAccessibleStates). Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleStateChangeEvent.prototype.state=0;
/**
*
*
*/
Components.interfaces.nsIAccessibleStateChangeEvent.prototype.isEnabled=function(){};
/**
*
*
*/
Components.interfaces.nsIAccessibleStateChangeEvent.prototype.isExtraState=function(){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleStates=function(){};
/**
* The object is unavailable, that is disabled.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_UNAVAILABLE=0x00000001;
/**
* The object is selected, That is it indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that has been selected.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_SELECTED=0x00000002;
/**
* The object is focused.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_FOCUSED=0x00000004;
/**
* The object is pressed.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_PRESSED=0x00000008;
/**
* The object is checked.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_CHECKED=0x00000010;
/**
* Indicates that the state of a three-state check box or toolbar button is not determined. The check box is neither checked nor unchecked and is therefore in the third or mixed state.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_MIXED=0x00000020;
/**
* The object is designated read-only.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_READONLY=0x00000040;
/**
* The object is hot-tracked by the mouse, which means that its appearance has changed to indicate that the mouse pointer is located over it. Currently unused.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_HOTTRACKED=0x00000080;
/**
* This state represents the default button in a window.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_DEFAULT=0x00000100;
/**
* Children of this object that have the ROLE_OUTLINEITEM role are displayed. (See nsIAccessibleRole.Constants).
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_EXPANDED=0x00000200;
/**
* Children of this object that have the ROLE_OUTLINEITEM role are hidden. (See nsIAccessibleRole.Constants).
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_COLLAPSED=0x00000400;
/**
* The control cannot accept input at this time.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_BUSY=0x00000800;
/**
* Children "owned" not "contained" by parent.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_FLOATING=0x00001000;
/**
* The object is scrolling or moving text or graphics.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_MARQUEED=0x00002000;
/**
* The object's appearance changes rapidly or constantly. Graphics that are occasionally animated are described as ROLE_GRAPHIC (See nsIAccessibleRole.Constants) with the State property set to STATE_ANIMATED. This state is used to indicate that the object's location is changing.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_ANIMATED=0x00004000;
/**
* The object is programmatically hidden. For example, menu items are programmatically hidden until a user activates the menu. Because objects with this state are not available to users, client applications should not communicate information about the object to users. However, if client applications find an object with this state, they should check to see if STATE_OFFSCREEN is also set. If this second state is defined, then clients can communicate the information about the object to users. For example, a list box can have both STATE_INVISIBLE and STATE_OFFSCREEN set. In this case, the client application can communicate all items in the list to users.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_INVISIBLE=0x00008000;
/**
* Scrolled off.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_OFFSCREEN=0x00010000;
/**
* The object can be resized. For example, a user could change the size of a window by clicking the border with a mouse and dragging the mouse.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_SIZEABLE=0x00020000;
/**
* The object can be moved. For example, a user can click on the titlebar for the object and drag the object to a new location.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_MOVEABLE=0x00040000;
/**
* The object or child uses text-to-speech (TTS) technology for description purposes. A speech-based accessibility aid does not announce information when an object with this state has the focus because the object automatically announces information. Currently unused.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_SELFVOICING=0x00080000;
/**
* The object can be focused.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_FOCUSABLE=0x00100000;
/**
* The object can be selected.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_SELECTABLE=0x00200000;
/**
* The object is formatted as a hyperlink. The object role will usually be ROLE_TEXT_LEAF. (See nsIAccessibleRole.Constants).
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_LINKED=0x00400000;
/**
* The object is a hyperlink that has been visited (previously clicked) by a user.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_TRAVERSED=0x00800000;
/**
* Supports multiple selection.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_MULTISELECTABLE=0x01000000;
/**
* Supports extended selection.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_EXTSELECTABLE=0x02000000;
/**
* This information is of low priority.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_ALERT_LOW=0x04000000;
/**
* This information is of medium priority.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_ALERT_MEDIUM=0x08000000;
/**
* This information is of high priority.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_ALERT_HIGH=0x10000000;
/**
* Maps to Gnome's Role* ATK_ROLE_PASSWD_TEXT, nothing for Java?
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_PROTECTED=0x20000000;
/**
* New in MSAA 2.0.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_HASPOPUP=0x40000000;
/**
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_REQUIRED=STATE_ALERT_LOW;
/**
* Currently unused.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_IMPORTANT=STATE_ALERT_MEDIUM;
/**
* Indicates a validation failure.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_INVALID=STATE_ALERT_HIGH;
/**
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.STATE_CHECKABLE=STATE_MARQUEED;
/**
* For editable areas that have any kind of auto completion.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.EXT_STATE_SUPPORTS_AUTOCOMPLETION=0x00000001;
/**
* Object no longer exists.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.EXT_STATE_DEFUNCT=0x00000002;
/**
* For text which is selectable, object must implement nsIAccessibleText.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.EXT_STATE_SELECTABLE_TEXT=0x00000004;
/**
* Implements nsIAccessibleEditableText.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.EXT_STATE_EDITABLE=0x00000008;
/**
* This window is currently the active window.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.EXT_STATE_ACTIVE=0x00000010;
/**
* Must do something with control before leaving it.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.EXT_STATE_MODAL=0x00000020;
/**
* Edit control that can take multiple lines.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.EXT_STATE_MULTI_LINE=0x00000040;
/**
* Uses horizontal layout.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.EXT_STATE_HORIZONTAL=0x00000080;
/**
* Indicates this object paints every pixel within its rectangular region.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.EXT_STATE_OPAQUE=0x00000100;
/**
* This text object can only contain 1 line of text.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.EXT_STATE_SINGLE_LINE=0x00000200;
/**
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.EXT_STATE_TRANSIENT=0x00000400;
/**
* Especially used for sliders and scrollbars.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.EXT_STATE_VERTICAL=0x00000800;
/**
* Object not dead, but not up-to-date either.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.EXT_STATE_STALE=0x00001000;
/**
* A widget that is not unavailable.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.EXT_STATE_ENABLED=0x00002000;
/**
* Same as EXT_STATE_ENABLED for now.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.EXT_STATE_SENSITIVE=0x00004000;
/**
* If COLLAPSED or EXPANDED.
*
* @constant
*/
Components.interfaces.nsIAccessibleStates.prototype.EXT_STATE_EXPANDABLE=0x00008000;
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleTable=function(){};
/**
* The caption accessible for the table. For example, html:caption element of html:table element. Read only.
*
* @type {Components.interfaces.nsIAccessible}
*/
Components.interfaces.nsIAccessibleTable.prototype.caption=new Components.interfaces.nsIAccessible();
/**
* The number of columns in the table. Read only. Renamed from columns in Gecko 1.9.2
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleTable.prototype.columnCount=0;
/**
* Read only. Obsolete since Gecko 1.9.2
*
* @type {Components.interfaces.nsIAccessibleTable}
*/
Components.interfaces.nsIAccessibleTable.prototype.columnHeader=new Components.interfaces.nsIAccessibleTable();
/**
* The number of rows in the table. Read only. Renamed from rows in Gecko 1.9.2
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleTable.prototype.rowCount=0;
/**
* Read only. Obsolete since Gecko 1.9.2
*
* @type {Components.interfaces.nsIAccessibleTable}
*/
Components.interfaces.nsIAccessibleTable.prototype.rowHeader=new Components.interfaces.nsIAccessibleTable();
/**
* The total number of selected cells. Read only. Renamed from selectedCellsCount in Gecko 1.9.2
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleTable.prototype.selectedCellCount=0;
/**
* An array of selected cells. Read only.
*
* @type {Components.interfaces.nsIArray}
*/
Components.interfaces.nsIAccessibleTable.prototype.selectedCells=new Components.interfaces.nsIArray();
/**
* The total number of selected columns. Read only. Renamed from selectedColumnsCount in Gecko 1.9.2
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleTable.prototype.selectedColumnCount=0;
/**
* The total number of selected rows. Read only. Renamed from selectedRowsCount in Gecko 1.9.2
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleTable.prototype.selectedRowCount=0;
/**
* The summary description for the table. For example, @summary attribute on html:table element. Read only.
*
* @type {String}
*/
Components.interfaces.nsIAccessibleTable.prototype.summary="";
/**
* Return the description text of the specified column in the table.
*
* @param {Number} columnIndex in long columnIndex The column index.
*/
Components.interfaces.nsIAccessibleTable.prototype.getColumnDescription=function(columnIndex){};
/**
* Return the number of columns occupied by the accessible cell at the specified row and column in the table. The result differs from 1 if the specified cell spans multiple columns.
*
* @param {Number} row in long row, The row index of the cell.
* @param {Number} column in long column The column index of the cell.
*/
Components.interfaces.nsIAccessibleTable.prototype.getColumnExtentAt=function(row, column){};
/**
* Return the description text of the specified row in the table.
*
* @param {Number} rowIndex in long rowIndex The row index.
*/
Components.interfaces.nsIAccessibleTable.prototype.getRowDescription=function(rowIndex){};
/**
* Return the number of rows occupied by the accessible cell at the specified row and column in the table. The result differs from 1 if the specified cell spans multiple rows.
*
* @param {Number} row in long row, Row index of the cell.
* @param {Number} column in long column Column index of the cell.
*/
Components.interfaces.nsIAccessibleTable.prototype.getRowExtentAt=function(row, column){};
/**
* Return a boolean value indicating whether the specified cell is selected.
*
* @param {Number} rowIndex in long rowIndex, The row index of the cell.
* @param {Number} columnIndex in long columnIndex The column index of the cell.
*/
Components.interfaces.nsIAccessibleTable.prototype.isCellSelected=function(rowIndex, columnIndex){};
/**
* Return a boolean value indicating whether the specified column is selected, that is all cells within the column are selected.
*
* @param {Number} columnIndex in long columnIndex The column index.
*/
Components.interfaces.nsIAccessibleTable.prototype.isColumnSelected=function(columnIndex){};
/**
* Return a boolean value indicating whether the specified row is selected, that is all cells within the row are selected.
*
* @param {Number} rowIndex in long rowIndex The row index.
*/
Components.interfaces.nsIAccessibleTable.prototype.isRowSelected=function(rowIndex){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleTableCell=function(){};
/**
* Return the number of columns occupied by this cell. The result differs from 1 if the specified cell spans multiple columns. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleTableCell.prototype.columnExtent=0;
/**
* Return an array of column header cells for this cell. Read only.
*
* @type {Components.interfaces.nsIArray}
*/
Components.interfaces.nsIAccessibleTableCell.prototype.columnHeaderCells=new Components.interfaces.nsIArray();
/**
* Return column index of this cell. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleTableCell.prototype.columnIndex=0;
/**
* Return the number of rows occupied by this accessible cell. The result differs from 1 if the specified cell spans multiple rows. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleTableCell.prototype.rowExtent=0;
/**
* Return an array of row header cells for this cell. Read only.
*
* @type {Components.interfaces.nsIArray}
*/
Components.interfaces.nsIAccessibleTableCell.prototype.rowHeaderCells=new Components.interfaces.nsIArray();
/**
* Return row index of this cell. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleTableCell.prototype.rowIndex=0;
/**
* Return host table accessible. Read only.
*
* @type {Components.interfaces.nsIAccessibleTable}
*/
Components.interfaces.nsIAccessibleTableCell.prototype.table=new Components.interfaces.nsIAccessibleTable();
/**
*
*
*/
Components.interfaces.nsIAccessibleTableCell.prototype.isSelected=function(){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleTableChangeEvent=function(){};
/**
* Return the number of rows or cols. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleTableChangeEvent.prototype.numRowsOrCols=0;
/**
* Return the row or column index. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleTableChangeEvent.prototype.rowOrColIndex=0;
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleText=function(){};
/**
* Will be treated as the equal to the end of the text.
*
* @constant
*/
Components.interfaces.nsIAccessibleText.prototype.TEXT_OFFSET_END_OF_TEXT=-1;
/**
* Will be treated as the caret position.
*
* @constant
*/
Components.interfaces.nsIAccessibleText.prototype.TEXT_OFFSET_CARET=-2;
/**
* @constant
*/
Components.interfaces.nsIAccessibleText.prototype.BOUNDARY_CHAR=0;
/**
* @constant
*/
Components.interfaces.nsIAccessibleText.prototype.BOUNDARY_WORD_START=1;
/**
* @constant
*/
Components.interfaces.nsIAccessibleText.prototype.BOUNDARY_WORD_END=2;
/**
* Do not use in new code.
*
* @constant
*/
Components.interfaces.nsIAccessibleText.prototype.BOUNDARY_SENTENCE_START=3;
/**
* Do not use in new code.
*
* @constant
*/
Components.interfaces.nsIAccessibleText.prototype.BOUNDARY_SENTENCE_END=4;
/**
* @constant
*/
Components.interfaces.nsIAccessibleText.prototype.BOUNDARY_LINE_START=5;
/**
* @constant
*/
Components.interfaces.nsIAccessibleText.prototype.BOUNDARY_LINE_END=6;
/**
* @constant
*/
Components.interfaces.nsIAccessibleText.prototype.BOUNDARY_ATTRIBUTE_RANGE=7;
/**
* @constant
*/
Components.interfaces.nsIAccessibleText.prototype.COORD_TYPE_SCREEN=0;
/**
* @constant
*/
Components.interfaces.nsIAccessibleText.prototype.COORD_TYPE_WINDOW=1;
/**
* The current current caret offset. If set < 0 then caret will be placed at the end of the text.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleText.prototype.caretOffset=0;
/**
* Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleText.prototype.characterCount=0;
/**
* Return the text attributes that apply to the entire accessible. Read only.
*
* @type {Components.interfaces.nsIPersistentProperties}
*/
Components.interfaces.nsIAccessibleText.prototype.defaultTextAttributes=new Components.interfaces.nsIPersistentProperties();
/**
* Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleText.prototype.selectionCount=0;
/**
*
*
* @param {Number} startOffset in long startOffset,
* @param {Number} endOffset in long endOffset
*/
Components.interfaces.nsIAccessibleText.prototype.addSelection=function(startOffset, endOffset){};
/**
* It would be better to return an unsigned long here, to allow unicode chars > 16 bits.
*
* @param {Number} offset in long offset
*/
Components.interfaces.nsIAccessibleText.prototype.getCharacterAtOffset=function(offset){};
/**
* Returns the bounding box of the specified position.The virtual character after the last character of the represented text, that is the one at position length is a special case. It represents the current input position and will therefore typically be queried by AT more often than other positions. Because it does not represent an existing character its bounding box is defined in relation to preceding characters. It should be roughly equivalent to the bounding box of some character when inserted at the end of the text. Its height typically being the maximal height of all the characters in the text or the height of the preceding character, its width being at least one pixel so that the bounding box is not degenerate.
*
* @param {Number} offset in long offset, Index of the character for which to return its bounding box. The valid range is 0..length.
* @param {Number} x out long x, X coordinate of the bounding box of the referenced character.
* @param {Number} y out long y, Y coordinate of the bounding box of the referenced character.
* @param {Number} width out long width, Width of the bounding box of the referenced character.
* @param {Number} height out long height, Height of the bounding box of the referenced character.
* @param {Number} coordType in unsigned long coordType Specifies if the coordinates are relative to the screen or to the parent window (see constants declared in nsIAccessibleCoordinateType.Constants).
*/
Components.interfaces.nsIAccessibleText.prototype.getCharacterExtents=function(offset, x, y, width, height, coordType){};
/**
* Get the text offset at the given point, or return -1 if no character exists at that point.
*
* @param {Number} x in long x, The position's x value for which to look up the index of the character that is rendered on to the display at that point.
* @param {Number} y in long y, The position's y value for which to look up the index of the character that is rendered on to the display at that point.
* @param {Number} coordType in unsigned long coordType Screen coordinates or window coordinates (see constants declared in nsIAccessibleCoordinateType).
*/
Components.interfaces.nsIAccessibleText.prototype.getOffsetAtPoint=function(x, y, coordType){};
/**
*
*
* @param {Number} selectionNum in long selectionNum,
* @param {Number} startOffset out long startOffset,
* @param {Number} endOffset out long endOffset
*/
Components.interfaces.nsIAccessibleText.prototype.getSelectionBounds=function(selectionNum, startOffset, endOffset){};
/**
* String methods may need to return multibyte-encoded strings, since some locales can not be encoded using 16-bit chars. So this method might return UTF-16 strings, or it could return "string" values which are UTF-8.
*
* @param {Number} startOffset in long startOffset,
* @param {Number} endOffset in long endOffset
*/
Components.interfaces.nsIAccessibleText.prototype.getText=function(startOffset, endOffset){};
/**
* String methods may need to return multibyte-encoded strings, since some locales can't be encoded using 16-bit chars. So this method might return UTF-16 strings, or it could return "string" values which are UTF-8.
*
* @param {Number} offset in long offset,
* @param {Components.interfaces.nsAccessibleTextBoundary} boundaryType in nsAccessibleTextBoundary boundaryType,
* @param {Number} startOffset out long startOffset,
* @param {Number} endOffset out long endOffset
*/
Components.interfaces.nsIAccessibleText.prototype.getTextAfterOffset=function(offset, boundaryType, startOffset, endOffset){};
/**
* String methods may need to return multibyte-encoded strings, since some locales can't be encoded using 16-bit chars. So this method might return UTF-16 strings, or it could return "string" values which are UTF-8.
*
* @param {Number} offset in long offset,
* @param {Components.interfaces.nsAccessibleTextBoundary} boundaryType in nsAccessibleTextBoundary boundaryType,
* @param {Number} startOffset out long startOffset,
* @param {Number} endOffset out long endOffset
*/
Components.interfaces.nsIAccessibleText.prototype.getTextAtOffset=function(offset, boundaryType, startOffset, endOffset){};
/**
* String methods may need to return multibyte-encoded strings, since some locales can't be encoded using 16-bit chars. So this method might return UTF-16 strings, or it could return "string" values which are UTF-8.
*
* @param {Number} offset in long offset,
* @param {Components.interfaces.nsAccessibleTextBoundary} boundaryType in nsAccessibleTextBoundary boundaryType,
* @param {Number} startOffset out long startOffset,
* @param {Number} endOffset out long endOffset
*/
Components.interfaces.nsIAccessibleText.prototype.getTextBeforeOffset=function(offset, boundaryType, startOffset, endOffset){};
/**
*
*
* @param {Number} selectionNum in long selectionNum
*/
Components.interfaces.nsIAccessibleText.prototype.removeSelection=function(selectionNum){};
/**
* Set the bounds for the given selection range.
*
* @param {Number} selectionNum in long selectionNum,
* @param {Number} startOffset in long startOffset,
* @param {Number} endOffset in long endOffset
*/
Components.interfaces.nsIAccessibleText.prototype.setSelectionBounds=function(selectionNum, startOffset, endOffset){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleTextChangeEvent=function(){};
/**
* Returns length of changed text. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleTextChangeEvent.prototype.length=0;
/**
* The inserted or removed text. Read only.
*
* @type {String}
*/
Components.interfaces.nsIAccessibleTextChangeEvent.prototype.modifiedText="";
/**
* Returns offset of changed text in accessible. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleTextChangeEvent.prototype.start=0;
/**
*
*
*/
Components.interfaces.nsIAccessibleTextChangeEvent.prototype.isInserted=function(){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleValue=function(){};
/**
*
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleValue.prototype.currentValue=0;
/**
* Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleValue.prototype.maximumValue=0;
/**
* Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleValue.prototype.minimumIncrement=0;
/**
* Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAccessibleValue.prototype.minimumValue=0;
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessibleWin32Object=function(){};
/**
* Handle to the external window implementing IAccessible. Read only. Native code only!
*
* @type {Object}
*/
Components.interfaces.nsIAccessibleWin32Object.prototype.hwnd={};
/**
* An interface used by in-process accessibility clients to get style, window, markup and other information about a DOM node. When accessibility is active in Gecko, every DOM node can have one nsIAccessNode.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAccessNode=function(){};
/**
* The document accessible that this access node resides in. Read only. Renamed from accessibleDocument in Gecko 2.0
*
* @type {Components.interfaces.nsIAccessibleDocument}
*/
Components.interfaces.nsIAccessNode.prototype.document=new Components.interfaces.nsIAccessibleDocument();
/**
* The DOM node this nsIAccessNode is associated with. Read only.
*
* @type {Object}
*/
Components.interfaces.nsIAccessNode.prototype.DOMNode={};
/**
* The first nsIAccessNode child. Read only. Obsolete since Gecko 2.0
*
* @type {Components.interfaces.nsIAccessNode}
*/
Components.interfaces.nsIAccessNode.prototype.firstChildNode=new Components.interfaces.nsIAccessNode();
/**
* The innerHTML for the DOM node This is a text string of all the markup inside the DOM node, not including the start and end tag for the node. Read only.
*
* @type {String}
*/
Components.interfaces.nsIAccessNode.prototype.innerHTML="";
/**
* The language for the current DOM node, for example en, de, and so on. Read only.
*
* @type {String}
*/
Components.interfaces.nsIAccessNode.prototype.language="";
/**
* The last nsIAccessNode child. Read only. Obsolete since Gecko 2.0
*
* @type {Components.interfaces.nsIAccessNode}
*/
Components.interfaces.nsIAccessNode.prototype.lastChildNode=new Components.interfaces.nsIAccessNode();
/**
* The next nsIAccessNode sibling. Read only. Obsolete since Gecko 2.0
*
* @type {Components.interfaces.nsIAccessNode}
*/
Components.interfaces.nsIAccessNode.prototype.nextSiblingNode=new Components.interfaces.nsIAccessNode();
/**
* The number of DOM children for the DOM node, which matches the number of nsIAccessNode children for this nsIAccessNode. Read only. Obsolete since Gecko 2.0
*
* @type {Number}
*/
Components.interfaces.nsIAccessNode.prototype.numChildren=0;
/**
* The OS window handle for the window this node is being displayed in. Read only. Native code only! Obsolete since Gecko 8.0
*
* @type {Object}
*/
Components.interfaces.nsIAccessNode.prototype.ownerWindow={};
/**
* The parent nsIAccessNode. Read only. Obsolete since Gecko 2.0
*
* @type {Components.interfaces.nsIAccessNode}
*/
Components.interfaces.nsIAccessNode.prototype.parentNode=new Components.interfaces.nsIAccessNode();
/**
* The previous nsIAccessNode sibling. Read only. Obsolete since Gecko 2.0
*
* @type {Components.interfaces.nsIAccessNode}
*/
Components.interfaces.nsIAccessNode.prototype.previousSiblingNode=new Components.interfaces.nsIAccessNode();
/**
* The root document accessible that this access node resides in. Read only.
*
* @type {Components.interfaces.nsIAccessibleDocument}
*/
Components.interfaces.nsIAccessNode.prototype.rootDocument=new Components.interfaces.nsIAccessibleDocument();
/**
* A unique ID calculated for this DOM node, for the purposes of caching and referencing this object. Read only. Native code only!
*
* @type {Object}
*/
Components.interfaces.nsIAccessNode.prototype.uniqueID={};
/**
* Retrieve the computed style value for this DOM node, if it is a DOM element.Note: The meanings of width, height and other size measurements depend on the version of CSS being used. Therefore, for bounds information, it is better to use nsIAccessible.getBounds().
*
* @param {String} pseudoElt in DOMString pseudoElt, The pseudo element to retrieve style for, or null for general computed style information for this node.
* @param {String} propertyName in DOMString propertyName Retrieve the computed style value for this property name, for example "border-bottom".
*/
Components.interfaces.nsIAccessNode.prototype.getComputedStyleValue=function(pseudoElt, propertyName){};
/**
* This interface can be used to notify the user of something that does not require an immediate reaction. For example, it can be used to notify the user that their downloads are complete or that they have new mail.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAlertsService=function(){};
/**
* Displays a notification window.Note: If you are calling this function from JavaScript, you should wrap it in a try/catch because it can fail on Mac OS X prior Firefox 22.
*
* @param {String} imageUrl in AString imageUrl, A URL identifying the image to display in the notification alert.
* @param {String} title in AString title, The title for the alert.
* @param {String} text in AString text, The text to display in the alert, explaining the alert condition. The text must not be too long, otherwise it might be truncated to a platform-specific length. If the text is too long, try to use line returns in the text to have it split and displayed over multiple lines.
* @param {Components.interfaces.boolean textClickable} Optional in boolean textClickable, Optional If true, the text is made to look like a link; if the user clicks on it, the listener is notified.
* @param {Components.interfaces.AString cookie} Optional in AString cookie, Optional A blind cookie the alert passes back to the consumer during alert listener callbacks.
* @param {Components.interfaces.nsIObserver alertListener} Optional in nsIObserver alertListener, Optional An object to receive callbacks from the alert; may be null if you don't care about callbacks. It must implement an observe() method that accepts three parameters: subject: always null. topic: "alertfinished" when the alert disappears, "alertclickcallback" if the user clicks the text or "alertshow" (since Gecko 22) when the alert is shown. data: The value of the cookie parameter passed into the showAlertNotification method.
* @param {Components.interfaces.AString name} Optional in AString name, Optional A name for the notification; this is not displayed in the alert. However, certain notification systems (such as Growl on Mac OS X) allow the user to disable alerts by name. This name is used in that configuration panel. On Android the name is hashed and used as a notification ID.
* @param {Components.interfaces.AString dir} Optional in AString dir, Optional Requires Gecko 22 Bidi override for the title. Valid values are "auto", "ltr" or "rtl". Only available on supported platforms.
* @param {Components.interfaces.AString lang} Optional in AString lang Optional Requires Gecko 22 Language of title and text of the alert. Only available on supported platforms.
*/
Components.interfaces.nsIAlertsService.prototype.showAlertNotification=function(imageUrl, title, text, Optional, Optional, Optional, Optional, Optional, Optional){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAnnotationObserver=function(){};
/**
* This method is called when an annotation is deleted for an item. If aName is empty, then ALL annotations for the given item have been deleted. This is not called when annotations are expired (normally happens when the application exits).
*
* @param {Number} aItemId in long long aItemId, The item whose annotation is to be deleted.
* @param {String} aName in AUTF8String aName The annotation name.
*/
Components.interfaces.nsIAnnotationObserver.prototype.onItemAnnotationRemoved=function(aItemId, aName){};
/**
* This method is called when an annotation value is set for an item. It could be a new annotation, or it could be a new value for an existing annotation.
*
* @param {Number} aItemId in long long aItemId, The item on which the annotation is to be set.
* @param {String} aName in AUTF8String aName The annotation name.
*/
Components.interfaces.nsIAnnotationObserver.prototype.onItemAnnotationSet=function(aItemId, aName){};
/**
* Called when an annotation is deleted for a URI. If aName is empty, then ALL annotations for the given URI have been deleted. This is not called when annotations are expired (normally happens when the application exits).
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI whose annotation is to be deleted.
* @param {String} aName in AUTF8String aName The annotation name.
*/
Components.interfaces.nsIAnnotationObserver.prototype.onPageAnnotationRemoved=function(aURI, aName){};
/**
* This method is called when an annotation value is set for a URI. It could be a new annotation, or it could be a new value for an existing annotation.
*
* @param {Components.interfaces.nsIURI} aPage in nsIURI aPage, The URI on which the annotation is to be set.
* @param {String} aName in AUTF8String aName The annotation name.
*/
Components.interfaces.nsIAnnotationObserver.prototype.onPageAnnotationSet=function(aPage, aName){};
/**
* Stores arbitrary data about a web page. Supported for use from trusted code, such as extensions, but not from web content.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAnnotationService=function(){};
/**
* For temporary data that can be discarded when the user exits. Removed at application exit.
*
* @constant
*/
Components.interfaces.nsIAnnotationService.prototype.EXPIRE_SESSION=0;
/**
* For general page settings, things the user is interested in seeing if they come back to this page some time in the near future. Removed at 30 days.
*
* @constant
*/
Components.interfaces.nsIAnnotationService.prototype.EXPIRE_WEEKS=2;
/**
* Something that the user will be interested in seeing in their history like favicons. If they haven't visited a page in a couple of months, they probably aren't interested in many other annotations, the positions of things, or other stuff you create, so put that in the weeks policy. Removed at 180 days.
*
* @constant
*/
Components.interfaces.nsIAnnotationService.prototype.EXPIRE_MONTHS=3;
/**
* For data that should never expire as long as the URI is in the database.
*
* @constant
*/
Components.interfaces.nsIAnnotationService.prototype.EXPIRE_NEVER=4;
/**
* For annotations that only live as long as the URI is in history (For example, has > 0 visits). This is only valid for page annotations.
*
* @constant
*/
Components.interfaces.nsIAnnotationService.prototype.EXPIRE_WITH_HISTORY=5;
/**
* For short-lived temporary data that you still want to outlast a session. Removed at 7 days.
*
* @constant
*/
Components.interfaces.nsIAnnotationService.prototype.EXPIRE_DAYS=6;
/**
* INT32 type constant.
*
* @constant
*/
Components.interfaces.nsIAnnotationService.prototype.TYPE_INT32=1;
/**
* DOUBLE type constant.
*
* @constant
*/
Components.interfaces.nsIAnnotationService.prototype.TYPE_DOUBLE=2;
/**
* STRING type constant.
*
* @constant
*/
Components.interfaces.nsIAnnotationService.prototype.TYPE_STRING=3;
/**
* BINARY type constant.
*
* @constant
*/
Components.interfaces.nsIAnnotationService.prototype.TYPE_BINARY=4;
/**
* INT64 type constant.
*
* @constant
*/
Components.interfaces.nsIAnnotationService.prototype.TYPE_INT64=5;
/**
* This method sets an annotation for given URI, overwriting any previous annotation with the same URL/name. IT IS YOUR JOB TO NAMESPACE YOUR ANNOTATION NAMES. Use the form "namespace/value", so your name would be like "bills_extension/page_state" or "history/thumbnail".Do not use characters that are not valid in URLs such as spaces, ":", commas, or most other symbols. You should stick to ASCII letters and numbers plus "_", "-", and "/".The annotation "favicon" is special. Favicons are stored in the favicon service, but are special cased in the protocol handler so they look like annotations. Do not set favicons using this service, it will not work.Binary annotations should be set using setItemAnnotationBinary() or setPageAnnotationBinary(). For other types, only C++ consumers may use the type-specific methods.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI on which the annotation is to be set.
* @param {String} aName in AUTF8String aName, The annotation name.
* @param {Components.interfaces.nsIVariant} aValue in nsIVariant aValue, The annotation value.
* @param {Number} aFlags in long aFlags, Should be "0" for now, some flags will be defined in the future.
* @param {Number} aExpiration in unsigned short aExpiration One of the EXPIRE_* constant value defined above.
*/
Components.interfaces.nsIAnnotationService.prototype.setPageAnnotation=function(aURI, aName, aValue, aFlags, aExpiration){};
/**
* This method sets an annotation for given item, overwriting any previous annotation with the same URL/name. IT IS YOUR JOB TO NAMESPACE YOUR ANNOTATION NAMES. Use the form "namespace/value", so your name would be like "bills_extension/page_state" or "history/thumbnail".Do not use characters that are not valid in URLs such as spaces, ":", commas, or most other symbols. You should stick to ASCII letters and numbers plus "_", "-", and "/".The annotation "favicon" is special. Favicons are stored in the favicon service, but are special cased in the protocol handler so they look like annotations. Do not set favicons using this service, it will not work.Binary annotations should be set using setItemAnnotationBinary() or setPageAnnotationBinary(). For other types, only C++ consumers may use the type-specific methods.
*
* @param {Number} aItemId in long long aItemId, The item on which the annotation is to be set.
* @param {String} aName in AUTF8String aName, The annotation name.
* @param {Components.interfaces.nsIVariant} aValue in nsIVariant aValue, The annotation value.
* @param {Number} aFlags in long aFlags, Should be "0" for now, some flags will be defined in the future.
* @param {Number} aExpiration in unsigned short aExpiration One of the EXPIRE_* constant value defined above.
*/
Components.interfaces.nsIAnnotationService.prototype.setItemAnnotation=function(aItemId, aName, aValue, aFlags, aExpiration){};
/**
* This method sets an annotation for given URI by taking a String as input value, overwriting any previous annotation with the same URL/name. IT IS YOUR JOB TO NAMESPACE YOUR ANNOTATION NAMES. Use the form "namespace/value", so your name would be like "bills_extension/page_state" or "history/thumbnail".Do not use characters that are not valid in URLs such as spaces, ":", commas, or most other symbols. You should stick to ASCII letters and numbers plus "_", "-", and "/".The annotation "favicon" is special. Favicons are stored in the favicon service, but are special cased in the protocol handler so they look like annotations. Do not set favicons using this service, it will not work.Binary annotations should be set using setItemAnnotationBinary() or setPageAnnotationBinary(). For other types, only C++ consumers may use the type-specific methods.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI on which the annotation is to be set.
* @param {String} aName in AUTF8String aName, The annotation name.
* @param {String} aValue in AString aValue, The annotation value.
* @param {Number} aFlags in long aFlags, Should be "0" for now, some flags will be defined in the future.
* @param {Number} aExpiration in unsigned short aExpiration One of the EXPIRE_* constant value defined above.
*/
Components.interfaces.nsIAnnotationService.prototype.setPageAnnotationString=function(aURI, aName, aValue, aFlags, aExpiration){};
/**
* This method sets an annotation for given item by taking a String as input value, overwriting any previous annotation with the same URL/name. IT IS YOUR JOB TO NAMESPACE YOUR ANNOTATION NAMES. Use the form "namespace/value", so your name would be like "bills_extension/page_state" or "history/thumbnail".Do not use characters that are not valid in URLs such as spaces, ":", commas, or most other symbols. You should stick to ASCII letters and numbers plus "_", "-", and "/".The annotation "favicon" is special. Favicons are stored in the favicon service, but are special cased in the protocol handler so they look like annotations. Do not set favicons using this service, it will not work.Binary annotations should be set using setItemAnnotationBinary(). For other types, only C++ consumers may use the type-specific methods.
*
* @param {Number} aItemId in long long aItemId, The item on which the annotation is to be set.
* @param {String} aName in AUTF8String aName, The annotation name.
* @param {String} aValue in AString aValue, The annotation value.
* @param {Number} aFlags in long aFlags, Should be "0" for now, some flags will be defined in the future.
* @param {Number} aExpiration in unsigned short aExpiration One of the EXPIRE_* constant value defined above.
*/
Components.interfaces.nsIAnnotationService.prototype.setPageAnnotation=function(aItemId, aName, aValue, aFlags, aExpiration){};
/**
* This method sets an annotation for given URI, just like setPageAnnotationString(), but takes an Int32 as an input.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, undefined
* @param {String} aName in AUTF8String aName, undefined
* @param {Number} aValue in long aValue, undefined
* @param {Number} aFlags in long aFlags, undefined
* @param {Number} aExpiration in unsigned short aExpiration undefined
*/
Components.interfaces.nsIAnnotationService.prototype.setPageAnnotationInt32=function(aURI, aName, aValue, aFlags, aExpiration){};
/**
* This method sets an annotation for given item, just like setItemAnnotationString(), but takes an Int32 as an input.
*
* @param {Number} aItemId in long long aItemId, The item on which the annotation is to be set.
* @param {String} aName in AUTF8String aName, The annotation name.
* @param {Number} aValue in long aValue, The annotation value.
* @param {Number} aFlags in long aFlags, Should be "0" for now, some flags will be defined in the future.
* @param {Number} aExpiration in unsigned short aExpiration One of the EXPIRE_* constant value defined above.
*/
Components.interfaces.nsIAnnotationService.prototype.setItemAnnotationInt32=function(aItemId, aName, aValue, aFlags, aExpiration){};
/**
* This method sets an annotation for given URI, just like setPageAnnotationString(), but takes an Int64 as an input.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI on which the annotation is to be set.
* @param {String} aName in AUTF8String aName, The annotation name.
* @param {Number} aValue in long long aValue, The annotation value.
* @param {Number} aFlags in long aFlags, Should be "0" for now, some flags will be defined in the future.
* @param {Number} aExpiration in unsigned short aExpiration One of the EXPIRE_* constant value defined above.
*/
Components.interfaces.nsIAnnotationService.prototype.setPageAnnotationInt64=function(aURI, aName, aValue, aFlags, aExpiration){};
/**
* This method sets an annotation for given item, just like setItemAnnotationString(), but takes an Int64 as an input.
*
* @param {Number} aItemId in long long aItemId, The item on which the annotation is to be set.
* @param {String} aName in AUTF8String aName, The annotation name.
* @param {Number} aValue in long long aValue, The annotation value.
* @param {Number} aFlags in long aFlags, Should be "0" for now, some flags will be defined in the future.
* @param {Number} aExpiration in unsigned short aExpiration One of the EXPIRE_* constant value defined above.
*/
Components.interfaces.nsIAnnotationService.prototype.setItemAnnotationInt64=function(aItemId, aName, aValue, aFlags, aExpiration){};
/**
* This method sets an annotation for given URI, just like setPageAnnotationString(), but takes an Double as an input.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI on which the annotation is to be set.
* @param {String} aName in AUTF8String aName, The annotation name.
* @param {Number} aValue in double aValue, The annotation value.
* @param {Number} aFlags in long aFlags, Should be "0" for now, some flags will be defined in the future.
* @param {Number} aExpiration in unsigned short aExpiration One of the EXPIRE_* constant value defined above.
*/
Components.interfaces.nsIAnnotationService.prototype.setPageAnnotationDouble=function(aURI, aName, aValue, aFlags, aExpiration){};
/**
* This method sets an annotation for given item, just like setItemAnnotationString(), but takes an Double as an input.
*
* @param {Number} aItemId in long long aItemId, The item on which the annotation is to be set.
* @param {String} aName in AUTF8String aName, The annotation name.
* @param {Number} aValue in double aValue, The annotation value.
* @param {Number} aFlags in long aFlags, Should be "0" for now, some flags will be defined in the future.
* @param {Number} aExpiration in unsigned short aExpiration One of the EXPIRE_* constant value defined above.
*/
Components.interfaces.nsIAnnotationService.prototype.setItemAnnotationDouble=function(aItemId, aName, aValue, aFlags, aExpiration){};
/**
* This method sets an annotation for given URI, just like setPageAnnotationString(), but takes Binary data as an input. You MUST supply a valid MIME type.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI on which the annotation is to be set.
* @param {String} aName in AUTF8String aName, The annotation name.
* @param {Number} aData [const,array,size_is(aDataLen] in octet aData, Binary contents of the page to save.
* @param {Number} aDataLen in unsigned long aDataLen, Length of binary data.
* @param {String} aMimeType in AUTF8String aMimeType, MIME type of the data to store. MUST be supplied.
* @param {Number} aFlags in long aFlags, Should be "0" for now, some flags will be defined in the future.
* @param {Number} aExpiration in unsigned short aExpiration One of the EXPIRE_* constant value defined above.
*/
Components.interfaces.nsIAnnotationService.prototype.setPageAnnotationBinary=function(aURI, aName, aData, aDataLen, aMimeType, aFlags, aExpiration){};
/**
* This method sets an annotation for given item, just like setItemAnnotationString(), but takes Binary data as an input. You MUST supply a valid MIME type.
*
* @param {Number} aItemId in long long aItemId, The item on which the annotation is to be set.
* @param {String} aName in AUTF8String aName, The annotation name.
* @param {Number} aData [const,array,size_is(aDataLen] in octet aData, Binary contents of the item to save.
* @param {Number} aDataLen in unsigned long aDataLen, Length of binary data.
* @param {String} aMimeType in AUTF8String aMimeType, MIME type of the data to store. MUST be supplied.
* @param {Number} aFlags in long aFlags, Should be "0" for now, some flags will be defined in the future.
* @param {Number} aExpiration in unsigned short aExpiration One of the EXPIRE_* constant value defined above.
*/
Components.interfaces.nsIAnnotationService.prototype.setItemAnnotationBinary=function(aItemId, aName, aData, aDataLen, aMimeType, aFlags, aExpiration){};
/**
* This method retrieves the value of a given URI annotation. Throws an error if the annotation does not exist. Throws for binary annotations, for which getPageAnnotationBinary() or getItemAnnotationBinary() should be used. C++ consumers may use the type-specific methods. The type-specific methods throw if the given annotation is set in a different type.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI on which the annotation is set.
* @param {String} aName in AUTF8String aName The annotation name.
*/
Components.interfaces.nsIAnnotationService.prototype.getPageAnnotation=function(aURI, aName){};
/**
* This method retrieves the value of a given item annotation. Throws an error if the annotation does not exist. Throws for binary annotations, for which getPageAnnotationBinary() or getItemAnnotationBinary() should be used. C++ consumers may use the type-specific methods. The type-specific methods throw if the given annotation is set in a different type.
*
* @param {Number} aItemId in long long aItemId, undefined
* @param {String} aName in AUTF8String aName undefined
*/
Components.interfaces.nsIAnnotationService.prototype.getItemAnnotation=function(aItemId, aName){};
/**
* This method retrieves the value of a given URI annotation in String format. Throws an error if the annotation does not exist. Throws for binary annotations, for which getPageAnnotationBinary() or getItemAnnotationBinary() should be used. C++ consumers may use the type-specific methods. The type-specific methods throw if the given annotation is set in a different type.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI on which the annotation is set.
* @param {String} aName in AUTF8String aName The annotation name.
*/
Components.interfaces.nsIAnnotationService.prototype.getPageAnnotationString=function(aURI, aName){};
/**
* This method retrieves the value of a given item annotation in String format. Throws an error if the annotation does not exist. Throws for binary annotations, for which getPageAnnotationBinary() or getItemAnnotationBinary() should be used. C++ consumers may use the type-specific methods. The type-specific methods throw if the given annotation is set in a different type.
*
* @param {Number} aItemId in long long aItemId, The item on which the annotation is set.
* @param {String} aName in AUTF8String aName The annotation name.
*/
Components.interfaces.nsIAnnotationService.prototype.getItemAnnotationString=function(aItemId, aName){};
/**
* This method retrieves the value of a given URI annotation in a Int32 format. Throws an error if the annotation does not exist. Throws for binary annotations, for which getPageAnnotationBinary() or getItemAnnotationBinary() should be used. C++ consumers may use the type-specific methods. The type-specific methods throw if the given annotation is set in a different type.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, undefined
* @param {String} aName in AUTF8String aName undefined
*/
Components.interfaces.nsIAnnotationService.prototype.getPageAnnotationInt32=function(aURI, aName){};
/**
* This method retrieves the value of a given item annotation in a Int32 format. Throws an error if the annotation does not exist. Throws for binary annotations, for which getPageAnnotationBinary() or getItemAnnotationBinary() should be used. C++ consumers may use the type-specific methods. The type-specific methods throw if the given annotation is set in a different type.
*
* @param {Number} aItemId in long long aItemId, undefined
* @param {String} aName in AUTF8String aName undefined
*/
Components.interfaces.nsIAnnotationService.prototype.getItemAnnotationInt32=function(aItemId, aName){};
/**
* This method retrieves the value of a given URI annotation in a Int64 format. Throws an error if the annotation does not exist. Throws for binary annotations, for which getPageAnnotationBinary() or getItemAnnotationBinary() should be used. C++ consumers may use the type-specific methods. The type-specific methods throw if the given annotation is set in a different type.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, undefined
* @param {String} aName in AUTF8String aName undefined
*/
Components.interfaces.nsIAnnotationService.prototype.getPageAnnotationInt64=function(aURI, aName){};
/**
* This method retrieves the value of a given item annotation in a Int64 format. Throws an error if the annotation does not exist. Throws for binary annotations, for which getPageAnnotationBinary() or getItemAnnotationBinary() should be used. C++ consumers may use the type-specific methods. The type-specific methods throw if the given annotation is set in a different type.
*
* @param {Number} aItemId in long long aItemId, The item on which the annotation is set.
* @param {String} aName in AUTF8String aName The annotation name.
*/
Components.interfaces.nsIAnnotationService.prototype.getItemAnnotationInt64=function(aItemId, aName){};
/**
* This method retrieves the value of a given URI annotation in Double format. Throws an error if the annotation does not exist. Throws for binary annotations, for which getPageAnnotationBinary() or getItemAnnotationBinary() should be used. C++ consumers may use the type-specific methods. The type-specific methods throw if the given annotation is set in a different type.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI on which the annotation is set.
* @param {String} aName in AUTF8String aName The annotation name.
*/
Components.interfaces.nsIAnnotationService.prototype.getPageAnnotationDouble=function(aURI, aName){};
/**
* This method retrieves the value of a given item annotation in Double format. Throws an error if the annotation does not exist. Throws for binary annotations, for which getPageAnnotationBinary() or getItemAnnotationBinary() should be used. C++ consumers may use the type-specific methods. The type-specific methods throw if the given annotation is set in a different type.
*
* @param {Number} aItemId in long long aItemId, The item on which the annotation is set.
* @param {String} aName in AUTF8String aName The annotation name.
*/
Components.interfaces.nsIAnnotationService.prototype.getItemAnnotationDouble=function(aItemId, aName){};
/**
* This method retrieves the value of a given URI annotation in a Binary format. Throws an error if the annotation does not exist. Throws for binary annotations, for which getPageAnnotationBinary() or getItemAnnotationBinary() should be used. C++ consumers may use the type-specific methods. The type-specific methods throw if the given annotation is set in a different type. This also returns the MIME type.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI on which the annotation is set.
* @param {String} aName in AUTF8String aName, The annotation name.
* @param {Number} aData [array,size_is(aDataLen] out octet aData, Binary contents of the page to retrieve.
* @param {Number} aDataLen out unsigned long aDataLen, Length of binary data.
* @param {String} aMimeType out AUTF8String aMimeType MIME type of the data to be retrieved.
*/
Components.interfaces.nsIAnnotationService.prototype.getPageAnnotationBinary=function(aURI, aName, aData, aDataLen, aMimeType){};
/**
* This method retrieves the value of a given item annotation in a Binary format. Throws an error if the annotation does not exist. Throws for binary annotations, for which getPageAnnotationBinary() or getItemAnnotationBinary() should be used. C++ consumers may use the type-specific methods. The type-specific methods throw if the given annotation is set in a different type. This also returns the MIME type.
*
* @param {Number} aItemId in long long aItemId, The item on which the annotation is set.
* @param {String} aName in AUTF8String aName, The annotation name.
* @param {Number} aData [array,size_is(aDataLen] out octet aData, Binary contents of the item to retrieve.
* @param {Number} aDataLen out unsigned long aDataLen, Length of binary data.
* @param {String} aMimeType out AUTF8String aMimeType MIME type of the data to be retrieved.
*/
Components.interfaces.nsIAnnotationService.prototype.getItemAnnotationBinary=function(aItemId, aName, aData, aDataLen, aMimeType){};
/**
* This method retrieves info about an existing annotation for the given URI.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI on which the annotation is set.
* @param {String} aName in AUTF8String aName, The annotation name.
* @param {Number} aFlags out PRInt32 aFlags, Should be "0" for now, some flags will be defined in the future.
* @param {Number} aExpiration out unsigned short aExpiration, One of the EXPIRE_* constant value defined above.
* @param {String} aMimeType out AUTF8String aMimeType, MIME type of the data to be retrieved. Default to "0" if value was not binary data.
* @param {Number} aType out unsigned short aType One of TYPE_* constansts defined above.
*/
Components.interfaces.nsIAnnotationService.prototype.getPageAnnotationInfo=function(aURI, aName, aFlags, aExpiration, aMimeType, aType){};
/**
* This method retrieves info about an existing annotation for the given item.
*
* @param {Number} aItemId in long long aItemId, undefined
* @param {String} aName in AUTF8String aName, undefined
* @param {Number} aFlags out long aFlags, undefined
* @param {Number} aExpiration out unsigned short aExpiration, undefined
* @param {String} aMimeType out AUTF8String aMimeType, undefined
* @param {Number} aType out unsigned short aType undefined
*/
Components.interfaces.nsIAnnotationService.prototype.getItemAnnotationInfo=function(aItemId, aName, aFlags, aExpiration, aMimeType, aType){};
/**
* This method retrieves the type of an existing annotation. Use getAnnotationInfo() method, if you need this along with the mime-type etc. It throwns an exception if the annotation is not set.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI on which the annotation is set.
* @param {String} aName in AUTF8String aName The annotation name.
*/
Components.interfaces.nsIAnnotationService.prototype.getPageAnnotationType=function(aURI, aName){};
/**
* This method retrieves the type of an existing annotation. Use getAnnotationInfo() method, if you need this along with the mime-type etc. It throwns an exception if the annotation is not set.
*
* @param {Number} aItemId in long long aItemId, The item on which the annotation is set.
* @param {String} aName in AUTF8String aName The annotation name.
*/
Components.interfaces.nsIAnnotationService.prototype.getPageAnnotationType=function(aItemId, aName){};
/**
* This method returns a list of all URIs having a given annotation.
*
* @param {String} name in AUTF8String name, The annotation name.
* @param {Number} resultCount [optional] out unsigned long resultCount, Count of URIs.
* @param {Components.interfaces.nsIURI} results [retval, array, size_is(resultCount] out nsIURI results Returns the list of all URIs.
*/
Components.interfaces.nsIAnnotationService.prototype.getPagesWithAnnotation=function(name, resultCount, results){};
/**
* This method returns a list of all items having a given annotation.
*
* @param {String} name in AUTF8String name, The annotation name.
* @param {Number} resultCount [optional] out unsigned long resultCount, Count of items.
* @param {Number} results [retval, array, size_is(resultCount] out long long results Returns the list of all items.
*/
Components.interfaces.nsIAnnotationService.prototype.getItemsWithAnnotation=function(name, resultCount, results){};
/**
* This method retrieves the names of all annotations for the given URI.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI on which the annotation is set.
* @param {Number} count [optional] out unsigned long count, Count of annotation names available.
* @param {Components.interfaces.nsIVariant} result [retval, array, size_is(count] out nsIVariant result Returns the name of all annotations.
*/
Components.interfaces.nsIAnnotationService.prototype.getPageAnnotationNames=function(aURI, count, result){};
/**
* This method retrieves the names of all annotations for the given item.
*
* @param {Number} aItemId in long long aItemId, The item on which the annotation is set.
* @param {Number} count [optional] out unsigned long count, Count of annotations name available.
* @param {Components.interfaces.nsIVariant} result [retval, array, size_is(count] out nsIVariant result Returns the name of all annotations.
*/
Components.interfaces.nsIAnnotationService.prototype.getItemAnnotationNames=function(aItemId, count, result){};
/**
* This method tests for annotation existance for given URI.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI on which the annotation is set.
* @param {String} aName in AUTF8String aName The annotation name.
*/
Components.interfaces.nsIAnnotationService.prototype.pageHasAnnotation=function(aURI, aName){};
/**
* This method tests for annotation existance for given item.
*
* @param {Number} aItemId in long long aItemId, The item on which the annotation is set.
* @param {String} aName in AUTF8String aName The annotation name.
*/
Components.interfaces.nsIAnnotationService.prototype.itemHasAnnotation=function(aItemId, aName){};
/**
* This method removes a specific annotation for given URI. Succeeds even if the annotation is not found.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI on which the annotation is set.
* @param {String} aName in AUTF8String aName The annotation name.
*/
Components.interfaces.nsIAnnotationService.prototype.removePageAnnotation=function(aURI, aName){};
/**
* This method removes a specific annotation for given item. Succeeds even if the annotation is not found.
*
* @param {Number} aItemId in long long aItemId, The item on which the annotation is set.
* @param {String} aName in AUTF8String aName The annotation name.
*/
Components.interfaces.nsIAnnotationService.prototype.removeItemAnnotation=function(aItemId, aName){};
/**
* This method removes all annotations for the given URI. We may want some other similar functions to get annotations with given flags (once we have flags defined).
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI The URI on which the annotation is set.
*/
Components.interfaces.nsIAnnotationService.prototype.removePageAnnotations=function(aURI){};
/**
* This method removes all annotations for the given item. We may want some other similar functions to get annotations with given flags (once we have flags defined).
*
* @param {Number} aItemId in long long aItemId The item on which the annotation is set.
*/
Components.interfaces.nsIAnnotationService.prototype.removeItemAnnotations=function(aItemId){};
/**
* This method copies all annotations from the source to the destination URI. If the destination already has an annotation with the same name as one on the source, it will be overwritten if aOverwriteDest is set. Otherwise, the destination URIs will be preferred.All the source annotations will stay as-is. If you don't want them any more, use removePageAnnotations() on that URI.
*
* @param {Components.interfaces.nsIURI} aSourceURI in nsIURI aSourceURI, Source item.
* @param {Components.interfaces.nsIURI} aDestURI in nsIURI aDestURI, Destination item.
* @param {Boolean} aOverwriteDest in boolean aOverwriteDest If you want to overwrite existing annotation, set this parameter to true, or else set it to false.
*/
Components.interfaces.nsIAnnotationService.prototype.copyPageAnnotations=function(aSourceURI, aDestURI, aOverwriteDest){};
/**
* This method copies all annotations from the source to the destination item. If the destination already has an annotation with the same name as one on the source, it will be overwritten if aOverwriteDest is set. Otherwise, the destination URIs will be preferred.All the source annotations will stay as-is. If you don't want them any more, use removePageAnnotations() on that URI.
*
* @param {Number} aSourceItemId in long long aSourceItemId, Source item.
* @param {Number} aDestItemId in long long aDestItemId, Destination item.
* @param {Boolean} aOverwriteDest in boolean aOverwriteDest If you want to overwrite existing annotation, set this parameter to true or else false.
*/
Components.interfaces.nsIAnnotationService.prototype.copyItemAnnotations=function(aSourceItemId, aDestItemId, aOverwriteDest){};
/**
* This method adds an annotation observer. The annotation service will keep an owning reference to the observer object.
*
* @param {Components.interfaces.nsIAnnotationObserver} aObserver in nsIAnnotationObserver aObserver Annotation observer.
*/
Components.interfaces.nsIAnnotationService.prototype.addObserver=function(aObserver){};
/**
* This method removes an annotaton observer previously registered by addObserver() method.
*
* @param {Components.interfaces.nsIAnnotationObserver} aObserver in nsIAnnotationObserver aObserver Annotation observer.
*/
Components.interfaces.nsIAnnotationService.prototype.removeObserver=function(aObserver){};
/**
* This method returns a URI that can be used to access the given binary annotation. This method does NOT check that the annotation exists. Also, note that you can only load URIs for annotations that have have a valid MIME type set by setPageAnnotationBinary() or setItemAnnotationBinary() methods. No non-URI valid chars in name, especially colon, which will mess up parsing.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI on which the annotation is set.
* @param {String} aName in AUTF8String aName The annotation name.
*/
Components.interfaces.nsIAnnotationService.prototype.getAnnotationURI=function(aURI, aName){};
/**
* This interface represents an application cache, which stores resources for offline use.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIApplicationCache=function(){};
/**
* This item is the application manifest.
*
* @constant
*/
Components.interfaces.nsIApplicationCache.prototype.ITEM_MANIFEST=1;
/**
* This item was explicitly listed in the application manifest.
*
* @constant
*/
Components.interfaces.nsIApplicationCache.prototype.ITEM_EXPLICIT=2;
/**
* This item was navigated to in a top level browsing context, and named this cache's group as its manifest.
*
* @constant
*/
Components.interfaces.nsIApplicationCache.prototype.ITEM_IMPLICIT=4;
/**
* This item was added to the cache using the dynamic scripting API.
*
* @constant
*/
Components.interfaces.nsIApplicationCache.prototype.ITEM_DYNAMIC=8;
/**
* This item was listed in the application manifest, but named a different cache group as its manifest.
*
* @constant
*/
Components.interfaces.nsIApplicationCache.prototype.ITEM_FOREIGN=16;
/**
* This item was listed as a fallback entry.
*
* @constant
*/
Components.interfaces.nsIApplicationCache.prototype.ITEM_FALLBACK=32;
/**
* This item matched an opportunistic cache namespace and was cached for that reason.
*
* @constant
*/
Components.interfaces.nsIApplicationCache.prototype.ITEM_OPPORTUNISTIC=64;
/**
* true if the cache is the active cache for this group, otherwise false. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIApplicationCache.prototype.active=false;
/**
* The client ID for this application cache. Clients can open a session with nsICacheService.createSession() using this client ID and a storage policy of STORE_OFFLINE to access this cache. Read only.
*
* @type {String}
*/
Components.interfaces.nsIApplicationCache.prototype.clientID="";
/**
* The group ID for this cache group. This is the URI of the cache manifest file. Read only.
*
* @type {String}
*/
Components.interfaces.nsIApplicationCache.prototype.groupID="";
/**
* The disk usage of the application cache, in bytes. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIApplicationCache.prototype.usage=0;
/**
* Makes this cache the active application cache for this group. Future loads associated with this group will come from this cache. Other caches from this cache group will be deactivated.
*
*/
Components.interfaces.nsIApplicationCache.prototype.activate=function(){};
/**
* Add a set of namespace entries to the application cache.
*
* @param {Components.interfaces.nsIArray} namespaces in nsIArray namespaces An nsIArray of nsIApplicationCacheNamespace objects describing the namespaces to add to the cache.
*/
Components.interfaces.nsIApplicationCache.prototype.addNamespaces=function(namespaces){};
/**
* Discards this application cache. This removes all resources it has cached. If this is the active application cache for the group, the group is removed.
*
*/
Components.interfaces.nsIApplicationCache.prototype.discard=function(){};
/**
* Returns a list of entries in the cache whose type matches one or more of the specified types.
*
* @param {Number} typeBits in PRUint32 typeBits, A bit field indicating the types against which to match. See Constants for a list of types.
* @param {Number} count out unsigned long count, On return, indicates how many matching entries were found.
* @param {String} keys [array, size_is(count] out string keys An array of the keys matching one or more of the types indicated by typeBits.
*/
Components.interfaces.nsIApplicationCache.prototype.gatherEntries=function(typeBits, count, keys){};
/**
* Returns the most specific namespace matching a given key.
*
* @param {String} key in ACString key The key for the cache entry whose most specific namespace is to be returned.
*/
Components.interfaces.nsIApplicationCache.prototype.getMatchingNamespace=function(key){};
/**
* Gets the types for a given entry in the cache.
*
* @param {String} key in ACString key The key for the cache entry whose types you wish to retrieve.
*/
Components.interfaces.nsIApplicationCache.prototype.getTypes=function(key){};
/**
* Adds item types to a given entry.
*
* @param {String} key in ACString key, The key for the cache entry to which to add types.
* @param {Number} typeBits in unsigned long typeBits A bit field indicating the types to add to the entry. See Constants for a list of types.
*/
Components.interfaces.nsIApplicationCache.prototype.markEntry=function(key, typeBits){};
/**
* Removes types from a given entry. If the resulting entry has no types left, the entry is removed.
*
* @param {String} key in ACString key, The key for the cache entry from which to remove types.
* @param {Number} typeBits in unsigned long typeBits A bit field indicating the types to remove from the entry. See Constants for a list of types.
*/
Components.interfaces.nsIApplicationCache.prototype.unmarkEntry=function(key, typeBits){};
/**
* This interface is implemented by communication channels that support application caches.
*
* @constructor
* @inherits {Components.interfaces.nsIApplicationCacheContainer}
*/
Components.interfaces.nsIApplicationCacheChannel=function(){};
/**
* When true, the channel will choose an application cache if one was not explicitly provided and none is available from the notification callbacks. The default value is false. This attribute will not be transferred through a redirect. Exceptions thrown NS_ERROR_ALREADY_OPENED If set after calling AsyncOpen() on the channel.
*
* @type {Boolean}
*/
Components.interfaces.nsIApplicationCacheChannel.prototype.chooseApplicationCache=false;
/**
* true if the channel will ask its notification callbacks for an application cache if one is not explicitly provided. The default value is true. Exceptions thrown NS_ERROR_ALREADY_OPENED If set after calling AsyncOpen() on the channel.
*
* @type {Boolean}
*/
Components.interfaces.nsIApplicationCacheChannel.prototype.inheritApplicationCache=false;
/**
* true if the resource was loaded from the application cache, otherwise false. This value may be false even if the resource is assigned to an application cache if, for example, it was loaded as a fallback. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIApplicationCacheChannel.prototype.loadedFromApplicationCache=false;
/**
* This interface is used by objects that can be associated with an application cache.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIApplicationCacheContainer=function(){};
/**
* The application cache with which the object is associated.
*
* @type {Components.interfaces.nsIApplicationCache}
*/
Components.interfaces.nsIApplicationCacheContainer.prototype.applicationCache=new Components.interfaces.nsIApplicationCache();
/**
* This interface represents an application cache namespace.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIApplicationCacheNamespace=function(){};
/**
* Items matching this namespace can be fetched from the network when loading from this cache. The data attribute is not used.
*
* @constant
*/
Components.interfaces.nsIApplicationCacheNamespace.prototype.NAMESPACE_BYPASS=1;
/**
* Items matching this namespace can be fetched from the network when loading from this cache; however, if the load fails, the cache entry specified by the data attribute should be loaded intstead.
*
* @constant
*/
Components.interfaces.nsIApplicationCacheNamespace.prototype.NAMESPACE_FALLBACK=2;
/**
* Items matching this namespace should be cached opportunistically. Successful top-level loads of resources in this namespace should be placed into the application cache. This can be combined with NAMESPACE_FALLBACK to provide a fallback entry in the data attribute.
*
* @constant
*/
Components.interfaces.nsIApplicationCacheNamespace.prototype.NAMESPACE_OPPORTUNISTIC=4;
/**
* Data associated with the namespace, such as a fallback. How this attribute is used varies depending on the namespace type. If the data is a URI, this attribute should be the URI's asciiSpec. Read only.
*
* @type {String}
*/
Components.interfaces.nsIApplicationCacheNamespace.prototype.data="";
/**
* A bit field indicating one or more namespace types. Must be one or more of the constants defined under Constants on this page. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIApplicationCacheNamespace.prototype.itemType=0;
/**
* The prefix of this namespace. This should be the asciiSpec of the URI prefix. Read only.
*
* @type {String}
*/
Components.interfaces.nsIApplicationCacheNamespace.prototype.namespaceSpec="";
/**
* Initializes the namespace.
*
* @param {Number} itemType in unsigned long itemType, The namespace type.
* @param {String} namespaceSpec in ACString namespaceSpec, The namespace's prefix.
* @param {String} data in ACString data The data to associate with the namespace.
*/
Components.interfaces.nsIApplicationCacheNamespace.prototype.init=function(itemType, namespaceSpec, data){};
/**
* This interface manages the set of application cache groups that manage offline resources for web applications.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIApplicationCacheService=function(){};
/**
* Flags the specified key as one that should be cached opportunistically.Note: This method should propagate the entry to other application caches with the same opportunistic namespace; however, this is not currently implemented.
*
* @param {Components.interfaces.nsIApplicationCache} cache in nsIApplicationCache cache, The cache in which the entry is currently cached.
* @param {String} key in ACString key The cache entry's key.
*/
Components.interfaces.nsIApplicationCacheService.prototype.cacheOpportunistically=function(cache, key){};
/**
* Tries to find the best application cache to serve a specified resource.
*
* @param {String} key in ACString key The cache entry key for which to select an application cache.
*/
Components.interfaces.nsIApplicationCacheService.prototype.chooseApplicationCache=function(key){};
/**
* Creates a new, empty application cache for the specified cache group.
*
* @param {String} group in ACString group The cache group for which to create an application cache.
*/
Components.interfaces.nsIApplicationCacheService.prototype.createApplicationCache=function(group){};
/**
* Deactivates the currently active cache object for the specified cache group.
*
* @param {String} group in ACString group The cache group to deactivate.
*/
Components.interfaces.nsIApplicationCacheService.prototype.deactivateGroup=function(group){};
/**
* Returns the currently active cache object for a cache group.
*
* @param {String} group in ACString group The cache group for which to return an application cache.
*/
Components.interfaces.nsIApplicationCacheService.prototype.getActiveCache=function(group){};
/**
* Returns the nsIApplicationCache object for the specified client ID.
*
* @param {String} clientID in ACString clientID The client ID for which to return the application cache object.
*/
Components.interfaces.nsIApplicationCacheService.prototype.getApplicationCache=function(clientID){};
/**
* Returns the list of application cache groups.
*
* @param {Components.interfaces.unsigned long count} Optional out unsigned long count, Optional The count of the application cache groups.
* @param {String} groupIDs [array, size_is(count, retval] out string groupIDs The list of application cache groups.
*/
Components.interfaces.nsIApplicationCacheService.prototype.getGroups=function(Optional, groupIDs){};
/**
* This interface describes a global application service that handles performing background update checks. It also provides utilities for selecting and downloading update patches.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIApplicationUpdateService=function(){};
/**
* The update checker being used for background update checking. Read only.
*
* @type {Components.interfaces.nsIUpdateChecker}
*/
Components.interfaces.nsIApplicationUpdateService.prototype.backgroundChecker=new Components.interfaces.nsIUpdateChecker();
/**
* true if the Update Service can download and install updates. Indicates if the current user has access privileges to the install directory. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIApplicationUpdateService.prototype.canApplyUpdates=false;
/**
* true if the Update Service can check for updates. Application updates might be disabled by the application and the platform the application is running on. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIApplicationUpdateService.prototype.canCheckForUpdates=false;
/**
* true if the update service is able to download and install updates. This depends on whether or not the current user has the necessary access privileges for the install directory. Read only. Obsolete since Gecko 1.9.1.7pre
*
* @type {Boolean}
*/
Components.interfaces.nsIApplicationUpdateService.prototype.canUpdate=false;
/**
* true if a download is in progress, otherwise false. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIApplicationUpdateService.prototype.isDownloading=false;
/**
* Adds a listener that receives progress and state information about the update that is currently being downloaded. This information is most commonly used to update a user interface that informs the user as to the status of an update.
*
* @param {Components.interfaces.nsIRequestObserver} listener in nsIRequestObserver listener An object implementing nsIRequestObserver and optionally nsIProgressEventSink that will be notified of state and progress information as the update is downloaded.
*/
Components.interfaces.nsIApplicationUpdateService.prototype.addDownloadListener=function(listener){};
/**
* Starts downloading a software update.
*
* @param {Components.interfaces.nsIUpdate} update in nsIUpdate update, An nsIUpdate object indicating the update to download.
* @param {Boolean} background in boolean background true to download the update in the background or false to download it in the foreground.
*/
Components.interfaces.nsIApplicationUpdateService.prototype.downloadUpdate=function(update, background){};
/**
* Pauses the currently active update download.
*
*/
Components.interfaces.nsIApplicationUpdateService.prototype.pauseDownload=function(){};
/**
* Removes a listener that is receiving progress and state information about the update that is currently being downloaded.
*
* @param {Components.interfaces.nsIRequestObserver} listener in nsIRequestObserver listener The listener object to remove.
*/
Components.interfaces.nsIApplicationUpdateService.prototype.removeDownloadListener=function(listener){};
/**
* Selects the best update to install from a provided list of available updates.
*
* @param {Components.interfaces.nsIUpdate} updates [array, size_is(updateCount] in nsIUpdate updates, An array of updates that are available to install.
* @param {Number} updateCount in unsigned long updateCount The number of updates in the updates array.
*/
Components.interfaces.nsIApplicationUpdateService.prototype.selectUpdate=function(updates, updateCount){};
/**
* Provides the AppShellService.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAppShellService=function(){};
/**
* Create a window, which will be initially invisible.
*
* @constant
*/
Components.interfaces.nsIAppShellService.prototype.SIZE_TO_CONTENT=-1;
/**
* Attempt to quit if all windows are closed. Obsolete since Gecko 1.8
*
* @constant
*/
Components.interfaces.nsIAppShellService.prototype.eConsiderQuit=1;
/**
* Try to close all windows, then quit if successful. Obsolete since Gecko 1.8
*
* @constant
*/
Components.interfaces.nsIAppShellService.prototype.eAttemptQuit=2;
/**
* Force all windows to close, then quit. Obsolete since Gecko 1.8
*
* @constant
*/
Components.interfaces.nsIAppShellService.prototype.eForceQuit=3;
/**
* Return true if the application hidden window was provided by the application. If it was not, the default hidden window was used. This will usually be false on all non-mac platforms. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIAppShellService.prototype.applicationProvidedHiddenWindow=false;
/**
* Return the (singleton) application hidden window, automatically created and maintained by this AppShellService. Read only.
*
* @type {Components.interfaces.nsIDOMWindow}
*/
Components.interfaces.nsIAppShellService.prototype.hiddenDOMWindow=new Components.interfaces.nsIDOMWindow();
/**
* Return the (singleton) application hidden window, automatically created and maintained by this AppShellService. Read only.
*
* @type {Components.interfaces.nsIXULWindow}
*/
Components.interfaces.nsIAppShellService.prototype.hiddenWindow=new Components.interfaces.nsIXULWindow();
/**
* Getter for "native application support." Read only. Obsolete since Gecko 1.8
*
* @type {Components.interfaces.nsINativeAppSupport}
*/
Components.interfaces.nsIAppShellService.prototype.nativeAppSupport=new Components.interfaces.nsINativeAppSupport();
/**
* This method creates a window, which will be initially invisible.
*
* @param {Components.interfaces.nsIXULWindow} aParent in nsIXULWindow aParent, The parent window. Can be null.
* @param {Components.interfaces.nsIURI} aUrl in nsIURI aUrl, The contents of the new window.
* @param {Boolean} aShowWindow in boolean aShowWindow, The window remains invisible if PR_FALSE.
* @param {Boolean} aLoadDefaultPage in boolean aLoadDefaultPage, Controls whether the window should try to load a default content page on its own.
* @param {Number} aChromeMask in PRUint32 aChromeMask, Chrome flags affecting the kind of OS border given to the window. (See nsIBrowserWindow for bit/flag definitions).
* @param {Number} aInitialWidth in long aInitialWidth, Width, in pixels, of the window. Width of window at creation. Can be overridden by the "width" tag in the XUL. Set to NS_SIZETOCONTENT to force the window to wrap to its contents.
* @param {Number} aInitialHeight in long aInitialHeight, Height, in pixels, of the window. Height of window at creation. Can be overridden by the "height" tag in the XUL. Set to NS_SIZETOCONTENT to force the window to wrap to its contents.
* @param {Components.interfaces.nsIAppShell} aAppShell in nsIAppShell aAppShell A widget "appshell" (event processor) to associate with the new window.
*/
Components.interfaces.nsIAppShellService.prototype.createTopLevelWindow=function(aParent, aUrl, aShowWindow, aLoadDefaultPage, aChromeMask, aInitialWidth, aInitialHeight, aAppShell){};
/**
* Add a window to the application's registry of windows. These windows are generally shown in the Windows taskbar, and the application knows it can not quit until it is out of registered windows.Note: When this method is successful, it fires the global notification "xul-window-registered"
*
* @param {Components.interfaces.nsIXULWindow} aWindow in nsIXULWindow aWindow The window to register.
*/
Components.interfaces.nsIAppShellService.prototype.registerTopLevelWindow=function(aWindow){};
/**
* Remove a window from the application's window registry.Note: This method will not automatically attempt to quit the application when the last window is unregistered. For that, see Quit().
*
* @param {Components.interfaces.nsIXULWindow} aWindow in nsIXULWindow aWindow The window to register.
*/
Components.interfaces.nsIAppShellService.prototype.unregisterTopLevelWindow=function(aWindow){};
/**
* This interface is intended to be used as application startup service. It also helps in quitting applications as well.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAppStartup=function(){};
/**
* Attempt to quit if all windows are closed.
*
* @constant
*/
Components.interfaces.nsIAppStartup.prototype.eConsiderQuit=0x01;
/**
* Try to close all windows, then quit if successful.
*
* @constant
*/
Components.interfaces.nsIAppStartup.prototype.eAttemptQuit=0x02;
/**
* Force all windows to close, then quit.
*
* @constant
*/
Components.interfaces.nsIAppStartup.prototype.eForceQuit=0x03;
/**
* Restart the application after quitting. The application will be restarted with the same profile and an empty command line.
*
* @constant
*/
Components.interfaces.nsIAppStartup.prototype.eRestart=0x10;
/**
* true if the startup process was interrupted by an interactive prompt. This can be used, for example, when doing performance testing of the startup process to discount numbers for tests that were interrupted by a user prompt.
*
* @type {Boolean}
*/
Components.interfaces.nsIAppStartup.prototype.interrupted=false;
/**
* Getter for "native application support." Read only. Obsolete since Gecko 1.9.1
*
* @type {Components.interfaces.nsINativeAppSupport}
*/
Components.interfaces.nsIAppStartup.prototype.nativeAppSupport=new Components.interfaces.nsINativeAppSupport();
/**
* Create the hidden window.
*
*/
Components.interfaces.nsIAppStartup.prototype.createHiddenWindow=function(){};
/**
* Serves for situations when all application windows will be closed but we don't want to take this as a signal to quit the application. Bracket the code where the last window could close with these.
*
*/
Components.interfaces.nsIAppStartup.prototype.enterLastWindowClosingSurvivalArea=function(){};
/**
* This method serves for situations when all application windows will be closed but we don't want to take this as a signal to quit the application. Bracket the code where the last window could close with these.
*
*/
Components.interfaces.nsIAppStartup.prototype.exitLastWindowClosingSurvivalArea=function(){};
/**
* Exit the event loop, and shut down the application.
*
* @param {Number} aMode in PRUint32 aMode This parameter modifies how the application is shutdown, and it is constructed from the constants defined above.
*/
Components.interfaces.nsIAppStartup.prototype.quit=function(aMode){};
/**
* Runs an application event loop: normally the main event pump which defines the lifetime of the application. If there are no windows open and no outstanding calls to enterLastWindowClosingSurvivalArea() this method will exit immediately.
*
*/
Components.interfaces.nsIAppStartup.prototype.run=function(){};
/**
* This lets you get information about the times at which key application startup events occurred.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAppStartup_MOZILLA_2_0=function(){};
/**
* This interface implements an array object.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIArray=function(){};
/**
* The number of elements in the array. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIArray.prototype.length=0;
/**
* Enumerate the array.
*
*/
Components.interfaces.nsIArray.prototype.enumerate=function(){};
/**
* Get the position of a specific element. Note that since null is a valid input, exceptions are used to indicate that an element is not found.
*
* @param {Number} startIndex in unsigned long startIndex, The initial element to search in the array. To start at the beginning, use 0 as the startIndex.
* @param {Components.interfaces.nsISupports} element in nsISupports element The element you are looking for.
*/
Components.interfaces.nsIArray.prototype.indexOf=function(startIndex, element){};
/**
* Retrieve a specific element of the array, and QueryInterface it to the specified interface. null is a valid result for this method, but exceptions are thrown in other circumstances.
*
* @param {Number} index in unsigned long index, Position of element.
* @param {Components.interfaces.nsIIDRef} uuid in nsIIDRef uuid, The IID of the requested interface.
* @param {Components.interfaces.nsQIResult} result [iid_is(uuid, retval] out nsQIResult result The object, QueryInterface'd to the requested interface.
*/
Components.interfaces.nsIArray.prototype.queryElementAt=function(index, uuid, result){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsIInputStream}
*/
Components.interfaces.nsIAsyncInputStream=function(){};
/**
* If passed to asyncWait(), this flag overrides the default behavior, causing the OnInputStreamReady notification to be suppressed until the stream becomes closed (either as a result of closeWithStatus()/close being called on the stream or possibly due to some error in the underlying stream).
*
* @constant
*/
Components.interfaces.nsIAsyncInputStream.prototype.WAIT_CLOSURE_ONLY=(1<<0);
/**
* Asynchronously wait for the stream to be readable or closed. The notification is one-shot, meaning that each asyncWait call will result in exactly one notification callback. After the OnInputStreamReady event is dispatched, the stream releases its reference to the nsIInputStreamCallback object. It is safe to call asyncWait again from the notification handler.This method may be called at any time (even if read has not been called). In other words, this method may be called when the stream already has data to read. It may also be called when the stream is closed. If the stream is already readable or closed when asyncWait is called, then the nsIInputStreamCallback.onInputStreamReady() event will be dispatched immediately. Otherwise, the event will be dispatched when the stream becomes readable or closed.
*
* @param {Components.interfaces.nsIInputStreamCallback} aCallback in nsIInputStreamCallback aCallback, This object is notified when the stream becomes ready. This parameter may be null to clear an existing callback.
* @param {Number} aFlags in unsigned long aFlags, This parameter specifies optional flags passed in to configure the behavior of this method. Pass zero to specify no flags.
* @param {Number} aRequestedCount in unsigned long aRequestedCount, Wait until at least this many bytes can be read. This is only a suggestion to the underlying stream; it may be ignored. The caller may pass zero to indicate no preference.
* @param {Components.interfaces.nsIEventTarget} aEventTarget in nsIEventTarget aEventTarget Specify null to receive notification on ANY thread (possibly even recursively on the calling thread, that is synchronously), or specify that the notification be delivered to a specific event target.
*/
Components.interfaces.nsIAsyncInputStream.prototype.asyncWait=function(aCallback, aFlags, aRequestedCount, aEventTarget){};
/**
* This method closes the stream and sets its internal status. If the stream is already closed, then this method is ignored. Once the stream is closed, the stream's status cannot be changed. Any successful status code passed to this method is treated as NS_BASE_STREAM_CLOSED, which has an effect equivalent to nsIInputStream.close().Note: This method exists in part to support pipes, which have both an input end and an output end. If the input end of a pipe is closed, then writes to the output end of the pipe will fail. The error code returned when an attempt is made to write to a "broken" pipe corresponds to the status code passed in when the input end of the pipe was closed, which greatly simplifies working with pipes in some cases.
*
* @param {Components.interfaces.nsresult} aStatus in nsresult aStatus The error that will be reported if this stream is accessed after it has been closed.
*/
Components.interfaces.nsIAsyncInputStream.prototype.closeWithStatus=function(aStatus){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsIOutputStream}
*/
Components.interfaces.nsIAsyncOutputStream=function(){};
/**
* If passed to asyncWait(), this flag overrides the default behavior, causing the OnOutputStreamReady notification to be suppressed until the stream becomes closed (either as a result of closeWithStatus()/close being called on the stream or possibly due to some error in the underlying stream).
*
* @constant
*/
Components.interfaces.nsIAsyncOutputStream.prototype.WAIT_CLOSURE_ONLY=(1<<0);
/**
* Asynchronously wait for the stream to be writable or closed. The notification is one-shot, meaning that each asyncWait call will result in exactly one notification callback. After the nsIOutputStreamCallback.onOutputStreamReady() event is dispatched, the stream releases its reference to the nsIOutputStreamCallback object. It is safe to call asyncWait again from the notification handler.This method may be called at any time (even if write has not been called). In other words, this method may be called when the stream already has room for more data. It may also be called when the stream is closed. If the stream is already writable or closed when asyncWait is called, then the nsIOutputStreamCallback.onOutputStreamReady() event will be dispatched immediately. Otherwise, the event will be dispatched when the stream becomes writable or closed.
*
* @param {Components.interfaces.nsIOutputStreamCallback} aCallback in nsIOutputStreamCallback aCallback, This object is notified when the stream becomes ready. This parameter may be null to clear an existing callback.
* @param {Number} aFlags in unsigned long aFlags, This parameter specifies optional flags passed in to configure the behavior of this method. Pass zero to specify no flags.
* @param {Number} aRequestedCount in unsigned long aRequestedCount, Wait until at least this many bytes can be written. This is only a suggestion to the underlying stream; it may be ignored. The caller may pass zero to indicate no preference.
* @param {Components.interfaces.nsIEventTarget} aEventTarget in nsIEventTarget aEventTarget Specify null to receive notification on ANY thread (possibly even recursively on the calling thread, that is synchronously), or specify that the notification be delivered to a specific event target.
*/
Components.interfaces.nsIAsyncOutputStream.prototype.asyncWait=function(aCallback, aFlags, aRequestedCount, aEventTarget){};
/**
* This method closes the stream and sets its internal status. If the stream is already closed, then this method is ignored. Once the stream is closed, the stream's status cannot be changed. Any successful status code passed to this method is treated as NS_BASE_STREAM_CLOSED, which has an effect equivalent to nsIInputStream.close().Note: This method exists in part to support pipes, which have both an input end and an output end. If the output end of a pipe is closed, then reads from the input end of the pipe will fail. The error code returned when an attempt is made to read to a "closed" pipe corresponds to the status code passed in when the output end of the pipe was closed, which greatly simplifies working with pipes in some cases.
*
* @param {Components.interfaces.nsresult} reason in nsresult reason The error that will be reported if this stream is accessed after it has been closed.
*/
Components.interfaces.nsIAsyncOutputStream.prototype.closeWithStatus=function(reason){};
/**
* This interface is used to copy the contents of one stream to another.
*
* @constructor
* @inherits {Components.interfaces.nsIRequest}
*/
Components.interfaces.nsIAsyncStreamCopier=function(){};
/**
* Starts the copy operation. The specified observer is notified when the copy completes.
*
* @param {Components.interfaces.nsIRequestObserver} aObserver in nsIRequestObserver aObserver, Receives notifications.
* @param {Components.interfaces.nsISupports} aObserverContext in nsISupports aObserverContext The object to receive notifications with information about the progress of the copy operation.
*/
Components.interfaces.nsIAsyncStreamCopier.prototype.asyncCopy=function(aObserver, aObserverContext){};
/**
* Initializes the stream copier.Note: At least one of the streams must be buffered.
*
* @param {Components.interfaces.nsIInputStream} aSource in nsIInputStream aSource, Contains the data to be copied.
* @param {Components.interfaces.nsIOutputStream} aSink in nsIOutputStream aSink, Specifies the destination for the data.
* @param {Components.interfaces.nsIEventTarget} aTarget in nsIEventTarget aTarget, Specifies the thread on which the copy will occur. A null value is permitted and causes the copy to occur on an unspecified background thread.
* @param {Boolean} aSourceBuffered in boolean aSourceBuffered, true if aSource implements nsIInputStream.readSegments().
* @param {Boolean} aSinkBuffered in boolean aSinkBuffered, true if aSink implements nsIInputStream.writeSegments() .
* @param {Number} aChunkSize in unsigned long aChunkSize, Specifies how many bytes to read and write at a time. This controls the granularity of the copy operation. This value should match the segment size of any buffered streams involved in the operation.
* @param {Boolean} aCloseSource in boolean aCloseSource, true if aSource should be closed after copying.
* @param {Boolean} aCloseSink in boolean aCloseSink true if aSink should be closed after copying.
*/
Components.interfaces.nsIAsyncStreamCopier.prototype.init=function(aSource, aSink, aTarget, aSourceBuffered, aSinkBuffered, aChunkSize, aCloseSource, aCloseSink){};
/**
* Implement this interface to receive a callback that lets you know whether an asynchronous redirect was verified or vetoed.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAsyncVerifyRedirectCallback=function(){};
/**
* Implements the asynchronous callback passed to nsIChannelEventSink.asyncOnChannelRedirect(). The result of the redirect decision is passed through this callback.
*
* @param {Components.interfaces.nsresult} result in nsresult result Result of the redirect veto decision. If this is NS_FAILED, the redirect has been vetoed. If this is NS_SUCCEEDED the redirect has been allowed by all consumers.
*/
Components.interfaces.nsIAsyncVerifyRedirectCallback.prototype.onRedirectVerifyCallback=function(result){};
/**
* A object that holds authentication information.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAuthInformation=function(){};
/**
* This dialog belongs to a network host.
*
* @constant
*/
Components.interfaces.nsIAuthInformation.prototype.AUTH_HOST=1;
/**
* This dialog belongs to a proxy.
*
* @constant
*/
Components.interfaces.nsIAuthInformation.prototype.AUTH_PROXY=2;
/**
* This dialog needs domain information. The user interface should show a domain field, prefilled with the domain attributes value.
*
* @constant
*/
Components.interfaces.nsIAuthInformation.prototype.NEED_DOMAIN=4;
/**
* This dialog only asks for password information. Authentication prompts SHOULD NOT show a username field. Attempts to change the username field will have no effect. nsIAuthPrompt2 implementations should, however, show its initial value to the user in some form. For example, a paragraph in the dialog might say "Please enter your password for user jsmith at server intranet". This flag is mutually exclusive with #NEED_DOMAIN.
*
* @constant
*/
Components.interfaces.nsIAuthInformation.prototype.ONLY_PASSWORD=8;
/**
* We have already tried to log in for this channel (with auth values from a previous promptAuth call), but it failed, so we now ask the user to provide a new, correct login.
*
* @constant
*/
Components.interfaces.nsIAuthInformation.prototype.PREVIOUS_FAILED=16;
/**
* The authentication scheme used for this request, if applicable. If the protocol for this authentication does not support schemes, this will be the empty string. Otherwise, this will be a string such as "basic" or "digest". This string will always be in lowercase. Read only.
*
* @type {String}
*/
Components.interfaces.nsIAuthInformation.prototype.authenticationScheme="";
/**
* The initial value should be used to prefill the dialog or be shown in some other way to the user. On return, this parameter should contain the domain entered by the user. This attribute is only used if flags include #NEED_DOMAIN.
*
* @type {String}
*/
Components.interfaces.nsIAuthInformation.prototype.domain="";
/**
* Flags describing this dialog. A bitwise OR of the constants. It is possible that neither #AUTH_HOST nor #AUTH_PROXY are set. Auth prompts should ignore flags they do not understand; especially, they should not throw an exception because of an unsupported flag. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAuthInformation.prototype.flags=0;
/**
* The initial value should be used to prefill the dialog or be shown in some other way to the user. The password should not be shown in clear. On return, this parameter should contain the password entered by the user.
*
* @type {String}
*/
Components.interfaces.nsIAuthInformation.prototype.password="";
/**
* The server-supplied realm of the authentication as defined in RFC 2617. Can be the empty string if the protocol does not support realms. Otherwise, this is a human-readable string like "Secret files". Read only.
*
* @type {String}
*/
Components.interfaces.nsIAuthInformation.prototype.realm="";
/**
* The initial value should be used to prefill the dialog or be shown in some other way to the user. On return, this parameter should contain the username entered by the user. This field can only be changed if the #ONLY_PASSWORD flag is not set.
*
* @type {String}
*/
Components.interfaces.nsIAuthInformation.prototype.username="";
/**
* This interface is intended to be used as server and client authentication service.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAuthModule=function(){};
/**
* Default behavior.
*
* @constant
*/
Components.interfaces.nsIAuthModule.prototype.REQ_DEFAULT=0;
/**
* Client and server will be authenticated.
*
* @constant
*/
Components.interfaces.nsIAuthModule.prototype.REQ_MUTUAL_AUTH=(1 << 0);
/**
* The server is allowed to impersonate the client. The REQ_MUTUAL_AUTH flag may also need to be specified in order for this flag to take effect.
*
* @constant
*/
Components.interfaces.nsIAuthModule.prototype.REQ_DELEGATE=(1 << 1);
/**
* This method is called to get the next token in a sequence of authentication steps.
*
* @param {Object} aInToken [const] in voidPtr aInToken, A buffer containing the input token (For example a challenge from a server). This may be null.
* @param {Number} aInTokenLength in unsigned long aInTokenLength, The length of the input token.
* @param {Object} aOutToken out voidPtr aOutToken, If getNextToken succeeds, then aOutToken will point to a buffer to be sent in response to the server challenge. The length of this buffer is given by aOutTokenLength. The buffer at aOutToken must be recycled with a call to nsIMemory.free().
* @param {Number} aOutTokenLength out unsigned long aOutTokenLength If getNextToken succeeds, then aOutTokenLength contains the length of the buffer (number of bytes) pointed to by aOutToken.
*/
Components.interfaces.nsIAuthModule.prototype.getNextToken=function(aInToken, aInTokenLength, aOutToken, aOutTokenLength){};
/**
* This method is called to initialize an auth module. The other methods cannot be called unless this method succeeds.
*
* @param {String} aServiceName in string aServiceName, The service name, which may be null if not applicable (For example, for NTLM, this parameter should be null).
* @param {Number} aServiceFlags in unsigned long aServiceFlags, A bitwise-or of the REQ_ constants (pass REQ_DEFAULT for default behavior).
* @param {String} aDomain in wstring aDomain, The authentication domain, which may be null if not applicable.
* @param {String} aUsername in wstring aUsername, The user's login name.
* @param {String} aPassword in wstring aPassword The user's password.
*/
Components.interfaces.nsIAuthModule.prototype.init=function(aServiceName, aServiceFlags, aDomain, aUsername, aPassword){};
/**
* This interface allows the networking layer to pose a user/password prompt to obtain the values needed for authentication.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAuthPrompt=function(){};
/**
* Never saves the password.
*
* @constant
*/
Components.interfaces.nsIAuthPrompt.prototype.SAVE_PASSWORD_NEVER=0;
/**
* Saves the password for the session.
*
* @constant
*/
Components.interfaces.nsIAuthPrompt.prototype.SAVE_PASSWORD_FOR_SESSION=1;
/**
* Saves the password permanently.
*
* @constant
*/
Components.interfaces.nsIAuthPrompt.prototype.SAVE_PASSWORD_PERMANENTLY=2;
/**
* This method puts up a text input dialog with OK and Cancel buttons.
*
* @param {String} dialogTitle in wstring dialogTitle, The title of the dialog.
* @param {String} text in wstring text, The text of the prompt message dialog box.
* @param {String} passwordRealm in wstring passwordRealm, The password realm. For example, ldap://localhost/dc=test.
* @param {Number} savePassword in PRUint32 savePassword, Saving password option. One of the SAVE_PASSWORD_* constants
* @param {String} defaultText in wstring defaultText, The default text for the text input dialog box.
* @param {String} result out wstring result The result of the dialog box, OK or Cancel buttons.
*/
Components.interfaces.nsIAuthPrompt.prototype.prompt=function(dialogTitle, text, passwordRealm, savePassword, defaultText, result){};
/**
* This method puts up a password dialog with OK and Cancel buttons.Note: If a username is specified, the username should be escaped.
*
* @param {String} dialogTitle in wstring dialogTitle, The title of the dialog.
* @param {String} text in wstring text, The text of the prompt message dialog box.
* @param {String} passwordRealm in wstring passwordRealm, The password realm. For example, ldap://localhost/dc=test. If a username is specified (http://user@site.com) it will be used when matching existing logins or saving new ones. If no username is specified, only password-only logins will be matched or saved.
* @param {Number} savePassword in PRUint32 savePassword, Saving password option. One of the SAVE_PASSWORD_* constants
* @param {String} pwd inout wstring pwd The password entered by the user if OK was selected.
*/
Components.interfaces.nsIAuthPrompt.prototype.promptPassword=function(dialogTitle, text, passwordRealm, savePassword, pwd){};
/**
* This method puts up a username/password dialog with OK and Cancel buttons.
*
* @param {String} dialogTitle in wstring dialogTitle, The title of the dialog.
* @param {String} text in wstring text, The text of the prompt message dialog box.
* @param {String} passwordRealm in wstring passwordRealm, The password realm. For example, ldap://localhost/dc=test.
* @param {Number} savePassword in PRUint32 savePassword, Saving password option. One of the SAVE_PASSWORD_* constants
* @param {String} user inout wstring user, The username entered in the dialog.
* @param {String} pwd inout wstring pwd The password entered by the user if OK was selected.
*/
Components.interfaces.nsIAuthPrompt.prototype.promptUsernameAndPassword=function(dialogTitle, text, passwordRealm, savePassword, user, pwd){};
/**
* An interface allowing to prompt for a username and password.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAuthPrompt2=function(){};
/**
* The password will be sent unencrypted. No security provided.
*
* @constant
*/
Components.interfaces.nsIAuthPrompt2.prototype.LEVEL_NONE=0;
/**
* Password will be sent encrypted, but the connection is otherwise insecure.
*
* @constant
*/
Components.interfaces.nsIAuthPrompt2.prototype.LEVEL_PW_ENCRYPTED=1;
/**
* The connection, both for password and data, is secure.
*
* @constant
*/
Components.interfaces.nsIAuthPrompt2.prototype.LEVEL_SECURE=2;
/**
* Asynchronously prompt the user for a username and password. This has largely the same semantics as nsIAuthPrompt.promptUsernameAndPassword(), but must return immediately after calling and return the entered data in a callback.If the user closes the dialog using a cancel button or similar, the callback's nsIAuthPromptCallback.onAuthCancelled() method must be called. Calling nsICancelable.cancel() on the returned object should close the dialog and must call nsIAuthPromptCallback.onAuthCancelled() on the provided callback.This implementation may: Coalesce identical prompts. This means prompts that are guaranteed to want the same authentication information from the user. A single prompt will be shown; then the callbacks for all the coalesced prompts will be notified with the resulting authentication information. Serialize prompts that are all in the same "context" (this might mean application-wide, for a given window, or something else depending on the user interface) so that the user is not deluged with prompts.
* Note: This method may throw any exception when the prompt fails to queue, for example because of out-of-memory error. It must not throw when the prompt could already be potentially shown to the user. In that case information about the failure has to come through the callback. This way we prevent multiple dialogs shown to the user because consumer may fall back to synchronous prompt on synchronous failure of this method.
*
* @param {Components.interfaces.nsIChannel} aChannel in nsIChannel aChannel, The channel that requires authentication.
* @param {Components.interfaces.nsIAuthPromptCallback} aCallback in nsIAuthPromptCallback aCallback,
* @param {Components.interfaces.nsISupports} aContext in nsISupports aContext,
* @param {Number} level in PRUint32 level, One of the level constants.
* @param {Components.interfaces.nsIAuthInformation} authInfo in nsIAuthInformation authInfo Authentication information object. The implementation should fill in this object with the information entered by the user before returning.
*/
Components.interfaces.nsIAuthPrompt2.prototype.asyncPromptAuth=function(aChannel, aCallback, aContext, level, authInfo){};
/**
* Requests a username and a password. Implementations will commonly show a dialog with a username and password field, depending on flags also a domain field.Note: Exceptions thrown from this function will be treated like a return value of false.
*
* @param {Components.interfaces.nsIChannel} aChannel in nsIChannel aChannel, The channel that requires authentication.
* @param {Number} level in PRUint32 level, One of the level constants.
* @param {Components.interfaces.nsIAuthInformation} authInfo in nsIAuthInformation authInfo Authentication information object. The implementation should fill in this object with the information entered by the user before returning.
*/
Components.interfaces.nsIAuthPrompt2.prototype.promptAuth=function(aChannel, level, authInfo){};
/**
* This interface requests a prompt interface for the given prompt reason.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAuthPromptProvider=function(){};
/**
* Normal (non-proxy) prompt request.
*
* @constant
*/
Components.interfaces.nsIAuthPromptProvider.prototype.PROMPT_NORMAL=0;
/**
* Proxy authentication request.
*
* @constant
*/
Components.interfaces.nsIAuthPromptProvider.prototype.PROMPT_PROXY=1;
/**
* This method requests a prompt interface for the given prompt reason.
*
* @param {Number} aPromptReason in PRUint32 aPromptReason, The reason for the authentication prompt, one of the PROMPT_* constants.
* @param {Components.interfaces.nsIIDRef} iid in nsIIDRef iid, The desired interface, for example, NS_GET_IID(nsIAuthPrompt2).
* @param {Components.interfaces.nsQIResult} result [iid_is(iid,retval] out nsQIResult result A nsIAuthPrompt2 interface.
*/
Components.interfaces.nsIAuthPromptProvider.prototype.getAuthPrompt=function(aPromptReason, iid, result){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsIAuthPrompt}
*/
Components.interfaces.nsIAuthPromptWrapper=function(){};
/**
* This method sets a prompt dialog using the given dialog implementation which will be used to display the prompts.
*
* @param {Components.interfaces.nsIPrompt} dialogs in nsIPrompt dialogs The dialog implementation which will be used to display the prompts.
*/
Components.interfaces.nsIAuthPromptWrapper.prototype.setPromptDialogs=function(dialogs){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAutoCompleteController=function(){};
/**
* Default status.
*
* @constant
*/
Components.interfaces.nsIAutoCompleteController.prototype.STATUS_NONE=1;
/**
* Searching for matches.
*
* @constant
*/
Components.interfaces.nsIAutoCompleteController.prototype.STATUS_SEARCHING=2;
/**
* Search completed but found no matches.
*
* @constant
*/
Components.interfaces.nsIAutoCompleteController.prototype.STATUS_COMPLETE_NO_MATCH=3;
/**
* Search completed and found matches.
*
* @constant
*/
Components.interfaces.nsIAutoCompleteController.prototype.STATUS_COMPLETE_MATCH=4;
/**
* @constant
*/
Components.interfaces.nsIAutoCompleteController.prototype.KEY_UP=1;
/**
* @constant
*/
Components.interfaces.nsIAutoCompleteController.prototype.KEY_DOWN=2;
/**
* @constant
*/
Components.interfaces.nsIAutoCompleteController.prototype.KEY_LEFT=3;
/**
* @constant
*/
Components.interfaces.nsIAutoCompleteController.prototype.KEY_RIGHT=4;
/**
* @constant
*/
Components.interfaces.nsIAutoCompleteController.prototype.KEY_PAGE_UP=5;
/**
* @constant
*/
Components.interfaces.nsIAutoCompleteController.prototype.KEY_PAGE_DOWN=6;
/**
* @constant
*/
Components.interfaces.nsIAutoCompleteController.prototype.KEY_HOME=7;
/**
* @constant
*/
Components.interfaces.nsIAutoCompleteController.prototype.KEY_END=8;
/**
* Either the XUL autocomplete textbox that is currently being controlled, or a form fill controller that handles website form history.
*
* @type {Components.interfaces.nsIAutoCompleteInput}
*/
Components.interfaces.nsIAutoCompleteController.prototype.input=new Components.interfaces.nsIAutoCompleteInput();
/**
* The number of matches. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAutoCompleteController.prototype.matchCount=0;
/**
* State which indicates the status of possible ongoing searches. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAutoCompleteController.prototype.searchStatus=0;
/**
* Get or set the current search string.
* Note: Setting this attribute will not initiate a search.
*
* @type {String}
*/
Components.interfaces.nsIAutoCompleteController.prototype.searchString="";
/**
* Gets the comment of the result at a given index in the last completed search.
*
* @param {Number} index in long index The given index.
*/
Components.interfaces.nsIAutoCompleteController.prototype.getCommentAt=function(index){};
/**
* Get the style hint for the result at a given index in the last completed search.
*
* @param {Number} index in long index The given index.
*/
Components.interfaces.nsIAutoCompleteController.prototype.getStyleAt=function(index){};
/**
* Gets the value of the result at a given index in the last completed search.
*
* @param {Number} index in long index The given index value.
*/
Components.interfaces.nsIAutoCompleteController.prototype.getValueAt=function(index){};
/**
* Notifies the controller that the user chose to delete the current auto-complete result.
*
*/
Components.interfaces.nsIAutoCompleteController.prototype.handleDelete=function(){};
/**
* Notifies the controller that the user wishes to enter the current text.
*
* @param {Boolean} aIsPopupSelection in boolean aIsPopupSelection true if a selection was made from the popup (That is the currently selected entry's value will entered into the input). false to indicate that the input's current value should be used. Typically used to differentiate between selections made with the mouse (which do not result in the input value being changed) and selections made with the keyboard (which may or may not result in the input's value changing, depending on the nsIAutocompleteInput's completeSelectedIndex attribute). See bug 408723 for more information.
*/
Components.interfaces.nsIAutoCompleteController.prototype.handleEnter=function(aIsPopupSelection){};
/**
* Notifies the controller that the user wishes to revert autocomplete.
*
*/
Components.interfaces.nsIAutoCompleteController.prototype.handleEscape=function(){};
/**
* Notifies the controller of the following key navigation events: up, down, left, right, page up, page down.
*
* @param {Number} key in unsigned long key The key for the navigation event.
*/
Components.interfaces.nsIAutoCompleteController.prototype.handleKeyNavigation=function(key){};
/**
* Handles tab; this just closes autocomplete.
*
*/
Components.interfaces.nsIAutoCompleteController.prototype.handleTab=function(){};
/**
* Notifies the controller that the user has changed text in the textbox. This includes all means of changing the text value, including typing a character, backspacing, deleting, or pasting in an entirely new value.
*
* @param {Boolean} aIgnoreSelection in boolean aIgnoreSelection Obsolete since Gecko 1.9.2 undefined
*/
Components.interfaces.nsIAutoCompleteController.prototype.handleText=function(aIgnoreSelection){};
/**
* Starts a search on a string, assuming the input property is already set.
*
* @param {String} searchString in AString searchString The string to start searching on.
*/
Components.interfaces.nsIAutoCompleteController.prototype.startSearch=function(searchString){};
/**
* This interface monitors the input in a text field and displays an autocomplete panel at the appropriate time.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAutoCompleteInput=function(){};
/**
* If a search result has its defaultIndex set, this will optionally try to complete the text in the textbox to the entire text of the result at the default index as the user types. This means that auto-fill is enabled.
*
* @type {Boolean}
*/
Components.interfaces.nsIAutoCompleteInput.prototype.completeDefaultIndex=false;
/**
* If true, the text in the text field will be autocompleted as the user selects from the popup list.
*
* @type {Boolean}
*/
Components.interfaces.nsIAutoCompleteInput.prototype.completeSelectedIndex=false;
/**
* If true, the event that rolls up the popup should be consumed by the popup itself. If false, the rollup event will be dispatched. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIAutoCompleteInput.prototype.consumeRollupEvent=false;
/**
* The controller. Read only.
*
* @type {Components.interfaces.nsIAutoCompleteController}
*/
Components.interfaces.nsIAutoCompleteInput.prototype.controller=new Components.interfaces.nsIAutoCompleteController();
/**
* true if auto-complete is currently disabled; otherwise false.
*
* @type {Boolean}
*/
Components.interfaces.nsIAutoCompleteInput.prototype.disableAutoComplete=false;
/**
* If true, the text field automatically completes to the default result whenever the user hits the enter key or the text field loses focus.
*
* @type {Boolean}
*/
Components.interfaces.nsIAutoCompleteInput.prototype.forceComplete=false;
/**
* The maximum number of rows to display in the autocomplete suggestion popup.
*
* @type {Number}
*/
Components.interfaces.nsIAutoCompleteInput.prototype.maxRows=0;
/**
* Specifies a minimum number of search results that must be available before the autocomplete popup will open.
*
* @type {Number}
*/
Components.interfaces.nsIAutoCompleteInput.prototype.minResultsForPopup=0;
/**
* The view in which results will be displayed.Read only.
*
* @type {Components.interfaces.nsIAutoCompletePopup}
*/
Components.interfaces.nsIAutoCompleteInput.prototype.popup=new Components.interfaces.nsIAutoCompletePopup();
/**
* Indicates whether or not the popup view is already open.
*
* @type {Boolean}
*/
Components.interfaces.nsIAutoCompleteInput.prototype.popupOpen=false;
/**
* The number of autocomplete sessions to search. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAutoCompleteInput.prototype.searchCount=0;
/**
* An additional parameter used for configuring searches.
*
* @type {String}
*/
Components.interfaces.nsIAutoCompleteInput.prototype.searchParam="";
/**
* The ending index of the current selection in the text field. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAutoCompleteInput.prototype.selectionEnd=0;
/**
* The starting index of the current selection in the text field. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIAutoCompleteInput.prototype.selectionStart=0;
/**
* If true, a column is added to the popup, showing the comment for each autocomplete result.
*
* @type {Boolean}
*/
Components.interfaces.nsIAutoCompleteInput.prototype.showCommentColumn=false;
/**
* If true, a column is added to the popup, showing an additional image for each autocomplete result.
*
* @type {Boolean}
*/
Components.interfaces.nsIAutoCompleteInput.prototype.showImageColumn=false;
/**
* The value of the text in the autocomplete text field.
*
* @type {String}
*/
Components.interfaces.nsIAutoCompleteInput.prototype.textValue="";
/**
* The number of milliseconds after a keystroke before a search begins.
*
* @type {Number}
*/
Components.interfaces.nsIAutoCompleteInput.prototype.timeout=0;
/**
* Returns the name of one of the autocomplete search session objects.
*
* @param {Number} index in unsigned long index The index number of the search session object whose name is to be returned.
*/
Components.interfaces.nsIAutoCompleteInput.prototype.getSearchAt=function(index){};
/**
* Called when the search ends successfully.
*
*/
Components.interfaces.nsIAutoCompleteInput.prototype.onSearchComplete=function(){};
/**
* Called when the user selects and presses enter on a result item.
*
*/
Components.interfaces.nsIAutoCompleteInput.prototype.onTextEntered=function(){};
/**
* Called when the user cancels the autocomplete session.
*
*/
Components.interfaces.nsIAutoCompleteInput.prototype.onTextReverted=function(){};
/**
* Selects a range of text in the autocomplete text field.
*
* @param {Number} startIndex in long startIndex, The index to the first character in the text field to select.
* @param {Number} endIndex in long endIndex The index to the last character in the text field to select.
*/
Components.interfaces.nsIAutoCompleteInput.prototype.selectTextRange=function(startIndex, endIndex){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAutoCompleteItem=function(){};
/**
* Class name used to define some style through css like the colors, an icon url, and so on.
*
* @type {String}
*/
Components.interfaces.nsIAutoCompleteItem.prototype.className="";
/**
* An extra comment that will be displayed next to the value but that will not be part of the value itself.
*
* @type {String}
*/
Components.interfaces.nsIAutoCompleteItem.prototype.comment="";
/**
* Parameter use by the search engine.
*
* @type {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAutoCompleteItem.prototype.param=new Components.interfaces.nsISupports();
/**
* The result value using AString to avoid excess allocations.
*
* @type {String}
*/
Components.interfaces.nsIAutoCompleteItem.prototype.value="";
/**
* This interface is deprecated. It only exists for legacy LDAP autocomplete session support. New code should use toolkit autocomplete interfaces.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAutoCompleteListener=function(){};
/**
* Private parameter used by the autocomplete widget.
*
* @type {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAutoCompleteListener.prototype.param=new Components.interfaces.nsISupports();
/**
* Called by the autocomplete session when the search is done or over. As of Gecko 1.9.1, can also be called with partial results, in a similar manner to the toolkit autocomplete interface.
*
* @param {Components.interfaces.nsIAutoCompleteResults} result in nsIAutoCompleteResults result, An nsIAutoCompleteResults object containing the (partial) results of the autocomplete.
* @param {Components.interfaces.nsIAutoCompleteStatus} status in nsIAutoCompleteStatus status One of the constants defined in the nsIAutoCompleteStatus interface.
*/
Components.interfaces.nsIAutoCompleteListener.prototype.onAutoComplete=function(result, status){};
/**
* Called by the autocomplete session during the search. This method does not seem to have ever been implemented.
*
* @param {String} statusText in wstring statusText
*/
Components.interfaces.nsIAutoCompleteListener.prototype.onStatus=function(statusText){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAutoCompleteObserver=function(){};
/**
* Called when a search is complete and the results are ready.
*
* @param {Components.interfaces.nsIAutoCompleteSearch} search in nsIAutoCompleteSearch search, The search object that processed this search.
* @param {Components.interfaces.nsIAutoCompleteResult} result in nsIAutoCompleteResult result The search result object.
*/
Components.interfaces.nsIAutoCompleteObserver.prototype.onSearchResult=function(search, result){};
/**
* This interface is implemented by results of autocomplete search.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAutoCompleteResult=function(){};
/**
* This interface is implemented by search providers to start and stop autocomplete.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIAutoCompleteSearch=function(){};
/**
* Search for a given string and notify a listener (either synchronously or asynchronously) of the result.
*
* @param {String} searchString in AString searchString, The string to search for.
* @param {String} searchParam in AString searchParam, An extra parameter. Can be empty if not needed.
* @param {Components.interfaces.nsIAutoCompleteResult} previousResult in nsIAutoCompleteResult previousResult, The previous nsIAutoCompleteResult to use for faster searching. Can be null.
* @param {Components.interfaces.nsIAutoCompleteObserver} listener in nsIAutoCompleteObserver listener An nsIAutoCompleteObserver listener to notify when the search is complete.
*/
Components.interfaces.nsIAutoCompleteSearch.prototype.startSearch=function(searchString, searchParam, previousResult, listener){};
/**
* Stop all searches that are in progress.
*
*/
Components.interfaces.nsIAutoCompleteSearch.prototype.stopSearch=function(){};
/**
* This interface is used to is report a broken SSL status. It can also be used to obtain the SSL handshake status of a connection that will be canceled because of improper certificate status.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIBadCertListener2=function(){};
/**
* Called in case of a broken ssl status.
*
* @param {Components.interfaces.nsIInterfaceRequestor} socketInfo in nsIInterfaceRequestor socketInfo, A network communication context that can be used to obtain more information about the active connection. This object usually supports nsISSLSocketControl, nsITransportSecurityInfo, nsIIdentityInfo, nsISSLStatusProvider, nsIClientAuthUserDecision and possibly other interfaces.
* @param {Components.interfaces.nsISSLStatus} status in nsISSLStatus status, The SSL status object that describes the problem(s).
* @param {String} targetSite in AUTF8String targetSite The Site name that was used to open the current connection.
*/
Components.interfaces.nsIBadCertListener2.prototype.notifyCertProblem=function(socketInfo, status, targetSite){};
/**
* This interface allows consumption of primitive data types from a "binary stream" containing untagged, big-endian binary data, that is as produced by an implementation of nsIBinaryOutputStream. This might be used, for example, to implement network protocols or to read from architecture-neutral disk files, that is ones that can be read and written by both big-endian and little-endian platforms.
*
* @constructor
* @inherits {Components.interfaces.nsIInputStream}
*/
Components.interfaces.nsIBinaryInputStream=function(){};
/**
* Reads from the stream.
*
*/
Components.interfaces.nsIBinaryInputStream.prototype.read8=function(){};
/**
* Reads from the stream.
*
*/
Components.interfaces.nsIBinaryInputStream.prototype.read16=function(){};
/**
* Reads from the stream.
*
*/
Components.interfaces.nsIBinaryInputStream.prototype.read32=function(){};
/**
* Reads from the stream.
* Warning: This method is available from JavaScript; however JavaScript does not support 64-bit integers.
*
*/
Components.interfaces.nsIBinaryInputStream.prototype.read64=function(){};
/**
* Reads an 8-bit value from the stream, treating it as a Boolean value.
*
*/
Components.interfaces.nsIBinaryInputStream.prototype.readBoolean=function(){};
/**
* Reads an opaque byte array from the stream, storing the results as an array of PRUint8s.
*
* @param {Number} aLength in PRUint32 aLength, The number of bytes that must be read.
* @param {Number} aBytes [array, size_is(aLength, retval] out PRUint8 aBytes An array containing the bytes read from the stream.
*/
Components.interfaces.nsIBinaryInputStream.prototype.readByteArray=function(aLength, aBytes){};
/**
* Reads an opaque byte array from the stream.
*
* @param {Number} aLength in PRUint32 aLength, The number of bytes to read.
* @param {String} aString [size_is(aLength, retval] out string aString A string containing the bytes read from the stream.
*/
Components.interfaces.nsIBinaryInputStream.prototype.readBytes=function(aLength, aString){};
/**
* Reads an 8-bit pascal style string from the stream. 32-bit length field, followed by length 8-bit chars.
*
*/
Components.interfaces.nsIBinaryInputStream.prototype.readCString=function(){};
/**
* Reads from the stream.
*
*/
Components.interfaces.nsIBinaryInputStream.prototype.readDouble=function(){};
/**
* Reads from the stream.
*
*/
Components.interfaces.nsIBinaryInputStream.prototype.readFloat=function(){};
/**
* Reads an 16-bit pascal style string from the stream. 32-bit length field, followed by length PRUnichars.
*
*/
Components.interfaces.nsIBinaryInputStream.prototype.readString=function(){};
/**
*
*
* @param {Components.interfaces.nsIInputStream} aInputStream in nsIInputStream aInputStream The stream from which to read.
*/
Components.interfaces.nsIBinaryInputStream.prototype.setInputStream=function(aInputStream){};
/**
* This interface allows writing of primitive data types (integers, floating-point values, booleans, and so on.) to a stream in a binary, untagged, fixed-endianness format. This might be used, for example, to implement network protocols or to produce architecture-neutral binary disk files, that is ones that can be read and written by both big-endian and little-endian platforms. Output is written in big-endian order (high-order byte first), as this is traditional network order.
*
* @constructor
* @inherits {Components.interfaces.nsIOutputStream}
*/
Components.interfaces.nsIBinaryOutputStream=function(){};
/**
* Sets the stream to which output is directed.
*
* @param {Components.interfaces.nsIOutputStream} aOutputStream in nsIOutputStream aOutputStream Instance of the nsIOutputStream object to which output should be directed.
*/
Components.interfaces.nsIBinaryOutputStream.prototype.setOutputStream=function(aOutputStream){};
/**
* Writes an 8-bit integer to the stream.
*
* @param {Number} aByte in PRUint8 aByte The byte to write to the stream.
*/
Components.interfaces.nsIBinaryOutputStream.prototype.write8=function(aByte){};
/**
* Writes a 16-bit integer to the stream.
*
* @param {Number} a16 in PRUint16 a16 The 16-bit integer to write to the stream.
*/
Components.interfaces.nsIBinaryOutputStream.prototype.write16=function(a16){};
/**
* Writes a 32-bit integer to the stream.
*
* @param {Number} a32 in PRUint32 a32 The 32-bit integer to write to the stream.
*/
Components.interfaces.nsIBinaryOutputStream.prototype.write32=function(a32){};
/**
* Writes a 64-bit integer to the stream.
*
* @param {Number} a64 in PRUint64 a64 The 64-bit integer to write to the stream.
*/
Components.interfaces.nsIBinaryOutputStream.prototype.write64=function(a64){};
/**
* Writes a boolean value (as a byte) to the stream.
*
* @param {Boolean} aBoolean in PRBool aBoolean The Boolean value to write to the stream; the value will consist of one byte in the output stream.
*/
Components.interfaces.nsIBinaryOutputStream.prototype.writeBoolean=function(aBoolean){};
/**
* Writes an opaque byte array to the stream.
*
* @param {Number} aBytes [array, size_is(aLength] in PRUint8 aBytes, The bytes to write to the stream.
* @param {Number} aLength in PRUint32 aLength The number of bytes to write to the stream.
*/
Components.interfaces.nsIBinaryOutputStream.prototype.writeByteArray=function(aBytes, aLength){};
/**
* Writes an opaque byte array to the stream.
*
* @param {String} aString [size_is(aLength] in string aString, The byte array to write to the stream.
* @param {Number} aLength in PRUint32 aLength The number of bytes to write to the stream.
*/
Components.interfaces.nsIBinaryOutputStream.prototype.writeBytes=function(aString, aLength){};
/**
* Writes a double precision floating point number to the stream.
*
* @param {Number} aDouble in double aDouble The double to write to the stream.
*/
Components.interfaces.nsIBinaryOutputStream.prototype.writeDouble=function(aDouble){};
/**
* Writes a floating point number to the stream.
*
* @param {Number} aFloat in float aFloat The floating point value to write to the stream.
*/
Components.interfaces.nsIBinaryOutputStream.prototype.writeFloat=function(aFloat){};
/**
* Writes an 8-bit pascal style string to the stream. The output data consists of a 32-bit length field, followed by that many 8-bit characters.
*
* @param {String} aString in string aString The string to write to the stream.
*/
Components.interfaces.nsIBinaryOutputStream.prototype.writeStringZ=function(aString){};
/**
* Writes an 8-bit pascal style string (UTF8-encoded) to the stream. The output data consists of a 32-bit length field, followed by that many 8-bit characters.
*
* @param {String} aString in wstring aString The string to write to the stream.
*/
Components.interfaces.nsIBinaryOutputStream.prototype.writeUtf8Z=function(aString){};
/**
* Writes a 16-bit pascal style string to the stream. The output data consists of a 32-bit length field, followed by that many PRUnichars.
*
* @param {String} aString in wstring aString The string to write to the stream.
*/
Components.interfaces.nsIBinaryOutputStream.prototype.writeWStringZ=function(aString){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIBlocklistService=function(){};
/**
* @constant
*/
Components.interfaces.nsIBlocklistService.prototype.STATE_NOT_BLOCKED=0;
/**
* @constant
*/
Components.interfaces.nsIBlocklistService.prototype.STATE_SOFTBLOCKED=1;
/**
* @constant
*/
Components.interfaces.nsIBlocklistService.prototype.STATE_BLOCKED=2;
/**
* @constant
*/
Components.interfaces.nsIBlocklistService.prototype.STATE_OUTDATED=3;
/**
* Determine if an item is blocklisted.
*
* @param {Object} addon in jsval addon, The addon object to be checked.
* @param {String} appVersion in AString appVersion, Optional from Gecko 1.9.1 The version of the application we are checking in the blocklist. If this parameter is null, the version of the running application is used.
* @param {String} toolkitVersion in AString toolkitVersion Optional from Gecko 1.9.1 The version of the toolkit we are checking in the blocklist. If this parameter is null, the version of the running toolkit is used.
*/
Components.interfaces.nsIBlocklistService.prototype.isAddonBlocklisted=function(addon, appVersion, toolkitVersion){};
/**
* A browser-specific interface to global history. It adds functions used by the basic browser like, marking pages as typed in the URL bar, and removing pages as from the history interface.
*
* @constructor
* @inherits {Components.interfaces.nsIGlobalHistory2}
*/
Components.interfaces.nsIBrowserHistory=function(){};
/**
* Indicates if there are entries in global history. For performance reasons this does not return the real number of entries. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIBrowserHistory.prototype.count=0;
/**
* The last page that was visited in a top-level window. Read only.
*
* @type {String}
*/
Components.interfaces.nsIBrowserHistory.prototype.lastPageVisited="";
/**
* This method removes all the pages from the global history.
*
*/
Components.interfaces.nsIBrowserHistory.prototype.removeAllPages=function(){};
/**
* This method removes all visits for a page from the history. The page itself is only deleted when it is not bookmarked and when it is not a place: URI. This method is called by the UI when the user deletes a history entry.
* Note: If removing fewer than 10 pages, calling this repeatedly is preferable over calling removePages(), since that's about the point at which the overhead of setting up a batch operation doesn't make sense anymore.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI The added page which is to be removed.
*/
Components.interfaces.nsIBrowserHistory.prototype.removePage=function(aURI){};
/**
* This method removes all the pages from the given host. It is called from the UI when the user deletes a group associated with a host or domain. This method lets you delete pages from a specific host, or pages from all hosts in a given domain.If aEntireDomain is true, it will assume aHost is a domain, and remove all pages from the entire domain.
*
* @param {String} aHost in AUTF8String aHost, The name of the host to be removed. An empty value for this parameter means local files and anything else without a hostname. You can also pass in the localized "(local files)" title given to you by a history query to remove all history information for local files.
* @param {Boolean} aEntireDomain in boolean aEntireDomain If set to true, it will assume aHost is a domain, and remove all pages from the entire domain, including subdomains. Set to false otherwise.
*/
Components.interfaces.nsIBrowserHistory.prototype.removePagesFromHost=function(aHost, aEntireDomain){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIBrowserSearchService=function(){};
/**
* The currently active search engine. May be null if there are no visible search engines.
*
* @type {Components.interfaces.nsISearchEngine}
*/
Components.interfaces.nsIBrowserSearchService.prototype.currentEngine=new Components.interfaces.nsISearchEngine();
/**
* The default search engine. Returns the first visible engine if the default engine is hidden. May be null if there are no visible search engines. Read only.
*
* @type {Components.interfaces.nsISearchEngine}
*/
Components.interfaces.nsIBrowserSearchService.prototype.defaultEngine=new Components.interfaces.nsISearchEngine();
/**
* The original default engine. This differs from the "defaultEngine" attribute in that it always returns a given build's default engine, regardless of whether it is hidden. Read only.
*
* @type {Components.interfaces.nsISearchEngine}
*/
Components.interfaces.nsIBrowserSearchService.prototype.originalDefaultEngine=new Components.interfaces.nsISearchEngine();
/**
* Adds a new search engine from the file at the supplied URI, optionally asking the user for confirmation first. If a confirmation dialog is shown, it will offer the option to begin using the newly added engine right away; if no confirmation dialog is shown, the new engine will be used right away automatically.
*
* @param {String} engineURL in AString engineURL, The URL to the search engine's description file.
* @param {Number} dataType in long dataType, An integer representing the plugin file format. Must be one of the supported search engine data types defined above.
* @param {String} iconURL in AString iconURL, A URL string to an icon file to be used as the search engine's icon. This value may be overridden by an icon specified in the engine description file.
* @param {Boolean} confirm in boolean confirm, A boolean value indicating whether the user should be asked for confirmation before this engine is added to the list. If this value is false, the engine will be added to the list upon successful load, but it will not be selected as the current engine.
* @param {Components.interfaces.nsISearchInstallCallback} callback [optional] in nsISearchInstallCallback callback A nsISearchInstallCallback that will be notified when the addition is complete, or if the addition fails. It will not be called if addEngine throws an exception.
*/
Components.interfaces.nsIBrowserSearchService.prototype.addEngine=function(engineURL, dataType, iconURL, confirm, callback){};
/**
* Adds a new search engine, without asking the user for confirmation and without starting to use it right away.
*
* @param {String} name in AString name, The search engine's name. Must be unique. Must not be null.
* @param {String} iconURL in AString iconURL, Optional: A URL string pointing to the icon to be used to represent the engine.
* @param {String} alias in AString alias, Optional: A unique shortcut that can be used to retrieve the search engine.
* @param {String} description in AString description, Optional: a description of the search engine.
* @param {String} method in AString method, The HTTP request method used when submitting a search query. Must be a case insensitive value of either "get" or "post".
* @param {String} url in AString url The URL to which search queries should be sent. Must not be null.
*/
Components.interfaces.nsIBrowserSearchService.prototype.addEngineWithDetails=function(name, iconURL, alias, description, method, url){};
/**
* Returns an array of all default search engines. This includes all loaded engines that aren't in the user's profile directory (NS_APP_USER_SEARCH_DIR).
*
* @param {Number} engineCount [optional] out unsigned long engineCount, The number of default search engines.
* @param {Components.interfaces.nsISearchEngine} engines [retval, array, size_is(engineCount] out nsISearchEngine engines An array of the default nsISearchEngines.
*/
Components.interfaces.nsIBrowserSearchService.prototype.getDefaultEngines=function(engineCount, engines){};
/**
* Returns an engine with the specified alias.
*
* @param {String} alias in AString alias The search engine's alias.
*/
Components.interfaces.nsIBrowserSearchService.prototype.getEngineByAlias=function(alias){};
/**
* Returns an engine with the specified name.
*
* @param {String} aEngineName in AString aEngineName The name of the engine.
*/
Components.interfaces.nsIBrowserSearchService.prototype.getEngineByName=function(aEngineName){};
/**
* Returns an array of all installed search engines.
*
* @param {Number} engineCount [optional] out unsigned long engineCount, The number of all installed search engines.
* @param {Components.interfaces.nsISearchEngine} engines [retval, array, size_is(engineCount] out nsISearchEngine engines An array of the all installed nsISearchEngines.
*/
Components.interfaces.nsIBrowserSearchService.prototype.getEngines=function(engineCount, engines){};
/**
* Returns an array of all installed search engines whose hidden attribute is false.
*
* @param {Number} engineCount [optional] out unsigned long engineCount, The number of hidden installed search engines.
* @param {Components.interfaces.nsISearchEngine} engines [retval, array, size_is(engineCount] out nsISearchEngine engines An array of the hidden installed nsISearchEngines.
*/
Components.interfaces.nsIBrowserSearchService.prototype.getVisibleEngines=function(engineCount, engines){};
/**
* Initialize the service, or if the service is already initialized, do nothing.
* This method was introduced in Firefox 16.
* Attempting to call any method of this interface before init() has completed will force the service to fall back to a slower, synchronous, initialization.
* If your code requires nsIBrowserSearchService and is executed during startup, you should make sure that this code is executed from the callback to init().
*
* @param {Components.interfaces.nsIBrowserSearchInitObserver} observer [optional] in nsIBrowserSearchInitObserver observer If specified, a callback called once initialization is complete, or immediately, if the service has already been initialized. In JavaScript, this observer can be a regular function.
*/
Components.interfaces.nsIBrowserSearchService.prototype.init=function(observer){};
/**
* Moves a visible search engine.
*
* @param {Components.interfaces.nsISearchEngine} engine in nsISearchEngine engine, The engine to move.
* @param {Number} newIndex in long newIndex The engine's new index in the set of visible engines.
*/
Components.interfaces.nsIBrowserSearchService.prototype.moveEngine=function(engine, newIndex){};
/**
* Removes the search engine. If the search engine is installed in a global location, this will just hide the engine. If the engine is in the user's profile directory, it will be removed from disk.
*
* @param {Components.interfaces.nsISearchEngine} engine in nsISearchEngine engine The engine to remove.
*/
Components.interfaces.nsIBrowserSearchService.prototype.removeEngine=function(engine){};
/**
* Un-hides all engines installed in the directory corresponding to the directory service's NS_APP_SEARCH_DIR key. (that is the set of engines returned by getDefaultEngines())
*
*/
Components.interfaces.nsIBrowserSearchService.prototype.restoreDefaultEngines=function(){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICache=function(){};
/**
* ACCESS GRANTED - No descriptor is provided.
*
* @constant
*/
Components.interfaces.nsICache.prototype.ACCESS_NONE=0;
/**
* ACCESS REQUESTED - I only want to READ, if there isn't an entry just fail. ACCESS GRANTED - You can READ from this descriptor.
*
* @constant
*/
Components.interfaces.nsICache.prototype.ACCESS_READ=1;
/**
* ACCESS REQUESTED - I have something new I want to WRITE into the cache, make me a new entry and doom the old one, if any. ACCESS GRANTED - You must WRITE to this descriptor because the cache entry was just created for you.
*
* @constant
*/
Components.interfaces.nsICache.prototype.ACCESS_WRITE=2;
/**
* ACCESS REQUESTED - I want to READ, but I'm willing to update an existing entry if necessary, or create a new one if none exists. ACCESS GRANTED - You can READ the descriptor to determine if it's valid, you may WRITE if it needs updating.
*
* @constant
*/
Components.interfaces.nsICache.prototype.ACCESS_READ_WRITE=3;
/**
* The storage policy of a cache entry determines the device(s) to which it belongs. See nsICacheSession and nsICacheEntryDescriptor for more details. Allows the cache entry to be stored in any device. The cache service decides which cache device to use based on "some resource management calculation."
*
* @constant
*/
Components.interfaces.nsICache.prototype.STORE_ANYWHERE=0;
/**
* The storage policy of a cache entry determines the device(s) to which it belongs. See nsICacheSession and nsICacheEntryDescriptor for more details. Requires the cache entry to reside in non-persistent storage. That is typically in system RAM.
*
* @constant
*/
Components.interfaces.nsICache.prototype.STORE_IN_MEMORY=1;
/**
* The storage policy of a cache entry determines the device(s) to which it belongs. See nsICacheSession and nsICacheEntryDescriptor for more details. Requires the cache entry to reside in persistent storage. That is typically on a system's hard disk.
*
* @constant
*/
Components.interfaces.nsICache.prototype.STORE_ON_DISK=2;
/**
* The storage policy of a cache entry determines the device(s) to which it belongs. See nsICacheSession and nsICacheEntryDescriptor for more details. Requires the cache entry to reside in persistent storage, and in a separate file.
*
* @constant
*/
Components.interfaces.nsICache.prototype.STORE_ON_DISK_AS_FILE=3;
/**
* The storage policy of a cache entry determines the device(s) to which it belongs. See nsICacheSession and nsICacheEntryDescriptor for more details. Requires the cache entry to reside in persistent, reliable storage for offline use.
*
* @constant
*/
Components.interfaces.nsICache.prototype.STORE_OFFLINE=4;
/**
* All entries for a cache session are stored as streams of data or as objects. This constant specify that cache session is not a stream based entry when calling nsICacheService.createSession() method.
*
* @constant
*/
Components.interfaces.nsICache.prototype.NOT_STREAM_BASED=0;
/**
* All entries for a cache session are stored as streams of data or as objects. This constant specify that cache session is a stream based entry when calling nsICacheService.createSession() method.
*
* @constant
*/
Components.interfaces.nsICache.prototype.STREAM_BASED=1;
/**
* The synchronous OpenCacheEntry() may be blocking or non-blocking. If a cache entry is waiting to be validated by another cache descriptor (so no new cache descriptors for that key can be created), OpenCacheEntry() will return NS_ERROR_CACHE_WAIT_FOR_VALIDATION in non-blocking mode. If the cache entry is validated, then a descriptor for that entry will be created and returned. If the cache entry was doomed, then a descriptor will be created for a new cache entry for the key.
*
* @constant
*/
Components.interfaces.nsICache.prototype.NON_BLOCKING=0;
/**
* The synchronous OpenCacheEntry() may be blocking or non-blocking. In blocking mode, it will wait until the cache entry for the key has been validated or doomed. If the cache entry is validated, then a descriptor for that entry will be created and returned. If the cache entry was doomed, then a descriptor will be created for a new cache entry for the key.
*
* @constant
*/
Components.interfaces.nsICache.prototype.BLOCKING=1;
/**
* This interface provides information about a cache device.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICacheDeviceInfo=function(){};
/**
* Get a human readable description of the cache device. Read only.
*
* @type {String}
*/
Components.interfaces.nsICacheDeviceInfo.prototype.description="";
/**
* Get the number of stored cache entries. Read only.
*
* @type {Number}
*/
Components.interfaces.nsICacheDeviceInfo.prototype.entryCount=0;
/**
* Get the upper limit of the size of the data the cache can store. Read only.
*
* @type {Number}
*/
Components.interfaces.nsICacheDeviceInfo.prototype.maximumSize=0;
/**
* Get the total size of the stored cache entries. Read only.
*
* @type {Number}
*/
Components.interfaces.nsICacheDeviceInfo.prototype.totalSize=0;
/**
* Get a usage report, statistics, miscellaneous data about the cache device. Read only.
*
* @type {String}
*/
Components.interfaces.nsICacheDeviceInfo.prototype.usageReport="";
/**
* This interface provides a cache entry descriptor.
*
* @constructor
* @inherits {Components.interfaces.nsICacheEntryInfo}
*/
Components.interfaces.nsICacheEntryDescriptor=function(){};
/**
* Get the access granted to this descriptor. See nsICache for the definitions of the access modes and a thorough description of their corresponding meanings. Read only.
*
* @type {Components.interfaces.nsCacheAccessMode}
*/
Components.interfaces.nsICacheEntryDescriptor.prototype.accessGranted=new Components.interfaces.nsCacheAccessMode();
/**
* Get or set the cache data element. This will fail if the cache entry is stream based. The cache entry holds a strong reference to this object. The object will be released when the cache entry is destroyed.
*
* @type {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICacheEntryDescriptor.prototype.cacheElement=new Components.interfaces.nsISupports();
/**
* Get the disk file associated with the cache entry. Read only.
*
* @type {Components.interfaces.nsIFile}
*/
Components.interfaces.nsICacheEntryDescriptor.prototype.file=new Components.interfaces.nsIFile();
/**
* Stores the Content-Length specified in the HTTP header for this entry. Checked before we write to the cache entry, to prevent ever taking up space in the cache for an entry that we know up front is going to have to be evicted anyway. See bug 588507.
*
* @type {Number}
*/
Components.interfaces.nsICacheEntryDescriptor.prototype.predictedDataSize=0;
/**
* Get or set security info on the cache entry for this descriptor. This fails if the storage policy is not STORE_IN_MEMORY.
*
* @type {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICacheEntryDescriptor.prototype.securityInfo=new Components.interfaces.nsISupports();
/**
* Get or set the storage policy of the cache entry. See nsICache for the definitions of the storage policies.
*
* @type {Components.interfaces.nsCacheStoragePolicy}
*/
Components.interfaces.nsICacheEntryDescriptor.prototype.storagePolicy=new Components.interfaces.nsCacheStoragePolicy();
/**
* This method explicitly closes the descriptor (optional).
*
*/
Components.interfaces.nsICacheEntryDescriptor.prototype.close=function(){};
/**
* This method dooms the cache entry this descriptor references in order to slate it for removal. Once doomed a cache entry cannot be undoomed.A descriptor with WRITE access can doom the cache entry and choose to fail pending requests. This means that pending requests will not get a cache descriptor. This is meant as a tool for clients that wish to instruct pending requests to skip the cache.
*
*/
Components.interfaces.nsICacheEntryDescriptor.prototype.doom=function(){};
/**
* This method with the WRITE access can doom the cache entry and choose to fail pending requests. This means that pending requests will not get a cache descriptor. This is meant as a tool for clients that wish to instruct pending requests to skip the cache.
*
* @param {Components.interfaces.nsresult} status in nsresult status The access status.
*/
Components.interfaces.nsICacheEntryDescriptor.prototype.doomAndFailPendingRequests=function(status){};
/**
* This method retrieves the meta data. Meta data is a table of key/value string pairs. The strings do not have to conform to any particular charset, but they must be null terminated.
*
* @param {String} key in string key The key for retrieving the meta data.
*/
Components.interfaces.nsICacheEntryDescriptor.prototype.getMetaDataElement=function(key){};
/**
* This method means that a writer must validate this cache object before any readers are given a descriptor to the object.
*
*/
Components.interfaces.nsICacheEntryDescriptor.prototype.markValid=function(){};
/**
* This method opens blocking input stream to cache data. This will fail if the cache entry is not stream based. Use the stream transport service to asynchronously read this stream on a background thread. The returned stream may implement nsISeekableStream.
*
* @param {Number} offset in unsigned long offset Read starting from this offset into the cached data. An offset beyond the end of the stream has undefined consequences.
*/
Components.interfaces.nsICacheEntryDescriptor.prototype.openInputStream=function(offset){};
/**
* This method opens blocking output stream to cache data. This will fail if the cache entry is not stream based. Use the stream transport service to asynchronously write to this stream on a background thread. The returned stream may implement nsISeekableStream.If opening an output stream to existing cached data, the data will be truncated to the specified offset.
*
* @param {Number} offset in unsigned long offset Write starting from this offset into the cached data. An offset beyond the end of the stream has undefined consequences.
*/
Components.interfaces.nsICacheEntryDescriptor.prototype.openOutputStream=function(offset){};
/**
* This method sets the cache entry data size. This will fail if the cache entry is stream based.
*
* @param {Number} size in unsigned long size The cache entry data size.
*/
Components.interfaces.nsICacheEntryDescriptor.prototype.setDataSize=function(size){};
/**
* This method sets the time at which the cache entry should be considered invalid (in seconds since the Epoch).
*
* @param {Number} expirationTime in PRUint32 expirationTime The time for cache entry expiration (in seconds).
*/
Components.interfaces.nsICacheEntryDescriptor.prototype.setExpirationTime=function(expirationTime){};
/**
* This method sets the meta data. Meta data is a table of key/value string pairs. The strings do not have to conform to any particular charset, but they must be null terminated.
*
* @param {String} key in string key, The key for setting the meta data.
* @param {String} value in string value The value for setting the meta data.
*/
Components.interfaces.nsICacheEntryDescriptor.prototype.setMetaDataElement=function(key, value){};
/**
* This method means that the visitor will be called with key/value pair for each meta data element.
*
* @param {Components.interfaces.nsICacheMetaDataVisitor} visitor in nsICacheMetaDataVisitor visitor The visitor to be called.
*/
Components.interfaces.nsICacheEntryDescriptor.prototype.visitMetaData=function(visitor){};
/**
* This interface provides information about a cache entry.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICacheEntryInfo=function(){};
/**
* Get the client id associated with this cache entry. Read only.
*
* @type {String}
*/
Components.interfaces.nsICacheEntryInfo.prototype.clientID="";
/**
* Get the cache entry data size. Read only.
*
* @type {Number}
*/
Components.interfaces.nsICacheEntryInfo.prototype.dataSize=0;
/**
* Get the id for the device that stores this cache entry. Read only.
*
* @type {String}
*/
Components.interfaces.nsICacheEntryInfo.prototype.deviceID="";
/**
* Get the expiration time of the cache entry (in seconds since the Epoch). Read only.
*
* @type {Number}
*/
Components.interfaces.nsICacheEntryInfo.prototype.expirationTime=0;
/**
* Get the number of times the cache entry has been opened. Read only.
*
* @type {Number}
*/
Components.interfaces.nsICacheEntryInfo.prototype.fetchCount=0;
/**
* Get the key identifying the cache entry. Read only.
*
* @type {String}
*/
Components.interfaces.nsICacheEntryInfo.prototype.key="";
/**
* Get the last time the cache entry was opened (in seconds since the Epoch). Read only.
*
* @type {Number}
*/
Components.interfaces.nsICacheEntryInfo.prototype.lastFetched=0;
/**
* Get the last time the cache entry was modified (in seconds since the Epoch). Read only.
*
* @type {Number}
*/
Components.interfaces.nsICacheEntryInfo.prototype.lastModified=0;
/**
* This method finds out whether or not the cache entry is stream based.
*
*/
Components.interfaces.nsICacheEntryInfo.prototype.isStreamBased=function(){};
/**
* This interface is a cache listener.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICacheListener=function(){};
/**
* This method is called when the requested access (or appropriate subset) is acquired. The status parameter equals NS_OK on success. See nsICacheService for accessGranted values.
*
* @param {Components.interfaces.nsICacheEntryDescriptor} descriptor in nsICacheEntryDescriptor descriptor, The cache entry descriptor.
* @param {Components.interfaces.nsCacheAccessMode} accessGranted in nsCacheAccessMode accessGranted, The cache access mode.
* @param {Components.interfaces.nsresult} status in nsresult status The status of the cache entry availability.
*/
Components.interfaces.nsICacheListener.prototype.onCacheEntryAvailable=function(descriptor, accessGranted, status){};
/**
* This method is called when the processing started by nsICacheSession.doomEntry() is completed.
*
* @param {Components.interfaces.nsresult} status in nsresult status The status is NS_OK when the entry was doomed, or NS_ERROR_NOT_AVAILABLE when there is no such entry.
*/
Components.interfaces.nsICacheListener.prototype.onCacheEntryDoomed=function(status){};
/**
* This interface is used for visiting the meta data elements for a specified cache entry.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICacheMetaDataVisitor=function(){};
/**
* This method is called for each key/value pair in the meta data for a cache entry.
*
* @param {String} key in string key, The key for visiting the meta data for a cache entry.
* @param {String} value in string value The value for visiting the meta data for a cache entry.
*/
Components.interfaces.nsICacheMetaDataVisitor.prototype.visitMetaDataElement=function(key, value){};
/**
* Handles visiting and evicting entries operations along with the creating of cache sessions and creation of temporary client IDs operations for offline caching.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICacheService=function(){};
/**
* This method creates a cache session.A cache session represents a client's access into the cache. The cache session is not "owned" by the cache service. Hence, it is possible to create duplicate cache sessions. Entries created by a cache session are invisible to other cache sessions, unless the cache sessions are equivalent.
*
* @param {String} clientID in string clientID, Specifies the name of the client using the cache.
* @param {Components.interfaces.nsCacheStoragePolicy} storagePolicy in nsCacheStoragePolicy storagePolicy, Limits the storage policy for all entries accessed via the returned session. As a result, devices excluded by the storage policy will not be searched when opening entries from the returned session.
* @param {Boolean} streamBased in boolean streamBased Indicates whether or not the data being cached can be represented as a stream. The storagePolicy must be consistent with the value of this field. For example, a non-stream-based cache entry can only have a storage policy of STORE_IN_MEMORY.
*/
Components.interfaces.nsICacheService.prototype.createSession=function(clientID, storagePolicy, streamBased){};
/**
* This method evicts all entries in all devices implied by the storage policy.Note: This function may evict some items but will throw if it fails to evict everything.
*
* @param {Components.interfaces.nsCacheStoragePolicy} storagePolicy in nsCacheStoragePolicy storagePolicy The cache storage policy.
*/
Components.interfaces.nsICacheService.prototype.evictEntries=function(storagePolicy){};
/**
* This method visits entries stored in the cache. Used to implement the about:cache URI.
*
* @param {Components.interfaces.nsICacheVisitor} visitor in nsICacheVisitor visitor The entry to be visited.
*/
Components.interfaces.nsICacheService.prototype.visitEntries=function(visitor){};
/**
* Handles open synchronous and asynchronous cache entry operations along with evicting cache entries and checking for cache devices instantiation according to the session storage policies.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICacheSession=function(){};
/**
* Expired entries will be doomed or evicted if this attribute is set to true. If false, expired entries will be returned (useful for offline mode and clients, such as HTTP, that can update the valid lifetime of cached content). This attribute defaults to true.
*
* @type {Boolean}
*/
Components.interfaces.nsICacheSession.prototype.doomEntriesIfExpired=false;
/**
* This method gives an asynchronous cache access. Does not block the calling thread. Instead, the listener will be notified when the descriptor is available.
*
* @param {String} key in ACString key, The key for cache entry.
* @param {Components.interfaces.nsCacheAccessMode} accessRequested in nsCacheAccessMode accessRequested, The requested access.
* @param {Components.interfaces.nsICacheListener} listener in nsICacheListener listener, The cache listener to be notified.
* @param {Boolean} noWait [optional] in boolean noWait Do not wait for the cache entry when it is in use and waits for validation.
*/
Components.interfaces.nsICacheSession.prototype.asyncOpenCacheEntry=function(key, accessRequested, listener, noWait){};
/**
* This method evicts all entries for this session's clientID according to its storagePolicy.
*
*/
Components.interfaces.nsICacheSession.prototype.evictEntries=function(){};
/**
* This method checks if the cache devices implied by the session storage policy are currently enabled for instantiation if they don't already exist.
*
*/
Components.interfaces.nsICacheSession.prototype.isStorageEnabled=function(){};
/**
* This method gives a synchronous cache access. It returns a unique descriptor each time it is called, even if the same key is specified. When called by multiple threads for WRITE access, only one writable descriptor will be granted. If blockingMode is set to false, it will return NS_ERROR_CACHE_WAIT_FOR_VALIDATION rather than block when another descriptor has been given WRITE access but hasn't validated the entry yet.Note: If at all possible, you should use asyncOpenCacheEntry() instead of calling openCacheEntry(), in order to avoid blocking on I/O on the calling thread. This will streamline overall application performance.A cache session can only give out one descriptor with WRITE access to a given cache entry at a time. Until the client calls MarkValid on its descriptor, other attempts to open the same cache entry will block.
*
* @param {String} key in ACString key, The key for cache entry.
* @param {Components.interfaces.nsCacheAccessMode} accessRequested in nsCacheAccessMode accessRequested, The requested access.
* @param {Boolean} blockingMode in boolean blockingMode True or False value to turn blocking mode for calling the thread to ON/OFF respectively.
*/
Components.interfaces.nsICacheSession.prototype.openCacheEntry=function(key, accessRequested, blockingMode){};
/**
* This interface provides information about cache devices and entries.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICacheVisitor=function(){};
/**
* This method is called to provide information about a cache device.
*
* @param {String} deviceID in string deviceID, Specifies the device being visited.
* @param {Components.interfaces.nsICacheDeviceInfo} deviceInfo in nsICacheDeviceInfo deviceInfo Specifies information about this device.
*/
Components.interfaces.nsICacheVisitor.prototype.visitDevice=function(deviceID, deviceInfo){};
/**
* This method is called to provide information about a cache entry.
*
* @param {String} deviceID in string deviceID, Specifies the device being visited.
* @param {Components.interfaces.nsICacheEntryInfo} entryInfo in nsICacheEntryInfo entryInfo Specifies information about this entry.
*/
Components.interfaces.nsICacheVisitor.prototype.visitEntry=function(deviceID, entryInfo){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsICacheInfoChannel}
*/
Components.interfaces.nsICachingChannel=function(){};
/**
* This load flag inhibits fetching from the net. An error of NS_ERROR_DOCUMENT_NOT_CACHED will be sent to the listener's onStopRequest if network IO is necessary to complete the request. This flag can be used to find out whether fetching this URL would cause validation of the cache entry via the network. Combining this flag with LOAD_BYPASS_LOCAL_CACHE will cause all loads to fail. This flag differs from LOAD_ONLY_FROM_CACHE in that this flag fails the load if validation is required while LOAD_ONLY_FROM_CACHE skips validation where possible.
*
* @constant
*/
Components.interfaces.nsICachingChannel.prototype.LOAD_NO_NETWORK_IO=1 << 26;
/**
* This load flag causes the offline cache to be checked when fetching a request. It will be set automatically if the browser is offline. This flag will not be transferred through a redirect.
*
* @constant
*/
Components.interfaces.nsICachingChannel.prototype.LOAD_CHECK_OFFLINE_CACHE=1 << 27;
/**
* This load flag causes the local cache to be skipped when fetching a request. Unlike LOAD_BYPASS_CACHE, it does not force an end-to-end load (That is, it does not affect proxy caches).
*
* @constant
*/
Components.interfaces.nsICachingChannel.prototype.LOAD_BYPASS_LOCAL_CACHE=1 << 28;
/**
* This load flag causes the local cache to be skipped if the request would otherwise block waiting to access the cache.
*
* @constant
*/
Components.interfaces.nsICachingChannel.prototype.LOAD_BYPASS_LOCAL_CACHE_IF_BUSY=1 << 29;
/**
* This load flag inhibits fetching from the net if the data in the cache has been evicted. An error of NS_ERROR_DOCUMENT_NOT_CACHED will be sent to the listener's onStopRequest in this case. This flag is set automatically when the application is offline.
*
* @constant
*/
Components.interfaces.nsICachingChannel.prototype.LOAD_ONLY_FROM_CACHE=1 << 30;
/**
* This load flag controls what happens when a document would be loaded from the cache to satisfy a call to AsyncOpen. If this attribute is set to true, then the document will not be loaded from the cache. A stream listener can check isFromCache() to determine if the AsyncOpen will actually result in data being streamed. If this flag has been set, and the request can be satisfied via the cache, then the OnDataAvailable events will be skipped. The listener will only see OnStartRequest followed by OnStopRequest.
*
* @constant
*/
Components.interfaces.nsICachingChannel.prototype.LOAD_ONLY_IF_MODIFIED=1 << 31;
/**
* Specifies whether or not the data should be cached to a file. This may fail if the disk cache is not present. The value of this attribute is usually only settable during the processing of a channel's OnStartRequest. The default value of this attribute depends on the particular implementation of nsICachingChannel.
*
* @type {Boolean}
*/
Components.interfaces.nsICachingChannel.prototype.cacheAsFile=false;
/**
* Get the "file" where the cached data can be found. This is valid for as long as a reference to the cache token is held. This may return an error if cacheAsFile is false. Read only.
*
* @type {Components.interfaces.nsIFile}
*/
Components.interfaces.nsICachingChannel.prototype.cacheFile=new Components.interfaces.nsIFile();
/**
* Specifies whether or not the data should be placed in the offline cache, in addition to normal memory/disk caching. This may fail if the offline cache is not present. The value of this attribute should be set before opening the channel.
*
* @type {Boolean}
*/
Components.interfaces.nsICachingChannel.prototype.cacheForOfflineUse=false;
/**
* Uniquely identifies the data in the cache for this channel. Holding a reference to this key does not prevent the cached data from being removed. A cache key retrieved from a particular instance of nsICachingChannel could be set on another instance of nsICachingChannel provided the underlying implementations are compatible and provided the new channel instance was created with the same URI. The implementation of nsICachingChannel would be expected to use the cache entry identified by the cache token. Depending on the value of nsIRequest.loadFlags(), the cache entry may be validated, overwritten, or simply read. The cache key may be null indicating that the URI of the channel is sufficient to locate the same cache entry. Setting a null cache key is likewise valid.
*
* @type {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICachingChannel.prototype.cacheKey=new Components.interfaces.nsISupports();
/**
* Uniquely identifies the data in the cache. Holding a reference to this token prevents the cached data from being removed. A cache token retrieved from a particular instance of nsICachingChannel could be set on another instance of nsICachingChannel provided the underlying implementations are compatible. The implementation of nsICachingChannel would be expected to only read from the cache entry identified by the cache token and not try to validate it. The cache token can be QueryInterface'd to a nsICacheEntryInfo if more detail about the cache entry is needed. For example, expiration time.
*
* @type {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICachingChannel.prototype.cacheToken=new Components.interfaces.nsISupports();
/**
* The session into which to cache offline data. If not specified, data will be placed in "HTTP-offline".
*
* @type {String}
*/
Components.interfaces.nsICachingChannel.prototype.offlineCacheClientID="";
/**
* The same as cacheToken but accessing the offline app cache token if there is any. Exceptions thrown NS_ERROR_NOT_AVAILABLE When there is not offline cache token.
*
* @type {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICachingChannel.prototype.offlineCacheToken=new Components.interfaces.nsISupports();
/**
* This interface provides a means to cancel an operation that is in progress.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICancelable=function(){};
/**
* Call this method to request that this object abort whatever operation it may be performing.
*
* @param {Components.interfaces.nsresult} aReason in nsresult aReason A failure code indicating why the operation is being canceled. It is an error to pass a success code.
*/
Components.interfaces.nsICancelable.prototype.cancel=function(aReason){};
/**
* This interface provides access to a data structure that holds a list of name-value pairs, called categories, where each value is a list of strings.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICategoryManager=function(){};
/**
* This method sets the value for the given entry on the given category. The category and/or entry are created if they do not exist.
*
* @param {String} aCategory in string aCategory, The name of the category being modified. ("protocol")
* @param {String} aEntry in string aEntry, The name of the category entry being modified. ("http")
* @param {String} aValue in string aValue, The value for the category entry. ("moz.httprulez.1")
* @param {Boolean} aPersist in boolean aPersist, No longer supported. Category entries never persist across application sessions. You must pass false for this parameter.
* @param {Boolean} aReplace in boolean aReplace A flag indicating whether or not to overwrite the value of an existing category entry.
*/
Components.interfaces.nsICategoryManager.prototype.addCategoryEntry=function(aCategory, aEntry, aValue, aPersist, aReplace){};
/**
* Delete a category and all entries.Note: If the category does not exist, then this method does nothing.
*
* @param {String} aCategory in string aCategory The name of the category being deleted.
*/
Components.interfaces.nsICategoryManager.prototype.deleteCategory=function(aCategory){};
/**
* Delete an entry from the category.Note: If the category does not exist, then this method does nothing.
*
* @param {String} aCategory in string aCategory, The name of the category being modified. ("protocol")
* @param {String} aEntry in string aEntry, The name of the category entry being deleted. ("http")
* @param {Boolean} aPersist in boolean aPersist Ignored. Category entries never persist across sessions. You should always pass false for this parameter.
*/
Components.interfaces.nsICategoryManager.prototype.deleteCategoryEntry=function(aCategory, aEntry, aPersist){};
/**
* Enumerate all existing categories.
*
*/
Components.interfaces.nsICategoryManager.prototype.enumerateCategories=function(){};
/**
* Enumerate the entries in a category.
*
* @param {String} aCategory in string aCategory The category to be enumerated.
*/
Components.interfaces.nsICategoryManager.prototype.enumerateCategory=function(aCategory){};
/**
* Get the value for the given category's entry.
*
* @param {String} aCategory in string aCategory, The category being queried. ("protocol")
* @param {String} aEntry in string aEntry The entry being queried. ("http")
*/
Components.interfaces.nsICategoryManager.prototype.getCategoryEntry=function(aCategory, aEntry){};
/**
* This interface allows clients to construct 'GET' requests for specific protocols, and manage them in a uniform way.
*
* @constructor
* @inherits {Components.interfaces.nsIRequest}
*/
Components.interfaces.nsIChannel=function(){};
/**
* Set (for example by the docshell) to indicate whether or not the channel corresponds to a document URI.
*
* @constant
*/
Components.interfaces.nsIChannel.prototype.LOAD_DOCUMENT_URI=16;
/**
* If the end consumer for this load has been retargeted after discovering its content, this flag will be set:
*
* @constant
*/
Components.interfaces.nsIChannel.prototype.LOAD_RETARGETED_DOCUMENT_URI=17;
/**
* This flag is set to indicate that this channel is replacing another channel. This means that:
* The stream listener this channel will be notifying was initially passed to the asyncOpen() method of some other channel
* This channel's URI is a better identifier of the resource being accessed than this channel's originalURI.
* This flag can be set, for example, for redirects or for cases when a single channel has multiple parts to it (and thus can follow onStopRequest with another onStartRequest/onStopRequest pair, each pair for a different request).
*
* @constant
*/
Components.interfaces.nsIChannel.prototype.LOAD_REPLACE=18;
/**
* Set (for example by the docshell) to indicate whether or not the channel corresponds to an initial document URI load (for example link click).
*
* @constant
*/
Components.interfaces.nsIChannel.prototype.LOAD_INITIAL_DOCUMENT_URI=19;
/**
* Set (For example by the URILoader) to indicate whether or not the end consumer for this load has been determined.
*
* @constant
*/
Components.interfaces.nsIChannel.prototype.LOAD_TARGETED=20;
/**
* If this flag is set, the channel should call the content sniffers as described in netwerk/build/nsNetCID.h about NS_CONTENT_SNIFFER_CATEGORY.
* Note: Channels may ignore this flag; however, new channel implementations should only do so with good reason.
*
* @constant
*/
Components.interfaces.nsIChannel.prototype.LOAD_CALL_CONTENT_SNIFFERS=21;
/**
* This flag tells the channel to use URI classifier service to check the URI when opening the channel.
*
* @constant
*/
Components.interfaces.nsIChannel.prototype.LOAD_CLASSIFY_URI=22;
/**
* The character set of the channel's content if available and if applicable. This attribute only applies to textual data.
* Setting contentCharset before the channel has been opened provides a hint to the channel on what the charset should be. The behavior is similar to contentType.
* The value of the contentCharset attribute is a mixed case string.
*
* @type {String}
*/
Components.interfaces.nsIChannel.prototype.contentCharset="";
/**
* The length of the data associated with the channel if available. A value of -1 indicates that the content length is unknown.
* Note: As of Gecko 19.0, this parameter changed from long to int64_t. In earlier versions callers could get the "content-length" property as 64-bit value by QueryInterfacing the channel to nsIPropertyBag2, if that interface is exposed by the channel.
*
* @type {Number}
*/
Components.interfaces.nsIChannel.prototype.contentLength=0;
/**
* The MIME type of the channel's content if available.
* Note: The content type can often be wrongly specified (For example wrong file extension, wrong MIME type, wrong document type stored on a server and so on.), and the caller most likely wants to verify with the actual data.
* Setting contentType before the channel has been opened provides a hint to the channel as to what the MIME type is. The channel may ignore this hint in deciding on the actual MIME type that it will report.
* Setting contentType after onStartRequest has been fired or after open() is called will override the type determined by the channel.
* Setting contentType between the time that asyncOpen() is called and the time when onStartRequest is fired has undefined behavior at this time.
* The value of the contentType attribute is a lowercase string. A value assigned to this attribute will be parsed and normalized as follows:
* Any parameters (delimited with a ';') will be stripped.
* If a charset parameter is given, then its value will replace the the contentCharset attribute of the channel.
* The stripped contentType will be lowercased. Any implementation of nsIChannel must follow these rules.
*
* @type {String}
*/
Components.interfaces.nsIChannel.prototype.contentType="";
/**
* The notification callbacks for the channel. This is set by clients, who wish to provide a means to receive progress, status and protocol-specific notifications. If this value is null, the channel implementation may use the notification callbacks from its load group. The channel may also query the notification callbacks from its load group if its notification callbacks do not supply the requested interface.
* Interfaces commonly requested include: nsIProgressEventSink, nsIPrompt, and nsIAuthPrompt / nsIAuthPrompt2.
* When the channel is done, it must not continue holding references to this object.
* Note: A channel implementation should take care when "caching" an interface pointer queried from its notification callbacks. If the notification callbacks are changed, then a cached interface pointer may become invalid and may therefore need to be re-queried.
*
* @type {Components.interfaces.nsIInterfaceRequestor}
*/
Components.interfaces.nsIChannel.prototype.notificationCallbacks=new Components.interfaces.nsIInterfaceRequestor();
/**
* The original URI used to construct the channel. This is used in the case of a redirect or URI "resolution" (For example resolving a resource: URI to a file: URI) so that the original pre-redirect URI can still be obtained. This is also used as the RI of the document resulting from the channel, unless the channel has the LOAD_REPLACE flag set. This is never null. Attempts to set it to null must throw.
* Note: This is distinctly different from the http Referer (referring URI), which is typically the page that contained the original URI (accessible from nsIHttpChannel.)
*
* @type {Components.interfaces.nsIURI}
*/
Components.interfaces.nsIChannel.prototype.originalURI=new Components.interfaces.nsIURI();
/**
* The owner, corresponding to the entity that is responsible for this channel. Used by the security manager to grant or deny privileges to mobile code loaded from this channel.
* Note: This is a strong reference to the owner, so if the owner is also holding a strong reference to the channel, care must be taken to explicitly drop its reference to the channel.
*
* @type {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIChannel.prototype.owner=new Components.interfaces.nsISupports();
/**
* Transport-level security information (if any, else null) corresponding to the channel, normally presented through the interfaces nsITransportSecurityInfo and nsISSLStatusProvider Read only.
*
* @type {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIChannel.prototype.securityInfo=new Components.interfaces.nsISupports();
/**
* The URI corresponding to the channel. Its value is immutable. Read only.
*
* @type {Components.interfaces.nsIURI}
*/
Components.interfaces.nsIChannel.prototype.URI=new Components.interfaces.nsIURI();
/**
* Asynchronously open this channel. Data is fed to the specified stream listener as it becomes available. The stream listener's methods are called on the thread that calls asyncOpen and are not called until after asyncOpen returns. If asyncOpen returns successfully, the channel promises to call at least onStartRequest and onStopRequest.If the nsIRequest object passed to the stream listener's methods is not this channel, an appropriate onChannelRedirect notification needs to be sent to the notification callbacks before onStartRequest is called. Once onStartRequest is called, all following method calls on aListener will get the request that was passed to onStartRequest.If the channel's and loadgroup's notification callbacks do not provide an nsIChannelEventSink when onChannelRedirect would be called, that's equivalent to having called onChannelRedirect.If asyncOpen returns successfully, the channel is responsible for keeping itself alive until it has called onStopRequest on aListener or called onChannelRedirect.Implementations are allowed to synchronously add themselves to the associated load group (if any).
*
* @param {Components.interfaces.nsIStreamListener} aListener in nsIStreamListener aListener, The nsIStreamListener implementation.
* @param {Components.interfaces.nsISupports} aContext in nsISupports aContext An opaque parameter forwarded to aListener's methods.
*/
Components.interfaces.nsIChannel.prototype.asyncOpen=function(aListener, aContext){};
/**
* Synchronously open the channel.Note: Extensions should not call this method, because it tends to fail when a request is redirected, rather than redirecting transparentlyNote: nsIChannel implementations are not required to implement this method. Moreover, since this method may block the calling thread, it should not be called on a thread that processes UI events. Like any other nsIChannel method it must not be called on any thread other than the XPCOM main thread.
*
*/
Components.interfaces.nsIChannel.prototype.open=function(){};
/**
* Implement this interface to gain control over various channel events, such as redirects.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIChannelEventSink=function(){};
/**
* This is a temporary redirect. New requests for this resource should continue to use the URI of the old channel.
* The new URI may be identical to the old one.
*
* @constant
*/
Components.interfaces.nsIChannelEventSink.prototype.REDIRECT_TEMPORARY=1 << 0;
/**
* This is a permanent redirect. New requests for this resource should use the URI of the new channel (This might be an HTTP 301 reponse). If this flag is not set, this is a temporary redirect.
* The new URI may be identical to the old one.
*
* @constant
*/
Components.interfaces.nsIChannelEventSink.prototype.REDIRECT_PERMANENT=1 << 1;
/**
* This is an internal redirect, i.e. it was not initiated by the remote server, but is specific to the channel implementation.
* The new URI may be identical to the old one.
*
* @constant
*/
Components.interfaces.nsIChannelEventSink.prototype.REDIRECT_INTERNAL=1 << 2;
/**
* A container for policy information to be used during channel creation.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIChannelPolicy=function(){};
/**
* A nsIContentSecurityPolicy object to determine if the load should be allowed.
*
* @type {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIChannelPolicy.prototype.contentSecurityPolicy=new Components.interfaces.nsISupports();
/**
* Indicates what type of content is being loaded, for example nsIContentPolicy::TYPE_IMAGE.
*
* @type {Number}
*/
Components.interfaces.nsIChannelPolicy.prototype.loadType=0;
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICharsetResolver=function(){};
/**
* Some implementations may request that they be notified when the charset is actually detected.
*
* @param {String} charset in ACString charset, The detected charset.
* @param {Components.interfaces.nsISupports} closure in nsISupports closure The closure returned by requestCharset().
*/
Components.interfaces.nsICharsetResolver.prototype.notifyResolvedCharset=function(charset, closure){};
/**
* Called to resolve the charset that should be used for parsing the document being loaded from aChannel.If the charset cannot be resolved, but the implementation of nsICharsetResolver wants to be notified of the final resolved charset when one is available, it can set aWantCharset to true. If this is done, the caller of requestCharset is responsible for calling notifyResolvedCharset() and passing it the final resolved charset and the closure that requestCharset set.
*
* @param {Components.interfaces.nsIWebNavigation} aWebNavigation in nsIWebNavigation aWebNavigation, The nsIWebNavigation the document is being loaded in. May be null.
* @param {Components.interfaces.nsIChannel} aChannel in nsIChannel aChannel, The channel the document is coming in from.
* @param {Boolean} aWantCharset out boolean aWantCharset, Gets set to true if notifyResolvedCharset() should be called with the given aClosure object.
* @param {Components.interfaces.nsISupports} aClosure out nsISupports aClosure A resulting object which should be passed to notifyResolvedCharset() if aWantCharset is set to true.
*/
Components.interfaces.nsICharsetResolver.prototype.requestCharset=function(aWebNavigation, aChannel, aWantCharset, aClosure){};
/**
* Handles loading of content in a remote chrome frame.
*
* @constructor
* @inherits {Components.interfaces.nsIFrameMessageManager}
*/
Components.interfaces.nsIChromeFrameMessageManager=function(){};
/**
* Loads a script into the remote frame.
*
* @param {String} aURL in AString aURL, The URL of the script to load into the frame; this must be an absolute URL, but data: URLs are supported.
* @param {Boolean} aAllowDelayedLoad in boolean aAllowDelayedLoad If true, the script will be loaded when the remote frame becomes available; otherwise, the script will only be loaded if the frame is already available.
*/
Components.interfaces.nsIChromeFrameMessageManager.prototype.loadFrameScript=function(aURL, aAllowDelayedLoad){};
/**
* Provides access to the chrome registry; you can use this to get information about chrome documents that have been registered.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIChromeRegistry=function(){};
/**
* @constant
*/
Components.interfaces.nsIChromeRegistry.prototype.NONE=0;
/**
* @constant
*/
Components.interfaces.nsIChromeRegistry.prototype.PARTIAL=1;
/**
* @constant
*/
Components.interfaces.nsIChromeRegistry.prototype.FULL=2;
/**
* Refreshes the chrome list at runtime, looking for new packages and so forth.
*
*/
Components.interfaces.nsIChromeRegistry.prototype.checkForNewChrome=function(){};
/**
* Resolves a chrome URL to an loadable URI using the information in the registry. A new nsIURI is returned; the original is left unmodified.This lets you take a non-canonical chrome URI, such as chrome://package/provider/file, and convert it into a canonical one. This is useful because chrome URLs are allowed to be specified in "shorthand", leaving the "file" portion off. In that case, the URL is expanded to chrome://package/provider/package.ext.The extension, ext, is one of:
* xul
* For a "content" package.
* css
* For a "skin" package.
* dtd
* For a "locale" package.
*
* @param {Components.interfaces.nsIURI} aChromeURL in nsIURI aChromeURL The URL that is to be converted.
*/
Components.interfaces.nsIChromeRegistry.prototype.convertChromeURL=function(aChromeURL){};
/**
* This interface supports basic clipboard operations such as: setting, retrieving, emptying, matching and supporting clipboard data.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIClipboard=function(){};
/**
* Clipboard for selection.
*
* @constant
*/
Components.interfaces.nsIClipboard.prototype.kSelectionClipboard=0;
/**
* Clipboard for global use.
*
* @constant
*/
Components.interfaces.nsIClipboard.prototype.kGlobalClipboard=1;
/**
* This method empties the clipboard and notifies the clipboard owner. It empties the "logical" clipboard. It does not clear the native clipboard.
*
* @param {Number} aWhichClipboard in long aWhichClipboard Specifies the clipboard to which this operation applies.
*/
Components.interfaces.nsIClipboard.prototype.emptyClipboard=function(aWhichClipboard){};
/**
* This method retrieves data from the clipboard into a transferable.
*
* @param {Components.interfaces.nsITransferable} aTransferable in nsITransferable aTransferable, The transferable to receive data from the clipboard.
* @param {Number} aWhichClipboard in long aWhichClipboard Specifies the clipboard to which this operation applies.
*/
Components.interfaces.nsIClipboard.prototype.getData=function(aTransferable, aWhichClipboard){};
/**
* This method provides a way to give correct UI feedback about, for instance, whether a paste should be allowed. It does not actually retrieve the data and should be a very inexpensive call. All it does is check if there is data on the clipboard matching any of the flavors in the given list.
*
* @param {String} aFlavorList [array, size_is(aLength] in string aFlavorList, An array of ASCII strings.
* @param {Number} aLength in unsigned long aLength, The length of the aFlavorList.
* @param {Number} aWhichClipboard in long aWhichClipboard Specifies the clipboard to which this operation applies.
*/
Components.interfaces.nsIClipboard.prototype.hasDataMatchingFlavors=function(aFlavorList, aLength, aWhichClipboard){};
/**
* This method sets the data from a transferable on the native clipboard.
*
* @param {Components.interfaces.nsITransferable} aTransferable in nsITransferable aTransferable, The transferable containing the data to put on the clipboard.
* @param {Components.interfaces.nsIClipboardOwner} anOwner in nsIClipboardOwner anOwner, The owner of the transferable.
* @param {Number} aWhichClipboard in long aWhichClipboard Specifies the clipboard to which this operation applies.
*/
Components.interfaces.nsIClipboard.prototype.setData=function(aTransferable, anOwner, aWhichClipboard){};
/**
* This method allows clients to determine if the implementation supports the concept of a separate clipboard for selection.
*
*/
Components.interfaces.nsIClipboard.prototype.supportsSelectionClipboard=function(){};
/**
* An interface for embedding clients who wish to interact with the system-wide OS clipboard. Mozilla does not use a private clipboard, instead it places its data directly onto the system clipboard. The webshell implements this interface.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIClipboardCommands=function(){};
/**
* Returns whether we can copy an image's contents.
*
*/
Components.interfaces.nsIClipboardCommands.prototype.canCopyImageContents=function(){};
/**
* Returns whether we can copy an image location.
*
*/
Components.interfaces.nsIClipboardCommands.prototype.canCopyImageLocation=function(){};
/**
* Returns whether we can copy a link location.
*
*/
Components.interfaces.nsIClipboardCommands.prototype.canCopyLinkLocation=function(){};
/**
* Returns whether there is a selection and it is copyable.
*
*/
Components.interfaces.nsIClipboardCommands.prototype.canCopySelection=function(){};
/**
* Returns whether there is a selection and it is not read-only.
*
*/
Components.interfaces.nsIClipboardCommands.prototype.canCutSelection=function(){};
/**
* Returns whether the current contents of the clipboard can be pasted and if the current selection is not read-only.
*
*/
Components.interfaces.nsIClipboardCommands.prototype.canPaste=function(){};
/**
* Copy the contents of the selected image.
*
*/
Components.interfaces.nsIClipboardCommands.prototype.copyImageContents=function(){};
/**
* Copy the location of the selected image.
*
*/
Components.interfaces.nsIClipboardCommands.prototype.copyImageLocation=function(){};
/**
* Copy the link location of the current selection (For example the |href| attribute of a selected |a| tag).
*
*/
Components.interfaces.nsIClipboardCommands.prototype.copyLinkLocation=function(){};
/**
* Copy the current selection onto the clipboard.
*
*/
Components.interfaces.nsIClipboardCommands.prototype.copySelection=function(){};
/**
* Cut the current selection onto the clipboard.
*
*/
Components.interfaces.nsIClipboardCommands.prototype.cutSelection=function(){};
/**
* Paste the contents of the clipboard into the current selection.
*
*/
Components.interfaces.nsIClipboardCommands.prototype.paste=function(){};
/**
* Select the entire contents.
*
*/
Components.interfaces.nsIClipboardCommands.prototype.selectAll=function(){};
/**
* Clear the current selection (if any). Insertion point ends up at beginning of current selection.
*
*/
Components.interfaces.nsIClipboardCommands.prototype.selectNone=function(){};
/**
* Interfaces for overriding the built-in drag, drop, copy, and paste implementations in the content area and editors. Use this to do things such as prevent a drag from starting, adding or removing data and flavors, or preventing the drop.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIClipboardDragDropHooks=function(){};
/**
* Tells gecko whether a drop is allowed on this content area.
*
* @param {Components.interfaces.nsIDOMEvent} event in nsIDOMEvent event, The DOM event (drag gesture).
* @param {Components.interfaces.nsIDragSession} session in nsIDragSession session The drag session from which client can get the flavors present or the actual data.
*/
Components.interfaces.nsIClipboardDragDropHooks.prototype.allowDrop=function(event, session){};
/**
* Prevents the drag from starting.
*
* @param {Components.interfaces.nsIDOMEvent} event in nsIDOMEvent event The DOM event (drag gesture).
*/
Components.interfaces.nsIClipboardDragDropHooks.prototype.allowStartDrag=function(event){};
/**
* Alters the flavors or data presented to the OS. Used for drag and copy actions. Because this can be called many times, it is highly recommended that the implementation be very efficient so user feedback is not negatively impacted.
*
* @param {Components.interfaces.nsIDOMEvent} aEvent in nsIDOMEvent aEvent, The DOM event (drag drop). null if triggered by copy.
* @param {Components.interfaces.nsITransferable} trans in nsITransferable trans The transferable holding the list of flavors and the data for each flavor.
*/
Components.interfaces.nsIClipboardDragDropHooks.prototype.onCopyOrDrag=function(aEvent, trans){};
/**
* Provide an alternative action to the built-in behavior when something is dropped on the browser or in an editor.
*
* @param {Components.interfaces.nsIDOMEvent} event in nsIDOMEvent event, The DOM event (drag drop); null if triggered by paste.
* @param {Components.interfaces.nsITransferable} trans in nsITransferable trans The transferable holding the list of flavors and the data for each flavor.
*/
Components.interfaces.nsIClipboardDragDropHooks.prototype.onPasteOrDrop=function(event, trans){};
/**
* The nsIClipboardHelper interface is a helper service for common uses of nsIClipboard interface.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIClipboardHelper=function(){};
/**
* This method copies string to (default) clipboard.
*
* @param {String} aString in AString aString The string to copy to the clipboard.
*/
Components.interfaces.nsIClipboardHelper.prototype.copyString=function(aString){};
/**
* This method copies string to given clipboard.
*
* @param {String} aString in AString aString, The string to copy to the clipboard.
* @param {Number} aClipboardID in long aClipboardID The ID of the clipboard to copy to (For example kSelectionClipboard).
*/
Components.interfaces.nsIClipboardHelper.prototype.copyStringToClipboard=function(aString, aClipboardID){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIClipboardOwner=function(){};
/**
* This method notifies the owner of the clipboard transferable that the transferable is being removed from the clipboard. It results into a NS_Ok if there are no errors.
*
* @param {Components.interfaces.nsITransferable} aTransferable in nsITransferable aTransferable The transferable.
*/
Components.interfaces.nsIClipboardOwner.prototype.LosingOwnership=function(aTransferable){};
/**
* An enhanced controller interface that supports passing parameters to commands.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICommandController=function(){};
/**
* Executes the specified command with a set of parameters contained in an nsICommandParams object.
*
* @param {String} command in string command, The command to execute.
* @param {Components.interfaces.nsICommandParams} aCommandParams in nsICommandParams aCommandParams The parameters.
*/
Components.interfaces.nsICommandController.prototype.doCommandWithParams=function(command, aCommandParams){};
/**
*
*
* @param {String} command in string command, The command whose state is to be determined.
* @param {Components.interfaces.nsICommandParams} aCommandParams in nsICommandParams aCommandParams The command parameters.
*/
Components.interfaces.nsICommandController.prototype.getCommandStateWithParams=function(command, aCommandParams){};
/**
* Represents the command line used to invoke a XUL application. This may be the original command line of this instance or a command line provided remotely by another instance of the application.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICommandLine=function(){};
/**
* The first launch of the application instance.
*
* @constant
*/
Components.interfaces.nsICommandLine.prototype.STATE_INITIAL_LAUNCH=0;
/**
* A remote command line automatically redirected to this instance.
*
* @constant
*/
Components.interfaces.nsICommandLine.prototype.STATE_REMOTE_AUTO=1;
/**
* A remote command line explicitly redirected to this instance using xremote/windde/appleevents.
*
* @constant
*/
Components.interfaces.nsICommandLine.prototype.STATE_REMOTE_EXPLICIT=2;
/**
* Number of arguments in the command line. The application name is not part of the command line. Read only.
*
* @type {Number}
*/
Components.interfaces.nsICommandLine.prototype.length=0;
/**
* There may be a command-line handler which performs a default action if there was no explicit action on the command line (open a default browser window, for example). This flag allows the default action to be prevented.
*
* @type {Boolean}
*/
Components.interfaces.nsICommandLine.prototype.preventDefault=false;
/**
* The type of command line being processed. See State constants. Read only.
*
* @type {Number}
*/
Components.interfaces.nsICommandLine.prototype.state=0;
/**
* A window to be targeted by this command line. In most cases, this will be null (xremote will sometimes set this attribute). Read only.
*
* @type {Components.interfaces.nsIDOMWindow}
*/
Components.interfaces.nsICommandLine.prototype.windowContext=new Components.interfaces.nsIDOMWindow();
/**
* The working directory for this command line. Use this property instead of the working directory for the current process, since a redirected command line may have had a different working directory. Read only.
*
* @type {Components.interfaces.nsIFile}
*/
Components.interfaces.nsICommandLine.prototype.workingDirectory=new Components.interfaces.nsIFile();
/**
* Finds a command-line flag, returning its position on the command line.
*
* @param {String} aFlag in AString aFlag, The flag name to locate. Do not include the initial hyphen.
* @param {Boolean} aCaseSensitive in boolean aCaseSensitive Whether to do case-sensitive comparisons.
*/
Components.interfaces.nsICommandLine.prototype.findFlag=function(aFlag, aCaseSensitive){};
/**
* Gets the value an argument from the array of command-line arguments, given the index into the argument list.On Windows, flags of the form /flag are normalized to -flag. /flag:param are normalized to -flag param.On Unix/Linux and Mac OS X, flags of the form --flag are normalized to -flag, and flags of the form --flag=param are normalized to the form -flag param.
*
* @param {Number} aIndex in long aIndex The argument to retrieve. This index is 0-based, and does not include the application name.
*/
Components.interfaces.nsICommandLine.prototype.getArgument=function(aIndex){};
/**
* Finds the specified flag, removing it from the array of flags. Reports whether or not the specified flag was found. This is useful for Boolean flags; that is, flags that don't accept a parameter. You can determine if the flag was provided and remove it from the list of flags waiting to be processed in one operation.
*
* @param {String} aFlag in AString aFlag, The flag name to find and remove.
* @param {Boolean} aCaseSensitive in boolean aCaseSensitive Whether to do case-sensitive comparisons.
*/
Components.interfaces.nsICommandLine.prototype.handleFlag=function(aFlag, aCaseSensitive){};
/**
* Finds a flag in the list of flags waiting to be processed and returns its value, after removing both the flag and its value from the list of flags waiting to be handled. This is useful for processing flags that accept a value. This is, essentially, a helper method that combines findFlag() and removeArguments() into one operation.
*
* @param {String} aFlag in AString aFlag, The flag name to find and remove.
* @param {Boolean} aCaseSensitive in boolean aCaseSensitive Whether to do case-sensitive flag search.
*/
Components.interfaces.nsICommandLine.prototype.handleFlagWithParam=function(aFlag, aCaseSensitive){};
/**
* Removes a range of arguments from the command line; this is typically done once those arguments have been handled.
*
* @param {Number} aStart in long aStart, The index to the first argument to remove from the command line; this is 0-based, and the name of the application is not included.
* @param {Number} aEnd in long aEnd The index to the last argument to remove from the command line.
*/
Components.interfaces.nsICommandLine.prototype.removeArguments=function(aStart, aEnd){};
/**
* Resolves a file-path argument into an nsIFile object. This method gracefully handles relative or absolute file paths, according to the working directory of this command line.
*
* @param {String} aArgument in AString aArgument The command-line argument to resolve.
*/
Components.interfaces.nsICommandLine.prototype.resolveFile=function(aArgument){};
/**
* Resolves a URI argument into a URI. This method has platform-specific logic for converting an absolute URI or a relative file-path into the appropriate URI object; it gracefully handles win32 C:\ paths which would confuse the I/O service if passed directly.
*
* @param {String} aArgument in AString aArgument The command-line argument to resolve.
*/
Components.interfaces.nsICommandLine.prototype.resolveURI=function(aArgument){};
/**
* Handles arguments on the command line of a XUL application.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICommandLineHandler=function(){};
/**
* When the application is launched with the -help argument, this attribute is retrieved and displayed to the user (on stdout). The text should have embedded newlines which wrap at 76 columns, and should include a newline at the end. By convention, the right column which contains flag descriptions begins at the 24th character. Read only.
*
* @type {String}
*/
Components.interfaces.nsICommandLineHandler.prototype.helpInfo="";
/**
* Processes a command line. If this handler finds arguments that it understands, it should perform the appropriate actions (such as opening a window), and remove the arguments from the command-line array.
*
* @param {Components.interfaces.nsICommandLine} aCommandLine in nsICommandLine aCommandLine Command line to process.
*/
Components.interfaces.nsICommandLineHandler.prototype.handle=function(aCommandLine){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsICommandLine}
*/
Components.interfaces.nsICommandLineRunner=function(){};
/**
* Process and combine the help text provided by each command-line handler. Read only.
*
* @type {String}
*/
Components.interfaces.nsICommandLineRunner.prototype.helpText="";
/**
* Called with the argc/argv combination passed to main. It assumes a native character set. On Windows the character set is UTF-8, not the native codepage.
*
* @param {Number} argc in long argc, The number of arguments being passed.
* @param {Components.interfaces.nsCharPtrArray} argv in nsCharPtrArray argv, An array storing pointers to the arguments
* @param {Components.interfaces.nsIFile} workingDir in nsIFile workingDir, Directory where the command will run. This is used to resolve file and URI paths.
* @param {Number} state in unsigned long state The type of command line being processed. This is an nsICommandLine state flag.
*/
Components.interfaces.nsICommandLineRunner.prototype.init=function(argc, argv, workingDir, state){};
/**
* Processes the command-line handlers in the proper order, and calls nsICommandLineHandler.handle() on each.
*
*/
Components.interfaces.nsICommandLineRunner.prototype.run=function(){};
/**
* Sets the windowContext parameter.
*
* @param {Components.interfaces.nsIDOMWindow} aWindow in nsIDOMWindow aWindow The DOM window object which will be set. It is an nsIDOMWindow object.
*/
Components.interfaces.nsICommandLineRunner.prototype.setWindowContext=function(aWindow){};
/**
* This interface provides methods to access factory objects and instantiate instances of classes.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIComponentManager=function(){};
/**
* Creates an instance of the class specified by ClassID.
*
* @param {Components.interfaces.nsCIDRef} aClass in nsCIDRef aClass, The ClassID of the object instance that is being requested.
* @param {Components.interfaces.nsISupports} aDelegate in nsISupports aDelegate, The outer object used for aggregation.
* @param {Components.interfaces.nsIIDRef} aIID in nsIIDRef aIID, The interface type to be returned.
* @param {Components.interfaces.nsQIResult} result [iid_is(aIID,retval] out nsQIResult result The resulting interface pointer.
*/
Components.interfaces.nsIComponentManager.prototype.createInstance=function(aClass, aDelegate, aIID, result){};
/**
* Creates an instance of the class specified by ContractID.
*
* @param {String} aContractID in string aContractID, The ContractID of the object instance that is being requested.
* @param {Components.interfaces.nsISupports} aDelegate in nsISupports aDelegate, The outer object used for aggregation.
* @param {Components.interfaces.nsIIDRef} aIID in nsIIDRef aIID, The interface type to be returned.
* @param {Components.interfaces.nsQIResult} result [iid_is(aIID,retval] out nsQIResult result The resulting interface pointer.
*/
Components.interfaces.nsIComponentManager.prototype.createInstanceByContractID=function(aContractID, aDelegate, aIID, result){};
/**
* Returns the factory object for the class specified by ClassID.
*
* @param {Components.interfaces.nsCIDRef} aClass in nsCIDRef aClass, The ClassID of the factory that is being requested.
* @param {Components.interfaces.nsIIDRef} aIID in nsIIDRef aIID, The interface type to be returned.
* @param {Components.interfaces.nsQIResult} result [iid_is(aIID,retval] out nsQIResult result The resulting interface pointer.
*/
Components.interfaces.nsIComponentManager.prototype.getClassObject=function(aClass, aIID, result){};
/**
* Returns the factory object for the class specified by ContractID.
*
* @param {String} aContractID in string aContractID, The ContractID of the factory that is being requested.
* @param {Components.interfaces.nsIIDRef} aIID in nsIIDRef aIID, The interface type to be returned.
* @param {Components.interfaces.nsQIResult} result [iid_is(aIID,retval] out nsQIResult result The resulting interface pointer.
*/
Components.interfaces.nsIComponentManager.prototype.getClassObjectByContractID=function(aContractID, aIID, result){};
/**
* This interface provides methods to access and modify the XPCOM component registry.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIComponentRegistrar=function(){};
/**
* Register a component (.manifest) file or all component files in a directory. Registration lasts for this run only, and is not cached.Note: Formerly this method would register component files directly. This is no longer supported.Component files must have an associated loader and export the required symbols which this loader defines. For example, if the given file is a native library, it must export the symbol NSGetModule. Other loaders may have different semantics.This method may only be called from the main thread.
*
* @param {Components.interfaces.nsIFile} aSpec in nsIFile aSpec This parameter indicates either a component file to be registered or a directory containing component files to be registered. XPCOM <= 1.8: If aSpec is null, then the application component's directory as defined by NS_XPCOM_COMPONENT_DIR will be registered. See nsDirectoryService. XPCOM >= 1.9: If aSpec is null, static components, GRE components, and the the application's component directories will be registered. See NS_GRE_DIR, NS_XPCOM_COMPONENT_DIR, and NS_XPCOM_COMPONENT_DIR_LIST in nsDirectoryService.
*/
Components.interfaces.nsIComponentRegistrar.prototype.autoRegister=function(aSpec){};
/**
* Unregister a component file or all component files in a directory.This method may only be called from the main thread.
*
* @param {Components.interfaces.nsIFile} aSpec in nsIFile aSpec This parameter indicates either a component file to be unregistered or a directory containing component files to be unregistered. If aSpec is null, then the application component's directory as defined by NS_XPCOM_COMPONENT_DIR will be unregistered. See nsDirectoryService.
*/
Components.interfaces.nsIComponentRegistrar.prototype.autoUnregister=function(aSpec){};
/**
* This method returns the ContractID corresponding to a given ClassID.
*
* @param {Components.interfaces.nsCIDRef} aClass in nsCIDRef aClass The ClassID to be queried.
*/
Components.interfaces.nsIComponentRegistrar.prototype.CIDToContractID=function(aClass){};
/**
* Returns the ClassID for a given ContractID, if one exists and is registered.
*
* @param {String} aContractID in string aContractID The ContractID to be queried.
*/
Components.interfaces.nsIComponentRegistrar.prototype.contractIDToCID=function(aContractID){};
/**
* This method returns an enumerator over the list of registered ClassIDs.Elements of the enumeration can be QueryInterfaced for the nsISupportsID interface. From the nsISupportsID, you can obtain the actual ClassID.
*
*/
Components.interfaces.nsIComponentRegistrar.prototype.enumerateCIDs=function(){};
/**
* This method returns an enumerator over the list of registered ContractIDs.Elements of the enumeration can be QueryInterfaced for the nsISupportsCString interface. From the nsISupportsCString interface, you can obtain the actual ContractID string.
*
*/
Components.interfaces.nsIComponentRegistrar.prototype.enumerateContractIDs=function(){};
/**
* This method is used to test for the existence of a specific ClassID.
*
* @param {Components.interfaces.nsCIDRef} aClass in nsCIDRef aClass The ClassID to be queried.
*/
Components.interfaces.nsIComponentRegistrar.prototype.isCIDRegistered=function(aClass){};
/**
* This method is used to test for the existence of a class implementing a specific ContractID.
*
* @param {String} aContractID in string aContractID The ContractID to be queried.
*/
Components.interfaces.nsIComponentRegistrar.prototype.isContractIDRegistered=function(aContractID){};
/**
* Registers a factory to be used to instantiate a particular class identified by ClassID, and creates an association of class name and ContractID with the class.
*
* @param {Components.interfaces.nsCIDRef} aClass in nsCIDRef aClass, The ClassID of the class being registered.
* @param {String} aClassName in string aClassName, The name of the class being registered. This value is intended as a human-readable name for the class and need not be globally unique. (unused)
* @param {String} aContractID in string aContractID, The ContractID of the class being registered. May be null if no ContractID is needed.
* @param {Components.interfaces.nsIFactory} aFactory in nsIFactory aFactory The nsIFactory instance of the class being registered. If aFactory is null, the contract will be associated with a previously registered ClassID.
*/
Components.interfaces.nsIComponentRegistrar.prototype.registerFactory=function(aClass, aClassName, aContractID, aFactory){};
/**
* Registers a factory to be used to instantiate a particular class identified by ClassID, and creates an association of class name and ContractID with the class. However, unlike registerFactory(), the location of the component containing the factory implementation is specified instead of the factory instance.
*
* @param {Components.interfaces.nsCIDRef} aClass in nsCIDRef aClass, The ClassID of the class being registered.
* @param {String} aClassName in string aClassName, The name of the class being registered. This value is intended as a human-readable name for the class and need not be globally unique.
* @param {String} aContractID in string aContractID, The ContractID of the class being registered.
* @param {Components.interfaces.nsIFile} aFile in nsIFile aFile, A component file. This file must have an associated loader and export the required symbols, which the loader specifies.
* @param {String} aLoaderStr in string aLoaderStr, Opaque loader specific string. This value is passed into the nsIModule.registerSelf() callback and must be forwarded unmodified when registering factories via their location.
* @param {String} aType in string aType Component Type of aClass. This value is passed into thensIModule.registerSelf() callback and must be forwarded unmodified when registering factories via their location.
*/
Components.interfaces.nsIComponentRegistrar.prototype.registerFactoryLocation=function(aClass, aClassName, aContractID, aFile, aLoaderStr, aType){};
/**
* Unregister a factory associated with a particular class identified by ClassID.
*
* @param {Components.interfaces.nsCIDRef} aClass in nsCIDRef aClass, The ClassID of the class being unregistered.
* @param {Components.interfaces.nsIFactory} aFactory in nsIFactory aFactory The nsIFactory instance of the class being unregistered.
*/
Components.interfaces.nsIComponentRegistrar.prototype.unregisterFactory=function(aClass, aFactory){};
/**
* Unregisters the factory associated with a given ClassID and component file location.
*
* @param {Components.interfaces.nsCIDRef} aClass in nsCIDRef aClass, The ClassID that was previously registered.
* @param {Components.interfaces.nsIFile} aFile in nsIFile aFile The component file that was previously registered.
*/
Components.interfaces.nsIComponentRegistrar.prototype.unregisterFactoryLocation=function(aClass, aFile){};
/**
* This interface allows you to listen for messages sent to the console.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIConsoleListener=function(){};
/**
* Called by the nsIConsoleService when a message is posted to the console. Listeners must first be attached to the service using nsIConsoleService.registerListener()
*
* @param {Components.interfaces.nsIConsoleMessage} aMessage in nsIConsoleMessage aMessage The nsIConsoleMessage being posted.
*/
Components.interfaces.nsIConsoleListener.prototype.observe=function(aMessage){};
/**
* This interface is a base interface for messages passed to or from the nsIConsoleService.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIConsoleMessage=function(){};
/**
* The message in a string format. [binaryname(MessageMoz)] Read only.
*
* @type {String}
*/
Components.interfaces.nsIConsoleMessage.prototype.message="";
/**
* The console service is the back-end part of the Error Console tool, bundled with every Mozilla application. It is used to log various messages, warnings, and errors and to obtain the logged messages.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIConsoleService=function(){};
/**
* Get an array of all the messages logged so far.Obsolete since Gecko 19 (Firefox 19 / Thunderbird 19 / SeaMonkey 2.16)This feature is obsolete. Although it is still supported by browsers, its usage is discouraged in new projects. Try to avoid using it.
*
* @param {Components.interfaces.nsIConsoleMessage} messages [array, size_is(count] out nsIConsoleMessage messages, An array of current logged messages.
* @param {Number} count out PRUint32 count The number of messages in the array. If no messages are logged, this function will return a count of 0 but still will allocate one word for messages, so as to show up as a 0-length array when called from script.
*/
Components.interfaces.nsIConsoleService.prototype.getMessageArray=function(messages, count){};
/**
*
*
* @param {Components.interfaces.nsIConsoleMessage} message in nsIConsoleMessage message An nsIConsoleMessage to log.
*/
Components.interfaces.nsIConsoleService.prototype.logMessage=function(message){};
/**
* Convenience method for logging simple messages.
*
* @param {String} message in wstring message The string to log.
*/
Components.interfaces.nsIConsoleService.prototype.logStringMessage=function(message){};
/**
* Registers a listener for notification when an error is logged.Note: To guard against stack overflows from listeners that could log messages (it is easy to do this inadvertently from listeners implemented in JavaScript), we do not call any listeners when another error is already being logged.
*
* @param {Components.interfaces.nsIConsoleListener} listener in nsIConsoleListener listener The nsIConsoleListener to add.
*/
Components.interfaces.nsIConsoleService.prototype.registerListener=function(listener){};
/**
* Unregisters a listener.
*
* @param {Components.interfaces.nsIConsoleListener} listener in nsIConsoleListener listener The nsIConsoleListener to remove.
*/
Components.interfaces.nsIConsoleService.prototype.unregisterListener=function(listener){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIContainerBoxObject=function(){};
/**
* Read only. The nsIDocShell object that manages the contained document. The browser.xml, editor.xml and general.xml bindings use this property to gain access to other properties such as webNavigation, contentDocument and contentWindow.
*
* @type {Components.interfaces.nsIDocShell}
*/
Components.interfaces.nsIContainerBoxObject.prototype.docShell=new Components.interfaces.nsIDocShell();
/**
* Implements content frames' support for receiving messages from the chrome process.
*
* @constructor
* @inherits {Components.interfaces.nsISyncMessageSender}
*/
Components.interfaces.nsIContentFrameMessageManager=function(){};
/**
* The current top level window in the frame or null. Read only.
*
* @type {Components.interfaces.nsIDOMWindow}
*/
Components.interfaces.nsIContentFrameMessageManager.prototype.content=new Components.interfaces.nsIDOMWindow();
/**
* The top level docshell or null. Read only.
*
* @type {Components.interfaces.nsIDocShell}
*/
Components.interfaces.nsIContentFrameMessageManager.prototype.docShell=new Components.interfaces.nsIDocShell();
/**
* Prints the specified string to standard output.
*
* @param {String} aStr in DOMString aStr The string to output.
*/
Components.interfaces.nsIContentFrameMessageManager.prototype.dump=function(aStr){};
/**
* Synchronously sends a message from the content frame to chrome.
*
* @param {String} messageName in DOMString messageName, The name of the message.
* @param {Components.interfaces.Object} json in Object json, An object that will be converted into JSON then sent along with the message.
* @param {Components.interfaces.[array]} jsObjects in [array] jsObjects An array of JavaScript objects to send, which the recipient can access using the message.objects array. For now, this is not implemented.
*/
Components.interfaces.nsIContentFrameMessageManager.prototype.sendSyncMessage=function(messageName, json, jsObjects){};
/**
* Convert Ascii base64 data to binary data.
*
* @param {String} aAsciiString in DOMString aAsciiString undefined
*/
Components.interfaces.nsIContentFrameMessageManager.prototype.atob=function(aAsciiString){};
/**
* Convert binary data to ascii base64 data .
*
* @param {String} aBase64Data in DOMString aBase64Data undefined
*/
Components.interfaces.nsIContentFrameMessageManager.prototype.btoa=function(aBase64Data){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIContentPolicy=function(){};
/**
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.TYPE_OTHER=1;
/**
* Indicates an executable script (such as JavaScript).
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.TYPE_SCRIPT=2;
/**
* Indicates an image (for example, IMG elements).
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.TYPE_IMAGE=3;
/**
* Indicates a stylesheet (for example, STYLE elements).
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.TYPE_STYLESHEET=4;
/**
* Indicates a generic object (plugin-handled content typically falls under this category).
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.TYPE_OBJECT=5;
/**
* Indicates a document at the top-level (that is in a browser).
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.TYPE_DOCUMENT=6;
/**
* Indicates a document contained within another document (for example, IFRAMEs, FRAMES, and OBJECTs).
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.TYPE_SUBDOCUMENT=7;
/**
* Indicates a timed refresh.
* shouldLoad() will never get this, because it does not represent content to be loaded (the actual load triggered by the refresh will go through shouldLoad() as expected).
* shouldProcess() will get this for, for example META Refresh elements and HTTP Refresh headers.
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.TYPE_REFRESH=8;
/**
* Indicates an XBL binding request, triggered either by -moz-binding CSS property or Document.addBinding method.
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.TYPE_XBL=9;
/**
* Indicates a ping triggered by a click on element.
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.TYPE_PING=10;
/**
* Indicates an XMLHttpRequest. Also used for document.load.
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.TYPE_XMLHTTPREQUEST=11;
/**
* Indicates a request by a plugin.
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.TYPE_OBJECT_SUBREQUEST=12;
/**
* Indicates a DTD loaded by an XML document.
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.TYPE_DTD=13;
/**
* Indicates a font loaded via @font-face rule.
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.TYPE_FONT=14;
/**
* Indicates a video or audio load.
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.TYPE_MEDIA=15;
/**
* Indicates a WebSocket load.
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.TYPE_WEBSOCKET=16;
/**
* Returned from shouldLoad() or shouldProcess() if the load or process request is rejected based on details of the request.
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.REJECT_REQUEST=-1;
/**
* Returned from shouldLoad() or shouldProcess() if the load/process is rejected based solely on its type (of the above flags).
* Note: It is not meant to stop future requests for this type--only the current request.
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.REJECT_TYPE=-2;
/**
* Returned from shouldLoad() or shouldProcess() if the load/process is rejected based on the server it is hosted on or requested from (aContentLocation or aRequestOrigin), e.g., if you block an IMAGE because it is served from goatse.cx (even if you don't necessarily block other types from that server/domain).
* Note: It is not meant to stop future requests for this server--only the current request.
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.REJECT_SERVER=-3;
/**
* Returned from shouldLoad() or shouldProcess() if the load/process is rejected based on some other criteria. Mozilla callers will handle this like REJECT_REQUEST; third-party implementors may, for example, use this to direct their own callers to consult the extra parameter for additional details.
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.REJECT_OTHER=-4;
/**
* Returned from shouldLoad() or shouldProcess() if the load or process request is not rejected.
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.ACCEPT=1;
/**
* Obsolete since Gecko 1.8
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.OTHER=0;
/**
* Obsolete since Gecko 1.8
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.SCRIPT=1;
/**
* Obsolete since Gecko 1.8
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.IMAGE=2;
/**
* Obsolete since Gecko 1.8
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.STYLESHEET=3;
/**
* Obsolete since Gecko 1.8
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.OBJECT=4;
/**
* Obsolete since Gecko 1.8
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.SUBDOCUMENT=5;
/**
* Obsolete since Gecko 1.8
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.CONTROL_TAG=6;
/**
* Obsolete since Gecko 1.8
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.RAW_URL=7;
/**
* Obsolete since Gecko 1.8
*
* @constant
*/
Components.interfaces.nsIContentPolicy.prototype.DOCUMENT=8;
/**
* Should the resource at this location be loaded? ShouldLoad() will be called before loading the resource at aContentLocation to determine whether to start the load at all.shouldLoad() can be called while the DOM and layout of the document involved is in an inconsistent state. This means that implementers of this method must not do any of the following:
* Modify the DOM in any way (e.g., setting attributes is a no-no).
* Query any DOM properties that depend on layout (e.g., offset* properties).
* Query any DOM properties that depend on style (e.g., computed style).
* Query any DOM properties that depend on the current state of the DOM outside the "context" node (e.g., lengths of node lists).
* [JavaScript implementations only] Access properties of any sort on any object without using XPCNativeWrapper (either explicitly or implicitly). Due to various DOM0 things, this leads to item 4.
* If you do any of these things in your shouldLoad() implementation, expect unpredictable behavior, possibly including crashes, content not showing up, content showing up doubled, etc. If you need to do any of the things above, do them off timeout or event.
* Note: When multiple content policies are used (for example through several extensions), if one of them rejects a request, the rest of the policies are not called. Reference: http://mxr.mozilla.org/mozilla-central/source/content/base/src/nsContentPolicy.cpp#146.
* Note: The order of content policies in the above case depends on the precedence of installation.
*
* @param {Number} aContentType in unsigned long aContentType, The type of content being tested. This will be one one of the TYPE_* constants.
* @param {Components.interfaces.nsIURI} aContentLocation in nsIURI aContentLocation, The location of the content being checked; must not be null.
* @param {Components.interfaces.nsIURI} aRequestOrigin in nsIURI aRequestOrigin, OPTIONAL. The location of the resource that initiated this load request; can be null if inapplicable.
* @param {Components.interfaces.nsISupports} aContext in nsISupports aContext, OPTIONAL. The nsIDOMNode or nsIDOMWindow that initiated the request, or something that can Query Interface to one of those; can be null if inapplicable. Note: aContext is the new tab/window when a user uses the context menu to open a link in a new tab/window or cmd/ctrl + clicks the link (i.e., aContext is not the tab which the link was on in these cases).
* @param {String} aMimeTypeGuess in ACString aMimeTypeGuess, OPTIONAL. a guess for the requested content's MIME type, based on information available to the request initiator (e.g., an OBJECT's type attribute); does not reliably reflect the actual MIME type of the requested content.
* @param {Components.interfaces.nsISupports} aExtra in nsISupports aExtra, An OPTIONAL argument, pass-through for non-Gecko callers to pass extra data to callees.
* @param {Components.interfaces.nsIPrincipal} aRequestPrincipal in nsIPrincipal aRequestPrincipal OPTIONAL. The requesting principal.
*/
Components.interfaces.nsIContentPolicy.prototype.shouldLoad=function(aContentType, aContentLocation, aRequestOrigin, aContext, aMimeTypeGuess, aExtra, aRequestPrincipal){};
/**
* Should the resource be processed? ShouldProcess() will be called once all the information passed to it has been determined about the resource, typically after part of the resource has been loaded. "Processing" means handling by the application. For instance, shouldProcess could be used to allow a response from a server to be handled or ignored depending on the MIME type of the response.Note: shouldProcess() can be called while the DOM and layout of the document involved is in an inconsistent state. See the note on shouldLoad() to see what this means for implementors of this method.
*
* @param {Number} aContentType in unsigned long aContentType, The type of content being tested. This will be one of the TYPE_* constants.
* @param {Components.interfaces.nsIURI} aContentLocation in nsIURI aContentLocation, OPTIONAL. The location of the resource being requested: MAY be, e.g., a post-redirection URI for the resource.
* @param {Components.interfaces.nsIURI} aRequestOrigin in nsIURI aRequestOrigin, OPTIONAL. The location of the resource that initiated this load request; can be null if inapplicable.
* @param {Components.interfaces.nsISupports} aContext in nsISupports aContext, OPTIONAL. The nsIDOMNode or nsIDOMWindow that initiated the request, or something that can Query Interface to one of those; can be null if inapplicable.
* @param {String} aMimeType in ACString aMimeType, The MIME type of the requested resource (for example, image/png), as reported by the networking library, if available (may be empty if inappropriate for the type, e.g., TYPE_REFRESH).
* @param {Components.interfaces.nsISupports} aExtra in nsISupports aExtra, An OPTIONAL argument, pass-through for non-Gecko callers to pass extra data to callees.
* @param {Components.interfaces.nsIPrincipal} aRequestPrincipal in nsIPrincipal aRequestPrincipal OPTIONAL. The requesting principal.
*/
Components.interfaces.nsIContentPolicy.prototype.shouldProcess=function(aContentType, aContentLocation, aRequestOrigin, aContext, aMimeType, aExtra, aRequestPrincipal){};
/**
* This interface allows code to easily watch for changes to the values of content preferences.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIContentPrefObserver=function(){};
/**
* Called when a content preference is removed.
*
* @param {String} aGroup in AString aGroup, The group to which the removed preference belonged; this may be the URI of a web site. This value is null if the preference was global, applying to all web sites.
* @param {String} aName in AString aName The name of the preference that was removed.
*/
Components.interfaces.nsIContentPrefObserver.prototype.onContentPrefRemoved=function(aGroup, aName){};
/**
* Called when the value of a preference is set (either by changing its current value or by creating the preference).
*
* @param {String} aGroup in AString aGroup, The group to which the preference belongs; this may be the URI of a web site. This value is null if the preference is global, applying to all web sites.
* @param {String} aName in AString aName, The name of the preference whose value has changed.
* @param {Components.interfaces.nsIVariant} aValue in nsIVariant aValue The preference's new value.
*/
Components.interfaces.nsIContentPrefObserver.prototype.onContentPrefSet=function(aGroup, aName, aValue){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIContentPrefService=function(){};
/**
* The database connection to the content preferences database. Useful for accessing and manipulating preferences in ways that are caller-specific or for which there is not yet a generic method, although generic functionality useful to multiple callers should generally be added to this unfrozen interface. Also useful for testing the database creation and migration code. Read only.
*
* @type {Components.interfaces.mozIStorageConnection}
*/
Components.interfaces.nsIContentPrefService.prototype.DBConnection=new Components.interfaces.mozIStorageConnection();
/**
* The component that the service uses to determine the groups to which URIs belong. By default, this is the "hostname grouper," which groups URIs by full hostname (in otherwords, by site). Read only.
*
* @type {Components.interfaces.nsIContentURIGrouper}
*/
Components.interfaces.nsIContentPrefService.prototype.grouper=new Components.interfaces.nsIContentURIGrouper();
/**
* Adds an observer that monitors a preference for changes.
*
* @param {String} aName in AString aName, The name of the preference to observe. You may specify null to add a generic observer that is notified of all preference changes.
* @param {Components.interfaces.nsIContentPrefObserver} aObserver in nsIContentPrefObserver aObserver The name of an object implementing nsIContentPrefObserver that will receive notifications of changes to the preference's value.
*/
Components.interfaces.nsIContentPrefService.prototype.addObserver=function(aName, aObserver){};
/**
* Returns the value of a preference saved for a particular site.
* Note: Prior to Gecko 2.0, the site could only be specified by nsIURI. Now a string can be used as well.
*
* @param {Components.interfaces.nsIVariant} aGroup in nsIVariant aGroup, The group for which to retrieve a preference; this may be specified as either a URI or as a string; in either case, the group consists of all sites matching the hostname portion of the specified URI. Specify null to get the preference from the global preference space; those preferences apply to all sites.
* @param {String} aName in AString aName, The name of the preference whose value is to be retrieved.
* @param {Components.interfaces.nsIContentPrefCallback aCallback} Optional in nsIContentPrefCallback aCallback Optional An optional nsIContentPrefCallback to receive the result. If desired, JavaScript callers can instead provide a function to call upon completion.
*/
Components.interfaces.nsIContentPrefService.prototype.getPref=function(aGroup, aName, Optional){};
/**
* Get all preferences and their values for the specified URI.
* Note: Prior to Gecko 2.0, the site could only be specified by nsIURI. Now a string can be used as well.
*
* @param {Components.interfaces.nsIVariant} aGroup in nsIVariant aGroup The group whose preferences are to be retrieved; this may be specified as either a URI or as a string; in either case, the group consists of all sites matching the hostname portion of the specified URI. Specify null to get the preferences from the global preference space; those preferences apply to all sites.
*/
Components.interfaces.nsIContentPrefService.prototype.getPrefs=function(aGroup){};
/**
* Determines whether or not a preference exists.
* Note: Prior to Gecko 2.0, the site could only be specified by nsIURI. Now a string can be used as well.
*
* @param {Components.interfaces.nsIVariant} aGroup in nsIVariant aGroup, The group for which to see if a preference exists; this may be specified as either a URI or as a string. In either case, the group consists of all sites matching the hostname portion of the specified URI. Specify null to check for the preference in the global preference space; those preferences apply to all sites.
* @param {String} aName in AString aName The name of the preference whose existence is to be determined.
*/
Components.interfaces.nsIContentPrefService.prototype.hasPref=function(aGroup, aName){};
/**
* Removes an observer that's presently monitoring a preference for changes.
*
* @param {String} aName in AString aName, The name of the preference to stop observing. You may specify null to remove a generic observer that is monitoring all preference changes.
* @param {Components.interfaces.nsIContentPrefObserver} aObserver in nsIContentPrefObserver aObserver The name of the observer that will cease receiving notifications of changes to the preference's value.
*/
Components.interfaces.nsIContentPrefService.prototype.removeObserver=function(aName, aObserver){};
/**
* Removes the specified preference.
* Note: Prior to Gecko 2.0, the site could only be specified by nsIURI. Now a string can be used as well.
*
* @param {Components.interfaces.nsIVariant} aGroup in nsIVariant aGroup, The group for which to delete a preference; this may be specified as either a URI or as a string. In either case, the group consists of all sites matching the hostname portion of the specified URI. Specify null to delete the preference from the global preference space; those preferences apply to all sites.
* @param {String} aName in AString aName The name of the preference to remove.
*/
Components.interfaces.nsIContentPrefService.prototype.removePref=function(aGroup, aName){};
/**
* Sets the value of a preference for a particular URI.
* Note: Prior to Gecko 2.0, the site could only be specified by nsIURI. Now a string can be used as well.
*
* @param {Components.interfaces.nsIVariant} aGroup in nsIVariant aGroup, The group for which to set a preference; this may be specified as either a URI or as a string; in either case, the group consists of all sites matching the hostname portion of the specified URI. Specify null to set the preference in the global preference space; those preferences apply to all sites.
* @param {String} aName in AString aName, The name of the preference whose value is to be set.
* @param {Components.interfaces.nsIVariant} aValue in nsIVariant aValue The value to assign to the preference.
*/
Components.interfaces.nsIContentPrefService.prototype.setPref=function(aGroup, aName, aValue){};
/**
* Asynchronous API for Content Preferences
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIContentPrefService2=function(){};
/**
* Registers an observer that will be notified whenever a preference with the given name is set() or removed.When a set() or remove method is called, observers are notified after the set() or removal completes but before method's callback is called.The service holds a strong reference to the observer, so the observer must be removed later to avoid leaking it.
*
* @param {String} name in AString name, The name of the preferences to observe. Pass null to observe all preference changes regardless of name.
* @param {Components.interfaces.nsIContentPrefObserver} observer in nsIContentPrefObserver observer The observer.
*/
Components.interfaces.nsIContentPrefService2.prototype.addObserverForName=function(name, observer){};
/**
* Gets the preference with the given domain and name.
*
* @param {String} domain in AString domain, The preference's domain.
* @param {String} name in AString name, The preference's name.
* @param {Components.interfaces.nsILoadContext} context in nsILoadContext context, The private-browsing context, if any.
* @param {Components.interfaces.nsIContentPrefCallback2} callback in nsIContentPrefCallback2 callback HandleResult is called once unless no such preference exists, in which case handleResult is not called at all.
*/
Components.interfaces.nsIContentPrefService2.prototype.getByDomainAndName=function(domain, name, context, callback){};
/**
* Gets all preferences with the given name whose domains are either the same as or subdomains of the given domain.
*
* @param {String} domain in AString domain, The preferences' domain.
* @param {String} name in AString name, The preferences' name.
* @param {Components.interfaces.nsILoadContext} context in nsILoadContext context, The private-browsing context, if any.
* @param {Components.interfaces.nsIContentPrefCallback2} callback in nsIContentPrefCallback2 callback HandleResult is called once for each preference. If no such preferences exist, handleResult is not called at all.
*/
Components.interfaces.nsIContentPrefService2.prototype.getBySubdomainAndName=function(domain, name, context, callback){};
/**
* Synchronously retrieves from the in-memory cache the preference with the given domain and name.In addition to caching preference values, the cache also keeps track of preferences that are known not to exist. If the preference is known not to exist, the value attribute of the returned object will be undefined (nsIDataType.VTYPE_VOID()).If the preference is neither cached nor known not to exist, then null is returned, and get() must be called to determine whether the preference exists.
*
* @param {String} domain in AString domain, The preference's domain.
* @param {String} name in AString name, The preference's name.
* @param {Components.interfaces.nsILoadContext} context in nsILoadContext context The private-browsing context, if any.
*/
Components.interfaces.nsIContentPrefService2.prototype.getCachedByDomainAndName=function(domain, name, context){};
/**
* Synchronously retrieves from the in-memory cache all preferences with the given name whose domains are either the same as or subdomains of the given domain.The preferences are returned in an array through the out-parameter. If a preference for a particular subdomain is known not to exist, then an object corresponding to that preference will be present in the array, and, as with getCachedByDomainAndName(), its value attribute will be undefined.
*
* @param {String} domain in AString domain, The preferences' domain.
* @param {String} name in AString name, The preferences' name.
* @param {Components.interfaces.nsILoadContext} context in nsILoadContext context, The private-browsing context, if any.
* @param {Number} len out unsigned long len, The length of the returned array.
* @param {Components.interfaces.nsIContentPref} prefs [retval,array,size_is(len] out nsIContentPref prefs The array of preferences.
*/
Components.interfaces.nsIContentPrefService2.prototype.getCachedBySubdomainAndName=function(domain, name, context, len, prefs){};
/**
* Synchronously retrieves from the in-memory cache the preference with no domain and the given name.As with getCachedByDomainAndName(), if the preference is cached then it is returned; if the preference is known not to exist, then the value attribute of the returned object will be undefined; if the preference is neither cached nor known not to exist, then null is returned.
*
* @param {String} name in AString name, The preference's name.
* @param {Components.interfaces.nsILoadContext} context in nsILoadContext context The private-browsing context, if any.
*/
Components.interfaces.nsIContentPrefService2.prototype.getCachedGlobal=function(name, context){};
/**
* Gets the preference with no domain and the given name.
*
* @param {String} name in AString name, The preference's name.
* @param {Components.interfaces.nsILoadContext} context in nsILoadContext context, The private-browsing context, if any.
* @param {Components.interfaces.nsIContentPrefCallback2} callback in nsIContentPrefCallback2 callback HandleResult is called once unless no such preference exists, in which case handleResult is not called at all.
*/
Components.interfaces.nsIContentPrefService2.prototype.getGlobal=function(name, context, callback){};
/**
* Removes all non-global preferences -- in other words, all preferences that have a domain.
*
* @param {Components.interfaces.nsILoadContext} context in nsILoadContext context, The private-browsing context, if any.
* @param {Components.interfaces.nsIContentPrefCallback2 callback} Optional in nsIContentPrefCallback2 callback Optional HandleCompletion is called when the operation completes.
*/
Components.interfaces.nsIContentPrefService2.prototype.removeAllDomains=function(context, Optional){};
/**
* Removes all global preferences -- in other words, all preferences that have no domain.
*
* @param {Components.interfaces.nsILoadContext} context in nsILoadContext context, The private-browsing context, if any.
* @param {Components.interfaces.nsIContentPrefCallback2 callback} Optional in nsIContentPrefCallback2 callback Optional HandleCompletion is called when the operation completes.
*/
Components.interfaces.nsIContentPrefService2.prototype.removeAllGlobals=function(context, Optional){};
/**
* Removes all preferences with the given domain.
*
* @param {String} domain in AString domain, The preferences' domain.
* @param {Components.interfaces.nsILoadContext} context in nsILoadContext context, The private-browsing context, if any.
* @param {Components.interfaces.nsIContentPrefCallback2 callback} Optional in nsIContentPrefCallback2 callback Optional HandleCompletion is called when the operation completes.
*/
Components.interfaces.nsIContentPrefService2.prototype.removeByDomain=function(domain, context, Optional){};
/**
* Removes the preference with the given domain and name.
*
* @param {String} domain in AString domain, The preference's domain.
* @param {String} name in AString name, The preference's name.
* @param {Components.interfaces.nsILoadContext} context in nsILoadContext context, The private-browsing context, if any.
* @param {Components.interfaces.nsIContentPrefCallback2 callback} Optional in nsIContentPrefCallback2 callback Optional HandleCompletion is called when the operation completes.
*/
Components.interfaces.nsIContentPrefService2.prototype.removeByDomainAndName=function(domain, name, context, Optional){};
/**
* Removes all preferences with the given name regardless of domain, including global preferences with the given name.
*
* @param {String} name in AString name, The preferences' name.
* @param {Components.interfaces.nsILoadContext} context in nsILoadContext context, The private-browsing context, if any.
* @param {Components.interfaces.nsIContentPrefCallback2 callback} Optional in nsIContentPrefCallback2 callback Optional HandleCompletion is called when the operation completes.
*/
Components.interfaces.nsIContentPrefService2.prototype.removeByName=function(name, context, Optional){};
/**
* Removes all preferences whose domains are either the same as or subdomains of the given domain.
*
* @param {String} domain in AString domain, The preferences' domain.
* @param {Components.interfaces.nsILoadContext} context in nsILoadContext context, The private-browsing context, if any.
* @param {Components.interfaces.nsIContentPrefCallback2 callback} Optional in nsIContentPrefCallback2 callback Optional HandleCompletion is called when the operation completes.
*/
Components.interfaces.nsIContentPrefService2.prototype.removeBySubdomain=function(domain, context, Optional){};
/**
* Removes all the preferences with the given name whose domains are either the same as or subdomains of the given domain.
*
* @param {String} domain in AString domain, The preferences' domain.
* @param {String} name in AString name, The preferences' name.
* @param {Components.interfaces.nsILoadContext} context in nsILoadContext context, The private-browsing context, if any.
* @param {Components.interfaces.nsIContentPrefCallback2 callback} Optional in nsIContentPrefCallback2 callback Optional HandleCompletion is called when the operation completes.
*/
Components.interfaces.nsIContentPrefService2.prototype.removeBySubdomainAndName=function(domain, name, context, Optional){};
/**
* Removes the preference with no domain and the given name.
*
* @param {String} name in AString name, The preference's name.
* @param {Components.interfaces.nsILoadContext} context in nsILoadContext context, The private-browsing context, if any.
* @param {Components.interfaces.nsIContentPrefCallback2 callback} Optional in nsIContentPrefCallback2 callback Optional HandleCompletion is called when the operation completes.
*/
Components.interfaces.nsIContentPrefService2.prototype.removeGlobal=function(name, context, Optional){};
/**
* Unregisters an observer for the given name.
*
* @param {String} name in AString name, The name for which the observer was registered. Pass null if the observer was added with a null name.
* @param {Components.interfaces.nsIContentPrefObserver} observer in nsIContentPrefObserver observer The observer.
*/
Components.interfaces.nsIContentPrefService2.prototype.removeObserverForName=function(name, observer){};
/**
* Sets a preference.
*
* @param {String} domain in AString domain, The preference's domain.
* @param {String} name in AString name, The preference's name.
* @param {Components.interfaces.nsIVariant} value in nsIVariant value, The preference's value.
* @param {Components.interfaces.nsILoadContext} context in nsILoadContext context, The private-browsing context, if any.
* @param {Components.interfaces.nsIContentPrefCallback2 callback} Optional in nsIContentPrefCallback2 callback Optional HandleCompletion is called when the preference has been stored.
*/
Components.interfaces.nsIContentPrefService2.prototype.set=function(domain, name, value, context, Optional){};
/**
* Sets a preference with no domain.
*
* @param {String} name in AString name, The preference's name.
* @param {Components.interfaces.nsIVariant} value in nsIVariant value, The preference's value.
* @param {Components.interfaces.nsILoadContext} context in nsILoadContext context, The private-browsing context, if any.
* @param {Components.interfaces.nsIContentPrefCallback2 callback} Optional in nsIContentPrefCallback2 callback Optional HandleCompletion is called when the preference has been stored.
*/
Components.interfaces.nsIContentPrefService2.prototype.setGlobal=function(name, value, context, Optional){};
/**
* Describes an XPCOM component used to model and enforce Content Security Policies.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIContentSecurityPolicy=function(){};
/**
* Whether this policy allows eval and eval-like functions such as setTimeout("code string", time). Calls to this may trigger violation reports when queried, so this value should not be cached. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIContentSecurityPolicy.prototype.allowsEval=false;
/**
* Whether this policy allows in-page script. Calls to this may trigger violation reports when queried, so this value should not be cached. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIContentSecurityPolicy.prototype.allowsInlineScript=false;
/**
* Set to true when the Content Security Policy has been read in and parsed and is ready to enforce. This is a barrier for the nsDocument so it doesn't load any sub-content until either it knows that a Content Security Policy is ready or will not be used.
*
* @type {Boolean}
*/
Components.interfaces.nsIContentSecurityPolicy.prototype.isInitialized=false;
/**
* A read-only string version of the policy for debugging. Read only.
*
* @type {String}
*/
Components.interfaces.nsIContentSecurityPolicy.prototype.policy="";
/**
* When set to true, content load-blocking and fail-closed are disabled: Content Security Policy will only send reports, and not modify behavior.
*
* @type {Boolean}
*/
Components.interfaces.nsIContentSecurityPolicy.prototype.reportOnlyMode=false;
/**
* Verifies ancestry as permitted by the policy.Calls to this may trigger violation reports when queried, so this value should not be cached.
*
* @param {Components.interfaces.nsIDocShell} docShell in nsIDocShell docShell Containing the protected resource.
*/
Components.interfaces.nsIContentSecurityPolicy.prototype.permitsAncestry=function(docShell){};
/**
* Updates the policy currently stored in the Content Security Policy to be "refined" or tightened by the one specified in the string policyString.
*
* @param {String} policyString in AString policyString,
* @param {Components.interfaces.nsIURI} selfURI in nsIURI selfURI
*/
Components.interfaces.nsIContentSecurityPolicy.prototype.refinePolicy=function(policyString, selfURI){};
/**
* Called after the Content Security Policy object is created to fill in the appropriate request and request header information needed in case a report needs to be sent.
*
* @param {Components.interfaces.nsIHttpChannel} aChannel in nsIHttpChannel aChannel
*/
Components.interfaces.nsIContentSecurityPolicy.prototype.scanRequestData=function(aChannel){};
/**
* Manually triggers violation report sending given a URI and reason. The URI may be null, in which case "self" is sent.
*
* @param {String} blockedURI in AString blockedURI, The URI that violated the policy.
* @param {String} violatedDirective in AString violatedDirective The directive that was violated.
*/
Components.interfaces.nsIContentSecurityPolicy.prototype.sendReports=function(blockedURI, violatedDirective){};
/**
* Delegate method called by the service when sub-elements of the protected document are being loaded. Given a bit of information about the request, decides whether or not the policy is satisfied.Calls to this may trigger violation reports when queried, so this value should not be cached.
*
* @param {Number} aContentType in unsigned long aContentType,
* @param {Components.interfaces.nsIURI} aContentLocation in nsIURI aContentLocation,
* @param {Components.interfaces.nsIURI} aRequestOrigin in nsIURI aRequestOrigin,
* @param {Components.interfaces.nsISupports} aContext in nsISupports aContext,
* @param {String} aMimeTypeGuess in ACString aMimeTypeGuess,
* @param {Components.interfaces.nsISupports} aExtra in nsISupports aExtra
*/
Components.interfaces.nsIContentSecurityPolicy.prototype.shouldLoad=function(aContentType, aContentLocation, aRequestOrigin, aContext, aMimeTypeGuess, aExtra){};
/**
* Delegate method called by the service when sub-elements of the protected document are being processed. Given a bit of information about the request, decides whether or not the policy is satisfied.
*
* @param {Number} aContentType in unsigned long aContentType,
* @param {Components.interfaces.nsIURI} aContentLocation in nsIURI aContentLocation,
* @param {Components.interfaces.nsIURI} aRequestOrigin in nsIURI aRequestOrigin,
* @param {Components.interfaces.nsISupports} aContext in nsISupports aContext,
* @param {String} aMimeType in ACString aMimeType,
* @param {Components.interfaces.nsISupports} aExtra in nsISupports aExtra
*/
Components.interfaces.nsIContentSecurityPolicy.prototype.shouldProcess=function(aContentType, aContentLocation, aRequestOrigin, aContext, aMimeType, aExtra){};
/**
* Represents a scrollable content view whose contents are actually drawn by a separate process; this is part of the Electrolysis multi-process support framework.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIContentView=function(){};
/**
* Read only.
*
* @type {Number}
*/
Components.interfaces.nsIContentView.prototype.contentHeight=0;
/**
* Dimensions of scrolled content in chrome-document CSS pixels. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIContentView.prototype.contentWidth=0;
/**
* ID that can be used in conjunction with nsIDOMWindowUtils to change the actual document, instead of just how it is transformed; this is a 64-bit unsigned integer. Read only.
*
* @type {Components.interfaces.nsContentViewId}
*/
Components.interfaces.nsIContentView.prototype.id=new Components.interfaces.nsContentViewId();
/**
* Horizontal scroll offset in chrome-document CSS pixels. When this view is active (that is it is being painted because it's in the visible region of the screen), this value is at first lined up with the content's scroll offset. Note: When this view becomes inactive, the new content view will have scroll values that are reset to the default. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIContentView.prototype.scrollX=0;
/**
* Horizontal scroll offset in chrome-document CSS pixels. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIContentView.prototype.scrollY=0;
/**
* Height of the viewport in chrome-document CSS pixels. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIContentView.prototype.viewportHeight=0;
/**
* Width of the viewport in chrome-document CSS pixels. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIContentView.prototype.viewportWidth=0;
/**
* Scrolls the content view by the specified number of chrome-document CSS pixels along each axis. Fails if the view isn't valid.
*
* @param {Number} dxPx in float dxPx, The number of CSS pixels to scroll on the X axis; specify a positive value to scroll to the right or a negative value to scroll to the left.
* @param {Number} dyPx in float dyPx The number of CSS pixels to scroll on the Y axis; specify a positive value to scroll down or a negative value to scroll up.
*/
Components.interfaces.nsIContentView.prototype.scrollBy=function(dxPx, dyPx){};
/**
* Scrolls the content view to the specified position, in chrome-document CSS pixels. Fails if the view isn't valid.
*
* @param {Number} xPx in float xPx, The X coordinate to scroll to, in CSS pixels.
* @param {Number} yPx in float yPx The Y coordinate to scroll to, in CSS pixels.
*/
Components.interfaces.nsIContentView.prototype.scrollTo=function(xPx, yPx){};
/**
* Sets the content view's scale for each axis.
*
* @param {Number} xScale in float xScale, Horizontal scaling factor; specify 1.0 to use the natural size of the content.
* @param {Number} yScale in float yScale Vertical scaling factor; specify 1.0 to use the natural size of the content.
*/
Components.interfaces.nsIContentView.prototype.setScale=function(xScale, yScale){};
/**
* An interface that can be implemented to receive and process commands and events.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIController=function(){};
/**
* When this method is called, your implementation should execute the command with the specified name.
*
* @param {String} command in string command The name of the command to execute.
*/
Components.interfaces.nsIController.prototype.doCommand=function(command){};
/**
* Implement this method to indicate whether or not the specified command is enabled.
*
* @param {String} command in string command The name of the command whose availability is to be checked.
*/
Components.interfaces.nsIController.prototype.isCommandEnabled=function(command){};
/**
* Implement this method to process the event with the specified name.
*
* @param {String} eventName in string eventName The name of the event to process.
*/
Components.interfaces.nsIController.prototype.onEvent=function(eventName){};
/**
* Implement this method to report whether or not the command with the specified name is supported.
*
* @param {String} command in string command The name of the command to determine whether or not it is supported.
*/
Components.interfaces.nsIController.prototype.supportsCommand=function(command){};
/**
* Represents a list of nsIController elements.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIControllers=function(){};
/**
* Obsolete since Gecko 1.9
*
* @type {Components.interfaces.nsIDOMXULCommandDispatcher}
*/
Components.interfaces.nsIControllers.prototype.commandDispatcher=new Components.interfaces.nsIDOMXULCommandDispatcher();
/**
* Adds a controller to the end of the list.
*
* @param {Components.interfaces.nsIController} controller in nsIController controller A controller to be added to the list of controllers.
*/
Components.interfaces.nsIControllers.prototype.appendController=function(controller){};
/**
* Returns the controller instance at the given position.
*
* @param {Number} index in unsigned long index The position of the wanted controller.
*/
Components.interfaces.nsIControllers.prototype.getControllerAt=function(index){};
/**
* Returns a controller given by its order, rather than position, of insertion.
*
* @param {Number} controllerID in unsigned long controllerID The ID (insertion order) of a controller.
*/
Components.interfaces.nsIControllers.prototype.getControllerById=function(controllerID){};
/**
* Returns the current number of controllers.
*
*/
Components.interfaces.nsIControllers.prototype.getControllerCount=function(){};
/**
* Searches for a controller that supports the given command.
*
* @param {String} command in string command The name of a command, e.g. cmd_copy
*/
Components.interfaces.nsIControllers.prototype.getControllerForCommand=function(command){};
/**
* Returns the order of insertion of a controller.
*
* @param {Components.interfaces.nsIController} controller in nsIController controller The controller for which you want to retrieve the insertion index.
*/
Components.interfaces.nsIControllers.prototype.getControllerId=function(controller){};
/**
* Inserts a controller at a specific position in the list of controllers. If the position is out of range, nothing happens.
*
* @param {Number} index in unsigned long index, The position within the list where you want the controller to be inserted.
* @param {Components.interfaces.nsIController} controller in nsIController controller The controller to be inserted into the list.
*/
Components.interfaces.nsIControllers.prototype.insertControllerAt=function(index, controller){};
/**
* Removes a controller from the list of controllers.
*
* @param {Components.interfaces.nsIController} controller in nsIController controller The controller to be removed from the list.
*/
Components.interfaces.nsIControllers.prototype.removeController=function(controller){};
/**
* Removes a controller from the list of controllers.
*
* @param {Number} index in unsigned long index The index of the controller to be removed.
*/
Components.interfaces.nsIControllers.prototype.removeControllerAt=function(index){};
/**
* A unichar input stream that wraps an input stream. This allows reading unicode strings from a stream, automatically converting the bytes from a selected character encoding.
*
* @constructor
* @inherits {Components.interfaces.nsIUnicharInputStream}
*/
Components.interfaces.nsIConverterInputStream=function(){};
/**
* Default replacement character value.
*
* @constant
*/
Components.interfaces.nsIConverterInputStream.prototype.DEFAULT_REPLACEMENT_CHARACTER=0xFFFD;
/**
* Initialize this stream.
*
* @param {Components.interfaces.nsIInputStream} aStream in nsIInputStream aStream, The source stream which is read and converted.
* @param {String} aCharset in string aCharset, The character encoding to use for converting the bytes of the stream. A value of null or "UTF-8" equals UTF-8 encoding. Latin 1 is specified as "ISO-8859-1".
* @param {Number} aBufferSize in long aBufferSize, Defines the buffer size of the converter stream. In case of a buffer size of less than or equal to 0, the default size CONVERTER_BUFFER_SIZE will be used. This is currently set to 8192 bytes.
* @param {Components.interfaces.PRUnichar} aReplacementChar in PRUnichar aReplacementChar Any unknown byte sequence will be replaced with this character. The default replacement character is U+FFFD. A value of 0x0000 will cause an exception to be thrown if unknown byte sequences are encountered in the stream.
*/
Components.interfaces.nsIConverterInputStream.prototype.init=function(aStream, aCharset, aBufferSize, aReplacementChar){};
/**
* This interface allows writing strings to a stream, doing automatic character encoding conversion.
*
* @constructor
* @inherits {Components.interfaces.nsIUnicharOutputStream}
*/
Components.interfaces.nsIConverterOutputStream=function(){};
/**
* Initialize this stream. Must be called before any other method on this interface, or you will crash. The output stream passed to this method must not be null, or you will crash.
*
* @param {Components.interfaces.nsIOutputStream} aOutStream in nsIOutputStream aOutStream, The underlying output stream to which the converted strings will be written.
* @param {String} aCharset in string aCharset, The character set to use for encoding the characters. A null charset will be interpreted as UTF-8.
* @param {Number} aBufferSize in unsigned long aBufferSize, How many bytes to buffer. A value of 0 means that no bytes will be buffered. Implementations not supporting buffering may ignore this parameter.
* @param {Components.interfaces.PRUnichar} aReplacementCharacter in PRUnichar aReplacementCharacter The replacement character to use when an unsupported character is found. A value of 0x0000 will cause an exception to be thrown upon attempts to write unsupported characters.
*/
Components.interfaces.nsIConverterOutputStream.prototype.init=function(aOutStream, aCharset, aBufferSize, aReplacementCharacter){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICookie=function(){};
/**
* The cookie collected in a previous session, and its information no longer exists. available
*
* @constant
*/
Components.interfaces.nsICookie.prototype.STATUS_UNKNOWN=0;
/**
* The cookie was accepted.
*
* @constant
*/
Components.interfaces.nsICookie.prototype.STATUS_ACCEPTED=1;
/**
* The cookie was accepted but downgraded to a session cookie.
*
* @constant
*/
Components.interfaces.nsICookie.prototype.STATUS_DOWNGRADED=2;
/**
* The cookie was not accepted.
*
* @constant
*/
Components.interfaces.nsICookie.prototype.STATUS_FLAGGED=3;
/**
* The cookie was rejected.
*
* @constant
*/
Components.interfaces.nsICookie.prototype.STATUS_REJECTED=4;
/**
* The cookie collected in a previous session, and its information no longer available.
*
* @constant
*/
Components.interfaces.nsICookie.prototype.POLICY_UNKNOWN=0;
/**
* The site did not send a compact policy along with the cookie.
*
* @constant
*/
Components.interfaces.nsICookie.prototype.POLICY_NONE=1;
/**
* The site collects identifiable information without user involvement.
*
* @constant
*/
Components.interfaces.nsICookie.prototype.POLICY_NO_CONSENT=2;
/**
* The site collects identifiable information unless user opts out.
*
* @constant
*/
Components.interfaces.nsICookie.prototype.POLICY_IMPLICIT_CONSENT=3;
/**
* The site does not collect identifiable information unless user opts in.
*
* @constant
*/
Components.interfaces.nsICookie.prototype.POLICY_EXPLICIT_CONSENT=4;
/**
* The site does not collect identifiable information.
*
* @constant
*/
Components.interfaces.nsICookie.prototype.POLICY_NO_II=5;
/**
* Expiration time in seconds since midnight (00:00:00), January 1, 1970 UTC. expires = 0 represents a session cookie. expires = 1 represents an expiration time earlier than Jan 1, 1970. Read only.
*
* @type {Number}
*/
Components.interfaces.nsICookie.prototype.expires=0;
/**
* The host (possibly fully qualified) of the cookie. Read only.
*
* @type {String}
*/
Components.interfaces.nsICookie.prototype.host="";
/**
* true if the cookie is a domain cookie, false otherwise. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsICookie.prototype.isDomain=false;
/**
* true if the cookie was transmitted over ssl, false otherwise. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsICookie.prototype.isSecure=false;
/**
* The name of the cookie. Read only.
*
* @type {String}
*/
Components.interfaces.nsICookie.prototype.name="";
/**
* The path pertaining to the cookie. Read only.
*
* @type {String}
*/
Components.interfaces.nsICookie.prototype.path="";
/**
* Holds the sites compact policy value. Read only.
*
* @type {Components.interfaces.nsCookiePolicy}
*/
Components.interfaces.nsICookie.prototype.policy=new Components.interfaces.nsCookiePolicy();
/**
* Holds the P3P status of cookie. Read only.
*
* @type {Components.interfaces.nsCookieStatus}
*/
Components.interfaces.nsICookie.prototype.status=new Components.interfaces.nsCookieStatus();
/**
* The cookie value. Read only.
*
* @type {String}
*/
Components.interfaces.nsICookie.prototype.value="";
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsICookie}
*/
Components.interfaces.nsICookie2=function(){};
/**
* The creation time of the cookie, in microseconds since midnight (00:00:00), January 1, 1970 UTC. Read only.
*
* @type {Number}
*/
Components.interfaces.nsICookie2.prototype.creationTime=0;
/**
* The actual expiry time of the cookie, in seconds since midnight (00:00:00), January 1, 1970 UTC. (where 0 does not represent a session cookie). Read only.
*
* @type {Number}
*/
Components.interfaces.nsICookie2.prototype.expiry=0;
/**
* true if the cookie is an http only cookie. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsICookie2.prototype.isHttpOnly=false;
/**
* true if the cookie is a session cookie. Note: That expiry time will also be honored for session cookies; thus, whichever is the more restrictive of the two will take effect. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsICookie2.prototype.isSession=false;
/**
* The last time the cookie was accessed, in microseconds since midnight (00:00:00) on January 1, 1970 UTC. "Accessed" means creation, modification, or reading by the server. Note: This time may be approximate. Read only.
*
* @type {Number}
*/
Components.interfaces.nsICookie2.prototype.lastAccessed=0;
/**
* The host (possibly fully qualified) of the cookie, without a leading dot to represent if it is a domain cookie. Read only.
*
* @type {String}
*/
Components.interfaces.nsICookie2.prototype.rawHost="";
/**
* This interface holds some constants for the cookie accept dialog.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICookieAcceptDialog=function(){};
/**
* Value for accepting a cookie object.
*
* @constant
*/
Components.interfaces.nsICookieAcceptDialog.prototype.ACCEPT_COOKIE=0;
/**
* Value for remembering a decision.
*
* @constant
*/
Components.interfaces.nsICookieAcceptDialog.prototype.REMEMBER_DECISION=1;
/**
* Value for holding the hostname object.
*
* @constant
*/
Components.interfaces.nsICookieAcceptDialog.prototype.HOSTNAME=2;
/**
* Value for holding the cookie from the host.
*
* @constant
*/
Components.interfaces.nsICookieAcceptDialog.prototype.COOKIESFROMHOST=3;
/**
* Value for changing cookie.
*
* @constant
*/
Components.interfaces.nsICookieAcceptDialog.prototype.CHANGINGCOOKIE=4;
/**
* Please add a summary to this article.
*
* @constructor
*/
Components.interfaces.nsICookieConsent=function(){};
/**
* Gives a decision on what should be done with a cookie, based on a site's p3p policy and the user's preferences. the policy for the given URI and channel is also returned.
*
* @param {Components.interfaces.nsIURI} uri in nsIURI uri, The URI to find the policy for.
* @param {Components.interfaces.nsIHttpChannel} httpChannel in nsIHttpChannel httpChannel, The channel to extract the p3p headers from.
* @param {Boolean} isForeign in boolean isForeign, True if the cookie originates from a third-party site. this is used to decide the cookie status based on user preferences.
* @param {Components.interfaces.nsCookiePolicy} policy out nsCookiePolicy policy The policy for the given URI, or nsICookie::POLICY_UNKNOWN if one cannot be found. valid values are defined in nsICookie.idl.
*/
Components.interfaces.nsICookieConsent.prototype.getConsent=function(uri, httpChannel, isForeign, policy){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICookieManager=function(){};
/**
* Called to enumerate through each cookie in the cookie list. The objects enumerated over are of type nsICookie. Read only.
*
* @type {Components.interfaces.nsISimpleEnumerator}
*/
Components.interfaces.nsICookieManager.prototype.enumerator=new Components.interfaces.nsISimpleEnumerator();
/**
* This method is called to remove an individual cookie from the cookie list, specified by host, name, and path. If the cookie cannot be found, no exception is thrown. Typically, the arguments to this method will be obtained directly from the desired nsICookie object.
*
* @param {String} aHost in AUTF8String aHost, The host or domain for which the cookie was set. See nsICookieManager2.add() for a description of acceptable host strings. If the target cookie is a domain cookie, a leading dot must be present.
* @param {String} aName in ACString aName, The name specified in the cookie.
* @param {String} aPath in AUTF8String aPath, The path for which the cookie was set.
* @param {Boolean} aBlocked in boolean aBlocked Indicates if cookies from this host should be permanently blocked.
*/
Components.interfaces.nsICookieManager.prototype.remove=function(aHost, aName, aPath, aBlocked){};
/**
* This method is called to remove all cookies from the cookie list.
*
*/
Components.interfaces.nsICookieManager.prototype.removeAll=function(){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsICookieManager}
*/
Components.interfaces.nsICookieManager2=function(){};
/**
* Adds a cookie. nsICookieService is the normal way to do this. This method is something of a back door.
*
* @param {String} aHost in AUTF8String aHost, The host or domain for which the cookie is set. presence of a leading dot indicates a domain cookie; otherwise, the cookie is treated as a non-domain cookie. See RFC2109 for details. The host string will be normalized to ASCII or ACE; any trailing dot will be stripped. To be a domain cookie, the host must have at least two subdomain parts (e.g. '.foo.com', not '.com'), otherwise an exception will be thrown. An empty string is acceptable (e.g. file:// URI's).
* @param {String} aPath in AUTF8String aPath, The path within the domain for which the cookie is valid.
* @param {String} aName in ACString aName, The cookie name.
* @param {String} aValue in ACString aValue, The cookie data.
* @param {Boolean} aIsSecure in boolean aIsSecure, true if the cookie should only be sent over a secure connection.
* @param {Boolean} aIsHttpOnly in boolean aIsHttpOnly, true if the cookie should only be sent to, and can only be modified by, an HTTP connection.
* @param {Boolean} aIsSession in boolean aIsSession, true if the cookie should exist for the current session only.
* @param {Number} aExpiry in PRInt64 aExpiry Holds the expiration date, in seconds since the epoch. Only relevant if aIsSession is false.
*/
Components.interfaces.nsICookieManager2.prototype.add=function(aHost, aPath, aName, aValue, aIsSecure, aIsHttpOnly, aIsSession, aExpiry){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICookiePermission=function(){};
/**
* nsCookieAccess's access default value
*
* @constant
*/
Components.interfaces.nsICookiePermission.prototype.ACCESS_DEFAULT=0;
/**
* nsCookieAccess's access allow value
*
* @constant
*/
Components.interfaces.nsICookiePermission.prototype.ACCESS_ALLOW=1;
/**
* nsCookieAccess's access deny value
*
* @constant
*/
Components.interfaces.nsICookiePermission.prototype.ACCESS_DENY=2;
/**
* Additional values for nsCookieAccess, which are not directly used by any methods on this interface, but are nevertheless convenient to define here. These may be relocated somewhere else if we ever consider freezing this interface.
*
* @constant
*/
Components.interfaces.nsICookiePermission.prototype.ACCESS_SESSION=8;
/**
* Tests whether or not the given URI/channel may access the cookie database, either to set or get cookies.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI trying to access cookies.
* @param {Components.interfaces.nsIURI} aFirstURI in nsIURI aFirstURI, Obsolete since Gecko 1.9 The URI initiated by the user that resulted in aURI being loaded.
* @param {Components.interfaces.nsIChannel} aChannel in nsIChannel aChannel The channel corresponding to aURI.
*/
Components.interfaces.nsICookiePermission.prototype.canAccess=function(aURI, aFirstURI, aChannel){};
/**
* Tests whether or not the given URI/channel may set a specific cookie. This method is always preceded by a call to canAccess(). It may modify the isSession and expiry attributes of the cookie via the aIsSession and aExpiry parameters, in order to limit or extend the lifetime of the cookie. This is useful, for instance, to downgrade a cookie to session-only if it fails to meet certain criteria.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI trying to set the cookie.
* @param {Components.interfaces.nsIChannel} aChannel in nsIChannel aChannel, The channel corresponding to aURI.
* @param {Components.interfaces.nsICookie2} aCookie in nsICookie2 aCookie, The cookie being added to the cookie database.
* @param {Boolean} aIsSession inout boolean aIsSession, When canSetCookie is invoked, this is the current isSession attribute of the cookie. canSetCookie may leave this value unchanged to preserve this attribute of the cookie.
* @param {Number} aExpiry inout PRInt64 aExpiry When canSetCookie is invoked, this is the current expiry time of the cookie. canSetCookie may leave this value unchanged to preserve this attribute of the cookie.
*/
Components.interfaces.nsICookiePermission.prototype.canSetCookie=function(aURI, aChannel, aCookie, aIsSession, aExpiry){};
/**
* Sets cookie access permissions for the given URI. This may result in other URIs being blocked as well, such as URIs that share the same host name.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI to block.
* @param {Components.interfaces.nsCookieAccess} aAccess in nsCookieAccess aAccess The new cookie access permissions for the URI.
*/
Components.interfaces.nsICookiePermission.prototype.setAccess=function(aURI, aAccess){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICookiePromptService=function(){};
/**
* Holds the value for a denying the cookie.
*
* @constant
*/
Components.interfaces.nsICookiePromptService.prototype.DENY_COOKIE=0;
/**
* Holds the value for accepting the cookie.
*
* @constant
*/
Components.interfaces.nsICookiePromptService.prototype.ACCEPT_COOKIE=1;
/**
* Holds the value for accepting the session cookie.
*
* @constant
*/
Components.interfaces.nsICookiePromptService.prototype.ACCEPT_SESSION_COOKIE=2;
/**
* Opens a dialog that asks for permission to accept a cookie.
*
* @param {Components.interfaces.nsIDOMWindow} parent in nsIDOMWindow parent, The parent window for the dialog.
* @param {Components.interfaces.nsICookie} cookie in nsICookie cookie, The cookie about which permission is being requested.
* @param {String} hostname in ACString hostname, The host that wants to set the cookie, not the domain; this is part of the cookie.
* @param {Number} cookiesFromHost in long cookiesFromHost, The number of cookies there are already for this host.
* @param {Boolean} changingCookie in boolean changingCookie, Are we changing this cookie?
* @param {Boolean} rememberDecision out boolean rememberDecision Should we set the matching permission for this host?
*/
Components.interfaces.nsICookiePromptService.prototype.cookieDialog=function(parent, cookie, hostname, cookiesFromHost, changingCookie, rememberDecision){};
/**
* Provides methods for setting and getting cookies in the context of a page load.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICookieService=function(){};
/**
* This attribute really doesn't belong on this interface. CVS blame will tell you why it is here. It remains until we can find a better home for it.
*
* @type {Boolean}
*/
Components.interfaces.nsICookieService.prototype.cookieIconIsVisible=false;
/**
* Get the complete cookie string associated with the URI.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI of the document for which cookies are being queried.
* @param {Components.interfaces.nsIChannel} aChannel in nsIChannel aChannel The channel used to load the document. this parameter may be null, but it is strongly recommended that a non-null value be provided to ensure that the cookie privacy preferences are honored.
*/
Components.interfaces.nsICookieService.prototype.getCookieString=function(aURI, aChannel){};
/**
* Get the complete cookie string associated with the URI.Note: This function is redundant and will most likely be removed in a future revision of this interface. getCookieString() will query the documentURI property off of nsIHttpChannelInternal if supported, so getCookieString() can be used in place of this method.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI of the document for which cookies are being queried.
* @param {Components.interfaces.nsIURI} aFirstURI in nsIURI aFirstURI, The URI that the user originally typed in or clicked on to initiate the load of the document referenced by aURI.
* @param {Components.interfaces.nsIChannel} aChannel in nsIChannel aChannel The channel used to load the document. this parameter may be null, but it is strongly recommended that a non-null value be provided to ensure that the cookie privacy preferences are honored.
*/
Components.interfaces.nsICookieService.prototype.getCookieStringFromHttp=function(aURI, aFirstURI, aChannel){};
/**
* Set the cookie string associated with the URI.Note: Should be able to allow null aPrompt, since nsIPrompt can be queried from aChannel.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI of the document for which cookies are being queried.
* @param {Components.interfaces.nsIPrompt} aPrompt in nsIPrompt aPrompt, The prompt to use for all user-level cookie notifications.
* @param {String} aCookie in string aCookie, The cookie string to set.
* @param {Components.interfaces.nsIChannel} aChannel in nsIChannel aChannel The channel used to load the document. this parameter may be null, but it is strongly recommended that a non-null value be provided to ensure that the cookie privacy preferences are honored.
*/
Components.interfaces.nsICookieService.prototype.setCookieString=function(aURI, aPrompt, aCookie, aChannel){};
/**
* Set the cookie string and expires associated with the URI.Note: This function is redundant and will most likely be removed in a future revision of this interface. setCookieString() will query the documentURI property off of nsIHttpChannelInternal if supported, and setCookieString() could also query the Date header from the channel if aChannel supports nsIHttpChannel.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI, The URI of the document for which cookies are being queried.
* @param {Components.interfaces.nsIURI} aFirstURI in nsIURI aFirstURI, The URI that the user originally typed in or clicked on to initiate the load of the document referenced by aURI.
* @param {Components.interfaces.nsIPrompt} aPrompt in nsIPrompt aPrompt, The prompt to use for all user-level cookie notifications.
* @param {String} aCookie in string aCookie, The cookie string to set.
* @param {String} aServerTime in string aServerTime, The expiry information of the cookie (the Date header from the HTTP response).
* @param {Components.interfaces.nsIChannel} aChannel in nsIChannel aChannel The channel used to load the document. this parameter may be null, but it is strongly recommended that a non-null value be provided to ensure that the cookie privacy preferences are honored.
*/
Components.interfaces.nsICookieService.prototype.setCookieStringFromHttp=function(aURI, aFirstURI, aPrompt, aCookie, aServerTime, aChannel){};
/**
* Provides access to crash reporting functionality.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICrashReporter=function(){};
/**
* Enable or disable the crashreporter at runtime.
*
* @type {Boolean}
*/
Components.interfaces.nsICrashReporter.prototype.enabled=false;
/**
* Get or set the path on the local system to which minidumps will be written when a crash happens. Exceptions thrown NS_ERROR_NOT_INITIALIZED If crash reporting is not initialized.
*
* @type {Components.interfaces.nsILocalFile}
*/
Components.interfaces.nsICrashReporter.prototype.minidumpPath=new Components.interfaces.nsILocalFile();
/**
* Get or set the URL to which crash reports will be submitted. Only https and http URLs are allowed, as the submission is handled by OS-native networking libraries. Exceptions thrown NS_ERROR_FAILURE On get if no URL is set. NS_ERROR_INVALID_ARG On set if a non-http(s) URL is assigned. NS_ERROR_NOT_INITIALIZED If crash reporting is not initialized.
*
* @type {Components.interfaces.nsIURL}
*/
Components.interfaces.nsICrashReporter.prototype.serverURL=new Components.interfaces.nsIURL();
/**
* User preference for submitting crash reports.
*
* @type {Boolean}
*/
Components.interfaces.nsICrashReporter.prototype.submitReports=false;
/**
* Add some extra data to be submitted with a crash report.
*
* @param {String} key in ACString key, Name of the data to be added.
* @param {String} data in ACString data Data to be added.
*/
Components.interfaces.nsICrashReporter.prototype.annotateCrashReport=function(key, data){};
/**
* Information on a Certificate Revocation List (CRL) issued by a Certificate Authority (CA).
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICRLInfo=function(){};
/**
* The URL this CRL was last fetched from. Read only.
*
* @type {String}
*/
Components.interfaces.nsICRLInfo.prototype.lastFetchURL="";
/**
* The time this CRL was created at. Read only.
*
* @type {Number}
*/
Components.interfaces.nsICRLInfo.prototype.lastUpdate=0;
/**
* lastUpdate formatted as a human readable string formatted according to the environment locale. Read only.
*
* @type {String}
*/
Components.interfaces.nsICRLInfo.prototype.lastUpdateLocale="";
/**
* The key identifying the CRL in the database. Read only.
*
* @type {String}
*/
Components.interfaces.nsICRLInfo.prototype.nameInDb="";
/**
* The time the suggested next update for this CRL. Read only.
*
* @type {Number}
*/
Components.interfaces.nsICRLInfo.prototype.nextUpdate=0;
/**
* nextUpdate formatted as a human readable string formatted according to the environment locale. Read only.
*
* @type {String}
*/
Components.interfaces.nsICRLInfo.prototype.nextUpdateLocale="";
/**
* The issuing CA's organization. Read only.
*
* @type {String}
*/
Components.interfaces.nsICRLInfo.prototype.organization="";
/**
* The issuing CA's organizational unit. Read only.
*
* @type {String}
*/
Components.interfaces.nsICRLInfo.prototype.organizationalUnit="";
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICRLManager=function(){};
/**
* @constant
*/
Components.interfaces.nsICRLManager.prototype.TYPE_AUTOUPDATE_TIME_BASED=1;
/**
* @constant
*/
Components.interfaces.nsICRLManager.prototype.TYPE_AUTOUPDATE_FREQ_BASED=2;
/**
*
*
* @param {Components.interfaces.nsICRLInfo} info in nsICRLInfo info,
* @param {Number} autoUpdateType in unsigned long autoUpdateType,
* @param {Number} noOfDays in double noOfDays
*/
Components.interfaces.nsICRLManager.prototype.computeNextAutoUpdateTime=function(info, autoUpdateType, noOfDays){};
/**
* Delete the crl.
*
* @param {Number} crlIndex in unsigned long crlIndex
*/
Components.interfaces.nsICRLManager.prototype.deleteCrl=function(crlIndex){};
/**
* Get a list of Crl entries in the DB.
*
*/
Components.interfaces.nsICRLManager.prototype.getCrls=function(){};
/**
* Import a CRL into the certificate database.
*
* @param {Number} data [array, size_is(length] in octet data,
* @param {Number} length in unsigned long length,
* @param {Components.interfaces.nsIURI} uri in nsIURI uri,
* @param {Number} type in unsigned long type,
* @param {Boolean} doSilentDownload in boolean doSilentDownload,
* @param {String} crlKey in wstring crlKey
*/
Components.interfaces.nsICRLManager.prototype.importCrl=function(data, length, uri, type, doSilentDownload, crlKey){};
/**
* This would reschedule the autoupdate of crls with auto update enable.
*
*/
Components.interfaces.nsICRLManager.prototype.rescheduleCRLAutoUpdate=function(){};
/**
* Update an existing crl from the last fetched url. Needed for the update button in crl manager.
*
* @param {String} url in wstring url,
* @param {String} key in wstring key
*/
Components.interfaces.nsICRLManager.prototype.updateCRLFromURL=function(url, key){};
/**
* This interface can be used to compute a cryptographic hash function of some data. You can, for example, calculate the MD5 hash of a file to determine if it contains the data you think it does. The hash algorithms supported are MD2, MD5, SHA-1, SHA-256, SHA-384, and SHA-512.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICryptoHash=function(){};
/**
* Message Digest Algorithm 2
*
* @constant
*/
Components.interfaces.nsICryptoHash.prototype.MD2=1;
/**
* Message-Digest algorithm 5
*
* @constant
*/
Components.interfaces.nsICryptoHash.prototype.MD5=2;
/**
* Secure Hash Algorithm 1
*
* @constant
*/
Components.interfaces.nsICryptoHash.prototype.SHA1=3;
/**
* Secure Hash Algorithm 256
*
* @constant
*/
Components.interfaces.nsICryptoHash.prototype.SHA256=4;
/**
* Secure Hash Algorithm 384
*
* @constant
*/
Components.interfaces.nsICryptoHash.prototype.SHA384=5;
/**
* Secure Hash Algorithm 512
*
* @constant
*/
Components.interfaces.nsICryptoHash.prototype.SHA512=6;
/**
* Completes the hash object and produces the actual hash data.Note: This method may be called any time after " .. manch("init") .. " is called. This call resets the object.
*
* @param {Boolean} aASCII in PRBool aASCII If true then the returned value is a base-64 encoded string. If false, then the returned value is binary data.
*/
Components.interfaces.nsICryptoHash.prototype.finish=function(aASCII){};
/**
* Initialize the hashing object. This method may be called multiple times with different algorithm types.Note: This method or " .. manch("initWithString") .. " must be called before any other method on this interface is called.
*
* @param {Number} aAlgorithm in unsigned long aAlgorithm The hash algorithm to use. Must be one of the Hash Algorithms.
*/
Components.interfaces.nsICryptoHash.prototype.init=function(aAlgorithm){};
/**
* Initialize the hashing object. This method may be called multiple times with different algorithm types.Note: This method or " .. manch("init") .. " must be called before any other method on this interface is called.
*
* @param {String} aAlgorithm in ACString aAlgorithm The hash algorithm type to be used as a string, such as "MD5".
*/
Components.interfaces.nsICryptoHash.prototype.initWithString=function(aAlgorithm){};
/**
* Adds an array of data to be hashed to the object. See Computing the Hash of a String for an example of using this method.
*
* @param {Number} aData [const, array, size_is(aLen] in octet aData, A buffer to calculate the hash over.
* @param {Number} aLen in unsigned long aLen The length of the buffer aData.
*/
Components.interfaces.nsICryptoHash.prototype.update=function(aData, aLen){};
/**
* Calculates and updates a new hash based on a given data stream (nsIInputStream). See Computing the Hash of a File for an example of using this method.
*
* @param {Components.interfaces.nsIInputStream} aStream in nsIInputStream aStream, An input stream to read from.
* @param {Number} aLen in unsigned long aLen How much to read from the given aStream. Passing PR_UINT32_MAX indicates that all data available will be used to update the hash.
*/
Components.interfaces.nsICryptoHash.prototype.updateFromStream=function(aStream, aLen){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICurrentCharsetListener=function(){};
/**
*
*
* @param {String} charset in wstring charset
*/
Components.interfaces.nsICurrentCharsetListener.prototype.SetCurrentCharset=function(charset){};
/**
*
*
* @param {String} charset in wstring charset
*/
Components.interfaces.nsICurrentCharsetListener.prototype.SetCurrentComposerCharset=function(charset){};
/**
*
*
* @param {String} charset in wstring charset
*/
Components.interfaces.nsICurrentCharsetListener.prototype.SetCurrentMailCharset=function(charset){};
/**
* Interface to pass to the cycle collector to get information about the cycle collector graph while it is being built.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsICycleCollectorListener=function(){};
/**
*
*
*/
Components.interfaces.nsICycleCollectorListener.prototype.begin=function(){};
/**
*
*
*/
Components.interfaces.nsICycleCollectorListener.prototype.beginDescriptions=function(){};
/**
*
*
* @param {Number} aAddress in unsigned long long aAddress,
* @param {Boolean} aMarked in boolean aMarked
*/
Components.interfaces.nsICycleCollectorListener.prototype.describeGCedObject=function(aAddress, aMarked){};
/**
*
*
* @param {Number} aAddress in unsigned long long aAddress,
* @param {Number} aKnownEdges in unsigned long aKnownEdges,
* @param {Number} aTotalEdges in unsigned long aTotalEdges
*/
Components.interfaces.nsICycleCollectorListener.prototype.describeRefcountedObject=function(aAddress, aKnownEdges, aTotalEdges){};
/**
*
*
*/
Components.interfaces.nsICycleCollectorListener.prototype.end=function(){};
/**
*
*
* @param {Number} aFromAddress in unsigned long long aFromAddress,
* @param {Number} aToAddress in unsigned long long aToAddress,
* @param {String} aEdgeName in string aEdgeName
*/
Components.interfaces.nsICycleCollectorListener.prototype.noteEdge=function(aFromAddress, aToAddress, aEdgeName){};
/**
*
*
* @param {Number} aAddress in unsigned long long aAddress,
* @param {String} aObjectDescription in string aObjectDescription
*/
Components.interfaces.nsICycleCollectorListener.prototype.noteObject=function(aAddress, aObjectDescription){};
/**
* An interface for verifying that a given string of data was signed by the private key matching the given public key.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDataSignatureVerifier=function(){};
/**
* Verifies that the data matches the data that was used to generate the signature.
*
* @param {String} aData in ACString aData, The data to be tested.
* @param {String} aSignature in ACString aSignature, The signature of the data, base64 encoded.
* @param {String} aPublicKey in ACString aPublicKey The public part of the key used for signing, DER encoded then base64 encoded.
*/
Components.interfaces.nsIDataSignatureVerifier.prototype.verifyData=function(aData, aSignature, aPublicKey){};
/**
* Provides debugging support for scripted languages, such as JavaScript, Java, Python, Perl, and so forth.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDebug=function(){};
/**
* Requests the process to trigger a fatal abort.
*
* @param {String} aFile in string aFile, File containing abort request.
* @param {Number} aLine in long aLine Line number of abort request.
*/
Components.interfaces.nsIDebug.prototype.abort=function(aFile, aLine){};
/**
* Shows an assertion and triggers optional behavior based on the XPCOM_DEBUG_BREAK environment variable, defaulting to calling break() on Windows and OS/2 and warning on other platforms.
*
* @param {String} aStr in string aStr, assertion message.
* @param {String} aExpr in string aExpr, Expression that failed.
* @param {String} aFile in string aFile, File containing assertion.
* @param {Number} aLine in long aLine Line number of assertion.
*/
Components.interfaces.nsIDebug.prototype.assertion=function(aStr, aExpr, aFile, aLine){};
/**
* Requests the software break into a debugger. If no debugger is running then this usually results in a program crash. However, on Windows a dialog is first presented giving the user the option of aborting, breaking, or ignoring the request. The dialog can be suppressed by use of the windbgdlg registry key. This allows the debugger to be attached before the software break.
*
* @param {String} aFile in string aFile, File containing break request.
* @param {Number} aLine in long aLine Line number of break request.
*/
Components.interfaces.nsIDebug.prototype.break=function(aFile, aLine){};
/**
* Shows a warning.
*
* @param {String} aStr in string aStr, warning message.
* @param {String} aFile in string aFile, File containing warning.
* @param {Number} aLine in long aLine Line number of warning.
*/
Components.interfaces.nsIDebug.prototype.warning=function(aStr, aFile, aLine){};
/**
* This interface is used to implement accelerometer support.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDeviceMotion=function(){};
/**
* When called, the accelerometer support implementation must begin to notify the specified nsIDeviceMotionListener by calling its nsIDeviceMotionListener.onAccelerationChange() method as appropriate to share updated acceleration data.
*
* @param {Components.interfaces.nsIDeviceMotionListener} aListener in nsIDeviceMotionListener aListener The nsIDeviceMotionListener object whose nsIDeviceMotionListener.onAccelerationChange() method should be called with updated acceleration data.
*/
Components.interfaces.nsIDeviceMotion.prototype.addListener=function(aListener){};
/**
* Tells the accelerometer to stop sending updates to the specified nsIDeviceMotionListener.
*
* @param {Components.interfaces.nsIDeviceMotionListener} aListener in nsIDeviceMotionListener aListener The nsIDeviceMotionListener object to which no further updates should be sent.
*/
Components.interfaces.nsIDeviceMotion.prototype.removeListener=function(aListener){};
/**
* This interface provides information about device motion.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDeviceMotionData=function(){};
/**
* The motion data describes device acceleration.
*
* @constant
*/
Components.interfaces.nsIDeviceMotionData.prototype.TYPE_ACCELERATION=0;
/**
* The motion data describes a device orientation chang.
*
* @constant
*/
Components.interfaces.nsIDeviceMotionData.prototype.TYPE_ORIENTATION=1;
/**
* The type of motion data reported by this object; see Motion type constants for possible values. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDeviceMotionData.prototype.type=0;
/**
* The amount of tilt along the X axis. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDeviceMotionData.prototype.x=0;
/**
* The amount of tilt along the Y axis. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDeviceMotionData.prototype.y=0;
/**
* The amount of tilt along the Z axis. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDeviceMotionData.prototype.z=0;
/**
* This interface can be implemented by clients that want to be notified orientation or acceleration changes on supported devices.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDeviceMotionListener=function(){};
/**
* Called when new orientation or acceleration data is available.
*
* @param {Components.interfaces.nsIDeviceMotionData} aMotionData in nsIDeviceMotionData aMotionData The nsIDeviceMotionData object describing updated motion information.
*/
Components.interfaces.nsIDeviceMotionListener.prototype.onMotionChange=function(aMotionData){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDialogCreator=function(){};
/**
* @constant
*/
Components.interfaces.nsIDialogCreator.prototype.UNKNOWN_DIALOG=0;
/**
* @constant
*/
Components.interfaces.nsIDialogCreator.prototype.GENERIC_DIALOG=1;
/**
* @constant
*/
Components.interfaces.nsIDialogCreator.prototype.SELECT_DIALOG=2;
/**
*
*
* @param {Number} aType in unsigned long aType,
* @param {String} aName in ACString aName,
* @param {String} aFeatures in ACString aFeatures,
* @param {Components.interfaces.nsIDialogParamBlock} aArguments in nsIDialogParamBlock aArguments,
* @param {Components.interfaces.nsIDOMElement aFrameElement} Optional in nsIDOMElement aFrameElement Optional
*/
Components.interfaces.nsIDialogCreator.prototype.openDialog=function(aType, aName, aFeatures, aArguments, Optional){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDictionary=function(){};
/**
* Check if a given key is present in the dictionary.
*
* @param {String} key in string key Key to check for.
*/
Components.interfaces.nsIDictionary.prototype.hasKey=function(key){};
/**
* Retrieve all keys in the dictionary.
*
* @param {Number} count out PRUint32 count, undefined
* @param {String} keys [retval, array, size_is(count] out string keys undefined
*/
Components.interfaces.nsIDictionary.prototype.getKeys=function(count, keys){};
/**
* Find the value indicated by the key.
*
* @param {String} key in string key The lookup key indicating the value.
*/
Components.interfaces.nsIDictionary.prototype.getValue=function(key){};
/**
* Add the key-value pair to the dictionary. If the key is already present, the new value replaces the old one.
*
* @param {String} key in string key, The key by which the value can be accessed.
* @param {Components.interfaces.nsISupports} value in nsISupports value The value to store.
*/
Components.interfaces.nsIDictionary.prototype.setValue=function(key, value){};
/**
* Find the value indicated by the key.
*
* @param {String} key in string key The key indicating the pair to be removed.
*/
Components.interfaces.nsIDictionary.prototype.deleteValue=function(key){};
/**
* Delete all key-value pairs from the dictionary.
*
*/
Components.interfaces.nsIDictionary.prototype.clear=function(){};
/**
* Please add a summary to this article.
*
* @constructor
*/
Components.interfaces.nsIDirectoryIterator=function(){};
/**
*
*
* @type {Components.interfaces.nsIFileSpec}
*/
Components.interfaces.nsIDirectoryIterator.prototype.currentSpec=new Components.interfaces.nsIFileSpec();
/**
* This interface provides methods to initialize and configure a directory service instance. The XPCOM Directory Service implements this interface to provide support for a variety of well-known file and directory locations.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDirectoryService=function(){};
/**
* This interface is used by the Directory Service to get file locations.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDirectoryServiceProvider=function(){};
/**
* The Directory Service calls this method when it gets the first request for a prop or on every request if the prop is not persistent.
*
* @param {String} prop in string prop, The symbolic name of the file.
* @param {Boolean} persistent out PRBool persistent true if the returned file will be cached by Directory Service. Subsequent requests for this prop will bypass the provider and use the cache. false if the provider will be asked for this prop each time it is requested.
*/
Components.interfaces.nsIDirectoryServiceProvider.prototype.getFile=function(prop, persistent){};
/**
* An extension of nsIDirectoryServiceProvider which allows multiple files to be returned for the given key.
*
* @constructor
* @inherits {Components.interfaces.nsIDirectoryServiceProvider}
*/
Components.interfaces.nsIDirectoryServiceProvider2=function(){};
/**
* The directory service calls this when it gets a request for a prop and the requested type is nsISimpleEnumerator.
*
* @param {String} prop in string prop The symbolic name of the file list.
*/
Components.interfaces.nsIDirectoryServiceProvider2.prototype.getFiles=function(prop){};
/**
* A class holding information about a directory index. Because this has no reference back to their original source, changing these attributes won't affect the directory.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDirIndex=function(){};
/**
* The type is unknown.
*
* @constant
*/
Components.interfaces.nsIDirIndex.prototype.TYPE_UNKNOWN=0;
/**
* The directory entry represents a directory.
*
* @constant
*/
Components.interfaces.nsIDirIndex.prototype.TYPE_DIRECTORY=1;
/**
* The directory entry represents a file.
*
* @constant
*/
Components.interfaces.nsIDirIndex.prototype.TYPE_FILE=2;
/**
* The directory entry represents a symlink.
*
* @constant
*/
Components.interfaces.nsIDirIndex.prototype.TYPE_SYMLINK=3;
/**
* The content type; may be null if it is unknown. Unspecified for directories.
*
* @type {String}
*/
Components.interfaces.nsIDirIndex.prototype.contentType="";
/**
* A description for the filename, which should be displayed by a viewer.
*
* @type {String}
*/
Components.interfaces.nsIDirIndex.prototype.description="";
/**
* Last-modified time in seconds-since-epoch. If the last modified time is unknown, this value is -1.
*
* @type {Number}
*/
Components.interfaces.nsIDirIndex.prototype.lastModified=0;
/**
* The fully qualified filename, expressed as a URI. This is encoded with the encoding specified in the nsIDirIndexParser, and is also escaped.
*
* @type {String}
*/
Components.interfaces.nsIDirIndex.prototype.location="";
/**
* File size; if the size is unknown, this value is -1.
*
* @type {Number}
*/
Components.interfaces.nsIDirIndex.prototype.size=0;
/**
* The type of the entry; one of the TYPE_* constants.
*
* @type {Number}
*/
Components.interfaces.nsIDirIndex.prototype.type=0;
/**
* This interface is used to receive contents of directory index listings from a protocol. They can then be transformed into an output format (such as rdf, html and so on)
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDirIndexListener=function(){};
/**
* Called for each directory entry.
*
* @param {Components.interfaces.nsIRequest} aRequest in nsIRequest aRequest, The request.
* @param {Components.interfaces.nsISupports} aCtxt in nsISupports aCtxt, Opaque parameter
* @param {Components.interfaces.nsIDirIndex} aIndex in nsIDirIndex aIndex New index to add.
*/
Components.interfaces.nsIDirIndexListener.prototype.onIndexAvailable=function(aRequest, aCtxt, aIndex){};
/**
* A parser for 'application/http-index-format' directories.
*
* @constructor
* @inherits {Components.interfaces.nsIStreamListener}
*/
Components.interfaces.nsIDirIndexParser=function(){};
/**
* The comment given, if any. This result is only valid after OnStopRequest has occurred, because it can occur anywhere in the datastream. Read only.
*
* @type {String}
*/
Components.interfaces.nsIDirIndexParser.prototype.comment="";
/**
* The encoding to use.
*
* @type {String}
*/
Components.interfaces.nsIDirIndexParser.prototype.encoding="";
/**
* The interface to use as a callback for new entries.
*
* @type {Components.interfaces.nsIDirIndexListener}
*/
Components.interfaces.nsIDirIndexParser.prototype.listener=new Components.interfaces.nsIDirIndexListener();
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDiskCacheStreamInternal=function(){};
/**
* We use this method internally to close nsDiskCacheOutputStream under the cache service lock.
*
*/
Components.interfaces.nsIDiskCacheStreamInternal.prototype.closeInternal=function(){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDNSListener=function(){};
/**
* Called when an asynchronous host lookup completes.
*
* @param {Components.interfaces.nsICancelable} aRequest in nsICancelable aRequest, The value returned from asyncResolve.
* @param {Components.interfaces.nsIDNSRecord} aRecord in nsIDNSRecord aRecord, The DNS record corresponding to the hostname that was resolved. this parameter is null if there was an error.
* @param {Components.interfaces.nsresult} aStatus in nsresult aStatus If the lookup failed, this parameter gives the reason.
*/
Components.interfaces.nsIDNSListener.prototype.onLookupComplete=function(aRequest, aRecord, aStatus){};
/**
* This interface represents the result of a DNS lookup. Since a DNS query may return more than one resolved IP address, the record acts like an enumerator, allowing the caller to easily step through the list of IP addresses.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDNSRecord=function(){};
/**
* for example, www.mozilla.org --> rheet.mozilla.org. Read only.
*
* @type {String}
*/
Components.interfaces.nsIDNSRecord.prototype.canonicalName="";
/**
* This function returns the value of the next IP address as a string and increments the internal address iterator.
*
*/
Components.interfaces.nsIDNSRecord.prototype.getNextAddrAsString=function(){};
/**
* This method checks if there is another address in the record.
*
*/
Components.interfaces.nsIDNSRecord.prototype.hasMore=function(){};
/**
* This function resets the internal address iterator to the first address in the record.
*
*/
Components.interfaces.nsIDNSRecord.prototype.rewind=function(){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDNSRequest=function(){};
/**
* Called to cancel a pending asynchronous DNS request. The listener will passed to asyncResolve will be notified immediately with a status code of NS_ERROR_ABORT.
*
*/
Components.interfaces.nsIDNSRequest.prototype.cancel=function(){};
/**
* Provides domain name resolution service.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDNSService=function(){};
/**
* This flag suppresses the internal DNS lookup cache.
*
* @constant
*/
Components.interfaces.nsIDNSService.prototype.RESOLVE_BYPASS_CACHE=(1 << 0);
/**
* The canonical name of the specified host will be queried.
*
* @constant
*/
Components.interfaces.nsIDNSService.prototype.RESOLVE_CANONICAL_NAME=(1 << 1);
/**
* The query is given medium priority. If used with low, medium takes precedence.
*
* @constant
*/
Components.interfaces.nsIDNSService.prototype.RESOLVE_PRIORITY_MEDIUM=(1 << 2);
/**
* The query is given lower priority. If used with medium, medium takes precedence.
*
* @constant
*/
Components.interfaces.nsIDNSService.prototype.RESOLVE_PRIORITY_LOW=(1 << 3);
/**
* Indicates request is speculative. Speculative requests return errors if prefetching is disabled by configuration.
*
* @constant
*/
Components.interfaces.nsIDNSService.prototype.RESOLVE_SPECULATE=(1 << 4);
/**
* If this flag is set, only IPv4 addresses will be returned by asyncResolve() and resolve().
*
* @constant
*/
Components.interfaces.nsIDNSService.prototype.RESOLVE_DISABLE_IPV6=(1 << 5);
/**
* Read only.
*
* @type {String}
*/
Components.interfaces.nsIDNSService.prototype.myHostName="";
/**
* Begins off an asynchronous host lookup. A specified nsIDNSListener is invoked when the resolution process is completed.
*
* @param {String} aHostName in AUTF8String aHostName, The host name or IP-address-literal to resolve.
* @param {Number} aFlags in unsigned long aFlags, A bitwise OR of the Resolve flag constants.
* @param {Components.interfaces.nsIDNSListener} aListener in nsIDNSListener aListener, The listener to be notified when the result is available.
* @param {Components.interfaces.nsIEventTarget} aListenerTarget in nsIEventTarget aListenerTarget Optional parameter (may be null). If not null, this parameter specifies the nsIEventTarget of the thread on which the listener's onLookupComplete should be called. If this parameter is null, then onLookupComplete will be called on an unspecified thread (possibly recursively).
*/
Components.interfaces.nsIDNSService.prototype.asyncResolve=function(aHostName, aFlags, aListener, aListenerTarget){};
/**
* Called to synchronously resolve a host name. Warning this method may block the calling thread for a long period of time. It is extremely unwise to call this function on the User Interface thread of an application.
*
* @param {String} aHostName in AUTF8String aHostName, The host name or IP-address-literal to resolve.
* @param {Number} aFlags in unsigned long aFlags A bitwise OR of the Resolve flag constants.
*/
Components.interfaces.nsIDNSService.prototype.resolve=function(aHostName, aFlags){};
/**
* ??? need a description here ???
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDocShell=function(){};
/**
* Used as a placeholder when you don't want to explicitly specify flags.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.INTERNAL_LOAD_FLAGS_NONE=0x0;
/**
* Used to indicate that it may be safe to inherit the owner of a javascript: or data: URL from the existing document.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.INTERNAL_LOAD_FLAGS_INHERIT_OWNER=0x1;
/**
* Used to indicate that the load was caused by a meta refresh and the current document URI shouldn't be sent as the HTTP referrer.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.INTERNAL_LOAD_FLAGS_DONT_SEND_REFERRER=0x2;
/**
* Used to indicate that LOAD_FLAGS_ALLOW_THIRD_PARTY_FIXUP was passed as one of the flags to loadURI().
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.INTERNAL_LOAD_FLAGS_ALLOW_THIRD_PARTY_FIXUP=0x4;
/**
* This flag marks the first load in this object. See nsIWebNavigation.LOAD_FLAGS_FIRST_LOAD.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.INTERNAL_LOAD_FLAGS_FIRST_LOAD=0x8;
/**
* Used to indicate that LOAD_FLAGS_BYPASS_CLASSIFIER was passed as one of the flags to loadURI().
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.INTERNAL_LOAD_FLAGS_BYPASS_CLASSIFIER=0x10;
/**
* Used to indicate that LOAD_FLAGS_FORCE_ALLOW_COOKIES was passed as one of the flags to loadURI().
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.INTERNAL_LOAD_FLAGS_FORCE_ALLOW_COOKIES=0x20;
/**
* Used by getDocShellEnumerator()to determine the direction of the enumeration.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.ENUMERATE_FORWARDS=0;
/**
* Used by getDocShellEnumerator()to determine the direction of the enumeration.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.ENUMERATE_BACKWARDS=1;
/**
* This is the default value of the appType attribute.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.APP_TYPE_UNKNOWN=0;
/**
* This is the value of the appType attribute used by Thunderbird and SeaMonkey to indicate that email messages are displayed in this window.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.APP_TYPE_MAIL=1;
/**
* This is the value of the appType attribute used by Thunderbird and SeaMonkey to indicate that email messages or web pages are composed in this window.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.APP_TYPE_EDITOR=2;
/**
* Returned by the busyFlags attribute when the nsIDocShell is not loading a document.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.BUSY_FLAGS_NONE=0;
/**
* Returned by the busyFlags attribute when the nsIDocShell is loading a document from the network.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.BUSY_FLAGS_BUSY=1;
/**
* Returned by the busyFlags attribute when the nsIDocShell has started loading a document from the network, but no data has been received yet.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.BUSY_FLAGS_BEFORE_PAGE_LOAD=2;
/**
* Returned by the busyFlags attribute when the nsIDocShell is receiving data from the network.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.BUSY_FLAGS_PAGE_LOADING=4;
/**
* Returned by the loadType attribute for normal loads.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.LOAD_CMD_NORMAL=0x1;
/**
* Returned by the loadType attribute for reloads.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.LOAD_CMD_RELOAD=0x2;
/**
* Returned by the loadType attribute for history navigation.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.LOAD_CMD_HISTORY=0x4;
/**
* Returned by the loadType attribute when the page has used history.pushState()
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.LOAD_CMD_PUSHSTATE=0x8;
/**
* The character set has not yet been initialized.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.kCharsetUninitialized=0;
/**
* @constant
*/
Components.interfaces.nsIDocShell.prototype.kCharsetFromWeakDocTypeDefault=1;
/**
* The user's default character set is being used.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.kCharsetFromUserDefault=2;
/**
* The character set has been inferred from the doctype. All values from here upward are confident enough to be used for XMLHttpRequest.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.kCharsetFromDocTypeDefault=3;
/**
* The character set has been retrieved from the cache.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.kCharsetFromCache=4;
/**
* The parent frame's character set is being used.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.kCharsetFromParentFrame=5;
/**
* The character set was automatically detected.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.kCharsetFromAutoDetection=6;
/**
* The character set was hinted by the previous document.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.kCharsetFromHintPrevDoc=7;
/**
* Values from this one downward are HTML5 tentative.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.kCharsetFromMetaPrescan=8;
/**
* Values from this one upward are HTML5 confident.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.kCharsetFromMetaTag=9;
/**
* @constant
*/
Components.interfaces.nsIDocShell.prototype.kCharsetFromIrreversibleAutoDetection=10;
/**
* The character set was determined from a byte order mark in the content.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.kCharsetFromByteOrderMark=11;
/**
* The nsIChannel specified the character set.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.kCharsetFromChannel=12;
/**
* @constant
*/
Components.interfaces.nsIDocShell.prototype.kCharsetFromOtherComponent=13;
/**
* The parent's character set was forced onto this content; all descendents will have this character set forced onto it.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.kCharsetFromParentForced=14;
/**
* The user specified a character set to force onto this content; all descendents will have this character set forced onto it.
*
* @constant
*/
Components.interfaces.nsIDocShell.prototype.kCharsetFromUserForced=15;
/**
* @constant
*/
Components.interfaces.nsIDocShell.prototype.kCharsetFromPreviousLoading=16;
/**
* Certain dochshells (like the message pane) should not throw up auth dialogs because it can act as a password trojan.
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.allowAuth=false;
/**
* Attribute that determines whether DNS prefetch is allowed for this subtree of the docshell tree. Defaults to true. Setting this will make it take effect starting with the next document loaded in the docshell.
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.allowDNSPrefetch=false;
/**
* Attribute stating whether or not images should be loaded.
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.allowImages=false;
/**
* Whether to allow Javascript execution.
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.allowJavascript=false;
/**
* Attribute stating if refresh based redirects can be allowed.
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.allowMetaRedirects=false;
/**
* Whether to allow plugin execution.
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.allowPlugins=false;
/**
* Attribute stating if it should allow subframes (framesets/iframes) or not.
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.allowSubframes=false;
/**
* Specifies whether or not content is allowed to control the window (that is, to resize or move the window). Default is true, which lets content control the window.
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.allowWindowControl=false;
/**
* The type of application that created this window. Types are defined in Constants.
*
* @type {Number}
*/
Components.interfaces.nsIDocShell.prototype.appType=0;
/**
* Current busy state for DocShell. Valid states are defined in Constants. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDocShell.prototype.busyFlags=0;
/**
* Whether this docshell can execute scripts based on its hierarchy. The rule of thumb here is that we disable js if this docshell or any of its parents disallow scripting, unless the only reason for js being disabled in this docshell is a parent docshell having a document that is in design mode. In that case, we explicitly allow scripting on the current docshell. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.canExecuteScripts=false;
/**
* Tells the docshell whether the canvas should have focus. Called by the focus manager when the user tabs to the frame rather than an element. Obsolete since Gecko 1.9.2
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.canvasHasFocus=false;
/**
* Find out if the currently loaded document came from a suspicious channel (such as a JAR channel where the server-returned content type is not a known JAR type). Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.channelIsUnsafe=false;
/**
* The converter to use when reading the document's data.
* In Mozilla code, all text is encoded as Unicode. When reading a document, a converter is used to translate the text from its original format into Unicode. This attribute lets you:
* See what converter was used when retrieving the document's data.
* Override that character set for documents for which the specified fallback or auto-detected character set is incorrect.
* Reading this value reports the encoding that was used when loading the data into the document. Setting this attribute overrides the encoding; however, to update the DOM or display of the content, you need have the data reparsed.
* Overriding the character set also sets the fallback encoding for the container frame.
* Note: Prior to Gecko 12.0, this attribute was part of a separate nsIDocCharset interface.
*
* @type {String}
*/
Components.interfaces.nsIDocShell.prototype.charset="";
/**
* Events generated in the frame bubble up to its chromeEventHandler. In the case of a content frame or subframe this is the containing chrome frame. In the case of a chrome frame this is the same as the frame element. This attribute allows chrome to tie in to handle DOM events that may be of interest to chrome.
*
* @type {Components.interfaces.nsIDOMEventTarget}
*/
Components.interfaces.nsIDocShell.prototype.chromeEventHandler=new Components.interfaces.nsIDOMEventTarget();
/**
* Content Viewer that is currently loaded for this DocShell. This may change as the underlying content changes. Read only.
*
* @type {Components.interfaces.nsIContentViewer}
*/
Components.interfaces.nsIDocShell.prototype.contentViewer=new Components.interfaces.nsIContentViewer();
/**
* Gets the channel for the currently loaded document, if any. For a new document load, this will be the channel of the previous document until after OnLocationChange fires. Read only.
*
* @type {Components.interfaces.nsIChannel}
*/
Components.interfaces.nsIDocShell.prototype.currentDocumentChannel=new Components.interfaces.nsIChannel();
/**
* The document character set info. This is used by a load to determine priorities for charset detection and so on. Obsolete since Gecko 12.0
* Note: The properties of the old nsIDocumentCharsetInfo interface were merged into nsIDocShell in Gecko 12.0.
*
* @type {Components.interfaces.nsIDocumentCharsetInfo}
*/
Components.interfaces.nsIDocShell.prototype.documentCharsetInfo=new Components.interfaces.nsIDocumentCharsetInfo();
/**
* Presentation shell for the oldest document, if this docshell is currently transitioning between documents. Read only. Native code only!
*
* @type {Components.interfaces.nsIPresShell}
*/
Components.interfaces.nsIDocShell.prototype.eldestPresShell=new Components.interfaces.nsIPresShell();
/**
* A character set to override the page's default character set while processing; this is tried before using any other character set during page loads.
* Note: Prior to Gecko 12.0, this attribute was part of a separate nsIDocCharsetInfo interface.
*
* @type {Components.interfaces.nsIAtom}
*/
Components.interfaces.nsIDocShell.prototype.forcedCharset=new Components.interfaces.nsIAtom();
/**
* Tells the DocShell that it now has focus or has lost focus. Obsolete since Gecko 1.9.2
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.hasFocus=false;
/**
* The ID of the docshell in the session history. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDocShell.prototype.historyID=0;
/**
* Indicates whether or not the DocShell is currently active. An active DocShell is one that is currently visible, which means it's not a good candidate for optimizations such as image frame discarding. DocShells are active if this is true, which is the default state.
* Note: Starting in Gecko 8.0, isActive is false for documents in minimized windows.
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.isActive=false;
/**
* Sets whether a docshell is an app tab. An app tab docshell may behave differently than a non-app tab docshell in some cases, such as when handling link clicks. Docshells are not app tabs unless told otherwise.
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.isAppTab=false;
/**
* Returns true if the docshell is currently executing the onLoad Handler. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.isExecutingOnLoadHandler=false;
/**
* Find out whether the docshell is currently in the middle of a page transition (after the onunload event has fired, but before the new document has been set up) Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.isInUnload=false;
/**
* If true, this docshell is not visible in the traditional sense, but is being actively rendered to the screen (such as by being painted to a canvas), and should be treated accordingly.
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.isOffScreenBrowser=false;
/**
*
*
* @type {Components.interfaces.nsILayoutHistoryState}
*/
Components.interfaces.nsIDocShell.prototype.layoutHistoryState=new Components.interfaces.nsILayoutHistoryState();
/**
* Keeps track of the previous SHTransaction index and the current SHTransaction index at the time that the doc shell begins to load. Used for ContentViewer eviction. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDocShell.prototype.loadedTransIndex=0;
/**
* Load type for the document. Valid states are defined in Constants. Note that nsIDocShell may use other states internally so you should check for the specific state bit.
*
* @type {Number}
*/
Components.interfaces.nsIDocShell.prototype.loadType=0;
/**
* The value of the marginheight attribute on the frame element, or negative if it was not set.
*
* @type {Number}
*/
Components.interfaces.nsIDocShell.prototype.marginHeight=0;
/**
* The value of the marginwidth attribute on the frame element, or negative if it was not set.
*
* @type {Number}
*/
Components.interfaces.nsIDocShell.prototype.marginWidth=0;
/**
* Indicates the DocShell's parent document's character set.
* Note: Prior to Gecko 12.0, this attribute was part of a separate nsIDocCharsetInfo interface.
*
* @type {Components.interfaces.nsIAtom}
*/
Components.interfaces.nsIDocShell.prototype.parentCharset=new Components.interfaces.nsIAtom();
/**
* Indicates the source from which the character set being used was obtained. Higher numbers override lower ones. See Character set source constants for defined values.
* Note: Prior to Gecko 12.0, this attribute was part of a separate nsIDocCharsetInfo interface.
*
* @type {Number}
*/
Components.interfaces.nsIDocShell.prototype.parentCharsetSource=0;
/**
* URI content listener parent. This is not refcounted and is assumed to be nulled out by the parent when the parent is going away. Obsolete since Gecko 1.8
*
* @type {Components.interfaces.nsIURIContentListener}
*/
Components.interfaces.nsIDocShell.prototype.parentURIContentListener=new Components.interfaces.nsIURIContentListener();
/**
* Presentation context for the currently loaded document. This may be null. Read only. Native code only!
*
* @type {Components.interfaces.nsPresContext}
*/
Components.interfaces.nsIDocShell.prototype.presContext=new Components.interfaces.nsPresContext();
/**
* Presentation shell for the currently loaded document. This may be null. Read only. Native code only!
*
* @type {Components.interfaces.nsIPresShell}
*/
Components.interfaces.nsIDocShell.prototype.presShell=new Components.interfaces.nsIPresShell();
/**
* Keeps track of the previous SHTransaction index and the current SHTransaction index at the time that the doc shell begins to load. Used for ContentViewer eviction. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDocShell.prototype.previousTransIndex=0;
/**
* If the current content viewer is not initialized for print preview, it is replaced with one which is and to which an about:blank document is loaded. Read only.
*
* @type {Components.interfaces.nsIWebBrowserPrint}
*/
Components.interfaces.nsIDocShell.prototype.printPreview=new Components.interfaces.nsIWebBrowserPrint();
/**
* Track whether we're currently restoring a document presentation. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.restoringDocument=false;
/**
* The SecureBrowserUI object for this docshell. This is set by browser or nsWebBrowser for their root docshell.
*
* @type {Components.interfaces.nsISecureBrowserUI}
*/
Components.interfaces.nsIDocShell.prototype.securityUI=new Components.interfaces.nsISecureBrowserUI();
/**
* Indicates whether the current page can be cached. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.shouldSaveLayoutState=false;
/**
* Attribute to access whether error pages are enabled.
*
* @type {Boolean}
*/
Components.interfaces.nsIDocShell.prototype.useErrorPages=false;
/**
* Set/Get the document scale factor. When setting this attribute, a NS_ERROR_NOT_IMPLEMENTED error may be returned by implementations not supporting zoom. Implementations not supporting zoom should return 1.0 all the time for the Get operation. 1.0 by the way is the default of zoom. This means 100% of normal scaling or in other words normal size no zoom.
*
* @type {Number}
*/
Components.interfaces.nsIDocShell.prototype.zoom=0;
/**
* Creates a DocShellLoadInfo object that you can manipulate and then pass to loadURI().
*
* @param {Components.interfaces.nsIDocShellLoadInfo} loadInfo out nsIDocShellLoadInfo loadInfo The new nsIDocShellLoadInfo object.
*/
Components.interfaces.nsIDocShell.prototype.createLoadInfo=function(loadInfo){};
/**
* Get an enumerator over this docShell and its children.
*
* @param {Number} aItemType in long aItemType, Only include docShells of this type, or if typeAll, include all child shells. Uses types from nsIDocShellTreeItem.
* @param {Number} aDirection in long aDirection Whether to enumerate forwards or backwards.
*/
Components.interfaces.nsIDocShell.prototype.getDocShellEnumerator=function(aItemType, aDirection){};
/**
*
*
*/
Components.interfaces.nsIDocShell.prototype.isBeingDestroyed=function(){};
/**
* Reset state to a new content model within the current document and the document viewer. Called by the document before initiating an out of band document.write().
*
*/
Components.interfaces.nsIDocShell.prototype.prepareForNewContentModel=function(){};
/**
* For editors and suchlike who wish to change the URI associated with the document. Note if you want to get the current URI, use the read-only property on nsIWebNavigation.
*
* @param {Components.interfaces.nsIURI} aURI in nsIURI aURI The URI to load.
*/
Components.interfaces.nsIDocShell.prototype.setCurrentURI=function(aURI){};
/**
* Tells the docshell to offer focus to its tree owner. This is currently only necessary for embedding chrome.
*
* @param {Boolean} forward in boolean forward, Whether to tab forwards or backwards.
* @param {Boolean} tookFocus out boolean tookFocus Whether or not an element was successfully focused.
*/
Components.interfaces.nsIDocShell.prototype.tabToTreeOwner=function(forward, tookFocus){};
/**
* This interface is implemented on the window object in chrome.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMChromeWindow=function(){};
/**
* The window is maximized.
*
* @constant
*/
Components.interfaces.nsIDOMChromeWindow.prototype.STATE_MAXIMIZED=1;
/**
* The window is minimized.
*
* @constant
*/
Components.interfaces.nsIDOMChromeWindow.prototype.STATE_MINIMIZED=2;
/**
* The window is normal.
*
* @constant
*/
Components.interfaces.nsIDOMChromeWindow.prototype.STATE_NORMAL=3;
/**
* The window is in full screen mode.
*
* @constant
*/
Components.interfaces.nsIDOMChromeWindow.prototype.STATE_FULLSCREEN=4;
/**
* The related nsIBrowserDOMWindow instance which provides access to yet another layer of utility functions by chrome script. It will be null for DOMWindows not corresponding to browsers.
*
* @type {Components.interfaces.nsIBrowserDOMWindow}
*/
Components.interfaces.nsIDOMChromeWindow.prototype.browserDOMWindow=new Components.interfaces.nsIBrowserDOMWindow();
/**
* Read only.
*
* @type {Components.interfaces.nsIChromeFrameMessageManager}
*/
Components.interfaces.nsIDOMChromeWindow.prototype.messageManager=new Components.interfaces.nsIChromeFrameMessageManager();
/**
* Obsolete since Gecko 1.9.1
*
* @type {String}
*/
Components.interfaces.nsIDOMChromeWindow.prototype.title="";
/**
* Returns current window state, the value is one of STATE_* constants. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMChromeWindow.prototype.windowState=0;
/**
*
*
*/
Components.interfaces.nsIDOMChromeWindow.prototype.getAttention=function(){};
/**
* Same as getAttention method excepting that this can specify the maximum number of times to animate the window per system conventions.
*
* @param {Number} aCycleCount in long aCycleCount The maximum number of times to animate the window per system conventions. If set to -1, cycles indefinitely until window is brought into the foreground. This behavior is same as getAttention method.
*/
Components.interfaces.nsIDOMChromeWindow.prototype.getAttentionWithCycleCount=function(aCycleCount){};
/**
* Maximizes the window.
*
*/
Components.interfaces.nsIDOMChromeWindow.prototype.maximize=function(){};
/**
* Minimizes the window.
*
*/
Components.interfaces.nsIDOMChromeWindow.prototype.minimize=function(){};
/**
* Restores the size and position of the window.
*
*/
Components.interfaces.nsIDOMChromeWindow.prototype.restore=function(){};
/**
* Sets the mouse cursor to the specified cursor. The mouse cursor is locked to the specified cursor if it's not "auto". At that time, the cursor has been never changed by cursor moving. After you call this method with "auto", the cursor will be unlocked.
*
* @param {String} cursor in DOMString cursor You can specify same values of CSS cursor property (including -moz- prefixed values). And there are special values: "grab", "grabbing" and "spinning". But they might be dropped in the future version, if you use the values, you should use -moz-* value instead.
*/
Components.interfaces.nsIDOMChromeWindow.prototype.setCursor=function(cursor){};
/**
* Represents a rectangular box. The type of box is specified by the method that returns such an object. It is returned by functions like element.getBoundingClientRect.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMClientRect=function(){};
/**
* Y-coordinate, relative to the viewport origin, of the bottom of the rectangle box. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMClientRect.prototype.bottom=0;
/**
* Height of the rectangle box (This is identical to bottom minus top). Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMClientRect.prototype.height=0;
/**
* X-coordinate, relative to the viewport origin, of the left of the rectangle box. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMClientRect.prototype.left=0;
/**
* X-coordinate, relative to the viewport origin, of the right of the rectangle box. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMClientRect.prototype.right=0;
/**
* Y-coordinate, relative to the viewport origin, of the top of the rectangle box. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMClientRect.prototype.top=0;
/**
* Width of the rectangle box (This is identical to right minus left). Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMClientRect.prototype.width=0;
/**
* This interface represents an element in an HTML or XML document.
*
* @constructor
* @inherits {Components.interfaces.nsIDOMNode}
*/
Components.interfaces.nsIDOMElement=function(){};
/**
* The element tag name. Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMElement.prototype.tagName="";
/**
* Get an attribute value.
*
* @param {String} name in DOMString name Attribute name
*/
Components.interfaces.nsIDOMElement.prototype.getAttribute=function(name){};
/**
* Get an attribute node.
*
* @param {String} name in DOMString name Attribute name
*/
Components.interfaces.nsIDOMElement.prototype.getAttributeNode=function(name){};
/**
* Get an attribute node in a given namespace.
*
* @param {String} namespaceURI in DOMString namespaceURI, Namespace URI
* @param {String} localName in DOMString localName Attribute name
*/
Components.interfaces.nsIDOMElement.prototype.getAttributeNodeNS=function(namespaceURI, localName){};
/**
* Get an attribute value in a given namespace.
*
* @param {String} namespaceURI in DOMString namespaceURI, Namespace URI
* @param {String} localName in DOMString localName Attribute name
*/
Components.interfaces.nsIDOMElement.prototype.getAttributeNS=function(namespaceURI, localName){};
/**
* Get all descendants of a tag name.
*
* @param {String} name in DOMString name Tag name
*/
Components.interfaces.nsIDOMElement.prototype.getElementsByTagName=function(name){};
/**
* Get all descendants of a tag name in a given namespace.
*
* @param {String} namespaceURI in DOMString namespaceURI, Namespace URI
* @param {String} localName in DOMString localName Tag name
*/
Components.interfaces.nsIDOMElement.prototype.getElementsByTagNameNS=function(namespaceURI, localName){};
/**
* Check if the element have this attribute set.
*
* @param {String} name in DOMString name Attribute name
*/
Components.interfaces.nsIDOMElement.prototype.hasAttribute=function(name){};
/**
* Check if the element for a given namespace have this attribute set.
*
* @param {String} namespaceURI in DOMString namespaceURI, Namespace URI
* @param {String} localName in DOMString localName Attribute name
*/
Components.interfaces.nsIDOMElement.prototype.hasAttributeNS=function(namespaceURI, localName){};
/**
* Remove an attribute.
*
* @param {String} name in DOMString name Attribute name
*/
Components.interfaces.nsIDOMElement.prototype.removeAttribute=function(name){};
/**
* Remove an attribute, giving the attribute node.
*
* @param {Components.interfaces.nsIDOMAttr} oldAttr in nsIDOMAttr oldAttr Attribute node to remove
*/
Components.interfaces.nsIDOMElement.prototype.removeAttributeNode=function(oldAttr){};
/**
* Remove an attribute.
*
* @param {String} namespaceURI in DOMString namespaceURI, Namespace URI
* @param {String} localName in DOMString localName Tag name
*/
Components.interfaces.nsIDOMElement.prototype.removeAttributeNS=function(namespaceURI, localName){};
/**
* Set an attribute.
*
* @param {String} name in DOMString name, Attribute name
* @param {String} value in DOMString value Attribute new value
*/
Components.interfaces.nsIDOMElement.prototype.setAttribute=function(name, value){};
/**
* Set an attribute, giving the attribute node.
*
* @param {Components.interfaces.nsIDOMAttr} newAttr in nsIDOMAttr newAttr Attribute node.
*/
Components.interfaces.nsIDOMElement.prototype.setAttributeNode=function(newAttr){};
/**
* Set an attribute, giving the attribute node.
*
* @param {Components.interfaces.nsIDOMAttr} newAttr in nsIDOMAttr newAttr Attribute node.
*/
Components.interfaces.nsIDOMElement.prototype.setAttributeNodeNS=function(newAttr){};
/**
* Set an attribute.
*
* @param {String} namespaceURI in DOMString namespaceURI, Namespace URI
* @param {String} qualifiedName in DOMString qualifiedName, Attribute name
* @param {String} value in DOMString value Attribute new value
*/
Components.interfaces.nsIDOMElement.prototype.setAttributeNS=function(namespaceURI, qualifiedName, value){};
/**
* This interface is the primary data type for all events in the Document Object Model.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMEvent=function(){};
/**
* The event is not being dispatched.
*
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.NONE=0;
/**
* The current event phase is the capturing phase.
*
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.CAPTURING_PHASE=1;
/**
* The event is currently being evaluated at the target EventTarget.
*
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.AT_TARGET=2;
/**
* The current event phase is the bubbling phase.
*
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.BUBBLING_PHASE=3;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.MOUSEDOWN=0x00000001;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.MOUSEUP=0x00000002;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.MOUSEOVER=0x00000004;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.MOUSEOUT=0x00000008;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.MOUSEMOVE=0x00000010;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.MOUSEDRAG=0x00000020;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.CLICK=0x00000040;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.DBLCLICK=0x00000080;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.KEYDOWN=0x00000100;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.KEYUP=0x00000200;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.KEYPRESS=0x00000400;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.DRAGDROP=0x00000800;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.FOCUS=0x00001000;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.BLUR=0x00002000;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.SELECT=0x00004000;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.CHANGE=0x00008000;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.RESET=0x00010000;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.SUBMIT=0x00020000;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.SCROLL=0x00040000;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.LOAD=0x00080000;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.UNLOAD=0x00100000;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.XFER_DONE=0x00200000;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.ABORT=0x00400000;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.ERROR=0x00800000;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.LOCATE=0x01000000;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.MOVE=0x02000000;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.RESIZE=0x04000000;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.FORWARD=0x08000000;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.HELP=0x10000000;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.BACK=0x20000000;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.TEXT=0x40000000;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.ALT_MASK=0x00000001;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.CONTROL_MASK=0x00000002;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.SHIFT_MASK=0x00000004;
/**
* @constant
*/
Components.interfaces.nsIDOMEvent.prototype.META_MASK=0x00000008;
/**
* Used to indicate whether or not an event is a bubbling event. If the event can bubble the value is true, else the value is false. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIDOMEvent.prototype.bubbles=false;
/**
* Used to indicate whether or not an event can have its default action prevented. If the default action can be prevented the value is true, else the value is false. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIDOMEvent.prototype.cancelable=false;
/**
* Used to indicate the EventTarget whose EventListeners are currently being processed. This is particularly useful during capturing and bubbling. Read only.
*
* @type {Components.interfaces.nsIDOMEventTarget}
*/
Components.interfaces.nsIDOMEvent.prototype.currentTarget=new Components.interfaces.nsIDOMEventTarget();
/**
* Used to indicate whether preventDefault() has been called for this event. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIDOMEvent.prototype.defaultPrevented=false;
/**
* Used to indicate which phase of event flow is currently being evaluated. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMEvent.prototype.eventPhase=0;
/**
* The explicit original target of the event. If the event was retargeted for some reason other than an anonymous boundary crossing, this will be set to the target before the retargeting occurs. For example, mouse events are retargeted to their parent node when they happen over text nodes (bug 185889), and in that case .target will show the parent and .explicitOriginalTarget will show the text node. .explicitOriginalTarget differs from .originalTarget in that it will never contain anonymous content. Read only.
*
* @type {Components.interfaces.nsIDOMEventTarget}
*/
Components.interfaces.nsIDOMEvent.prototype.explicitOriginalTarget=new Components.interfaces.nsIDOMEventTarget();
/**
* Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIDOMEvent.prototype.isTrusted=false;
/**
* The original target of the event, before any retargetings. Read only.
*
* @type {Components.interfaces.nsIDOMEventTarget}
*/
Components.interfaces.nsIDOMEvent.prototype.originalTarget=new Components.interfaces.nsIDOMEventTarget();
/**
* Used to indicate the EventTarget to which the event was originally dispatched. Read only.
*
* @type {Components.interfaces.nsIDOMEventTarget}
*/
Components.interfaces.nsIDOMEvent.prototype.target=new Components.interfaces.nsIDOMEventTarget();
/**
* Used to specify the time (in milliseconds relative to the epoch) at which the event was created. Due to the fact that some systems may not provide this information the value of timeStamp may be not available for all events. When not available, a value of 0 will be returned. Examples of epoch time are the time of the system start or 0:0:0 UTC 1st January 1970. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMEvent.prototype.timeStamp=0;
/**
* The name of the event (case-insensitive). The name must be an XML name. Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMEvent.prototype.type="";
/**
* This method is used to initialize the value of an Event created through the DocumentEvent interface. This method may only be called before the Event has been dispatched via the dispatchEvent method, though it may be called multiple times during that phase if necessary. If called multiple times the final invocation takes precedence. If called from a subclass of Event interface only the values specified in the initEvent method are modified, all other attributes are left unchanged.
*
* @param {String} eventTypeArg in DOMString eventTypeArg, Specifies the event type. This type may be any event type currently defined in this specification or a new event type. The string must be an XML name. Any new event type must not begin with any upper, lower, or mixed case version of the string "DOM". This prefix is reserved for future DOM event sets. It is also strongly recommended that third parties adding their own events use their own prefix to avoid confusion and lessen the probability of conflicts with other new events.
* @param {Boolean} canBubbleArg in boolean canBubbleArg, Specifies whether or not the event can bubble.
* @param {Boolean} cancelableArg in boolean cancelableArg Specifies whether or not the event's default action can be prevented.
*/
Components.interfaces.nsIDOMEvent.prototype.initEvent=function(eventTypeArg, canBubbleArg, cancelableArg){};
/**
* Obsolete since Gecko 24 (Firefox 24 / Thunderbird 24 / SeaMonkey 2.21)This feature is obsolete. Although it is still supported by browsers, its usage is discouraged in new projects. Try to avoid using it.Note: Use stopPropagation() instead.
*
*/
Components.interfaces.nsIDOMEvent.prototype.preventBubble=function(){};
/**
* Obsolete since Gecko 24 (Firefox 24 / Thunderbird 24 / SeaMonkey 2.21)This feature is obsolete. Although it is still supported by browsers, its usage is discouraged in new projects. Try to avoid using it.Note: Use stopPropagation() instead.
*
*/
Components.interfaces.nsIDOMEvent.prototype.preventCapture=function(){};
/**
* If an event is cancelable, the preventDefault method is used to signify that the event is to be canceled, meaning any default action normally taken by the implementation as a result of the event will not occur. If, during any stage of event flow, the preventDefault method is called the event is canceled. Any default action associated with the event will not occur. Calling this method for a non-cancelable event has no effect. Once preventDefault has been called it will remain in effect throughout the remainder of the event's propagation. This method may be used during any stage of event flow.
*
*/
Components.interfaces.nsIDOMEvent.prototype.preventDefault=function(){};
/**
* The stopPropagation method is used prevent further propagation of an event during event flow. If this method is called by any EventListener the event will cease propagating through the tree. The event will complete dispatch to all listeners on the current EventTarget before event flow stops. This method may be used during any stage of event flow.
*
*/
Components.interfaces.nsIDOMEvent.prototype.stopPropagation=function(){};
/**
* This interface is the interface implemented by all event targets in the Document Object Model.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMEventGroup=function(){};
/**
* Reports whether or not another event group is the same as this one.
*
* @param {Components.interfaces.nsIDOMEventGroup} other in nsIDOMEventGroup other Instance of nsIDOMEventGroup object to compare against.
*/
Components.interfaces.nsIDOMEventGroup.prototype.isSameEventGroup=function(other){};
/**
* This interface is the interface implemented by all event targets in the Document Object Model.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMEventTarget=function(){};
/**
* Describes a single font face.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMFontFace=function(){};
/**
* Indicates whether or not the font was located in a font group. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIDOMFontFace.prototype.fromFontGroup=false;
/**
* Indicates whether or not the font was located using language preferences. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIDOMFontFace.prototype.fromLanguagePrefs=false;
/**
* Indicates whether or not the font is the system fallback font. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIDOMFontFace.prototype.fromSystemFallback=false;
/**
* A family name that could be used in CSS font-family (not necessarily the actual name that was used, due to aliases, generics, localized names, and so on). Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMFontFace.prototype.CSSFamilyName="";
/**
* Full font name as obtained from the font resource. Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMFontFace.prototype.name="";
/**
* The font format. Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMFontFace.prototype.format="";
/**
* null if not a src:local(...) rule. Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMFontFace.prototype.localName="";
/**
* XML metadata from WOFF file(if any). Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMFontFace.prototype.metadata="";
/**
* null if no associated @font-face rule. Read only.
*
* @type {Components.interfaces.nsIDOMCSSFontFaceRule}
*/
Components.interfaces.nsIDOMFontFace.prototype.rule=new Components.interfaces.nsIDOMCSSFontFaceRule();
/**
* Index in the rule's src list, -1 if no @font-face rule. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMFontFace.prototype.srcIndex=0;
/**
* null if not a downloaded font, that is local. Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMFontFace.prototype.URI="";
/**
* A list of nsIDOMFontFace objects, each representing a single font face.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMFontFaceList=function(){};
/**
* The number of items in the list. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMFontFaceList.prototype.length=0;
/**
* Returns the nsIDOMFontFace object at the specified index into the list.
*
* @param {Number} index in unsigned long index The index into the array of the font face object to return.
*/
Components.interfaces.nsIDOMFontFaceList.prototype.item=function(index){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMGeoGeolocation=function(){};
/**
* The most recently retrieved location as seen by the provider. May be null. Read only.
*
* @type {Components.interfaces.nsIDOMGeoPosition}
*/
Components.interfaces.nsIDOMGeoGeolocation.prototype.lastPosition=new Components.interfaces.nsIDOMGeoPosition();
/**
* When the clearWatch() method is called, the watch() process stops calling for new position identifiers and cease invoking callbacks.
*
* @param {Number} watchId in unsigned short watchId undefined
*/
Components.interfaces.nsIDOMGeoGeolocation.prototype.clearWatch=function(watchId){};
/**
* Acquires the user's current position via a new position object. If this fails, errorCallback is invoked with an nsIDOMGeoPositionError argument.
*
* @param {Components.interfaces.nsIDOMGeoPositionCallback} successCallback in nsIDOMGeoPositionCallback successCallback, An nsIDOMGeoPositionCallback to be called when the current position is available.
* @param {Components.interfaces.nsIDOMGeoPositionErrorCallback} errorCallback [optional] in nsIDOMGeoPositionErrorCallback errorCallback, An nsIDOMGeoPositionErrorCallback that is called if an error occurs while retrieving the position; this parameter is optional.
* @param {Components.interfaces.nsIDOMGeoPositionOptions} options [optional] in nsIDOMGeoPositionOptions options An nsIDOMGeoPositionOptions object specifying options; this parameter is optional.
*/
Components.interfaces.nsIDOMGeoGeolocation.prototype.getCurrentPosition=function(successCallback, errorCallback, options){};
/**
* Similar to getCurrentPosition(), except it continues to call the callback with updated position information periodically until clearWatch() is called.
*
* @param {Components.interfaces.nsIDOMGeoPositionCallback} successCallback in nsIDOMGeoPositionCallback successCallback, An nsIDOMGeoPositionCallback that is to be called whenever new position information is available.
* @param {Components.interfaces.nsIDOMGeoPositionErrorCallback} errorCallback [optional] in nsIDOMGeoPositionErrorCallback errorCallback, An nsIDOMGeoPositionErrorCallback to call when an error occurs; this is an optional parameter.
* @param {Components.interfaces.nsIDOMGeoPositionOptions} options [optional] in nsIDOMGeoPositionOptions options An nsIDOMGeoPositionOptions object specifying options; this parameter is optional.
*/
Components.interfaces.nsIDOMGeoGeolocation.prototype.watchPosition=function(successCallback, errorCallback, options){};
/**
* This interface describes a geographical location at a specific time.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMGeoPosition=function(){};
/**
* This interface describes the geographical address of a location, including street, city, and country information, for example. This information may or may not be available, depending on the geolocation service being used.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMGeoPositionAddress=function(){};
/**
* The city. Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMGeoPositionAddress.prototype.city="";
/**
* The country. Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMGeoPositionAddress.prototype.country="";
/**
* Removed in Firefox 11, since it isn't defined in the specification; use country instead.
*
* @type {String}
*/
Components.interfaces.nsIDOMGeoPositionAddress.prototype.countryCode="";
/**
* The county. Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMGeoPositionAddress.prototype.county="";
/**
* The postal or ZIP code. Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMGeoPositionAddress.prototype.postalCode="";
/**
* The premises. Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMGeoPositionAddress.prototype.premises="";
/**
* The region. Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMGeoPositionAddress.prototype.region="";
/**
* The street of the address. Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMGeoPositionAddress.prototype.street="";
/**
* The street number of the address. Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMGeoPositionAddress.prototype.streetNumber="";
/**
* Please add a summary to this article.
*
* @constructor
*/
Components.interfaces.nsIDOMGeoPositionCallback=function(){};
/**
* Called when new position information is available.
*
* @param {Components.interfaces.nsIDOMGeoPosition} position in nsIDOMGeoPosition position An nsIDOMGeoPosition object indicating the updated location information.
*/
Components.interfaces.nsIDOMGeoPositionCallback.prototype.handleEvent=function(position){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMGeoPositionCoords=function(){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMGeoPositionError=function(){};
/**
* Numerical error code; see Error constants for a complete list. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMGeoPositionError.prototype.code=0;
/**
* Human readable error message. Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMGeoPositionError.prototype.message="";
/**
* Please add a summary to this article.
*
* @constructor
*/
Components.interfaces.nsIDOMGeoPositionErrorCallback=function(){};
/**
* Called to handle a geolocation error.
*
* @param {Components.interfaces.nsIDOMGeoPosition} position in nsIDOMGeoPosition position The error that occurred, as an nsIDOMGeoPositionError object.
*/
Components.interfaces.nsIDOMGeoPositionErrorCallback.prototype.handleEvent=function(position){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMGeoPositionOptions=function(){};
/**
* An initializer for global properties that lets them know about the window they're being attached to.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMGlobalPropertyInitializer=function(){};
/**
*
*
* @param {Components.interfaces.nsIDOMWindow} window in nsIDOMWindow window The window to which the global property is being attached.
*/
Components.interfaces.nsIDOMGlobalPropertyInitializer.prototype.init=function(window){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsIDOMHTMLMediaElement}
*/
Components.interfaces.nsIDOMHTMLAudioElement=function(){};
/**
* The basis for the nsIDOMHTMLAudioElement and nsIDOMHTMLVideoElement interfaces, which in turn implement the and HTML5 elements.
*
* @constructor
* @inherits {Components.interfaces.nsIDOMHTMLElement}
*/
Components.interfaces.nsIDOMHTMLMediaElement=function(){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsIDOMHTMLElement}
*/
Components.interfaces.nsIDOMHTMLSourceElement=function(){};
/**
* The src attribute gives the address of the media resource. The value must be a valid URL. This attribute must be present. Note that dynamically manipulating this value after the page has loaded has no effect on the containing element; instead, change the src attribute of that element (audio or video) instead.
*
* @type {String}
*/
Components.interfaces.nsIDOMHTMLSourceElement.prototype.src="";
/**
* The type attribute gives the type of the media resource, to help the user agent determine if it can play this media resource before fetching it. If specified, its value must be a valid MIME type. The codecs parameter may be specified and might be necessary to specify exactly how the resource is encoded.
*
* @type {String}
*/
Components.interfaces.nsIDOMHTMLSourceElement.prototype.type="";
/**
* The media attribute gives the intended media type of the media resource, to help the user agent determine if this media resource is useful to the user before fetching it. Its value must be a valid media query.
*
* @type {String}
*/
Components.interfaces.nsIDOMHTMLSourceElement.prototype.media="";
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMHTMLTimeRanges=function(){};
/**
* The number of ranges represented by the nsIDOMHTMLTimeRanges object. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMHTMLTimeRanges.prototype.length=0;
/**
* Returns the time offset to the end of the specified time range.
*
* @param {Number} index in unsigned long index The index to the time range whose end time is to be returned.
*/
Components.interfaces.nsIDOMHTMLTimeRanges.prototype.end=function(index){};
/**
* Returns the time offset to the start of the specified time range.
*
* @param {Number} index in unsigned long index The index to the time range whose start time is to be returned.
*/
Components.interfaces.nsIDOMHTMLTimeRanges.prototype.start=function(index){};
/**
* This interface represents a mouse scroll wheel event.
*
* @constructor
* @inherits {Components.interfaces.nsIDOMMouseEvent}
*/
Components.interfaces.nsIDOMMouseScrollEvent=function(){};
/**
* The horizontal (X) axis.
*
* @constant
*/
Components.interfaces.nsIDOMMouseScrollEvent.prototype.HORIZONTAL_AXIS=1;
/**
* The vertical (Y) axis.
*
* @constant
*/
Components.interfaces.nsIDOMMouseScrollEvent.prototype.VERTICAL_AXIS=2;
/**
* Indicates which mouse wheel axis changed; this will be either HORIZONTAL_AXIS or VERTICAL_AXIS. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMMouseScrollEvent.prototype.axis=0;
/**
* Initializes the progress event object.
*
* @param {String} typeArg in DOMString typeArg, The type of event. Must be one of "abort", "error", "load", "loadstart", or "progress".
* @param {Boolean} canBubbleArg in boolean canBubbleArg, Specifies whether or not the created event will bubble.
* @param {Boolean} cancelableArg in boolean cancelableArg, Specifies whether or not the created event can be canceled.
* @param {Components.interfaces.nsIDOMAbstractView} viewArg in nsIDOMAbstractView viewArg, The nsIDOMAbstractView in which the event occurred.
* @param {Number} detailArg in long detailArg,
* @param {Number} screenXArg in long screenXArg, The X coordinate at which the event occurred, in screen coordinates.
* @param {Number} screenYArg in long screenYArg, The Y coordinate at which the event occurred, in screen coordinates.
* @param {Number} clientXArg in long clientXArg, The X coordinate at which the event occurred, in client coordinates.
* @param {Number} clientYArg in long clientYArg, The Y coordinate at which the event occurred, in client coordinates.
* @param {Boolean} ctrlKeyArg in boolean ctrlKeyArg, true if the control key was down when the event occurred, otherwise false.
* @param {Boolean} altKeyArg in boolean altKeyArg, true if the Alt key was down when the event occurred, otherwise false.
* @param {Boolean} shiftKeyArg in boolean shiftKeyArg, true if the shift key was down when the event occurred, otherwise false.
* @param {Boolean} metaKeyArg in boolean metaKeyArg, true if the meta key was down when the event occurred, otherwise false.
* @param {Number} buttonArg in unsigned short buttonArg, Indicates which mouse button was pressed when the event occurred, if any.
* @param {Components.interfaces.nsIDOMEventTarget} relatedTargetArg in nsIDOMEventTarget relatedTargetArg, The event target related to this event.
* @param {Number} axis in long axis The mouse wheel axis for this event; this is either HORIZONTAL_AXIS or VERTICAL_AXIS.
*/
Components.interfaces.nsIDOMMouseScrollEvent.prototype.initMouseScrollEvent=function(typeArg, canBubbleArg, cancelableArg, viewArg, detailArg, screenXArg, screenYArg, clientXArg, clientYArg, ctrlKeyArg, altKeyArg, shiftKeyArg, metaKeyArg, buttonArg, relatedTargetArg, axis){};
/**
* Interface of the network stats object.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMMozNetworkStats=function(){};
/**
* Connection type of the stats. Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMMozNetworkStats.prototype.connectionType="";
/**
* Stats samples. Read only.
*
* @type {Array}
*/
Components.interfaces.nsIDOMMozNetworkStats.prototype.data=new Array();
/**
* Start date of the stats samples. Read only.
*
* @type {Date}
*/
Components.interfaces.nsIDOMMozNetworkStats.prototype.start=new Date();
/**
* End date of the stats samples. Read only.
*
* @type {Date}
*/
Components.interfaces.nsIDOMMozNetworkStats.prototype.end=new Date();
/**
* Represents a single record in the network statistics database, as reported using the nsIDOMMozNetworkStatsManager interface.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMMozNetworkStatsData=function(){};
/**
* The number of bytes received on the connection. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMMozNetworkStatsData.prototype.rxBytes=0;
/**
* The number of bytes transmitted on the connection. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMMozNetworkStatsData.prototype.txBytes=0;
/**
* The date of the sample. Read only.
*
* @type {Date}
*/
Components.interfaces.nsIDOMMozNetworkStatsData.prototype.date=new Date();
/**
* Interface that provides access to network usage statistics.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMMozNetworkStatsManager=function(){};
/**
* Available connection types. Read only.
*
* @type {Array}
*/
Components.interfaces.nsIDOMMozNetworkStatsManager.prototype.connectionTypes=[];
/**
* Time in seconds between samples stored in database. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMMozNetworkStatsManager.prototype.sampleRate=0;
/**
* Maximum number of samples stored in the database per connection type.
*
* @type {Number}
*/
Components.interfaces.nsIDOMMozNetworkStatsManager.prototype.maxStorageSamples=0;
/**
* Asynchronously queries network interface statistics. The query may be filtered by connection type and date.
*
* @param {Components.interfaces.NetowrkStatsOptions} aOptions in NetowrkStatsOptions aOptions Filtering options.
*/
Components.interfaces.nsIDOMMozNetworkStatsManager.prototype.getNetworkStats=function(aOptions){};
/**
* Clears all statistics from the statistics database.
*
*/
Components.interfaces.nsIDOMMozNetworkStatsManager.prototype.clearAllData=function(){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsIDOMMouseEvent}
*/
Components.interfaces.nsIDOMMozTouchEvent=function(){};
/**
* Initializes the touch event.
*
* @param {String} typeArg in DOMString typeArg, undefined
* @param {Boolean} canBubbleArg in boolean canBubbleArg, undefined
* @param {Boolean} cancelableArg in boolean cancelableArg, undefined
* @param {Components.interfaces.nsIDOMAbstractView} viewArg in nsIDOMAbstractView viewArg, undefined
* @param {Number} detailArg in long detailArg, undefined
* @param {Number} screenXArg in long screenXArg, undefined
* @param {Number} screenYArg in long screenYArg, undefined
* @param {Number} clientXArg in long clientXArg, undefined
* @param {Number} clientYArg in long clientYArg, undefined
* @param {Boolean} ctrlKeyArg in boolean ctrlKeyArg, undefined
* @param {Boolean} altKeyArg in boolean altKeyArg, undefined
* @param {Boolean} shiftKeyArg in boolean shiftKeyArg, undefined
* @param {Boolean} metaKeyArg in boolean metaKeyArg, undefined
* @param {Number} buttonArg in unsigned short buttonArg, undefined
* @param {Components.interfaces.nsIDOMEventTarget} relatedTargetArg in nsIDOMEventTarget relatedTargetArg, undefined
* @param {Number} streamIdArg in unsigned long streamIdArg undefined
*/
Components.interfaces.nsIDOMMozTouchEvent.prototype.initSimpleGestureEvent=function(typeArg, canBubbleArg, cancelableArg, viewArg, detailArg, screenXArg, screenYArg, clientXArg, clientYArg, ctrlKeyArg, altKeyArg, shiftKeyArg, metaKeyArg, buttonArg, relatedTargetArg, streamIdArg){};
/**
* Property that extends the navigator object.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMNavigatorDesktopNotification=function(){};
/**
* Read only.
*
* @type {Components.interfaces.nsIDOMDesktopNotificationCenter}
*/
Components.interfaces.nsIDOMNavigatorDesktopNotification.prototype.mozNotification=new Components.interfaces.nsIDOMDesktopNotificationCenter();
/**
* This interface is the primary datatype for the entire Document Object Model. It represents a single node in the document tree.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMNode=function(){};
/**
* @constant
*/
Components.interfaces.nsIDOMNode.prototype.ELEMENT_NODE=1;
/**
* @constant
*/
Components.interfaces.nsIDOMNode.prototype.ATTRIBUTE_NODE=2;
/**
* @constant
*/
Components.interfaces.nsIDOMNode.prototype.TEXT_NODE=3;
/**
* @constant
*/
Components.interfaces.nsIDOMNode.prototype.CDATA_SECTION_NODE=4;
/**
* @constant
*/
Components.interfaces.nsIDOMNode.prototype.ENTITY_REFERENCE_NODE=5;
/**
* @constant
*/
Components.interfaces.nsIDOMNode.prototype.ENTITY_NODE=6;
/**
* @constant
*/
Components.interfaces.nsIDOMNode.prototype.PROCESSING_INSTRUCTION_NODE=7;
/**
* @constant
*/
Components.interfaces.nsIDOMNode.prototype.COMMENT_NODE=8;
/**
* @constant
*/
Components.interfaces.nsIDOMNode.prototype.DOCUMENT_NODE=9;
/**
* @constant
*/
Components.interfaces.nsIDOMNode.prototype.DOCUMENT_TYPE_NODE=10;
/**
* @constant
*/
Components.interfaces.nsIDOMNode.prototype.DOCUMENT_FRAGMENT_NODE=11;
/**
* @constant
*/
Components.interfaces.nsIDOMNode.prototype.NOTATION_NODE=12;
/**
* Read only.
*
* @type {Components.interfaces.nsIDOMNamedNodeMap}
*/
Components.interfaces.nsIDOMNode.prototype.attributes=new Components.interfaces.nsIDOMNamedNodeMap();
/**
* Read only.
*
* @type {Components.interfaces.nsIDOMNodeList}
*/
Components.interfaces.nsIDOMNode.prototype.childNodes=new Components.interfaces.nsIDOMNodeList();
/**
* Read only.
*
* @type {Components.interfaces.nsIDOMNode}
*/
Components.interfaces.nsIDOMNode.prototype.firstChild=new Components.interfaces.nsIDOMNode();
/**
* Read only.
*
* @type {Components.interfaces.nsIDOMNode}
*/
Components.interfaces.nsIDOMNode.prototype.lastChild=new Components.interfaces.nsIDOMNode();
/**
* Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMNode.prototype.localName="";
/**
* Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMNode.prototype.namespaceURI="";
/**
* Read only.
*
* @type {Components.interfaces.nsIDOMNode}
*/
Components.interfaces.nsIDOMNode.prototype.nextSibling=new Components.interfaces.nsIDOMNode();
/**
* Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMNode.prototype.nodeName="";
/**
* Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMNode.prototype.nodeType=0;
/**
*
*
* @type {String}
*/
Components.interfaces.nsIDOMNode.prototype.nodeValue="";
/**
* Read only.
*
* @type {Components.interfaces.nsIDOMDocument}
*/
Components.interfaces.nsIDOMNode.prototype.ownerDocument=new Components.interfaces.nsIDOMDocument();
/**
* Read only.
*
* @type {Components.interfaces.nsIDOMNode}
*/
Components.interfaces.nsIDOMNode.prototype.parentNode=new Components.interfaces.nsIDOMNode();
/**
*
*
* @type {String}
*/
Components.interfaces.nsIDOMNode.prototype.prefix="";
/**
* Read only.
*
* @type {Components.interfaces.nsIDOMNode}
*/
Components.interfaces.nsIDOMNode.prototype.previousSibling=new Components.interfaces.nsIDOMNode();
/**
*
*
* @param {Components.interfaces.nsIDOMNode} newChild in nsIDOMNode newChild
*/
Components.interfaces.nsIDOMNode.prototype.appendChild=function(newChild){};
/**
*
*
* @param {Boolean} deep in boolean deep
*/
Components.interfaces.nsIDOMNode.prototype.cloneNode=function(deep){};
/**
*
*
*/
Components.interfaces.nsIDOMNode.prototype.hasAttributes=function(){};
/**
*
*
*/
Components.interfaces.nsIDOMNode.prototype.hasChildNodes=function(){};
/**
*
*
* @param {Components.interfaces.nsIDOMNode} newChild in nsIDOMNode newChild,
* @param {Components.interfaces.nsIDOMNode} refChild in nsIDOMNode refChild
*/
Components.interfaces.nsIDOMNode.prototype.insertBefore=function(newChild, refChild){};
/**
*
*
* @param {String} feature in DOMString feature,
* @param {String} version in DOMString version
*/
Components.interfaces.nsIDOMNode.prototype.isSupported=function(feature, version){};
/**
*
*
*/
Components.interfaces.nsIDOMNode.prototype.normalize=function(){};
/**
*
*
* @param {Components.interfaces.nsIDOMNode} oldChild in nsIDOMNode oldChild
*/
Components.interfaces.nsIDOMNode.prototype.removeChild=function(oldChild){};
/**
*
*
* @param {Components.interfaces.nsIDOMNode} newChild in nsIDOMNode newChild,
* @param {Components.interfaces.nsIDOMNode} oldChild in nsIDOMNode oldChild
*/
Components.interfaces.nsIDOMNode.prototype.replaceChild=function(newChild, oldChild){};
/**
* Please add a summary to this article.
*
* @constructor
* @inherits {Components.interfaces.nsIDOMEvent}
*/
Components.interfaces.nsIDOMOrientationEvent=function(){};
/**
* The amount of tilt along the X axis. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMOrientationEvent.prototype.x=0;
/**
* The amount of tilt along the Y axis. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMOrientationEvent.prototype.y=0;
/**
* The amount of tilt along the Z axis. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMOrientationEvent.prototype.z=0;
/**
* Initializes the orientation event object.
*
* @param {String} eventTypeArg in DOMString eventTypeArg, The type of event. Must be "MozOrientation".
* @param {Boolean} canBubbleArg in boolean canBubbleArg, Specifies whether or not the created event will bubble.
* @param {Boolean} cancelableArg in boolean cancelableArg, Specifies whether or not the created event can be canceled.
* @param {Number} x in double x, The amount of tilt along the X axis.
* @param {Number} y in double y, The amount of tilt along the Y axis.
* @param {Number} z in double z The amount of tilt along the Z axis.
*/
Components.interfaces.nsIDOMOrientationEvent.prototype.initProgressEvent=function(eventTypeArg, canBubbleArg, cancelableArg, x, y, z){};
/**
* This interface represents the events sent with progress information while uploading data using the XMLHttpRequest object.
*
* @constructor
* @inherits {Components.interfaces.nsIDOMEvent}
*/
Components.interfaces.nsIDOMProgressEvent=function(){};
/**
* Specifies whether or not the total size of the transfer is known. Read only.
*
* @type {Boolean}
*/
Components.interfaces.nsIDOMProgressEvent.prototype.lengthComputable=false;
/**
* The number of bytes transferred since the beginning of the operation. This doesn't include headers and other overhead, but only the content itself. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMProgressEvent.prototype.loaded=0;
/**
* The total number of bytes of content that will be transferred during the operation. If the total size is unknown, this value is zero. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMProgressEvent.prototype.total=0;
/**
* This method has been removed from use in JavaScript in Gecko 22.0. Use the regular constructor to construct a synthetic ProgressEvent.
* It still is usable from native C++ code.
* Initializes the progress event object.
*
* @param {String} typeArg in DOMString typeArg, The type of event. Must be one of "abort", "error", "load", "loadstart", or "progress".
* @param {Boolean} canBubbleArg in boolean canBubbleArg, Specifies whether or not the created event will bubble.
* @param {Boolean} cancelableArg in boolean cancelableArg, Specifies whether or not the created event can be canceled.
* @param {Boolean} lengthComputableArg in boolean lengthComputableArg, If the size of the data to be transferred is known, this should be true. Otherwise, specify false.
* @param {Number} loadedArg in unsigned long long loadedArg, The number of bytes already transferred. Must be a non-negative value.
* @param {Number} totalArg in unsigned long long totalArg The total number of bytes to be transferred. If lengthComputable is false, this must be zero.
*/
Components.interfaces.nsIDOMProgressEvent.prototype.initProgressEvent=function(typeArg, canBubbleArg, cancelableArg, lengthComputableArg, loadedArg, totalArg){};
/**
* This interface is really a placeholder till the W3C DOM Working Group defines a mechanism for serializing DOM nodes. An instance of this interface can be used to serialize a DOM document or any DOM subtree.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMSerializer=function(){};
/**
* The subtree rooted by the specified element is serialized to a byte stream using the character set specified.
*
* @param {Components.interfaces.nsIDOMNode} root in nsIDOMNode root, The root of the subtree to be serialized. This could be any node, including a Document.
* @param {Components.interfaces.nsIOutputStream} stream in nsIOutputStream stream, The byte stream to which the subtree is serialized.
* @param {String} charset in AUTF8String charset The name of the character set to use for the encoding to a byte stream. If this string is empty and root is a document, the document's character set will be used.
*/
Components.interfaces.nsIDOMSerializer.prototype.serializeToStream=function(root, stream, charset){};
/**
* The subtree rooted by the specified element is serialized to a string.
*
* @param {Components.interfaces.nsIDOMNode} root in nsIDOMNode root The root of the subtree to be serialized. This could be any node, including a Document.
*/
Components.interfaces.nsIDOMSerializer.prototype.serializeToString=function(root){};
/**
* This interface describes a mouse or trackpad gesture event.
*
* @constructor
* @inherits {Components.interfaces.nsIDOMMouseEvent}
*/
Components.interfaces.nsIDOMSimpleGestureEvent=function(){};
/**
* Upward swipe.
*
* @constant
*/
Components.interfaces.nsIDOMSimpleGestureEvent.prototype.DIRECTION_UP=1;
/**
* Downward swipe.
*
* @constant
*/
Components.interfaces.nsIDOMSimpleGestureEvent.prototype.DIRECTION_DOWN=2;
/**
* Leftward swipe.
*
* @constant
*/
Components.interfaces.nsIDOMSimpleGestureEvent.prototype.DIRECTION_LEFT=4;
/**
* Rightward swipe.
*
* @constant
*/
Components.interfaces.nsIDOMSimpleGestureEvent.prototype.DIRECTION_RIGHT=8;
/**
* Counter-clockwise rotation.
*
* @constant
*/
Components.interfaces.nsIDOMSimpleGestureEvent.prototype.ROTATION_COUNTERCLOCKWISE=1;
/**
* Clockwise rotation.
*
* @constant
*/
Components.interfaces.nsIDOMSimpleGestureEvent.prototype.ROTATION_CLOCKWISE=2;
/**
* The delta value indicating how far the gesture moved. For update events, this indicates the movement since the previous update; for the MozRotateGesture and MozMagnifyGesture events, this indicates the total movement that occurred while the event was being processed. The value is specified in degrees for rotation events (where positive values indicate clockwise rotation and negative values indicate counter-clockwise rotation). For magnify gestures, the units are implementation-specific; however, positive values indicate zooming in, and negative values indicate zooming out. Read only. Note: On Mac OS X, the units used for magnification gestures by the underlying operating system API are not documented at this time; typical values appear to be in the range 0.0 to 100.0, but currently you can only rely on the value being either positive or negative. On Windows, the units indicate the difference between the previous and current width between the two touch points, in pixels.
*
* @type {Number}
*/
Components.interfaces.nsIDOMSimpleGestureEvent.prototype.delta=0;
/**
* The direction in which the gesture moved. See Direction constants and Rotation constants on this page. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMSimpleGestureEvent.prototype.direction=0;
/**
* Initializes the gesture event.
*
* @param {String} typeArg in DOMString typeArg,
* @param {Boolean} canBubbleArg in boolean canBubbleArg,
* @param {Boolean} cancelableArg in boolean cancelableArg,
* @param {Components.interfaces.nsIDOMAbstractView} viewArg in nsIDOMAbstractView viewArg,
* @param {Number} detailArg in long detailArg,
* @param {Number} screenXArg in long screenXArg,
* @param {Number} screenYArg in long screenYArg,
* @param {Number} clientXArg in long clientXArg,
* @param {Number} clientYArg in long clientYArg,
* @param {Boolean} ctrlKeyArg in boolean ctrlKeyArg,
* @param {Boolean} altKeyArg in boolean altKeyArg,
* @param {Boolean} shiftKeyArg in boolean shiftKeyArg,
* @param {Boolean} metaKeyArg in boolean metaKeyArg,
* @param {Number} buttonArg in unsigned short buttonArg,
* @param {Components.interfaces.nsIDOMEventTarget} relatedTargetArg in nsIDOMEventTarget relatedTargetArg,
* @param {Number} directionArg in unsigned long directionArg, The value to assign to the direction attribute.
* @param {Number} deltaArg in double deltaArg The value to assign to the delta attribute.
*/
Components.interfaces.nsIDOMSimpleGestureEvent.prototype.initSimpleGestureEvent=function(typeArg, canBubbleArg, cancelableArg, viewArg, detailArg, screenXArg, screenYArg, clientXArg, clientYArg, ctrlKeyArg, altKeyArg, shiftKeyArg, metaKeyArg, buttonArg, relatedTargetArg, directionArg, deltaArg){};
/**
* This interface represents the storage space used for session storage in the DOM. Items stored in session storage may be accessed by any interested party in the same browsing context.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMStorage=function(){};
/**
* The number of keys stored in the session store. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMStorage.prototype.length=0;
/**
* Returns from session storage the data corresponding to the specified key.
*
* @param {String} key in DOMString key The key for which data should be returned.
*/
Components.interfaces.nsIDOMStorage.prototype.getItem=function(key){};
/**
* Returns the key for the item stored at the specified index in the data store.
*
* @param {Number} index in unsigned long index The index for which the corresponding key should be returned.
*/
Components.interfaces.nsIDOMStorage.prototype.key=function(index){};
/**
* Given a key, removes the corresponding entry from the session store.
*
* @param {String} key in DOMString key The key for which data should be removed from storage.
*/
Components.interfaces.nsIDOMStorage.prototype.removeItem=function(key){};
/**
* Sets the value corresponding to a given key. If the key does not already exist, a new key is added, associated with the specified value. If the key already exists, the existing value is replaced with the specified value.
*
* @param {String} key in DOMString key, The key for which data should be set.
* @param {String} data in DOMString data The data to associate with the specified key.
*/
Components.interfaces.nsIDOMStorage.prototype.setItem=function(key, data){};
/**
* This interface represents an event that occurs to notify interested parties about changes to the contents of a DOM storage space; it is used for both session storage and local storage.
*
* @constructor
* @inherits {Components.interfaces.nsIDOMEvent}
*/
Components.interfaces.nsIDOMStorageEventObsolete=function(){};
/**
* The domain of the storage area which changed, or "#session" if the event represents a change to session storage. Read only.
*
* @type {String}
*/
Components.interfaces.nsIDOMStorageEventObsolete.prototype.domain="";
/**
* Initializes a storage event.
*
* @param {String} typeArg in DOMString typeArg, The type argument.
* @param {Boolean} canBubbleArg in boolean canBubbleArg, true if the event is allowed to bubble, otherwise false.
* @param {Boolean} cancelableArg in boolean cancelableArg, true if the event can be canceled, otherwise false.
* @param {String} domainArg in DOMString domainArg The domain to which the event belongs, or "#session" if the event is associated with session storage.
*/
Components.interfaces.nsIDOMStorageEventObsolete.prototype.initStorageEvent=function(typeArg, canBubbleArg, cancelableArg, domainArg){};
/**
* This interface represents an object in DOM storage. This is for session storage.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMStorageItem=function(){};
/**
* If true, the item was stored for an HTTPS page. Note: All items, regardless of whether they were stored for an HTTP page or an HTTPS page, are visible from HTTPS pages. However, HTTP pages can only see items stored from HTTP pages, and will not see items stored from HTTPS pages. As such, this attribute is irrelevant for storage that is bound to an origin.
*
* @type {Boolean}
*/
Components.interfaces.nsIDOMStorageItem.prototype.secure=false;
/**
* The value associated with the item.
*
* @type {String}
*/
Components.interfaces.nsIDOMStorageItem.prototype.value="";
/**
* This interface is used to access the contextual storage areas used by globalStorage by domain.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMStorageList=function(){};
/**
* Called when the list of available access points changes.
*
* @param {String} domain in DOMString domain The name of the domain for whom to return the storage object.
*/
Components.interfaces.nsIDOMStorageList.prototype.namedItem=function(domain){};
/**
* This interface provides methods for managing data stored in the offline apps cache.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMStorageManager=function(){};
/**
* Clears keys owned by offline applications. All data owned by a domain with the "offline-app" permission is removed from the database.
*
*/
Components.interfaces.nsIDOMStorageManager.prototype.clearOfflineApps=function(){};
/**
* Returns the amount of disk space used by a domain. Usage is checked against the domain of the page that set the key (the owner domain), not the domain of the storage object.
*
* @param {String} aOwnerDomain AString aOwnerDomain The domain to check.
*/
Components.interfaces.nsIDOMStorageManager.prototype.getUsage=function(aOwnerDomain){};
/**
* This interface provides access to a DOM window's client side storage objects. All DOM windows inherit from this interface.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMStorageWindow=function(){};
/**
* Global storage, accessible by domain. Read only.
*
* @type {Components.interfaces.nsIDOMStorageList}
*/
Components.interfaces.nsIDOMStorageWindow.prototype.globalStorage=new Components.interfaces.nsIDOMStorageList();
/**
* Local storage for the current browsing context. Data stored in local storage may only be accessed from the same origin that inserted the data into storage in the first place. Read only.
*
* @type {Components.interfaces.nsIDOMStorage}
*/
Components.interfaces.nsIDOMStorageWindow.prototype.localStorage=new Components.interfaces.nsIDOMStorage();
/**
* Indexed Databases for the current browsing context. Read only.
*
* @type {Components.interfaces.nsIIDBFactory}
*/
Components.interfaces.nsIDOMStorageWindow.prototype.moz_indexedDB=new Components.interfaces.nsIIDBFactory();
/**
* Session storage for the current browsing context. Data stored in session storage may be accessed by any site in the browsing context. Read only.
*
* @type {Components.interfaces.nsIDOMStorage}
*/
Components.interfaces.nsIDOMStorageWindow.prototype.sessionStorage=new Components.interfaces.nsIDOMStorage();
/**
* The callback function for the setUserData method.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMUserDataHandler=function(){};
/**
* The node was cloned.
*
* @constant
*/
Components.interfaces.nsIDOMUserDataHandler.prototype.NODE_CLONED=1;
/**
* The node was cloned into a new document.
*
* @constant
*/
Components.interfaces.nsIDOMUserDataHandler.prototype.NODE_IMPORTED=2;
/**
* Unimplemented
*
* @constant
*/
Components.interfaces.nsIDOMUserDataHandler.prototype.NODE_DELETED=3;
/**
* Unimplemented
*
* @constant
*/
Components.interfaces.nsIDOMUserDataHandler.prototype.NODE_RENAMED=4;
/**
* The node was adopted into a new document.
*
* @constant
*/
Components.interfaces.nsIDOMUserDataHandler.prototype.NODE_ADOPTED=5;
/**
* This method is a callback which will be called if a node with user data is being cloned, imported or adopted.
*
* @param {Number} operation in unsigned short operation, One of the NODE_* operation type constants from the above table.
* @param {String} key in DOMString key, The key that was used to set the user data.
* @param {Components.interfaces.nsIVariant} data in nsIVariant data, The data that was set on the original node.
* @param {Components.interfaces.nsIDOMNode} src in nsIDOMNode src, The original node.
* @param {Components.interfaces.nsIDOMNode} dst in nsIDOMNode dst The new node, for clone and import operations.
*/
Components.interfaces.nsIDOMUserDataHandler.prototype.handle=function(operation, key, data, src, dst){};
/**
* This interface is the primary interface for a window object. It represents a single window object that may contain child windows if the document in the window contains an HTML frameset document, or if the document contains iframe elements.
*
* @constructor
* @inherits {Components.interfaces.nsISupports}
*/
Components.interfaces.nsIDOMWindow=function(){};
/**
* Get the application cache object for this window. Read only. Note: Prior to Gecko 7.0 this attribute was part of nsIDOMWindow2.
*
* @type {Components.interfaces.nsIDOMOfflineResourceList}
*/
Components.interfaces.nsIDOMWindow.prototype.applicationCache=new Components.interfaces.nsIDOMOfflineResourceList();
/**
* The document contained in the window. Read only.
*
* @type {Components.interfaces.nsIDOMDocument}
*/
Components.interfaces.nsIDOMWindow.prototype.document=new Components.interfaces.nsIDOMDocument();
/**
* The child windows for this window. Read only. Native code only!
*
* @type {Components.interfaces.nsIDOMWindowCollection}
*/
Components.interfaces.nsIDOMWindow.prototype.frames=new Components.interfaces.nsIDOMWindowCollection();
/**
* Global storage, accessible by domain. Read only. Note: Prior to Gecko 8.0 this attribute was part of nsIDOMStorageWindow.
*
* @type {Components.interfaces.nsIDOMStorageList}
*/
Components.interfaces.nsIDOMWindow.prototype.globalStorage=new Components.interfaces.nsIDOMStorageList();
/**
* Local storage for the current browsing context. Data stored in local storage may only be accessed from the same origin that inserted the data into storage in the first place. Read only. Note: Prior to Gecko 8.0 this attribute was part of nsIDOMStorageWindow.
*
* @type {Components.interfaces.nsIDOMStorage}
*/
Components.interfaces.nsIDOMWindow.prototype.localStorage=new Components.interfaces.nsIDOMStorage();
/**
* Get or set the name of this window. This attribute is "replaceable" in JavaScript.
*
* @type {String}
*/
Components.interfaces.nsIDOMWindow.prototype.name="";
/**
* The window's parent window. If there is no parent window, or if the parent is of a different type, this is the current window. The window hierarchy does not cross chrome-content boundaries. Read only.
*
* @type {Components.interfaces.nsIDOMWindow}
*/
Components.interfaces.nsIDOMWindow.prototype.parent=new Components.interfaces.nsIDOMWindow();
/**
* The current horizontal (x) scroll position, in pixels. This attribute is "replaceable" in JavaScript. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMWindow.prototype.scrollX=0;
/**
* The current vertical (y) scroll position, in pixels. This attribute is "replaceable" in JavaScript. Read only.
*
* @type {Number}
*/
Components.interfaces.nsIDOMWindow.prototype.scrollY=0;
/**
* The object that controls whether or not scrollbars are shown in the window. This attribute is "replaceable" in JavaScript. Read only.
*
* @type {Components.interfaces.nsIDOMBarProp}
*/
Components.interfaces.nsIDOMWindow.prototype.scrollbars=new Components.interfaces.nsIDOMBarProp();
/**
* Session storage for the current browsing context. Data stored in session storage may be accessed by any site in the browsing context. Read only.Note: Prior to Gecko 8.0 this attribute was part of nsIDOMStorageWindow.
*
* @type {Components.interfaces.nsIDOMStorage}
*/
Components.interfaces.nsIDOMWindow.prototype.sessionStorage=new Components.interfaces.nsIDOMStorage();
/**
* Get or set the document scale factor as a multiplier of the default size. When setting this attribute, an NS_ERROR_NOT_IMPLEMENTED error may be returned by implementations not supporting zoom. This attribute should always return 1.0 for implementations not supporting text zoom. 1.0 represents normal (unzoomed) size. Native code only!
*
* @type {Number}
*/
Components.interfaces.nsIDOMWindow.prototype.textZoom=0;
/**
* The root window for the hierarchy of windows that contain this nsIDOMWindow. This is the window itself if there is no parent, or if the parent is of a different type. The window hierarchy does not cross chrome-content boundaries. This attribute is "replaceable" in JavaScript. Read only.
*
* @type {Components.interfaces.nsIDOMWindow}
*/
Components.interfaces.nsIDOMWindow.prototype.top=new Components.interfaces.nsIDOMWindow();
/**
* The window root for this window. This is useful for connecting event listeners to this window as well as every other window nested in that window root. Read only. Native code only! Note: Prior to Gecko 7.0 this attribute was part of nsIDOMWindow2.
*
* @type {Components.interfaces.nsIDOMEventTarget}
*/
Components.interfaces.nsIDOMWindow.prototype.windowRoot=new Components.interfaces.nsIDOMEventTarget();
/**
* Returns the nsISelection object indicating what if any content is currently selected in the window.
*
*/
Components.interfaces.nsIDOMWindow.prototype.getSelection=function(){};
/**
* Scrolls the window by a given number of pixels relative to the current scroll position.
*
* @param {Number} xScrollDif in long xScrollDif, The number of pixels by which to scroll horizontally.
* @param {Number} yScrollDif in long yScrollDif The number of pixels by which to scroll vertically.
*/
Components.interfaces.nsIDOMWindow.prototype.scrollBy=function(xScrollDif, yScrollDif){};
/**
* Scrolls the window by the specified number of lines.
*
* @param {Number} numLines in long numLines The number of lines by which to scroll.
*/
Components.interfaces.nsIDOMWindow.prototype.scrollByLines=function(numLines){};
/**
* Scrolls the window by the specified number of pages.
*
* @param {Number} numPages in long numPages The number of pages by which to scroll.
*/
Components.interfaces.nsIDOMWindow.prototype.scrollByPages=function(numPages){};
/**
* Scrolls the window to an absolute pixel offset.
*
* @param {Number} xScroll in long xScroll, The horizontal position to which to scroll, in pixels.
* @param {Number} yScroll in long yScroll The vertical position to which to scroll, in pixels.
*/
Components.interfaces.nsIDOMWindow.prototype.scrollTo=function(xScroll, yScroll){};
/**
* Makes the window's size fit the contents of the window.
*
*/
Components.interfaces.nsIDOMWindow.prototype.sizeToContent=function(){};
/**
* This interface is the primary interface for a DOM window object. It represents a single window object that may contain child windows if the document in the window contains an HTML frameset document, or if the document contains