Search completed in 2.42 seconds.
RTCPeerConnection.setRemoteDescription() - Web APIs
the rtcpeerconnection method setremote
description() sets the specified session
description as the remote peer's current offer or answer.
... the
description specifies the properties of the remote end of the connection, including the media format.
... the method takes a single parameter—the session
description—and it returns a promise which is fulfilled once the
description has been changed, asynchronously.
...And 26 more matches
RTCPeerConnection.setLocalDescription() - Web APIs
the rtcpeerconnection method setlocal
description() changes the local
description associated with the connection.
... this
description specifies the properties of the local end of the connection, including the media format.
... the method takes a single parameter—the session
description—and it returns a promise which is fulfilled once the
description has been changed, asynchronously.
...And 23 more matches
RTCSessionDescription - Web APIs
the rtcsession
description interface describes one end of a connection—or potential connection—and how it's configured.
... each rtcsession
description consists of a
description type indicating which part of the offer/answer negotiation process it describes and of the sdp descriptor of the session.
... the process of negotiating a connection between two peers involves exchanging rtcsession
description objects back and forth, with each
description suggesting one combination of connection configuration options that the sender of the
description supports.
...And 15 more matches
RTCSessionDescription() - Web APIs
the rtcsession
description() constructor creates a new rtcsession
description with its properties initialized as described in the specified object.
... this constructor has been deprecated because rtcpeerconnection.setlocal
description() and other methods which take sdp as input now directly accept an object conforming to the rtcsession
descriptioninit dictionary, so you don't have to instantiate an rtcsession
description yourself.
... syntax session
description = new rtcsession
description(rtcsession
descriptioninit); values rtcsession
descriptioninit optional an object providing the default values for the session
description; the object conforms to the rtcsession
descriptioninit dictionary.
...And 11 more matches
OpenSearch description format
the opensearch
description format lets a website describe a search engine for itself, so that a browser or other client application can use that search engine.
... opensearch
description files can be advertised as described in autodiscovery of search plugins, and can be installed programmatically as described in adding search engines from web pages.
... opensearch
description file the xml file that describes a search engine follows the basic template below.
...And 8 more matches
Label and description - Archive of obsolete content
line breaking under normal conditions, a
description will not break long-running text and the text may be cropped or hidden.
... to cause the text to wrap: ensure the long-running text is a text node child of <
description/> or <label/> (i.e., do not specify the long-running text in the value attribute of these elements).
... <
description>i am your father's brother's nephew's cousin's former roommate.
...And 6 more matches
<dl>: The Description List element - HTML: Hypertext Markup Language
the html <dl> element represents a
description list.
... the element encloses a list of groups of terms (specified using the <dt> element) and
descriptions (provided by <dd> elements).
... examples single term and
description <dl> <dt>firefox</dt> <dd> a free, open source, cross-platform, graphical web browser developed by the mozilla corporation and hundreds of volunteers.
...And 6 more matches
Localizing extension descriptions
this article provides details on how to go about localizing the
descriptions of mozilla add-ons, as well as for other metadata about your add-on.
... localizing in gecko 1.9 gecko 1.9 includes a new, more robust method for localizing add-on
descriptions and other metadata.
... all of the different
descriptions now appear in the install.rdf file using em:localized properties.
...And 5 more matches
RTCPeerConnection.currentLocalDescription - Web APIs
the read-only property rtcpeerconnection.currentlocal
description returns an rtcsession
description object describing the local end of the connection as it was most recently successfully negotiated since the last time the rtcpeerconnection finished negotiating and connecting to a remote peer.
... also included is a list of any ice candidates that may already have been generated by the ice agent since the offer or answer represented by the
description was first instantiated.
... to change the currentlocal
description, call rtcpeerconnection.setlocal
description(), which triggers a series of events which leads to this value being set.
...And 5 more matches
RTCPeerConnection.currentRemoteDescription - Web APIs
the read-only property rtcpeerconnection.currentremote
description returns an rtcsession
description object describing the remote end of the connection as it was most recently successfully negotiated since the last time the rtcpeerconnection finished negotiating and connecting to a remote peer.
... also included is a list of any ice candidates that may already have been generated by the ice agent since the offer or answer represented by the
description was first instantiated.
... to change the currentremote
description, call rtcpeerconnection.setremote
description(), which triggers a series of events which leads to this value being set.
...And 5 more matches
Error.description - Archive of obsolete content
the error.
description property returns or sets the descriptive string associated with a specific error.
... syntax object .
description [= stringexpression] parameters object required.
...a string expression containing a
description of the error.
...And 4 more matches
RTCPeerConnection.pendingLocalDescription - Web APIs
the read-only property rtcpeerconnection.pendinglocal
description returns an rtcsession
description object describing a pending configuration change for the local end of the connection.
...use rtcpeerconnection.currentlocal
description or rtcpeerconnection.local
description to get the current state of the endpoint.
... for details on the difference, see pending and current
descriptions in webrtc connectivity.
...And 4 more matches
RTCPeerConnection.pendingRemoteDescription - Web APIs
the read-only property rtcpeerconnection.pendingremote
description returns an rtcsession
description object describing a pending configuration change for the remote end of the connection.
...use rtcpeerconnection.currentremote
description or rtcpeerconnection.remote
description to get the current session
description for the remote endpoint.
... for details on the difference, see pending and current
descriptions in webrtc connectivity.
...And 4 more matches
RTCSessionDescription.type - Web APIs
the property rtcsession
description.type is a read-only value of type rtcsdptype which describes the
description's type.
... syntax var value = session
description.type; session
description.type = value; value the possible values are defined by an enum of type rtcsdptype.
... the allowed values are those of an enum of type rtcsdptype: "offer", the
description is the initial proposal in an offer/answer exchange.
...And 4 more matches
NP_GetMIMEDescription - Archive of obsolete content
np_getmime
description returns a supported mime type list for your plugin.
... each mime type
description should be separated by a semicolon (;).
... each mime type
description contains the mime type, an extensions list and a short
description.
...And 3 more matches
RTCPeerConnection.remoteDescription - Web APIs
the read-only property rtcpeerconnection.remote
description returns a rtcsession
description describing the session (which includes configuration and media information) for the remote end of the connection.
... the returned value typically reflects a remote
description which has been received over the signaling server (as either an offer or an answer) and then put into effect by your code calling rtcpeerconnection.setremote
description() in response.
... syntax var session
description = peerconnection.remote
description; on a more fundamental level, the returned value is the value of rtcpeerconnection.pendingremote
description if that property isn't null; otherwise, the value of rtcpeerconnection.currentremote
description is returned.
...And 3 more matches
RTCPeerConnection.localDescription - Web APIs
the read-only property rtcpeerconnection.local
description returns an rtcsession
description describing the session for the local end of the connection.
... syntax var session
description = peerconnection.local
description; on a more fundamental level, the returned value is the value of rtcpeerconnection.pendinglocal
description if that property isn't null; otherwise, the value of rtcpeerconnection.currentlocal
description is returned.
... see pending and current
descriptions in webrtc connectivity for details on this algorithm and why it's used.
...And 2 more matches
description - Archive of obsolete content
the text can be set either with the value attribute or by placing text inside the open and close
description tags.
...if text appears as a child of the
description, it will wrap to multiple lines.
... attributes crop, disabled, tabindex value properties accessibletype, crop, disabled, tabindex, value style classes header, indent, monospace, plain, small-margin examples this is a long section of text that will word wrap when displayed <
description> this is a long section of text that will word wrap when displayed.
... </
description> this is a long section of text that will not word wrap <
description value="this is a long section of text that will not word wrap"> </
description> this is a long section of dynamically controlled text that will word wrap <
description id="desc" style="width: 300px"></
description> document.getelementbyid('desc').textcontent = "this is a long section of dynamic message text that will word wrap"; attributes crop type: one of the values below if the label of the element is too big to fit in its given space, the text will be cropped on the side specified by the crop attribute.
RTCSessionDescription.toJSON() - Web APIs
the rtcsession
description.tojson() method generates a json
description of the object.
... syntax var jsonvalue = sd.tojson(); the result value is a json object containing the following values: "type", containing the value of the rtcsession
description.type property and can be one of the following values: "offer", "answer", "pranswer" or null.
... "sdp", containing a domstring, or null, with the sdp message corresponding to rtcsession
description.sdp property.
... specifications specification status comment webrtc 1.0: real-time communication between browsersthe definition of 'rtcsession
description: tojson()' in that specification.
RTCSessionDescriptionCallback - Web APIs
the rtcsession
descriptioncallback type is used to represent the callback function passed into the deprecated callback-based version of createoffer() or createanswer() when using them to create offers or answers.
... syntax rtcsession
descriptioncallback(
description); parameters
description an rtcsession
descriptioninit (or rtcsession
description) object describing the session being offered or being accepted.
... this object contains the type and sdp properties which are part of rtcsession
description.
... example var pc = new rtcpeerconnection(); var
descriptioncallback = function(offer) { pc.setlocal
description(offer); } pc.createoffer(
descriptioncallback); specifications specification status comment webrtc 1.0: real-time communication between browsersthe definition of 'rtcsession
descriptioncallback' in that specification.
Symbol.prototype.description - JavaScript
the read-only
description property is a string returning the optional
description of symbol objects.
...
description symbol objects can be created with an optional
description which can be used for debugging but not to access the symbol itself.
... the symbol.prototype.
description property can be used to read that
description.
... examples using
description symbol('desc').tostring(); // "symbol(desc)" symbol('desc').
description; // "desc" symbol('').
description; // "" symbol().
description; // undefined // well-known symbols symbol.iterator.tostring(); // "symbol(symbol.iterator)" symbol.iterator.
description; // "symbol.iterator" // global symbols symbol.for('foo').tostring(); // "symbol(foo)" symbol.for('foo').
description; // "foo" specifications specification ecmascript (ecma-262)the definition of 'get symbol.prototype.
description' in that specification.
GetActionDescription
« nsiaccessible page summary this method retrieves the
description (localized name) of the accessible action at the given zero-based index.
... astring getaction
description( in pruint8 aindex ); parameters aindex[in] the zero-based index.
... return value returns the
description of the accessible action.
description - Web app manifests
type string mandatory no the
description member is a string in which developers can explain what the application does.
...
description is directionality-capable, which means it can be displayed left to right or right to left based on the values of the dir and lang manifest members.
... examples simple
description in left-to-right language: "
description": "awesome application that will help you achieve your dreams."
description in arabic, which will be displayed right-to-left: "dir": "rtl", "lang": "ar", "
description": ".تطبيق رائع سيساعدك على تحقيق أحلامك" specification specification status comment feedback web app manifestthe definition of '
description' in that specification.
Description
« nsiaccessible page summary accessible
description -- long text associated with this node.
... attribute astring
description; ...
PerformanceServerTiming.description - Web APIs
the
description read-only property returns a domstring value of the server-specified metric
description, or an empty string.
... syntax servertiming.
description; specifications specification status comment server timingthe definition of '
description' in that specification.
RTCSessionDescription.sdp - Web APIs
the property rtcsession
description.sdp is a read-only domstring containing the sdp which describes the session.
... syntax var value = session
description.sdp; session
description.sdp = value; value the value is a domstring containing an sdp message like this one: v=0 o=alice 2890844526 2890844526 in ip4 host.anywhere.com s= c=in ip4 host.anywhere.com t=0 0 m=audio 49170 rtp/avp 0 a=rtpmap:0 pcmu/8000 m=video 51372 rtp/avp 31 a=rtpmap:31 h261/90000 m=video 53000 rtp/avp 32 a=rtpmap:32 mpv/90000 example // the remote
description has been set previously on pc, an rtcpeerconnection alert(pc.remote
description.sdp); specifications specification status comment webrtc 1.0: real-time communication between browsersthe definition of 'rtcsession
description.sdp' in that specification.
sslfnc.html
description nss_init opens the certn.db, keyn.db, and secmod.db files (wheren is a numeric digit) in the specified directory.
...
description nss_initreadwrite opens the certn.db, keyn.db, and secmod.db files (wheren is a numeric digit) with both read and write permission in the specified directory.
...
description nss_nodb_init opens only the temporary database and the internal pkcs #112 module.
...And 55 more matches
WebGL constants - Web APIs
constant name value
description depth_buffer_bit 0x00000100 passed to clear to clear the current depth buffer.
... constant name value
description points 0x0000 passed to drawelements or drawarrays to draw single points.
... constant name value
description zero 0 passed to blendfunc or blendfuncseparate to turn off a component.
...And 44 more matches
nsIXPConnect
tholder wrapnative(in jscontextptr ajscontext, in jsobjectptr ascope, in nsisupports acomobj, in nsiidref aiid); void wrapnativetojsval(in jscontextptr ajscontext, in jsobjectptr ascope, in nsisupports acomobj, in nswrappercacheptr acache, in nsiidptr aiid, in boolean aallowwrapper, out jsval aval, out nsixpconnectjsobjectholder aholder); attributes attribute type
description collectgarbageonmainthreadonly prbool obsolete since gecko 1.9 currentjsstack nsistackframe read only.
... deferreleasesuntilaftergarbagecollection prbool obsolete since gecko 1.9 pendingexception nsiexception constants constant value
description init_js_standard_classes 1 << 0 flag_system_global_object 1 << 1 omit_components_object 1 << 2 xpc_xow_clearscope 1 tells updatexows() to clear the scope of all of the xows it finds.
... atracer missing
description exceptions thrown missing exception missing
description clearallwrappednativesecuritypolicies() void clearallwrappednativesecuritypolicies(); parameters none.
...And 36 more matches
imgIContainer
e gecko 2.0 void setframehasnoalpha(in unsigned long framenumber); obsolete since gecko 2.0 void setframetimeout(in unsigned long framenumber, in print32 atimeout); obsolete since gecko 2.0 void startanimation(); obsolete since gecko 2.0 void stopanimation(); obsolete since gecko 2.0 void unlockimage(); attributes attribute type
description animated boolean whether this image is animated.
... constants constant value
description type_raster 0 enumerated values for the 'type' attribute (below).
...void addrestoredata( [array, size_is(acount), const] in char data, in unsigned long acount ); parameters data missing
description acount missing
description exceptions thrown missing exception missing
description native code only!appendframe obsolete since gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1)this feature is obsolete.
...And 33 more matches
Index - Web APIs
708 domexception.message api, domexception, property, reference, message the message read-only property of the domexception interface returns a domstring representing a message or
description associated with the given error name.
... 1724 htmlimageelement.longdesc api, dom, html, html dom, htmlimageelement, long
description, obsolete, property, reference,
description, img, longdesc the obsolete property longdesc on the htmlimageelement interface specifies the url of a text or html file which contains a long-form
description of the image.
... 1928 htmltableelement.summary api, html dom, htmltableelement, needsbrowsercompatibility, needsspectable, property, reference the htmltableelement.summary property represents the table
description.
...And 30 more matches
Establishing a connection: The WebRTC perfect negotiation pattern - Web APIs
handling the negotiationneeded event first, we implement the rtcpeerconnection event handler onnegotiationneeded to get a local
description and send it using the signaling channel to the remote peer.
... let makingoffer = false; pc.onnegotiationneeded = async () => { try { makingoffer = true; await pc.setlocal
description(); signaler.send({
description: pc.local
description }); } catch(err) { console.error(err); } finally { makingoffer = false; } }; note that setlocal
description() without arguments automatically creates and sets the appropriate
description based on the current signalingstate.
... the set
description is either an answer to the most recent offer from the remote peer or a freshly-created offer if there's no negotiation underway.
...And 27 more matches
Observer Notifications
topic
description * everything.
... [nsobserverservice.cpp] topic
description xpcom-startup note: an extension can no longer be registered to receive this notification in firefox 4 and later.
... topic
description quit-application-requested something has requested that the application be shutdown.
...And 22 more matches
Key Values - Web APIs
keyboardevent.key value
description virtual keycode windows mac linux android "unidentified" the user agent wasn't able to map the event's virtual keycode to a specific key value.
... keyboardevent.key value
description virtual keycode windows mac linux android "alt" [5] the alt (alternative) key.
... whitespace keys keyboardevent.key value
description virtual keycode windows mac linux android "enter" the enter or ↵ key (sometimes labeled return).
...And 22 more matches
RTCPeerConnection - Web APIs
e read-only rtcpeerconnection property cantrickleicecandidates returns a boolean which indicates whether or not the remote peer can accept trickled ice candidates.connectionstate the read-only connectionstate property of the rtcpeerconnection interface indicates the current state of the peer connection by returning one of the string values specified by the enum rtcpeerconnectionstate.currentlocal
description read only the read-only property rtcpeerconnection.currentlocal
description returns an rtcsession
description object describing the local end of the connection as it was most recently successfully negotiated since the last time the rtcpeerconnection finished negotiating and connecting to a remote peer.
... also included is a list of any ice candidates that may already have been generated by the ice agent since the offer or answer represented by the
description was first instantiated.currentremote
description read only the read-only property rtcpeerconnection.currentremote
description returns an rtcsession
description object describing the remote end of the connection as it was most recently successfully negotiated since the last time the rtcpeerconnection finished negotiating and connecting to a remote peer.
... also included is a list of any ice candidates that may already have been generated by the ice agent since the offer or answer represented by the
description was first instantiated.getdefaulticeservers() the getdefaulticeservers() method of the rtcpeerconnection interface returns an array of objects based on the rtciceserver dictionary, which indicates what, if any, ice servers the browser will use by default if none are provided to the rtcpeerconnection in its rtcconfiguration.
...And 22 more matches
WebRTC connectivity - Web APIs
session
descriptions the configuration of an endpoint on a webrtc connection is called a session
description.
... the
description includes information about the kind of media being sent, its format, the transfer protocol being used, the endpoint's ip address and port, and other information needed to describe a media transfer endpoint.
... this information is exchanged and stored using session
description protocol (sdp); if you want details on the format of sdp data, you can find it in rfc 2327.
...And 21 more matches
nsIMsgIncomingServer
add brief
description of interface ???
...t afilterlist); void setintattribute(in string name, in long value); void setintvalue(in string attr, in long value); void setunicharattribute(in string name, in astring value); void setunicharvalue(in string attr, in astring value); void shutdown(); void storepassword(); astring tostring(); void writetofoldercache(in nsimsgfoldercache foldercache); attributes attribute type
description accountmanagerchrome astring read only.
... usesecauth boolean valid boolean constants constant value
description defaultsocket 0 trytls 1 alwaysusetls 2 usessl 3 keepdups 0 deletedups 1 movedupstotrash 2 markdupsread 3 methods clearallvalues() this is really dangerous.
...And 19 more matches
HTML elements reference - HTML: Hypertext Markup Language
main root element
description <html> the html <html> element represents the root (top-level element) of an html document, so it is also referred to as the root element.
... element
description <base> the html <base> element specifies the base url to use for all relative urls in a document.
... sectioning root element
description <body> the html <body> element represents the content of an html document.
...And 17 more matches
StringView - Archive of obsolete content
stringview.subview(unsigned long characteroffset, optional unsigned long characterslength); void stringview.foreachchar(function callback, optional object thisobject, optional unsigned long characteroffset, optional unsigned long characterslength); domstring stringview.valueof(); domstring stringview.tostring(); properties overview attribute type
description encoding read only domstring a string expressing the encoding type.
... constructor syntax new stringview(input[, encoding[, startoffset[, length]]])
description create a new string-like object based upon an arraybuffer.
...ngview1 = new stringview("hello world!"); // utf-8 alert(mystringview1) // "hello world!" var mystringview2 = new stringview(mystringview1, "utf-16"); alert(mystringview1.buffer.bytelength); // 12 alert(mystringview2.buffer.bytelength); // 24 stringview constructor's methods makefrombase64() syntax stringview.makefrombase64(base64string[, encoding][, byteoffset][, length])
description returns a new instance of stringview constructed decoding a given base64-encoded string.
...And 16 more matches
source-editor.jsm
void setcaretposition(number aline, [optional] number acolumn, [optional] number aalign); void setselection(number astart, number aend); breakpoint management void addbreakpoint(number alineindex, [optional] string acondition); array getbreakpoints(); boolean removebreakpoint(number alineindex); properties attribute type
description dirty boolean set this value to false whenever you save the text; the editor will update it to true when the content is changed.
... this object has the following properties: property type
description str string the last string that was searched for.
... constant value
description sourceeditor.prefs.component "devtools.editor.component" a string indicating the name of the source editor engine to use; this is "orion" by default.
...And 16 more matches
Signaling and video calling - Web APIs
exchanging session
descriptions when starting the signaling process, an offer is created by the user initiating the call.
... this offer includes a session
description, in sdp format, and needs to be delivered to the receiving user, which we'll call the callee.
... the callee responds to the offer with an answer message, also containing an sdp
description.
...And 16 more matches
Index - Archive of obsolete content
195 label and
description code snippets no summary!
...the previous document had a lot of places where ideas were simply introduced without explanation, and i've tried to go through things a bit more slowly with better
descriptions.
... 488 io guide/directory keys "directory keys" are the keys for nsidirectoryservice, see
description.
...And 15 more matches
Bindings - Archive of obsolete content
for example, a
description could be added to a photo.
...<query> <content uri="?start"/> <member container="?start" child="?photo"/> <triple subject="?photo" predicate="http://purl.org/dc/elements/1.1/title" object="?title"/> <triple subject="?photo" predicate="http://purl.org/dc/elements/1.1/
description" object="?
description"/> </query> it works similarly to the previous triple.
... the ?photo variable is filled in with the known value and then the arc is looked up the datasource, filling in the value for the ?
description variable.
...And 15 more matches
ARIA Test Cases - Accessibility
- fail voiceover (leopard) n/a n/a - fail window-eyes - - - - nvda - n/a - - zoom (leopard) pass n/a pass pass zoom (leopard) pass n/a pass pass zoomtext fail- announced as 'alert' pass - - orca - - - - button basic button button with
description dojo nightly build -- lots of other types of buttons there as well.
...sults: at firefox ie opera safari jaws 9 - - n/a n/a jaws 10 - - - voiceover (leopard) n/a n/a - fail window-eyes - - - - nvda - n/a - - zoom (leopard) pass n/a pass pass zoomtext - - - - orca - - - -
description description for groupbox and for button (al) note: the
description role is no longer necessary as long as aria-describedby is used; however, this test case is still useful for testing aria-describedby.
... expected at behavior: when any control is focused inside the groupbox, where focus was previously outside of the groupbox, the
description for the entire groupbox should be read by a screen reader.
...And 14 more matches
Places utilities for JavaScript
description_anno - this annotation stores
description information about a bookmark.
... string atype, nsiuri aoverrideuri); array unwrapnodes(string blob, string atype); nsitransaction maketransaction(string data, string type, nsinavhistoryresultnode container, int index, boolean copy); nsinavhistoryresult getfoldercontents(int afolderid, boolean aexcludeitems, boolean aexpandqueries); boolean showaddbookmarkui(nsiuri auri, string atitle, string a
description, int adefaultinsertionpoint, boolean ashowpicker, boolean aloadinsidebar, string akeyword, string apostdata); boolean showminimaladdbookmarkui(nsiuri auri, string atitle, string a
description, int adefaultinsertionpoint, boolean ashowpicker, boolean aloadinsidebar, string akeyword, string apostdata); boolean showaddlivemarkui(nsiuri afeeduri, nsiuri asiteuri, string atitle, strin...
...g a
description, int adefaultinsertionpoint, boolean ashowpicker); boolean showminimaladdlivemarkui(nsiuri afeeduri, nsiuri asiteuri, string atitle, string a
description, int adefaultinsertionpoint, boolean ashowpicker); boolean showminimaladdmultibookmarkui(array nsiuri aurilist); boolean showbookmarkproperties(int aid); boolean showfolderproperties(int aid); boolean showaddfolderui(string atitle, int adefaultinsertionpoint, boolean ashowpicker); array object getannotationsforuri(nsiuri auri); array object getannotationsforitem(int aitemid); void setannotationsforuri(nsiuri auri, object aannos); void setannotationsforuri(int aitemid, object aannos); getviewfornode(nsidomnode anode); void markpageastyped(...
...And 13 more matches
Creating a Help Content Pack - Archive of obsolete content
the previous document had a lot of places where ideas were simply introduced without explanation, and i've tried to go through things a bit more slowly with better
descriptions.
... the contents of a content pack content packs consist of a general pack
description file, table of contents, index, search, glossary, and help documents.
... next, you'll need to insert a rdf:
description element into the file, inside the rdf:rdf element just created: <rdf:
description rdf:about="urn:root" nc:title="" nc:defaulttopic="" nc:base=""> </rdf:
description> fill in the attributes as follows: rdf:about must be urn:root or your pack won't work.
...And 12 more matches
WebRequest.jsm
name type
description callback function the callback argument is a function to be called when the event is triggered.
... name type
description urls matchpattern only invoke the listener for urls that match one of the patterns.
... opt_extrainfospec values name
description "blocking" make the browser wait until the listener returns.
...And 12 more matches
Define terms with HTML - Learn web development
html provides several ways to convey
description semantics, whether inline or as structured glossaries.
... objective: learn how to introduce new keywords and how to build
description lists.
...dictionaries and glossaries formally associate keywords with one or more
descriptions, as in this case: blue (adjective) of a color like the sky in a sunny day.
...And 11 more matches
nsIDBFolderInfo
add brief
description of interface ???
...obsolete since gecko 1.8 void setproperty(in string propertyname, in astring propertystr); void setuint32property(in string propertyname, in unsigned long propertyvalue); attributes attribute type
description charactersetoverride boolean expiredmark nsmsgkey expungedbytes long flags long folderdate unsigned long foldername string foldersize unsigned long highwater nsmsgkey ...
... sortorder nsmsgviewsortordervalue sorttype nsmsgviewsorttypevalue version unsigned long viewflags nsmsgviewflagstypevalue viewtype nsmsgviewtypevalue methods andflags() long andflags( in long flags ); parameters flags missing
description return value missing
description exceptions thrown missing exception missing
description changeexpungedbytes() void changeexpungedbytes( in long delta ); parameters delta missing
description exceptions thrown missing exception missing
description changenummessages() void changenummessages( in long delta ); parameters delta miss...
...And 11 more matches
nsIMsgHeaderParser
add brief
description of interface ???
... exceptions thrown missing exception missing
description native code only!extractheaderaddressnames given a string which contains a list of header addresses, returns a comma-separated list of just the 'user name' portions.
... exceptions thrown missing exception missing
description native code only!extractheaderaddressname like extractheaderaddressnames(), but only returns the first name in the list, if there is more than one.
...And 11 more matches
Introduction to XUL - Archive of obsolete content
preamble mozilla has configurable, downloadable chrome, meaning that the arrangement and even presence or absence of controls in the main window is not hardwired into the application, but loaded from a separate ui
description.
...xul (pronounced "zool," as if that spelling helped any, and short for "xml user interface language") is our name for the language in which these ui
descriptions are built.
...ui
descriptions, then, look a great deal like html 4.
...And 10 more matches
AddonManager
callback) void addaddonlistener(in addonlistener listener) void removeaddonlistener(in addonlistener listener) void addtypelistener(in typelistener listener) void removetypelistener(in typelistener listener) nsiuri geturiforresourceinfile(in nsifile afile, in string apath) properties overview attribute type
description addontypes dictionary a dictionary that maps type id to addontype.
... addonlistcallback() a callback that is passed an array of addons void addonlistcallback( in addon addons[] ) parameters addons the array of addons passed back from the asynchronous request constants addoninstall states constant
description state_available an install that is waiting to be started.
... addoninstall errors constant
description error_network_failure a network error occurred.
...And 10 more matches
NSS PKCS11 Functions
description secmod_loadusermodule loads a new pkcs #11 module into nss and connects it to the current nss trust infrastructure.
...
description secmod_unloadusermodule detaches a module from the nss trust domain and unloads it.
...
description open a new database using the softoken.
...And 10 more matches
Install Manifests - Archive of obsolete content
layout the basic layout of an install manifest is like so: <?xml version="1.0" encoding="utf-8"?> <rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <
description about="urn:mozilla:install-manifest"> <!-- properties --> </
description> </rdf> some properties are required, some are optional.
...however, while <em:maxversion> is a required property, it is ignored unless you also set <em:strictcompatibility> in the main <
description> of your install.rdf (i.e.
... examples <em:targetapplication> <
description> <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id> <!--firefox--> <em:minversion>1.5</em:minversion> <em:maxversion>3.0.*</em:maxversion> </
description> </em:targetapplication> gecko 1.9 based applications allow you to use the special targetapplication id toolkit@mozilla.org to say that the add-on is compatible with any toolkit app with a toolkit version matching the minversion...
...And 9 more matches
JXON - Archive of obsolete content
conversion snippets now imagine you have this sample xml document: example.xml <?xml version="1.0"?> <!doctype catalog system "catalog.dtd"> <catalog> <product
description="cardigan sweater"> <catalog_item gender="men's"> <item_number>qwz5671</item_number> <price>39.95</price> <size
description="medium"> <color_swatch image="red_cardigan.jpg">red</color_swatch> <color_swatch image="burgundy_cardigan.jpg">burgundy</color_swatch> </size> <size
description="large"> <color_swatch image="red_cardigan.jpg">red</color_swatc...
...h> <color_swatch image="burgundy_cardigan.jpg">burgundy</color_swatch> </size> </catalog_item> <catalog_item gender="women's"> <item_number>rrx9856</item_number> <discount_until>dec 25, 1995</discount_until> <price>42.50</price> <size
description="medium"> <color_swatch image="black_cardigan.jpg">black</color_swatch> </size> </catalog_item> </product> <script type="text/javascript"><![cdata[function matchwo(a,b) { if (a < b && a < 0) { return 1; } else { return 0; } }]]></script> </catalog> first, create a dom tree like the previous example as described in the how to create a dom tree article.
...lue": 39.95 }, "size": [{ "color_swatch": [{ "keyvalue": "red", "keyattributes": { "image": "red_cardigan.jpg" } }, { "keyvalue": "burgundy", "keyattributes": { "image": "burgundy_cardigan.jpg" } }], "keyvalue": null, "keyattributes": { "
description": "medium" } }, { "color_swatch": [{ "keyvalue": "red", "keyattributes": { "image": "red_cardigan.jpg" } }, { "keyvalue": "burgundy", "keyattributes": { "image": "burgundy_cardigan.jpg" } }], "purchased": { "keyvalue": null }, ...
...And 9 more matches
Migrate apps from Internet Explorer to Mozilla - Archive of obsolete content
(css): css level 1, css level 2.1 and parts of css level 3 document object model (dom): dom level 1, dom level 2 and parts of dom level 3 mathematical markup language: mathml version 2.0 extensible markup language (xml): xml 1.0, namespaces in xml, associating style sheets with xml documents 1.0, fragment identifier for xml xsl transformations: xslt 1.0 xml path language: xpath 1.0 resource
description framework: rdf simple object access protocol: soap 1.1 ecma-262, revision 3 (javascript 1.5): ecma-262 general cross-browser coding tips even though web standards do exist, different browsers behave differently (in fact, the same browser may behave differently depending on the platform).
...the latest w3c html specification created the title attribute, which is meant to contain a detailed
description of the link.
...methods used to access elements method
description document.getelementbyid( aid ) returns a reference to the element with the specified id.
...And 9 more matches
Building accessible custom components in XUL - Archive of obsolete content
description elements for each row and column header.
...note: the row and column headers are denoted by
description elements, and individual cells are denoted by label elements.
...<code> <grid class="spreadsheet" id="accjaxspreadsheet" flex="1"> <rows flex="1"></rows> <columns flex="1"> <column> <
description value="entry #"/> <
description value="1"/> <
description value="2"/> <
description value="3"/> <
description value="4"/> <
description value="5"/> <
description value="6"/> <
description value="7"/> </column> <column flex="1"> <
description value="date"/> <label value="03/14/05" flex="1"/> <label value="03/15/05" flex="1"/> <label value="03/15/05" flex="1"/> <label value="03/16/05" flex="1"/> <la...
...And 9 more matches
Makefile - variables
variable name
description add_to_def_file cpp_sources cpp_unit_tests a list of source files to compile as unit tests.
... xpidl_name name of extension to build see also configure.sh variables
description build_project_arg command line/environment override configure_env_args command line/environment override directory variable dirs a list of subdirectories to build recursively.
... moz_ variable
description moz_auto_deps moz_build_app moz_build_projects build multiple projects in the same sandbox.
...And 9 more matches
Index
synopsis cmsutil [options] arguments
description the cmsutil command-line uses the s/mime toolkit to perform basic operations, such as encryption and decryption, on cryptographic message syntax (cms) messages.
... synopsis crlutil [options] arguments
description the certificate revocation list (crl) management tool, crlutil, is a command-line utility that can list, generate, modify, or delete crls within the nss security database file(s) and list, create, modify or delete certificates entries in a particular crl.
... synopsis modutil [options] arguments
description the security module database tool, modutil, is a command-line utility for managing pkcs #11 module information both within secmod.db files and within hardware tokens.
...And 9 more matches
Perceivable - Accessibility
a text
description may work, or an accessible data table (see html table advanced features and accessibility).
... note: also see the wcag
description for guideline 1.1: text alternatives.
... success criteria how to conform to the criteria practical resource 1.2.1 provide alternatives for pre-recorded audio-only and video-only content (a) a transcript should be provided for prerecorded audio-only media, and a transcript or audio
description should be provided for prerecorded video-only media (i.e., silent video).
...And 9 more matches
PKCS #11 Module Specs
library
description override the default library
description value for the module returned in the ck_info structure with an internationalize string (utf8).
... cryptotoken
description override the default label value for the internal crypto token returned in the ck_token_info structure with an internationalize string (utf8).
... dbtoken
description override the default label value for the internal db token returned in the ck_token_info structure with an internationalize string (utf8).
...And 8 more matches
nsIRadioInterfaceLayer
tid, in unsigned long long processid); void setupdatacall(in long radiotech, in domstring apn, in domstring user, in domstring passwd, in long chappap, in domstring pdptype); void starttone(in domstring dtmfchar); void stoptone(); void unregistercallback(in nsiriltelephonycallback callback); void unregisterdatacallcallback(in nsirildatacallback callback); attributes attribute type
description currentstate jsval read only.
... speakerenabled bool constants call state constants constant value
description call_state_unknown 0 call_state_dialing 1 call_state_alerting 2 call_state_busy 3 call_state_connecting 4 call_state_connected 5 call_state_holding 6 call_state_held 7 call_state_resuming 8 call_state_disconnecting 9 call_state_disconnected 10 call_state_incoming 11 datacall_state_unknown 0 datacall_state_connecting 1 datacall_state_connected 2 datacall_state_disconnecting 3 datacall_state_disconnected 4 call_state_ringing 2 obsolete since gecko 14.0 methods answercall() void answercall( in unsigned long callindex ); parameters callindex missing
description ...
... exceptions thrown missing exception missing
description deactivatedatacall() void deactivatedatacall( in domstring cid, in domstring reason ); parameters cid missing
description reason missing
description exceptions thrown missing exception missing
description dial() functionality for making and managing phone calls.
...And 8 more matches
nsIWebProgressListener
note: for document requests, a second state_stop is generated (see the
description of state_is_window for more details).
... constant value
description state_start 0x00000001 this flag indicates the start of a request.
... constant value
description state_is_request 0x00010000 this flag indicates that the state transition is for a request, which includes but is not limited to document requests.
...And 8 more matches
Index - Archive of obsolete content
91
description xul attributes, xul reference no summary!
... 438 introduction to xul guide, xul mozilla has configurable, downloadable chrome, meaning that the arrangement and even presence or absence of controls in the main window is not hardwired into the application, but loaded from a separate ui
description.
...xul (pronounced "zool," as if that spelling helped any, and short for "xml user interface language") is our name for the language in which these ui
descriptions are built.
...And 7 more matches
Gecko info for Windows accessibility vendors
iaccessible methods that we support: get_accparent get_accchildcount get_accchild get_accname get_accvalue get_acc
description get_accrole get_accstate get_accfocus get_accdefaultaction acclocation accselect acchittest accdodefaultaction accnavigate get_acckeyboardshortcut msaa support: iaccessible events and unique id's what msaa events do we support?
... enum { navrelation_label_for = 0x1002 }; enum { navrelation_
description_for = 0x100f }; these two relations can be used on object to determine what form control is being labelled or desribed.
...it is also useful to check for a
description.
...And 7 more matches
ARIA annotations - Accessibility
aria annotations features the aria attributes providing these new abilities are as follows: aria-
description="" — provides a detailed
description of an html element, as opposed to the brief label provided by aria-label.
... associating annotated elements with their details there are a number of different ways in which you can associate ui features with text labels or
descriptions for accessibility purposes.
... aria-
description="" works the same as aria-label="", but is used when you want to give an element a more detailed
description, rather than a short label.
...And 7 more matches
Image file type and format guide - Web media technologies
orer, opera, safari svg scalable vector graphics image/svg+xml .svg chrome, edge, firefox, internet explorer, opera, safari tiff tagged image file format image/tiff .tif, .tiff none built-in; add-ons required webp web picture format image/webp .webp chrome, edge, firefox, opera the abbreviation for each format links to a longer
description of the format, its capabilities, and detailed browser compatibility information; including which versions introduced support and specific special features that may have been introduced later.
... mime type image/apng file extension(s) .apng specification wiki.mozilla.org/apng_specification browser compatibility chrome 59, edge 12, firefox 3, opera 46, safari 8 maximum dimensions 2,147,483,647×2,147,483,647 pixels supported color modes color mode bits per component (d)
description greyscale 1, 2, 4, 8, and 16 each pixel consists of a single d-bit value indicating the brightness of the greyscale pixel.
...s.microsoft.com/en-us/windows/desktop/gdi/bitmap-storage browser compatibility all versions of chrome, edge, firefox, internet explorer, opera, and safari maximum dimensions either 32,767×32,767 or 2,147,483,647×2,147,483,647 pixels, depending on the format version supported color modes color mode bits per component (d)
description greyscale 1 each bit represents a single pixel, which can be either black or white.
...And 7 more matches
Localization - Archive of obsolete content
the sdk supports localization of strings appearing in: your main add-on's javascript code html files packaged with your add-on the title,
description and homepage fields of your add-on's metadata the title and
description fields of your add-on's preferences.
... it doesn't, yet, support localization of css or content scripts, or the add-on's title and
description that appear in the add-ons manager.
...support for homepage was added in jpm 1.0.7 by including a "locales" structure in your add-on's "package.json" file, you can localize the title,
description and homepage of your add-on.
...And 6 more matches
Extension Versioning, Update and Compatibility - Archive of obsolete content
it is important to get the initial rdf:
description's about attribute correct.
... <?xml version="1.0" encoding="utf-8"?> <rdf:rdf xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <!-- this
description resource includes all the update and compatibility information for a single add-on with the id foobar@developer.mozilla.org.
...--> <rdf:
description about="urn:mozilla:extension:foobar@developer.mozilla.org"> <em:updates> <rdf:seq> <!-- each li is a different version of the same add-on --> <rdf:li> <rdf:
description> <em:version>2.2</em:version> <!-- this is the version number of the add-on --> <!-- one targetapplication for each application the add-on is compatible with --> <em:targetapplication> <rdf:
description> <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id> <em:minversion>1.5</em:minversion> <em:maxversion>2.0.0.*</em:maxversion> <!-- this is where this version of the add-on will be downloaded...
...And 6 more matches
Dehydra Object Reference - Archive of obsolete content
common properties property type
description .loc location object source location of a type or declaration.
...the following properties are usually available: property type
description .name string the function or variable name.
...the following additional properties are available on functions: property type
description .isvirtual true or "pure" true for virtual methods, or "pure" for pure virtuals (e.g.
...And 6 more matches
Plug-in Development Overview - Gecko Plugin API Reference
also, the windows version information for the plug-in dll will be used to determines the mime types, file extensions, file open template, plug-in name, and
description.
... for this the version stamp of the embedded resource of the plug-in dll should contain the following set of string/value pairs: mimetype: for mime types fileextents: for file extensions fileopenname: for file open template productname: for plug-in name file
description: for
description language: for language in use in the mime types and file extensions strings, multiple values are separated by the "|" character, for example: video/quicktime|audio/aiff|image/jpeg the version stamp will be loaded only if it has been created with the language set to "us english" and the character set to "windows multilingual" in your development environment.
... to determine the mime types and file extensions that the plug-in handles, the browser loads each library and calls into the np_getmime
description entry point.
...And 6 more matches
Commenting IDL for better documentation
if an interface is used as a parameter or as the type of the value returned by a method, please use the full name of the interface in the
description of the method.
... command details @brief
description please only use this to provide a brief
description of the interface, keep it short and to the point.
... @param parameter
description every parameter of a method should be documented, only use the parameter name, leave out things like [in]/[out].
...And 6 more matches
sslcrt.html
see
description below for more information.
...
description the cert_verifycertnow function must call one or more pk11 functions to obtain the services of a pkcs #11 module.
...
description the comparison performed by cert_verifycertname is not a simple string comparison.
...And 6 more matches
Index
207 js_compilefilehandleforprincipals jsapi reference, needscontent, obsolete, spidermonkey please provide a
description of this function.
... 208 js_compilefilehandleforprincipalsversion jsapi reference, needscontent, obsolete, spidermonkey please provide a
description for this function.
... 213 js_compileucfunctionforprincipalsversion jsapi reference, needscontent, obsolete, spidermonkey please provide a
description for this function.
...And 6 more matches
IAccessibleTable
method overview [propget] hresult accessibleat([in] long row, [in] long column, [out] iunknown accessible ); [propget] hresult caption([out] iunknown accessible ); [propget] hresult childindex([in] long rowindex, [in] long columnindex, [out] long cellindex ); [propget] hresult column
description([in] long column, [out] bstr
description ); [propget] hresult columnextentat([in] long row, [in] long column, [out] long ncolumnsspanned ); [propget] hresult columnheader([out] iaccessibletable accessibletable, [out] long startingrowindex ); [propget] hresult columnindex([in] long cellindex, [out] long columnindex ); [propget] hresult iscolumnselected([in] long column, [out] boolean issel...
...out] long rowcount ); [propget] hresult nselectedchildren([out] long cellcount ); [propget] hresult nselectedcolumns([out] long columncount ); [propget] hresult nselectedrows([out] long rowcount ); [propget] hresult rowcolumnextentsatindex([in] long index, [out] long row, [out] long column, [out] long rowextents, [out] long columnextents, [out] boolean isselected ); [propget] hresult row
description([in] long row, [out] bstr
description ); [propget] hresult rowextentat([in] long row, [in] long column, [out] long nrowsspanned ); [propget] hresult rowheader([out] iaccessibletable accessibletable, [out] long startingcolumnindex ); [propget] hresult rowindex([in] long cellindex, [out] long rowindex ); hresult selectcolumn([in] long column ); [propget] hresult selectedchildren([in] long...
...column
description() returns the
description text of the specified column in the table.
...And 6 more matches
IAccessibleTable2
method overview [propget] hresult caption([out] iunknown accessible ); [propget] hresult cellat([in] long row, [in] long column, [out] iunknown cell ); [propget] hresult column
description([in] long column, [out] bstr
description ); [propget] hresult iscolumnselected([in] long column, [out] boolean isselected ); [propget] hresult isrowselected([in] long row, [out] boolean isselected ); [propget] hresult modelchange([out] ia2tablemodelchange modelchange ); [propget] hresult ncolumns([out] long columncount ); [propget] hresult nrows([out] long rowcount ); [propget] hresul...
...t nselectedcells([out] long cellcount ); [propget] hresult nselectedcolumns([out] long columncount ); [propget] hresult nselectedrows([out] long rowcount ); [propget] hresult row
description([in] long row, [out] bstr
description ); hresult selectcolumn([in] long column ); [propget] hresult selectedcells([out, size_is(, nselectedcells,)] iunknown cells, [out] long nselectedcells ); [propget] hresult selectedcolumns([out, size_is(, ncolumns)] long selectedcolumns, [out] long ncolumns ); [propget] hresult selectedrows([out, size_is(, nrows)] long selectedrows, [out] long nrows ); hresult selectrow([in] long row ); [propget] hresult summary([out] iunknown accessible ); hresult unselectcolumn([in] long column ); hresult unselectrow([in] long row ); methods caption() returns the cap...
...column
description() returns the
description text of the specified column in the table.
...And 6 more matches
nsIAccessibleTable
inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview nsiaccessible getcellat(in long rowindex, in long columnindex); note: renamed from cellrefat in gecko 1.9.2 long getcellindexat(in long rowindex, in long columnindex); note: renamed from getindexat in gecko 1.9.2 astring getcolumn
description(in long columnindex); long getcolumnextentat(in long row, in long column); long getcolumnindexat(in long cellindex); note: renamed from getcolumnatindex in gecko 1.9.2 void getrowandcolumnindicesat(in long cellindex, out long rowindex, out long columnindex); astring getrow
description(in long rowindex); long getrowextentat(in long row, in long column);...
...lumnindex); boolean iscolumnselected(in long columnindex); boolean isprobablyforlayout(); boolean isrowselected(in long rowindex); void selectcolumn(in long columnindex); void selectrow(in long rowindex); void unselectcolumn(in long columnindex); void unselectrow(in long rowindex); attributes attribute type
description caption nsiaccessible the caption accessible for the table.
... note: renamed from selectedrowscount in gecko 1.9.2 summary astring the summary
description for the table.
...And 6 more matches
nsIContentViewer
[noscript,notxpcom,nostdcall] void setnavigationtiming(in nsdomnavigationtimingptr atiming); void setpagemode(in boolean apagemode, in nsiprintsettings aprintsettings); void show(); void stop(); void unload(); obsolete since gecko 1.8 attributes attribute type
description container nsisupports domdocument nsidomdocument enablerendering boolean obsolete since gecko 2.0 historyentry nsishentry get the history entry that this viewer will save itself into when destroyed.
...native code only!getbounds void getbounds( in nsintrectref abounds ); parameters abounds missing
description getdocument() returns the dom document object (as an nsidocument without addrefing.
...void init( in nsiwidgetptr aparentwidget, [const] in nsintrectref abounds ); parameters aparentwidget missing
description abounds missing
description loadcomplete() void loadcomplete( in unsigned long astatus ); parameters astatus missing
description exceptions thrown missing exception missing
description loadstart() void loadstart( in nsisupports adoc ); parameters adoc missing
description exceptions thrown missing exception missing
description move() void move( in long ax, in long ay ); parameters ax missing
description ...
...And 6 more matches
ctypes
thod overview ctype arraytype(type[, length]); cdata cast(data, type); ctype functiontype(abi, returntype[, argtype1, ...]); cdata int64(n); string libraryname(name); library open(libspec); ctype pointertype(typespec); ctype structtype(name[, fields]); cdata uint64(n); properties property type
description errno number the value of the latest system error.
... constant
description default_abi corresponds to cdecl; standard libraries use this abi.
... type
description int8_t signed 8-bit integer.
...And 6 more matches
Plug-in Development Overview - Plugins
also, the windows version information for the plug-in dll will be used to determines the mime types, file extensions, file open template, plug-in name, and
description.
... for this the version stamp of the embedded resource of the plug-in dll should contain the following set of string/value pairs: mimetype: for mime types fileextents: for file extensions fileopenname: for file open template productname: for plug-in name file
description: for
description language: for language in use in the mime types and file extensions strings, multiple values are separated by the "|" character, for example: video/quicktime|audio/aiff|image/jpeg the version stamp will be loaded only if it has been created with the language set to "us english" and the character set to "windows multilingual" in your development environment.
... to determine the mime types and file extensions that the plug-in handles, the browser loads each library and calls into the np_getmime
description entry point.
...And 6 more matches
simple-prefs - Archive of obsolete content
"preferences": [{ "name": "somepreference", "title": "some preference title", "
description": "some short
description for the preference", "type": "string", "value": "this is the default string value" }, { "
description": "how many of them we have.", "name": "myinteger", "type": "integer", "value": 8, "title": "how many?" }] } each preference is defined by a group of attributes.
... attribute
description type the type of preference, as defined in the "preference types" section below.
... optional common attributes these are attributes that all preferences may have: attribute
description description this appears below the preference title in the add-ons manager ui.
...And 5 more matches
Search Extension Tutorial (Draft) - Archive of obsolete content
adding a new search engine search engines may be added either directly via an api call, or indirectly via an xml
description file.
... while the former is the simpler method, it does not support complex
descriptions containing suggestion urls or separate keyword search urls.
...cu.import("resource://gre/modules/services.jsm"); // the details of the engine to add const engine_details = { name: "example engine", iconurl: "data:image/png;base64,...", alias: "example-engine",
description: "an example search engine", method: "get", // the http request method url: "https://www.example.com/?q=_searchterms_" }; // keep track of whether this is the first run.
...And 5 more matches
Creating a status bar extension - Archive of obsolete content
<?xml version="1.0"?> <rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <
description about="urn:mozilla:install-manifest"> <em:id>status-bar-sample-1@example.com</em:id> <em:version>1.0</em:version> <em:type>2</em:type> <!-- front end metadata --> <em:name>status bar sample 1</em:name> <em:
description>sample static status bar panel</em:
description> <em:creator>my name</em:creator> <em:homepageurl>http://developer.mozilla.org/en/docs/creating_a_status_ba...
...r_extension</em:homepageurl> <!-- describe the firefox versions we support --> <em:targetapplication> <
description> <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id> <em:minversion>1.5</em:minversion> <em:maxversion>2.0.0.*</em:maxversion> </
description> </em:targetapplication> </
description> </rdf> let's take a look at some key parts of the manifest.
...in this sample, these fields are: property name
description id a unique identification string.
...And 5 more matches
Install script template - Archive of obsolete content
var plid = "@myplugin.com/myplugin,version=5.3"; var version = "5.3.0.0"; var mimetype = "application/x-my-plugin"; var suffix = "my"; var suffix_
description = "my plugin files"; var company_name = "mypluginco"; var plugin_
description = "my exemplary plugin mine all mine"; // registry constant paths // these will be used when the win32 registry keys are written var hkey_local_machine = "hkey_local_machine"; var hkey_current_user = "hkey_current_user"; var reg_moz_path = "software\\mozillaplugins"; // my own error code in case secondary installat...
...dsecondaryfolderdll = secondaryfolder + plugin_file; var qualifiedsecondaryfolderxpt = secondaryfolder + component_file; // write plid keys (mozilla.org/projects/plugins/first-install-problem.html) // write plid keys to hklm var hklm_status = registerplid(hkey_local_machine, reg_moz_path, plid, qualifiedsecondaryfolderdll, qualifiedsecondaryfolderxpt, plugin_
description, company_name, software_name, version, mimetype, suffix, suffix_
description); logcomment("moz first install installation: registerplid("+hkey_local_machine+") returned, status "+hklm_status); if (hklm_status == false) { // write plid keys (mozilla.org/projects/plugins/first-install-problem.html) // write plid keys to hkcu var hkcu_status = registerplid(hkey_current_user, reg...
..._moz_path, plid, qualifiedsecondaryfolderdll, qualifiedsecondaryfolderxpt, plugin_
description, company_name, software_name, version, mimetype, suffix, suffix_
description); logcomment("first install installation: registerplid("+hkey_current_user+") returned, status "+hklm_status); if (hkcu_status != 0) { logcomment("could not write to the registry.
...And 5 more matches
RDF Modifications - Archive of obsolete content
for instance, an assert call looks like the following: var source = rdf.getresource("http://www.xulplanet.com/ndeakin/images/t/obelisk.jpg"); var predicate = rdf.getresource("http://purl.org/dc/elements/1.1/
description"); var target = rdf.getliteral("one of the thirty or so egyptian obelisks"); datasource.assert(source, predicate, target, true); the assert call adds a new triple to the rdf datasource.
... subject: http://www.xulplanet.com/ndeakin/images/t/obelisk.jpg predicate: http://purl.org/dc/elements/1.1/
description object: one of the thirty or so egyptian obelisks the template builder will be notified through the rdf observer mechanism of the change.
...let's assume we have single query with as follows: <query> <content uri="?start"/> <member container="?start" child="?photo"/> <triple subject="?photo" predicate="http://purl.org/dc/elements/1.1/title" object="?title"/> <triple subject="?photo" predicate="http://purl.org/dc/elements/1.1/
description" object="?
description"/> </query> these query statements will cause any photos with both a title and a
description to be displayed.
...And 5 more matches
Advanced text formatting - Learn web development
here you'll learn about marking up quotations,
description lists, computer code and other related text, subscript and superscript, contact information, and more.
...
description lists in html text fundamentals, we walked through how to mark up basic lists in html, but we didn't mention the third type of list you'll occasionally come across —
description lists.
... the purpose of these lists is to mark up a set of items and their associated
descriptions, such as terms and definitions, or questions and answers.
...And 5 more matches
What’s in the head? Metadata in HTML - Learn web development
this is the code we used: <p>japanese example: ご飯が熱い。</p> adding an author and
description many <meta> elements include name and content attributes: name specifies the type of meta element it is; what type of information it contains.
... two such meta elements that are useful to include on your page define the author of the page, and provide a concise
description of the page.
... let's look at an example: <meta name="author" content="chris mills"> <meta name="
description" content="the mdn web docs learning area aims to provide complete beginners to the web with all they need to know to get started with developing web sites and applications."> specifying an author is beneficial in many ways: it is useful to be able to understand who wrote the page, if you have any questions about the content and you would like to contact them.
...And 5 more matches
Animated PNG graphics
for purposes of chunk
descriptions, an unsigned int shall be a 32-bit unsigned integer in network byte order limited to the range 0 to (2^32)-1; an unsigned short shall be a 16-bit unsigned integer in network byte order with the range 0 to (2^16)-1; and a byte shall be an 8-bit unsigned integer with the range 0 to (2^8)-1.
... the 'actl' chunk contains: byte offset field name field type
description 0 num_frames unsigned int the number of frames in the apng.
... byte offset field name field type
description 0 sequence_number unsigned int sequence number of the animation chunk, starting with 0.
...And 5 more matches
Index
here is the interface, and a
description of its use.</t> 10 how to pass an xpcom object to a new window needsexample, needshelp if you want to be able to call functions within an xpcom object from a xul window's code, you can do so if you pass the xpcom object as one of the arguments to the window creation method.
... 12 index found 1275 pages: 13 interfacing with the xpcom cycle collector firefox 3, xpcom this is a quick overview of the cycle collector introduced into xpcom for firefox 3, including a
description of the steps involved in modifying an existing c++ class to participate in xpcom cycle collection.
... 61 xpconnect wrappers guide, needscontent, xpcom, xpcom:language bindings, xpconnect this document is a high-level overview of xpconnect wrapper objects (for the more technical
description see xpconnect security membranes).
...And 5 more matches
nsIPrincipal
boolean subsumes(in nsiprincipal other); attributes attribute type
description certificate nsisupports the certificate associated with this principal, if any.
... constant value
description enable_denied 1 enable_unknown 2 enable_with_user_permission 3 enable_granted 4 methods native code only!canenablecapability short canenablecapability( in string capability ); parameters capability missing
description return value missing
description exceptions thrown missing exception missing descript...
...void checkmayload( in nsiuri uri, in boolean report ); parameters uri missing
description report if true, will report a warning to the console service if the load is not allowed.
...And 5 more matches
A simple RTCDataChannel sample - Web APIs
localconnection.createoffer() .then(offer => localconnection.setlocal
description(offer)) .then(() => remoteconnection.setremote
description(localconnection.local
description)) .then(() => remoteconnection.createanswer()) .then(answer => remoteconnection.setlocal
description(answer)) .then(() => localconnection.setremote
description(remoteconnection.local
description)) .catch(handlecreate
descriptionerror); let's go through this line by line and decipher what it...
... first, we call rtcpeerconnection.createoffer() method to create an sdp (session
description protocol) blob describing the connection we want to make.
... if the offer is created successfully, we pass the blob along to the local connection's rtcpeerconnection.setlocal
description() method.
...And 5 more matches
SVG documentation index - SVG: Scalable Vector Graphics
this article lists these types along with their syntax and
descriptions of what they're used for.
... 226 u1 deprecated, svg, svg attribute the u1 attribute specifies list of unicode characters (refer to the
description of the unicode attribute of the <glyph> element for a
description of how to express individual unicode characters) and/or ranges of unicode characters, which identify a set of possible first glyphs in a kerning pair.
... 227 u2 deprecated, svg, svg attribute the u2 attribute specifies list of unicode characters (refer to the
description of the unicode attribute of the <glyph> element for a
description of how to express individual unicode characters) and/or ranges of unicode characters, which identify a set of possible second glyphs in a kerning pair.
...And 5 more matches
package.json - Archive of obsolete content
some of its entries, such as icon, name, and
description, have direct analogues in the install manifest format, and entries from package.json are written into the install manifest when the add-on is built using jpm xpi.
...it looks like this (assuming the add-on's directory is "my-addon"): { "name": "my-addon", "title": "my-addon", "id": "jid1-1fergv45e4f4f@jetpack", "
description": "a basic add-on", "author": "", "license": "mpl-2.0", "version": "0.1" } if you are using the new jpm tool, you can easily access manifest data from package.json by requiring it like any other module: var title = require("./package.json").title; key reference package.json may contain the following keys: author the name of the package's original author; this could be ...
...
description the add-on's
description; this is a human-readable message describing what the add-on does.
...And 4 more matches
The Box Model - Archive of obsolete content
text there are 2 xul elements that are typically used for displaying text: label and
description.
... the
description element is used for the rest of the cases, where the text is only meant as additional information and is not related to input elements.
...
descriptions may be longer, and in general you should plan it so that they can wrap into multiple lines.
...And 4 more matches
Multiple Rule Example - Archive of obsolete content
for instance, in an earlier example, one of the photos had a
description and the other photos did not.
... in this case, you might wish to display the photo with a
description in a different manner.
... this is useful if you wish to hide any content that would be needed to display the
description.
...And 4 more matches
Introduction to RDF - Archive of obsolete content
« previousnext » in this section, we'll look at rdf (resource
description framework).
... resource
description framework we can use the tree elements to display a set of data, such as bookmarks or mail messages.
...rdf (resource
description framework) is a format that can be used to store resources such as bookmarks or mail.
...And 4 more matches
HTML: A good basis for accessibility - Learn web development
if you access this with some screen readers, you may only be given a
description along the lines of "edit text." the following is a much better example: <div> <label for="name">fill in your name:</label> <input type="text" id="name" name="name"> </div> with code like this, the label will be clearly associated with the input; the
description will be more like "fill in your name: edit text." as an added bonus, in most browsers associating a label with a form input mea...
...any personal knowledge or extra
description shouldn't be included here, as it is not useful for people who have not come across the image before.
...</p> in this case, we are not using the alt attribute at all — instead, we have presented our
description of the image as a regular text paragraph, given it an id, and then used the aria-labelledby attribute to refer to that id, which causes screen readers to use that paragraph as the alt text/label for that image.
...And 4 more matches
HTML: A good basis for accessibility - Learn web development
if you access this with some screen readers, you may only be given a
description along the lines of "edit text." the following is a much better example: <div> <label for="name">fill in your name:</label> <input type="text" id="name" name="name"> </div> with code like this, the label will be clearly associated with the input; the
description will be more like "fill in your name: edit text." as an added bonus, in most browsers associating a label with a form input mea...
...any personal knowledge or extra
description shouldn't be included here, as it is not useful for people who have not come across the image before.
...</p> in this case, we are not using the alt attribute at all — instead, we have presented our
description of the image as a regular text paragraph, given it an id, and then used the aria-labelledby attribute to refer to that id, which causes screen readers to use that paragraph as the alt text/label for that image.
...And 4 more matches
Message manager overview
global frame message manager
description there's a single global frame message manager in the chrome process.
... window message manager
description there's a window message manager for every browser window: two, in the diagram above.
...
description finally, there's a browser message manager for every open content tab: three, in the diagram above.
...And 4 more matches
imgIDecoderObserver
acurrentframe missing
description arect missing
description ondiscard() called when the decoded image data is discarded.
... acontainer missing
description onstartdecode() this decode notification is called as soon as the image begins getting decoded.
... aframe missing
description onstartrequest() a load notification which is called at the same time that nsirequestobserver.onstartrequest() would be (used only for observers of imgirequest objects, which are nsirequests, not imgidecoder objects).
...And 4 more matches
nsIBrowserSearchService
method overview void addengine(in astring engineurl, in long datatype, in astring iconurl, in boolean confirm, [optional] in nsisearchinstallcallback callback); void addenginewithdetails(in astring name, in astring iconurl, in astring alias, in astring
description, in astring method, in astring url); void getdefaultengines([optional] out unsigned long enginecount, [retval, array, size_is(enginecount)] out nsisearchengine engines); nsisearchengine getenginebyalias(in astring alias); nsisearchengine getenginebyname(in astring aenginename); void getengines([optional] out unsigned long enginecount...
...nt, [retval, array, size_is(enginecount)] out nsisearchengine engines); void init([optional] in nsibrowsersearchinitobserver observer); void moveengine(in nsisearchengine engine, in long newindex); void removeengine(in nsisearchengine engine); void restoredefaultengines(); attributes attribute type
description currentengine nsisearchengine the currently active search engine.
...void addengine( in astring engineurl, in long datatype, in astring iconurl, in boolean confirm, [optional] in nsisearchinstallcallback callback ); parameters engineurl the url to the search engine's
description file.
...And 4 more matches
nsITransferable
n ); void gettransferdata( in string aflavor, out nsisupports adata, out unsigned long adatalen ); void init(in nsiloadcontext acontext); boolean islargedataset( ); void removedataflavor( in string adataflavor ); void settransferdata( in string aflavor, in nsisupports adata, in unsigned long adatalen ); attributes attribute type
description converter nsiformatconverter an nsiformatconverter instance which implements the code needed to convert data into and out of the transferable given the supported flavors.
... constants kflavorhasdataprovider (that title needs to be better) constant value
description kflavorhasdataprovider 0 a
description is needed here.
... common mime types some of these need better
descriptions, especially the mozilla-specific ones.
...And 4 more matches
HTMLImageElement.longDesc - Web APIs
the obsolete property longdesc on the htmlimageelement interface specifies the url of a text or html file which contains a long-form
description of the image.
... this can be used to provide optional added details beyond the short
description provided in the title attribute.
... syntax descurl = htmlimageelement.longdesc; htmlimageelement.longdesc = descurl; value a domstring which may be either an empty string (indicating that no long
description is available) or the url of a file containing a long form
description of the image's contents.
...And 4 more matches
RTCPeerConnection.signalingState - Web APIs
for example, if you receive an answer while the signalingstate isn't "have-local-offer", you know that something is wrong, since you should only receive answers after creating an offer but before an answer has been received and passed into rtcpeerconnection.setlocal
description().
... constant
description "stable" there is no ongoing exchange of offer and answer underway.
... this may mean that the rtcpeerconnection object is new, in which case both the local
description and remote
description are null; it may also mean that negotiation is complete and a connection has been established.
...And 4 more matches
WebRTC API - Web APIs
rtcsession
description represents the parameters of a session.
... each rtcsession
description consists of a
description type indicating which part of the offer/answer negotiation process it describes and of the sdp descriptor of the session.
... icecandidate an rtcpeerconnectioniceevent which is sent whenever the local device has identified a new ice candidate which needs to be added to the local peer by calling setlocal
description().
...And 4 more matches
ARIA live regions - Accessibility
below is a list of each related aria live region property with a
description.
...value="">select a planet…</option> <option value="mercury">mercury</option> <option value="venus">venus</option> <option value="earth">earth</option> <option value="mars">mars</option> </select> <button id="renderplanetinfobutton">go</button> </fieldset> <div role="region" id="planetinfo" aria-live="polite"> <h2 id="planettitle">no planet selected</h2> <p id="planet
description">select a planet to view its
description</p> </div> <p><small>information courtesy <a href="https://en.wikipedia.org/wiki/solar_system#inner_solar_system">wikipedia</a></small></p> javascript const planets_info = { mercury: { title: 'mercury',
description: 'mercury is the smallest and innermost planet in the solar system.
... it is named after the roman deity mercury, the messenger to the gods.' }, venus: { title: "venus",
description: 'venus is the second planet from the sun.
...And 4 more matches
<img>: The Image Embed element - HTML: Hypertext Markup Language
the alt attribute holds a text
description of the image, which isn't mandatory but is incredibly useful for accessibility — screen readers read this
description out to their users so they know what the image means.
...orer, opera, safari svg scalable vector graphics image/svg+xml .svg chrome, edge, firefox, internet explorer, opera, safari tiff tagged image file format image/tiff .tif, .tiff none built-in; add-ons required webp web picture format image/webp .webp chrome, edge, firefox, opera the abbreviation for each format links to a longer
description of the format, its capabilities, and detailed browser compatibility information; including which versions introduced support and specific special features that may have been introduced later.
... alt defines an alternative text
description of the image.
...And 4 more matches
<input>: The Input (Form Input) element - HTML: Hypertext Markup Language
the available types are as follows: type
description basic examples spec button a push button with no default behavior displaying the value of the value attribute, empty by default.
... this section provides a table listing all the attributes with a brief
description.
... attributes for the <input> element include global html attributes and: attribute type or types
description accept file hint for expected file type in file upload controls alt image alt attribute for the image type.
...And 4 more matches
2015 MDN Fellowship Program - Archive of obsolete content
specific projects (we encourage you to target one of these in your application): testthewebforward brief project
description mozilla participates in an important w3c open testing initiative, testthewebforward.com.
... github: jdm twitter: @lastontheboat service workers brief project
description service workers essentially act as proxy servers that sit between web applications, the browser and (when available) the network.
...provide detailed api
descriptions.
...And 3 more matches
MCD, Mission Control Desktop, AKA AutoConfig - Archive of obsolete content
home"); } else { // windows settings var env_user = getenv("username"); var env_home = getenv("homepath"); } var env_mozdebug= getenv("mozilla_debug"); // var env_user = prompt("indiquez votre login", toto); // 2) lock general preferences //ldap address book lockpref("ldap_2.prefs_migrated", true); lockpref("ldap_2.servers.ldapint.auth.savepassword", true); lockpref("ldap_2.servers.ldapint.
description", "ldap int"); lockpref("ldap_2.servers.ldapint.filename", "abook-1.mab"); lockpref("ldap_2.servers.ldapint.uri", "ldap://ldap1.int-evry.fr:389/ou=people,dc=int-evry,dc=fr??sub"); lockpref("ldap_2.servers.history.filename", "history.mab"); lockpref("ldap_2.servers.history.replication.lastchangenumber", 0); lockpref("ldap_2.servers.pab.filename", "abook.mab"); lockpref("ldap_2.servers.pab.replicat...
...yimap.server.com" ); defaultpref("mail.server.server1.name", userinfo.mail ); defaultpref("mail.server.server1.port", 993 ); defaultpref("mail.server.server1.sockettype", 3 ); defaultpref("mail.server.server1.type", "imap" ); defaultpref("mail.server.server1.username", userinfo.mail ); // smtp server settings defaultpref("mail.smtpserver.smtp1.authmethod", 3 ); defaultpref("mail.smtpserver.smtp1.
description", "my company name" ); defaultpref("mail.smtpserver.smtp1.hostname", "mysmtp.server.com" ); defaultpref("mail.smtpserver.smtp1.port", 465 ); defaultpref("mail.smtpserver.smtp1.try_ssl", 3 ); defaultpref("mail.smtpserver.smtp1.username", userinfo.mail ); // glue it all together defaultpref("mail.account.account1.identities", "id1" ); defaultpref("mail.account.account1.server", "server1" ); defaul...
... locating the file on a web server that was the case in the netscape 4.x
description below, however, at first it was a hard thing to do in mozilla, cf.
...And 3 more matches
Complete - Archive of obsolete content
localizing the
description firefox etc.
... display a
description of the extension in the extensions window.
... the
description in install.rdf is the default.
...And 3 more matches
Adding Labels and Images - Archive of obsolete content
description element for descriptive text not associated with any particular control, you can use the
description tag.
...as with the label element, you can either use the value attribute for a single line of text or place text or xhtml content inside opening and closing
description tags for longer blocks of text.
... it is more common to use the attribute syntax for labels, and the text content syntax for
descriptions.
...And 3 more matches
Adobe Flash - Archive of obsolete content
every plugin exposes a
description string that typically includes the plugin's name and version number.
... the flash plugin's
description string uses a standard versioning nomenclature that can then be parsed for meaningful information.
...the
description string exposes this version.
...And 3 more matches
Index - MDN Web Docs Glossary: Definitions of Web-related terms
202 head codingscripting, glossary, html, head, metadata the head is the part of an html document that contains metadata about that document, such as author,
description, and links to css or javascript files that should be applied to the html.
... 215 idl codingscripting, glossary, idl, interface
description language an idl (interface
description language) is a generic language used to specified objects' interfaces apart from any specific programming language.
...in acronym order, the main tenets are: 352 rdf codingscripting, glossary, infrastructure, openpractices, webmechanics rdf (resource
description framework) is a language developed by w3c for representing information on the world wide web, such as webpages.
...And 3 more matches
Styling lists - Learn web development
throughout this article, we'll look at unordered, ordered, and
description lists — all have styling features that are similar, and some that are particular to their type of list.
...graph for reference, paragraph for reference, paragraph for reference, paragraph for reference, paragraph for reference.</p> <ol> <li>toast pita, leave to cool, then slice down the edge.</li> <li>fry the halloumi in a shallow, non-stick pan, until browned on both sides.</li> <li>wash and chop the salad.</li> <li>fill pita with salad, hummus, and fried halloumi.</li> </ol> <h2>ingredient
description list</h2> <p>paragraph for reference, paragraph for reference, paragraph for reference, paragraph for reference, paragraph for reference, paragraph for reference.</p> <dl> <dt>hummus</dt> <dd>a thick dip/sauce generally made from chick peas blended with tahini, lemon juice, salt, garlic, and other ingredients.</dd> <dt>pita</dt> <dd>a soft, slightly leavened flatbread.</dd> <dt>hallou...
...ical rhythm), and the same horizontal spacing as each other (you can see the finished styled example on github, and find the source code too.) the css used for the text styling and spacing is as follows: /* general styles */ html { font-family: helvetica, arial, sans-serif; font-size: 10px; } h2 { font-size: 2rem; } ul,ol,dl,p { font-size: 1.5rem; } li, p { line-height: 1.5; } /*
description list styles */ dd, dt { line-height: 1.5; } dt { font-weight: bold; } the first rule sets a sitewide font and a baseline font size of 10px.
...And 3 more matches
How to implement a custom autocomplete search component
const class_id = components.id('x753d830-ba1e-11e0-962b-0800200c9a66'); // ← change this const class_name = "basic autocomplete"; const contract_id = '@mozilla.org/autocomplete/search;1?name=basic-autocomplete'; /** * @constructor * * @implements {nsiautocompleteresult} * * @param {string} searchstring * @param {number} searchresult * @param {number} defaultindex * @param {string} error
description * @param {array.<string>} results * @param {array.<string>|null=} comments */ function providerautocompleteresult(searchstring, searchresult, defaultindex, error
description, results, comments) { this._searchstring = searchstring; this._searchresult = searchresult; this._defaultindex = defaultindex; this._error
description = error
description; this._results = results; this._comments...
... = comments; } providerautocompleteresult.prototype = { _searchstring: "", _searchresult: 0, _defaultindex: 0, _error
description: "", _results: [], _comments: [], /** * @return {string} the original search string */ get searchstring() { return this._searchstring; }, /** * @return {number} the result code of this result object, either: * result_ignored (invalid searchstring) * result_failure (failure) * result_nomatch (no matches found) * result_success (matches found) */ get searchresult() { return this._searchresult; }, /** * @return {number} the index of the default item that should be entered if * none is selected */ get defaultindex() { return this._defaultindex; }, /** * @return {string} descri...
...ption of the cause of a search failure */ get error
description() { return this._error
description; }, /** * @return {number} the number of matches */ get matchcount() { return this._results.length; }, /** * @return {string} the value of the result at the given index */ getvalueat: function(index) { return this._results[index]; }, /** * @return {string} the comment of the result at the given index */ getcommentat: function(index) { if (this._comments) return this._comments[index]; else return ''; }, /** * @return {string} the style hint for the result at the given index */ getstyleat: function(index) { if (!this._comments || !this._comments[index]) return null; // not a category label, so no special styl...
...And 3 more matches
ssltyp.html
syntax #include <certt.h> typedef struct certcertificatestr certcertificate;
description certificate structures are shared objects.
...the use of the word "destroy" in function names or in the
description of a function often implies reference counting.
...<prtypes.h> #include <secport.h> typedef enum { sibuffer, sicleardatabuffer, sicipherdatabuffer, sidercertbuffer, siencodedcertbuffer, sidernamebuffer, siencodednamebuffer, siasciinamestring, siasciistring, sideroid } secitemtype; typedef struct secitemstr secitem; struct secitemstr { secitemtype type; unsigned char *data; unsigned int len; };
description a secitem structure can be used to associate your own data with an ssl socket.
...And 3 more matches
JS::CompileOptions
constructor js::readonlycompileoptions(); // added in spidermonkey 31 js::owningcompileoptions(jscontext *cx); // added in spidermonkey 31 js::compileoptions(jscontext *cx, jsversion version = jsversion_unknown); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
... methods of js::readonlycompileoptions method
description bool mutederrors() const determines if errors are muted.
... methods of js::owningcompileoptions method
description jsobject *element() const returns the dom element to which this source code belongs, if any, or null if it belongs to no dom element.
...And 3 more matches
nsIAccessibleEvent
inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) attributes attribute type
description accessible nsiaccessible the nsiaccessible associated with the event.
... constants constant gecko version
description 1.7 - 1.8.1 1.9 - 1.9.2 2.0 event_show 0x8002 0x0001 an object has been created.
... event_
description_change 0x000c 0x0009 an object's
description property has changed.
...And 3 more matches
nsIAccessibleRelation
method overview nsiaccessible gettarget(in unsigned long index); nsiarray gettargets(); attributes attribute type
description relationtype unsigned long returns the type of the relation.
... constants constant value
description relation_nul 0x00 relation_controlled_by 0x01 some attribute of this object is affected by a target object.
... 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.
...And 3 more matches
nsIRequest
method overview void cancel(in nsresult astatus); boolean ispending(); void resume(); void suspend(); attributes attribute type
description loadflags nsloadflags the load flags of this request.
... constant value
description load_normal 0 no special load flags.
... constant value
description inhibit_caching 1 << 7 this flag prevents caching of any kind.
...And 3 more matches
Using COM from js-ctypes
$ cl ole32.lib test.cpp vtable needs vtable
description here.
... __stdcall and __cdecl needs __stdcall and __cdecl (callback_abi)
description here.
... call by reference needs c++ reference (&) and c pointer (*)
description here.
...And 3 more matches
RTCPeerConnection.addIceCandidate() - Web APIs
this adds this new remote candidate to the rtcpeerconnection's remote
description, which describes the state of the remote end of the connection.
... return value a promise which is fulfilled when the candidate has been successfully added to the remote peer's
description by the ice agent.
... invalidstateerror the rtcpeerconnection currently has no remote peer established (remote
description is null).
...And 3 more matches
Using DTMF with WebRTC - Web APIs
function handlecallernegotiationneeded() { log("negotiating..."); callerpc.createoffer(offeroptions) .then(function(offer) { log("setting caller's local
description: " + offer.sdp); return callerpc.setlocal
description(offer); }) .then(function() { log("setting receiver's remote
description to the same as caller's local"); return receiverpc.setremote
description(callerpc.local
description) }) .then(function() { log("creating answer"); return receiverpc.createanswer(); }) .then(function(answer) { log("setting receiver's local ...
...
description to " + answer.sdp); return receiverpc.setlocal
description(answer); }) .then(function() { log("setting caller's remote
description to match"); return callerpc.setremote
description(receiverpc.local
description); }) .catch(err => log("error during negotiation: " + err.message)); } since the various methods involved in negotiating the connection return promises, we can chain them together like this: call callerpc.createoffer() to get an offer.
... then take that offer and set the caller's local
description to match by calling callerpc.setlocal
description().
...And 3 more matches
Using the aria-describedby attribute - Accessibility
description the aria-describedby attribute is used to indicate the ids of the elements that describe the object.
...this is very similar to aria-labelledby: a label describes the essence of an object, while a
description provides more information that the user might need.
... examples example 1: application landmark
descriptions in the example below, an introductory paragraph describes a calendar application.
...And 3 more matches
Expressions and operators - JavaScript
the following table describes the comparison operators in terms of this sample code: var var1 = 3; var var2 = 4; comparison operators operator
description examples returning true equal (==) returns true if the operands are equal.
...for example: 1 / 2; // 0.5 1 / 2 == 1.0 / 2.0; // this is true in addition to the standard arithmetic operations (+, -, *, /), javascript provides the arithmetic operators listed in the following table: arithmetic operators operator
description example remainder (%) binary operator.
... bitwise operators operator usage
description bitwise and a & b returns a one in each bit position for which the corresponding bits of both operands are ones.
...And 3 more matches
Using templates and slots - Web Components
ac0; padding: 2px 6px 2px 6px } h4 span { border: 1px solid #cee9f9; border-radius: 4px } h4 span { color: white } .attributes { margin-left: 22px; font-size: 90% } .attributes p { margin-left: 16px; font-style: italic } </style> <details> <summary> <span> <code class="name"><<slot name="element-name">need name</slot>></code> <i class="desc"><slot name="
description">need
description</slot></i> </span> </summary> <div class="attributes"> <h4><span>attributes</span></h4> <slot name="attributes"><p>none</p></slot> </div> </details> <hr> </template> that <template> element has several features: the <template> has a <style> element with a set of css styles that are scoped just to the document fragment the <template> create...
... the <template> uses <slot> and its name attribute to make three named slots: <slot name="element-name"> <slot name="
description"> <slot name="attributes"> the <template> wraps the named slots in a <details> element.
...telementbyid('element-details-template') .content; const shadowroot = this.attachshadow({mode: 'open'}) .appendchild(template.clonenode(true)); } } ); using the <element-details> custom element with named slots now let’s take that <element-details> element and actually use it in our document: <element-details> <span slot="element-name">slot</span> <span slot="
description">a placeholder inside a web component that users can fill with their own markup, with the effect of composing different dom trees together.</span> <dl slot="attributes"> <dt>name</dt> <dd>the name of the slot.</dd> </dl> </element-details> <element-details> <span slot="element-name">template</span> <span slot="
description">a mechanism for holding client- side cont...
...And 3 more matches
Dialogs and Prompts - Archive of obsolete content
the header to the right of the sections buttons is made with <dialogheader>: <dialogheader title="general"
description="whatever"/> note, that you should only use this element in a <dialog>, because otherwise it may be not styled properly.
...the code to open a dialog named mydialog.xul and pass it arguments: var params = {inn:{name:"foo",
description:"bar", enabled:true}, out:null}; window.opendialog("chrome://myext/content/mydialog.xul", "", "chrome, dialog, modal, resizable=yes", params).focus(); if (params.out) { // user clicked ok.
...dialog" ondialogaccept="return onok();" onload="onload();" persist="screenx screeny width height" windowtype="mydialogwindowtype"> <script type="application/javascript" src="chrome://myext/content/mydialog.js"/> <grid> <columns><column/><column/></columns> <rows> <row align="center"><label value="name:"/><textbox id="name"/></row> <row align="center"><label value="
description:"/><textbox id="
description"/></row> <row align="center"><spacer/><checkbox id="enabled" label="check to enable"/></row> </rows> </grid> </dialog> mydialog.js: // called once when the dialog displays function onload() { // use the arguments passed to us by the caller document.getelementbyid("name").value = window.arguments[0].inn.name; document.getelementbyid("
description").v...
...And 2 more matches
Chapter 5: Let's build a Firefox extension - Archive of obsolete content
in the following you will find a brief
description how to do so; a more detailed one can be found under setting up an extension development environment.
... preference
description value nglayout.debug.disable_xul_cache (not present in firefox 3.5+) ordinarily, firefox will cache xul documents after they have been read in once, to speed subsequent displays.
... listing 1: content for install.rdf <?xml version="1.0"?> <rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <
description about="urn:mozilla:install-manifest"> <!-- unique id for extension.
...And 2 more matches
XUL Events - Archive of obsolete content
inherited dom events event
description blur the opposite of the focus event, the blur event is passed after an element loses the focus.
... attribute: onunload mutation dom events event
description domattrmodified this event is sent to an element when one of its attributes is modified.
... common xul events event
description broadcast the event handler should be placed on an observer.
...And 2 more matches
Adding HTML Elements - Archive of obsolete content
in xul, you can add labels with the
description or label element.
...text outside of one will not be displayed, unless the xul element the text is inside allows this (the
description element, for example).
...to have this text appear, you would need to put it inside the div tag, or enclose the text in a
description tag.
...And 2 more matches
The First Install Problem - Archive of obsolete content
the mimetypes subkeys contain the following string (reg_sz) value: "
description" -- this is the actual
description of the mimetype, very much as it appears in the dll (e.g.
... the same mimetype
description that apears when you type "about:plugins" as a url in mozilla's location bar.
... example: [hkey_local_machine\software\mozillaplugins\]\@mycompany.com/myapplication,version=5.01\mimetypes\application/x-myapp]
description=myapplication plugin for app files "suffixes" -- this will be a semi-colon concatenated list of supported suffixes.
...And 2 more matches
What is RSS - Archive of obsolete content
for example: <?xml version="1.0"?> <rss version="2.0"> <channel> <title>example news site</title> <
description>this is an example news site.</
description> <lastbuilddate>wed, 27 jul 2005 00:30:30 -0700</lastbuilddate> <link>http://news.example.com/</link> <item> <title>news flash: i like bread</title> <guid ispermalink="false">4d4a0a12-f188-4c97-908b-eea27213c2fe</guid> <pubdate>wed, 27 jul 2005 00:30:30 -0700</pubdate> <link>http://n...
...for example: <?xml version="1.0"?> <rss version="2.0"> <channel> <title>joe blow's blog</title> <
description>this is the weblog of joe blow</
description> <lastbuilddate>sun, 15 may 2005 13:02:08 -0500</lastbuilddate> <link>http://joe-blow.example.net/</link> <item> <title>i be blogging...</title> <guid>http://joe-blow.example.net/log/21</guid> <pubdate>sun, 15 may 2005 13:02:08 -0500</pubdate> <link>http://joe-blow.example.net/log/2...
...for example: <?xml version="1.0"?> <rss version="2.0"> <channel> <title>joe blow's blog</title> <
description>this is the weblog of joe blow</
description> <lastbuilddate>sun, 15 may 2005 13:02:08 -0500</lastbuilddate> <link>http://joe-blow.example.net/</link> <item> <title>i be blogging...</title> <guid>http://joe-blow.example.net/log/21</guid> <pubdate>sun, 15 may 2005 13:02:08 -0500</pubdate> <link>http://joe-blow.example.net/log/2...
...And 2 more matches
XPCOMUtils.jsm
mycomponent.prototype = { // properties required for xpcom registration: class
description: "unique text
description", classid: components.id("{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"), contractid: "@example.com/xxx;1", // [optional] custom factory (an object implementing nsifactory).
... category: "some-category", // optional, defaults to the object's class
description entry: "entry name", // optional, defaults to the object's contractid (unless // 'service' is specified) value: "...", // optional, defaults to false.
... classinfo: xpcomutils.generateci( {classid: components.id("{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"), contractid: "@example.com/xxx;1", class
description: "unique text
description", interfaces: [components.interfaces.nsiobserver, components.interfaces.nsimyinterface, "nsifoo", "nsibar"], flags: ci.nsiclassinfo.singleton}), // ...component implementation...
...And 2 more matches
pkfnc.html
description a nickname is an alias for a certificate subject.
...
description when you are finished with the private key structure returned by pk11_findkeybyanycert, you must free it by calling seckey_destroyprivatekey.
...
description if the slot is freed, the string with the slot name may also be freed.
...And 2 more matches
JS::CallArgs
syntax js::callargs js::callargsfromvp(unsigned argc, js::value *vp); name type
description args unsigned number of argument.
...(3nd argument of jsnative) methods methods of js::callargs method
description bool requireatleast(jscontext *cx, const char *fnname, unsigned required) returns true if there are at least required arguments passed in.
... methods inherited from js::callargsbase method
description unsigned length() const returns the number of arguments..
...And 2 more matches
JSNewEnumerateOp
syntax typedef bool (* jsnewenumerateop)(jscontext *cx, js::handleobject obj, js::autoidvector &properties); // added in spidermonkeysidebar 38 typedef bool (* jsnewenumerateop)(jscontext *cx, js::handleobject obj, jsiterateop enum_op, js::mutablehandlevalue statep, js::mutablehandleid idp); // obsolete since jsapi 37 name type
description cx jscontext * the context in which the enumeration is taking place.
...see the
description below.
...see the
description below.
...And 2 more matches
JS_SET_TRACING_DETAILS
syntax js_set_tracing_details(trc, printer, arg, index) name type
description trc jstracer * the tracer whose debugging hooks are to be set.
... arg void * see the
description.
... index size_t see the
description.
...And 2 more matches
TPS Bookmark Lists
description: the bookmark
description.
...the properties for this object include the uri, title, loadinsidebar,
description, tags, keyword properties above, plus two additional properties: location: the full path of the folder that the bookmark should be moved to position: the title of the existing bookmark item, in the current folder, where this bookmark should be moved to (i.e., this bookmark would be inserted into the bookmark list at the position of the named bookmark, causing that bookmark to be positioned below...
...
description: the folder's
description.
...And 2 more matches
XUL Accessibility
at api general rules this section holds some rules applied to generating accessible name and
description.
...name the following rules to generate accessible name are applied: check aria-labelledby attribute, name is generated from elements pointed by aria-labelledby attribute <
description id="descr1">label1</
description> <
description id="descr2">label2</
description> <textbox aria-labelledby="descr1 descr2" /> if the element implements nsidomxullabeledcontrolelement or nsidomxulselectcontrolitemelement interface then it is used label property if the element doesn't implement nsidomxulselectcontrolelement then label attribute is used if neighbour of the element has label element p...
...iptext attribute if the element is anonymous child of the element that is the direct child of toolbaritem element or the element is direct child of toolbaritem element then title attribute of toolbaritem element is used (currently it's used in firefox ui only) if the element has aria role and the role allows to aggregate name from subtree of element then generate name from subtree of the element
description the following rules to generate accessible
description are applied: check aria-describedby attribute,
description is generated from elements pointed by aria-describedby attribute <
description id="descr1">label1</
description> <
description id="descr2">label2</
description> <textbox aria-describedby="descr1 descr2" /> if neighbour of the element has
description element pointing to this element ...
...And 2 more matches
IAccessibleAction
each action can be performed or queried for a name,
description or associated key bindings.
...method overview [propget] hresult
description([in] long actionindex, [out] bstr
description ); hresult doaction([in] long actionindex ); [propget] hresult keybinding([in] long actionindex, [in] long nmaxbindings, [out, size_is(,nmaxbindings), length_is(, nbindings)] bstr keybindings, [out] long nbindings ); [propget] hresult localizedname([in] long actionindex, [out] bstr localizedname ); hresult nactions([out,retval] long nactions )...
...; [propget] hresult name([in] long actionindex, [out] bstr name ); methods
description() returns a
description of the specified action of the object.
...And 2 more matches
nsINavHistoryQueryOptions
1.0 66 introduced gecko 1.9 inherits from: nsisupports last changed in gecko 13.0 (firefox 13.0 / thunderbird 13.0 / seamonkey 2.10) method overview nsinavhistoryqueryoptions clone(); attributes attribute type
description applyoptionstocontainers boolean if true, the query options are only applied to the containers.
... constant value
description sort_by_none 0 for bookmark items, this constant means sort by the natural bookmark order.
... result type constants constant value
description results_as_uri 0 "uri" results, one for each uri visited in the range.
...And 2 more matches
nsIPromptService
constant value
description button_pos_0 1 this is usually the button used to confirm the prompt.
... constant value
description button_title_ok 1 these flags are used to select standard labels from the user's current locale.
... constant value
description button_pos_0_default 0 button_pos_1_default 16777216 button_pos_2_default 33554432 button_delay_enable button_delay_enable causes the buttons to be initially disabled.
...And 2 more matches
Deprecated tools - Firefox Developer Tools
description scratchpad provided an environment for experimenting with javascript code.
...
description webide allowed you to connect the firefox developer tools to remote browsers, such as firefox for android.
... canvas debugger bugzilla issue: bug 1403938 removed as of firefox 67
description canvas debugger allowed users to inspect the canvas element and see how frequently a given function is called.
...And 2 more matches
ContentIndex.add() - Web APIs
syntax contentindex.add(content
description).then(...); parameters content
description the item registered is an object containing the following data: id: a unique string identifier.
...
description: a string
description of the item.
... if the id, title,
description or url are missing, not of type string, or an empty string.
...And 2 more matches
FileSystemEntrySync - Web APIs
filesystementrysync moveto (in directoryentrysync parent, optional domstring newname) raises (fileexception); filesystementrysync copyto(in directoryentrysync parent, optional domstring newname) raises (fileexception); domstring tourl(); void remove() raises (fileexception); directoryentrysync getparent(); attributes attribute type
description filesystem readonly filesystemsync the file system where the entry resides.
...[ todo: specify what kind of metadata ] metadata getmetada () raises (fileexception); parameter none returns metadata exceptions this method can raise a fileexception with the following codes: exception
description not_found_err the entry does not exist.
... exceptions this method can raise a fileexception with the following codes: exception
description encoding_err the name supplied is invalid, because at least one of the characters is reserved or illegal.
...And 2 more matches
RTCPeerConnection.createOffer() - Web APIs
the return value is a promise which, when the offer has been created, is resolved with a rtcsession
description object containing the newly-created offer.
... successcallback an rtcsession
descriptioncallback which will be passed a single rtcsession
description object describing the newly-created offer.
... return value a promise whose fulfillment handler will receive an object conforming to the rtcsession
descriptioninit dictionary which contains the sdp describing the generated offer.
...And 2 more matches
Operable - Accessibility
understanding character key shortcuts note: also see the wcag
description for guideline 2.1 keyboard accessible: make all functionality available from a keyboard.
... understanding timeouts note: also see the wcag
description for guideline 2.2 enough time: provide users enough time to read and use content.
... understanding animations from interactions note: also see the wcag
description for guideline 2.3 seizures and physical reactions: do not design content in a way that is known to cause seizures or physical reactions.
...And 2 more matches
Text labels and names - Accessibility
the caption describes the purpose of the figure in the document, which may be different from a simple
description of a visual item, as provided by the alternative text.
... <figure> <img src="milkweed.jgp" alt="black and white close-up photo of milkweed flowers"> <figcaption>asclepias verticillata</figcaption> </figure> fieldset elements must be labeled fieldset elements must have a text
description, similar to other form elements.
... use a legend to label a fieldset when grouping a set of form elements together with a <fieldset> element, you should include a nested <legend> element inside it, containing a clear
description of the group.
...And 2 more matches
Standard metadata names - HTML: Hypertext Markup Language
description: a short and accurate summary of the content of the page.
... several browsers, like firefox and opera, use this as the default
description of bookmarked pages.
... values for the content of <meta name="viewport"> value possible subvalues
description width a positive integer number, or the text device-width defines the pixel width of the viewport that you want the web site to be rendered at.
...And 2 more matches
HTML documentation index - HTML: Hypertext Markup Language
56 <abbr>: the abbreviation element acronym, definitions, element, html, html text-level semantics, html:flow content, html:palpable content, html:phrasing content, reference, web, abbr, abbreviation, semantics the html abbreviation element (<abbr>) represents an abbreviation or acronym; the optional title attribute can provide an expansion or
description for the abbreviation.
... 87 <dd>: the
description details element definition,
description details, element, html, html grouping content, reference, web, dd,
description list, details the html <dd> element provides the
description, definition, or value for the preceding term (<dt>) in a
description list (<dl>).
... 94 <dl>: the
description list element element, html, html grouping content, html:flow content, html:palpable content, reference, web the html <dl> element represents a
description list.
...And 2 more matches
Deprecated and obsolete features - JavaScript
this does not affect their use in replacement strings: property
description $1-$9 parenthesized substring matches, if any.
... the following are now properties of regexp instances, no longer of the regexp object: property
description global whether or not to test the regular expression against all possible matches in a string, or only against the first.
... object property
description __count__ returns the number of enumerable properties directly on a user-defined object.
...And 2 more matches
The Essentials of an Extension - Archive of obsolete content
<em:name>xul school hello world</em:name> <em:
description>welcome to xul school!</em:
description> <em:version>0.1</em:version> <em:creator>appcoast</em:creator> <em:homepageurl>https://developer.mozilla.org/docs/xul_school</em:homepageurl> this is the data that is displayed before and after the extension is installed, that you can see in the add-ons manager.
... since extensions can be translated to multiple languages, it is often necessary to translate the extension's
description, or even its name.
... a localized
description and name can be added with the following code: <em:localized> <
description> <em:locale>es-es</em:locale> <em:name>xul school hola mundo</em:name> <em:
description>bienvenido a xul school!</em:
description> </
description> </em:localized> the es-es locale string indicates that this is the spanish (es) localization for spain (es).
... <em:targetapplication> <
description> <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id> <em:minversion>4.0</em:minversion> <em:maxversion>10.*</em:maxversion> </
description> </em:targetapplication> this node specifies the target application and target versions for the extension, specifically firefox, from version 4 up to version 10.
Supporting search suggestions in search plugins - Archive of obsolete content
for example: ["term 1", "term 2", "term 3", "term 4"]
descriptions this optional element is an array of
descriptions for each of the suggestions in thecompletion list .
...
descriptions are not supported in firefox, and are ignored if any are specified.
... if you don't specify a query url, the default query is used based on the search described by the <url> element in the search plugin's xml
description.
... for example, if the search term is "fir", and you don't need to return
descriptions or alternate query urls, you might return the following json: ["fir", ["firefox", "first choice", "mozilla firefox"]] note that in this example, only the query string and completion array are specified, leaving out the optional elements.
Creating XPI Installer Modules - Archive of obsolete content
the xpi packaging scheme a complete
description of the new packaging scheme is beyond the scope of this article.
...what follows is a very brief overview of the design and a
description of what mozilla expects in installable packages.
...where before a single manifest.rdf file described the resources in an entire package directory or archive, now contents.rdf files can be used for as large or as small a part of your package
description as you want; you can use several contents.rdf files in your package to describe the various parts (e.g., one for the skin of your package, another for the content, and so on), or you can use a single one, as was common before.
...r to the barley package and can be edited for your own distribution: <?xml version="1.0"?> <rdf:rdf xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:chrome="http://www.mozilla.org/rdf/chrome#"> <!-- list all the packages being supplied --> <rdf:seq about="urn:mozilla:package:root"> <rdf:li resource="urn:mozilla:package:barley"/> </rdf:seq> <!-- package information --> <rdf:
description about="urn:mozilla:package:barley" chrome:displayname="barley grain" chrome:author="ian oeschger" chrome:name="barley"> </rdf:
description> </rdf:rdf> create a contents.rdf file like the one in the listing above and put it in the content/ subdirectory with the other package resources.
appendNotification - Archive of obsolete content
buttons - array of button
descriptions to appear on the notification.
... priority levels (defined as properties of notificationbox) : priority_info_low priority_info_medium priority_info_high priority_warning_low priority_warning_medium priority_warning_high priority_critical_low priority_critical_medium priority_critical_high priority_critical_block buttons : the buttons argument is an array of button
descriptions.
... each
description is an object with the following properties: accesskey - the accesskey to appear on the button callback - function to be called when the button is activated.
... this function is passed three arguments: the <notification> the button is associated with the button
description as passed to appendnotification.
SeaMonkey - making custom toolbar (SM ver. 1.x) - Archive of obsolete content
paste it into the new file: <?xml version="1.0" encoding="utf-8"?> <!doctype rdf:rdf> <rdf:rdf xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:chrome="http://www.mozilla.org/rdf/chrome#"> <rdf:seq rdf:about="urn:mozilla:package:root"> <rdf:li rdf:resource="urn:mozilla:package:custombutton"/> </rdf:seq> <rdf:
description rdf:about="urn:mozilla:package:custombutton" chrome:displayname="custom button" chrome:
description="my custom toolbar button" chrome:author="my name" chrome:name="custombutton" chrome:localeversion="1.8" chrome:skinversion="1.5" chrome:extension="true"/> <rdf:seq about="urn:mozilla:overlays"> <!-- browser --> <rdf:li> <rdf:seq about="chrome://naviga...
.../chatzilla.xul"> <rdf:li>chrome://custombutton/content/button.xul</rdf:li> </rdf:seq> </rdf:li> <!-- calendar --> <rdf:li> <rdf:seq about="chrome://calendar/content/calendar.xul"> <rdf:li>chrome://custombutton/content/button.xul</rdf:li> </rdf:seq> </rdf:li> </rdf:seq> </rdf:rdf> optionally customize the file by changing the displayname,
description and author attributes.
... use this name to replace the text custombutton, custom-button and custombutton in all four text files: button.css button.js button.xul contents.rdf in contents.rdf, also change the displayname,
description and author attributes.
... document in the same folder, pasting the following text within: <?xml version="1.0" encoding="utf-8"?> <!doctype rdf:rdf> <rdf:rdf xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:chrome="http://www.mozilla.org/rdf/chrome#"> <rdf:seq rdf:about="urn:mozilla:package:root"> <rdf:li rdf:resource="urn:mozilla:package:myapp"/> </rdf:seq> <rdf:
description rdf:about="urn:mozilla:package:myapp" chrome:displayname="myapp" chrome:
description="my first xul app" chrome:author="yours truly" chrome:name="myapp" chrome:localeversion="1.8" chrome:skinversion="1.5" chrome:extension="true"/> </rdf:rdf> replace the fields in bold with your xul file name and change the displayname,
description, and author attrib...
Stacks and Decks - Archive of obsolete content
for example, you could create an effect similar to the text-shadow property with the following: example 1 : source view <stack> <
description value="shadowed" style="padding-left: 1px; padding-top: 1px; font-size: 15pt"/> <
description value="shadowed" style="color: red; font-size: 15pt;"/> </stack> both
description elements create text with a size of 15 points.
...the second
description element is drawn in red so the effect is more visible.
...shadowing is very useful for creating the disabled appearance of buttons: example 2 : source view <stack style="background-color: #c0c0c0"> <
description value="disabled" style="color: white; padding-left: 1px; padding-top: 1px;"/> <
description value="disabled" style="color: grey;"/> </stack> this arrangement of text and shadow colors creates the disabled look under some platforms.
... example 3 : source view <deck selectedindex="2"> <
description value="this is the first page"/> <button label="this is the second page"/> <box> <
description value="this is the third page"/> <button label="this is also the third page"/> </box> </deck> three pages exist here, the default being the third one.
XUL controls - Archive of obsolete content
<datepicker type="popup" value="2008/08/24"/> datepicker reference <
description> the
description element is used for descriptive text.
... <
description> select a time for the event to start </
description> more information about the
description element.
...
description reference <groupbox> a groupbox displays a labelled box around other user interface controls.
... <splitter collapse="before"> <grippy/> </splitter> splitter reference related elements: grippy <tab>
description goes here.
menulist - Archive of obsolete content
attributes accesskey, crop, disableautoselect, disabled, editable, focused, image, label, oncommand, open, preference, readonly, sizetopopup, tabindex, value properties accessibletype, crop,
description, disableautoselect, disabled, editable, editor, image, inputfield, itemcount, label, menuboxobject, menupopup, open, selectedindex, selecteditem, tabindex, value methods appenditem, contains, getindexofitem, getitematindex, insertitemat, removeallitems, removeitemat, select examples <menulist> <menupopup> <menuitem label="option 1" value="1"/> <menuitem label="option 2" value=...
...
description type: string set to the
description of the currently selected menuitem.
... insertbefore(), isdefaultnamespace(), isequalnode, issamenode, issupported(), lookupnamespaceuri, lookupprefix, normalize(), queryselector(), queryselectorall(), removeattribute(), removeattributenode(), removeattributens(), removechild(), removeeventlistener(), replacechild(), setattribute(), setattributenode(), setattributenodens(), setattributens(), setuserdata appenditem( label, value,
description ) return type: element creates a new menuitem element and adds it to the end of the menulist.
... you may optionally set a value and
description.
notificationbox - Archive of obsolete content
buttons - array of button
descriptions to appear on the notification.
... priority levels (defined as properties of notificationbox) : priority_info_low priority_info_medium priority_info_high priority_warning_low priority_warning_medium priority_warning_high priority_critical_low priority_critical_medium priority_critical_high priority_critical_block buttons : the buttons argument is an array of button
descriptions.
... each
description is an object with the following properties: accesskey - the accesskey to appear on the button callback - function to be called when the button is activated.
... this function is passed three arguments: the <notification> the button is associated with the button
description as passed to appendnotification.
ant script to assemble an extension - Archive of obsolete content
this ant script helps to package an extension <?xml version="1.0"?> this build file was written by régis décamps <decamps@users.sf.net> <project name="blogmark" default="createxpi"> <property name="version" value="1.3-rc1"/> <property name="
description" value="new context-menu item to add the current page in your blogmarks"/> xpi file is created after "chrome/blogmark.jar" is created, which is then stuffed into "blogmark.xpi" <target name="createxpi" depends="createjar"
description="assemble the final build blogmark.xpi"> <zip destfile="blogmark-${version}.xpi"> <zipfileset dir="." includes="chrome/blogmark.jar" /> <zipfileset d...
...ir="." includes="install.rdf" /> </zip> </target> everything inside the chrome directory is zipped into chrome/blogmark.jar <target name="createjar" depends="templates"
description="assemble the jar"> <jar destfile="chrome/blogmark.jar"> <fileset dir="chrome/"> <include name="**/*"/> <exclude name="**/*~"/> <exclude name="**/*.tpl.*"/> <exclude name="blogmark.jar"/> </fileset> </jar> </target> <target name="templates"
description="generate files from templates."> <copy file="chrome/content/blogmark/contents.rdf.tpl.xml" ...
... tofile="chrome/content/blogmark/contents.rdf" overwrite="true"> <filterchain> <replacetokens> <token key="version" value="${version}"/> <token key="
description" value="${
description}"/> </replacetokens> </filterchain> </copy> <copy file="chrome/content/blogmark/about.xul.tpl.xml" tofile="chrome/content/blogmark/about.xul" overwrite="true"> <filterchain> <replacetokens> <token key="version" value="${version}"/> ...
... </filterchain> </copy> <copy file="install.rdf.tpl.xml" tofile="install.rdf" overwrite="true"> <filterchain> <replacetokens> <token key="version" value="${version}"/> <token key="
description" value="${
description}"/> </replacetokens> </filterchain> </copy> </target> </project> ...
External resources for plugin creation - Archive of obsolete content
framework: firebreath project home page project history
description (from the project creators): firebreath is a cross-platform browser plugin framework written in c++.
...project: nixysa project home page
description (from the home page): nixysa is a framework written in python to automatically generate glue code for npapi plugins (plugins for browsers such as google chrome or firefox), letting you easily expose c++ classes to javascript from a simple idl representation.
...project: juce project home page
description (from the home page): juce (jules' utility class extensions) is an all-encompassing c++ class library for developing cross-platform applications.
...project: qtbrowserplugin project home page
description (from the home page): the qtbrowserplugin solution makes it easy to write browser plugins that can be used in mozilla firefox, safari, opera, google chrome, qtwebkit and any other web browser that supports the "netscape plugin api", npapi articles, information, and tutorials npapi has been around a very long time, and there have been many attempts to distill down useful information on creating ...
Symbol - MDN Web Docs Glossary: Definitions of Web-related terms
symbol can have an optional
description, but for debugging purposes only.
...for example: // here are two symbols with the same
description: let sym1 = symbol("sym") let sym2 = symbol("sym") console.log(sym1 === sym2) // returns "false" // symbols are guaranteed to be unique.
... // even if we create many symbols with the same
description, // they are different values.
... let sym = symbol("sym") alert(sym.tostring()) // symbol(sym), now it works or you can use the symbol.
description property to get its
description: let _sym = symbol("sym"); alert(_sym.
description); // sym well-known symbols the symbol class has constants for so-called well-known symbols.
Graceful asynchronous programming with Promises - Learn web development
download our source files (coffee.jpg, tea.jpg, and
description.txt), or feel free to substitute your own.
...add the following below your previous code: let coffee = fetchanddecode('coffee.jpg', 'blob'); let tea = fetchanddecode('tea.jpg', 'blob'); let
description = fetchanddecode('
description.txt', 'text'); next, we will define a promise.all() block to run some code only when all three of the promises stored above have successfully fulfilled.
... to begin with, add a block with an empty executor inside the .then() call, like so: promise.all([coffee, tea,
description]).then(values => { }); you can see that it takes an array containing the promises as a parameter.
...the decoded response bodies), kind of like [coffee-results, tea-results,
description-results].
Handling common accessibility problems - Learn web development
this should contain a
description of the image that successfully conveys its meaning and content on the page, to be picked up by a screenreader and read out to the user.
... check out the
description of the accessibility problems on the results page (the icons you can click to see what problems are occuring where are rather useful).
... most common voiceover keyboard shortcuts keyboard shortcut
description vo + cursor keys move the vo cursor up, right, down, left.
... most common nvda keyboard shortcuts keyboard shortcut
description nvda + q turn nvda off again after you've started it.
Accessibility API cross-reference
s fill out events cross reference table use this info to expand mozilla's accessibility api coverage to include mac, so that we can start to freeze them talk about the fact that msaa uses one interface (iaccessible), wherease gnome accessibility uses a lot of different interfaces depending on the type of object go through the atk info and make sure it's up-to-date accessible roles
description & notes msaa role (role_system_*) java accessibility role gnome accessibility role (atk_role_*) mac os x accessibility role aria (role=*) html tagged pdf relevant xul for alerts, in java/gnome for any alert, in msaa if no other role applies.
... n/a <input type=color> a dialog for picking a file n/a file_chooser file_chooser n/a invoked with <input type=file> no explanation given n/a n/a invalid n/a contains accessible info, but its role is not known n/a n/a unknown accessible states and properties
description & notes msaa state (state_system_*) java accessibility state gnome accessibility state (atk_state_*) mac os x accessibility state aria state or property html attribute tagged pdf relevant xul used in aria to denote non-conformant user input n/a n/a invalid aria-invalid this window is currently the active window n/a ac...
... n/a n/a aria-describedby identifies the element that provides a detailed, extended
description for the object.
... unavailable enabled n/a aria-disabled=true disabled (boolean attribute) especially used for sliders and scrollbars n/a vertical vertical aria-orientation=vertical accessible events msaa event (event_object_*, event_system_*) java accessibility event gnome accessibility signals mac os x accessibility event
description & notes javascript relevant xul focus focus, focusin blur, focusout selection select state_change change (not sure if this is the same thing?) ...
Addon
elistener listener, in integer reason, in string appversion, in string platformversion) overview of optional methods void uninstall() void canceluninstall() boolean hasresource(in string path) nsiuri getresourceuri(in string path) void getdatadirectory(in datadirectorycallback callback) required properties attribute type
description appdisabled read only boolean true if this add-on cannot be used in the application based on version compatibility, dependencies, and blocklisting.
... optional properties attribute type
description abouturl read only string the url of the about dialog to display for this add-on.
...
description read only string the
description of the add-on.
... full
description read only string developercomments read only string eula read only string icon64url read only string supporturl read only string contributionurl read only string contributionamount read only string averagerating read only number reviewcount read only ...
CustomizableUI.jsm
the following properties are recognized: property
description type the type of area.
...before customizableui was introduced, then you have to make sure that in case of running on newer browsers, xul overlay does not contain
description of the button that you are creating with createwidget() method.
... properties for readability, the properties are split according to purpose: dynamic getters attribute type
description areas array always returns an up to date array of all the area ids that are currently registered with customizableui.
... area constants attribute type
description area_navbar string "nav-bar", a constant reference to the id of the navigation toolbar.
PerfMeasurement.jsm
variable type
description cpu_cycles uint64 the number of cpu cycles elapsed.
... variable type
description eventsmeasured eventmask a bit mask of the event types recorded; this can differ from the events requested if the platform doesn't support all of the event types you specified when creating the perfmeasurement object.
... constant value
description cpu_cycles 0x00000001 measure cpu cycles elapsed.
... constant value
description num_measurable_events 11 the number of types of events that can be measured.
Python binding for NSS
the exact error code, error
description, and often contextual error information will be present in the exception object.
...source readme into package long
description.
... error codes and
descriptions were updated from upstream nspr & nss.
... nsprerror now derived from standardexception, provides: errno (numeric error code) strerror (error
description associated with error code) error_message (optional detailed message) error_code (alias for errno) error_desc (alias for strerror) certverifyerror derived from nsprerror, extends with: usages (bitmask of returned usages) log (certverifylog object) expose error lookup to sibling ...
FC_GetInfo
syntax ck_rv fc_getinfo(ck_info_ptr pinfo); parameters fc_getinfo has one parameter: pinfo points to a ck_info structure
description fc_getinfo returns general information about the pkcs #11 library.
... library
description:
description of the library, "nss internal crypto services", padded with spaces to 32 characters and not null-terminated.
... examples note the use of the %.32s format string to print the manufacturerid and library
description members of the ck_info structure.
...c_getinfo as pfunctionlist->c_getinfo */ crv = pfunctionlist->c_getinfo(&info); assert(crv == ckr_ok); printf("general information about the pkcs #11 library:\n"); printf(" pkcs #11 version: %d.%d\n", (int)info.cryptokiversion.major, (int)info.cryptokiversion.minor); printf(" manufacturer id: %.32s\n", info.manufacturerid); printf(" flags: 0x%08lx\n", info.flags); printf(" library
description: %.32s\n", info.library
description); printf(" library version: %d.%d\n", (int)info.libraryversion.major, (int)info.libraryversion.minor); printf("\n"); see also nsc_getinfo ...
JS_AddArgumentFormatter
syntax jsbool js_addargumentformatter(jscontext *cx, const char *format, jsargumentformatter formatter); void js_removeargumentformatter(jscontext *cx, const char *format); name type
description cx jscontext * the context in which to install the formatter.
...
description js_addargumentformatter establishes formatter as the conversion function for format strings beginning with format in the context cx.
...callback syntax jsbool (*jsargumentformatter)(jscontext *cx, const char *format, jsbool fromjs, jsval **vpp, va_list *app); name type
description cx jscontext * the context in which the conversion is being performed.
... callback
description the conversion function should return true on success, and return false after reporting an error or detecting an already-reported error.
JS_AddFinalizeCallback
syntax bool js_addfinalizecallback(jsruntime *rt, jsfinalizecallback cb, void *data); // added in spidermonkey 38 (jsapi 32) void js_removefinalizecallback(jsruntime *rt, jsfinalizecallback cb); // added in spidermonkey 38 (jsapi 32) void js_setfinalizecallback(jsruntime *rt, jsfinalizecallback cb); // obsolete since jsapi 32 name type
description rt jsruntime * the jsruntime for which to set the finalization callback.
... callback syntax typedef enum jsfinalizestatus { jsfinalize_group_start, jsfinalize_group_end, jsfinalize_collection_end } jsfinalizestatus; typedef void (* jsfinalizecallback)(jsfreeop *fop, jsfinalizestatus status, bool iscompartment, void *data); name type
description fop jsfreeop * a pointer to an instance of jsfreeop.
...added in spidermonkey 38 name
description jsfinalize_group_start called when preparing to sweep a group of compartments, before anything has been swept.
...
description js_addfinalizecallback add a callback function which the garbage collector calls at several points during garbage collection.
JS_CompileUCFunctionForPrincipalsVersion
this article covers features introduced in spidermonkey 1.8.5 please provide a
description for this function.
... syntax jsfunction * js_compileucfunctionforprincipalsversion(jscontext *cx, jsobject *obj, jsprincipals *principals, const char *name, unsigned int nargs, const char **argnames, const jschar *chars, size_t length, const char *filename, unsigned int lineno, jsversion version); name type
description cx jscontext * the context.
... obj jsobject * principals jsprincipals * name const char * nargs unsigned int argnames const char ** chars const jschar * length size_t filename const char * lineno unsigned int version jsversion
description please provide a
description.
... see also please provide a
description.
JS_GetOwnPropertyDescriptor
get a detailed
description of that property.
...pertydescriptor> desc); bool js_getownpropertydescriptorbyid(jscontext *cx, js::handleobject obj, js::handleid id, js::mutablehandle<jspropertydescriptor> desc); bool js_getownucpropertydescriptor(jscontext *cx, js::handleobject obj, const char16_t *name, js::mutablehandle desc); // added in spidermonkey 45 name type
description cx jscontext * a context.
...if a property is found, *desc receives a
description of it.
...
description js_getownpropertydescriptor and js_getownpropertydescriptorbyid get a detailed
description of that property (returned in desc->obj).
JS_GetPropertyDescriptor
finds a specified property of an object and gets a detailed
description of that property.
... syntax bool js_getpropertydescriptor(jscontext *cx, js::handleobject obj, const char *name, js::mutablehandle<jspropertydescriptor> desc); // added in spidermonkey 31 bool js_getpropertydescriptorbyid(jscontext *cx, js::handleobject obj, js::handleid id, js::mutablehandle<jspropertydescriptor> desc); name type
description cx jscontext * a context.
...if a property is found, *desc receives a
description of it.
...
description js_getpropertydescriptor and js_getpropertydescriptorbyid find a specified property of an object and gets a detailed
description of that property on the prototype chain (returned in desc->obj).
How to build an XPCOM component in JavaScript
************************************************ class definition ***********************************************************/ //class constructor function helloworld() { // if you only need to access your component from javascript, uncomment the following line: //this.wrappedjsobject = this; } // class definition helloworld.prototype = { // properties required for xpcom registration: class
description: "my hello world javascript xpcom component", classid: components.id("{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"), contractid: "@dietrich.ganx4.com/helloworld;1", // [optional] custom factory (an object implementing nsifactory).
... category: "some-category", // optional, defaults to the object's class
description entry: "entry name", // optional, defaults to the object's contractid (unless 'service' is specified) value: "...", // optional, defaults to false.
...gher else var nsgetmodule = xpcomutils.generatensgetmodule(components); // firefox 3.x so the total simplified version of your component now looks like (of course documentation and comments aren't a bad thing, but as a template something smaller is nice to have): components.utils.import("resource://gre/modules/xpcomutils.jsm"); function helloworld() { } helloworld.prototype = { class
description: "my hello world javascript xpcom component", classid: components.id("{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"), contractid: "@dietrich.ganx4.com/helloworld;1", queryinterface: xpcomutils.generateqi([components.interfaces.nsihelloworld]), hello: function() { return "hello world!"; } }; var components = [helloworld]; if ("generatensgetfactory" in xpcomutils) var nsgetfactor...
...y = xpcomutils.generatensgetfactory(components); // firefox 4.0 and higher else var nsgetmodule = xpcomutils.generatensgetmodule(components); // firefox 3.x note: starting with firefox 4.0 you will need to declare your component in chrome.manifest; class
description and contractid properties on the other hand are no longer required.
imgIEncoder
in pruint8 data, in unsigned long length, in pruint32 width, in pruint32 height, in pruint32 stride, in pruint32 inputformat, in astring outputoptions); void startimageencode(in pruint32 width, in pruint32 height, in pruint32 inputformat, in astring outputoptions); constants possible values for input format (note that not all image formats support saving alpha channels): constant value
description input_format_rgb 0 input is rgb each pixel is represented by three bytes: r, g, and b (in that order, regardless of host endianness) input_format_rgba 1 input is rgb each pixel is represented by four bytes: r, g, and b (in that order, regardless of host endianness).
...length missing
description width width in pixels.
...frameformat missing
description frameoptions missing
description encodeclipboardimage() obsolete since gecko 1.9 (firefox 3) void encodeclipboardimage( in nsiclipboardimage aclipboardimage, out nsifile aimagefile ); parameters aclipboardimage missing
description aimagefile missing
description endimageencode() void endimageencode(); parameters none.
...length missing
description width width in pixels.
nsIAccessible
the following methods are intended for this nsiaccessible.actioncount, nsiaccessible.getactionname(), nsiaccessible.getaction
description() and nsiaccessible.doaction().
...
descriptions nsiaccessible.
description and nsiaccessible.help provides additional text information about accessible.
... getaction
description this method retrieves the
description of the accessible action at the given zero-based index.
...
description accessible
description -- long text associated with this node.
nsIAccessibleProvider
inherits from: nsisupports last changed in gecko 1.9 (firefox 3) attributes attribute type
description accessible nsiaccessible read only.
... constants common use constants constant value
description noaccessible 0 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.
... xul controls constants constant value
description xulalert 0x00001001 xulbutton 0x00001002 xulcheckbox 0x00001003 xulcolorpicker 0x00001004 xulcolorpickertile 0x00001005 xulcombobox 0x00001006 xuldropmarker 0x00001007 xulgroupbox 0x00001008 xulimage 0x00001009 xullink 0x0000100a xullistbox 0x0000100b xullistcell 0x00001026 xullisthead 0x00001024 xullistheader 0x00001025 xullistitem 0x0000100c xulmenubar 0x0000100d xulmenuitem 0x0000100e xulmenupopup 0x0000100f xulmenuseparator 0x00001010 xulpane 0x00001011 xulprogressmeter 0x00001012 xulscale 0x00001013 xulstatusbar 0x0...
... xultext 0x0000101a xultextbox 0x0000101b xulthumb 0x0000101c xultree 0x0000101d xultreecolumns 0x0000101e xultreecolumnitem 0x0000101f xultoolbar 0x00001020 xultoolbarseparator 0x00001021 xultooltip 0x00001022 xultoolbarbutton 0x00001023 xforms elements constants constant value
description xformscontainer 0x00002000 used for xforms elements that provide accessible object for itself as well for anonymous content.
nsIAccessibleText
g endoffset); void removeselection(in long selectionnum); void scrollsubstringto(in long startindex, in long endindex, in unsigned long scrolltype); void scrollsubstringtopoint(in long startindex, in long endindex, in unsigned long coordinatetype, in long x, in long y); void setselectionbounds(in long selectionnum, in long startoffset, in long endoffset); attributes attribute type
description caretoffset long the current current caret offset.
... constants text offset constants constant value
description text_offset_end_of_text -1 will be treated as the equal to the end of the text.
... text boundary constants constant value
description boundary_char 0 boundary_word_start 1 boundary_word_end 2 boundary_sentence_start 3 do not use in new code.
... constant value
description coord_type_screen 0 coord_type_window 1 methods addselection() void addselection( in long startoffset, in long endoffset ); parameters startoffset endoffset getattributerange() obsolete since gecko 1.9.1 (firefox 3.5 / thunderbird 3.0 / seamonkey 2.0) get the accessible and start/end offsets around the given offset.
nsICycleCollectorListener
1.0 66 introduced gecko 2.0 inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) the order of calls will be call to begin(); then for every node in the graph a call to noteobject() and calls to noteedge() for every edge starting at that node; then a call to begin
descriptions(); then for every black node in the cycle collector graph a call to either describerefcountedobject() or to describegcedobject(); and then a call to end().
...method overview void begin(); void begin
descriptions(); void describegcedobject(in unsigned long long aaddress, in boolean amarked); void describerefcountedobject(in unsigned long long aaddress, in unsigned long aknownedges, in unsigned long atotaledges); void end(); void noteedge(in unsigned long long afromaddress, in unsigned long long atoaddress, in string aedgename); void noteobject(in unsigned long long aaddress, in string aobject
description); methods begin() void begin(); parameters none.
... begin
descriptions() void begin
descriptions(); parameters none.
...noteedge() void noteedge( in unsigned long long afromaddress, in unsigned long long atoaddress, in string aedgename ); parameters afromaddress atoaddress aedgename noteobject() void noteobject( in unsigned long long aaddress, in string aobject
description ); parameters aaddress aobject
description ...
nsIDocShell
need a
description here ???
... void setcurrenturi(in nsiuri auri); void suspendrefreshuris(); void tabtotreeowner(in boolean forward, out boolean tookfocus); attributes attribute type
description allowauth boolean certain dochshells (like the message pane) should not throw up auth dialogs because it can act as a password trojan.
... constants constant value
description internal_load_flags_none 0x0 used as a placeholder when you don't want to explicitly specify flags.
... constant value
description kcharsetuninitialized 0 the character set has not yet been initialized.
nsIFilePicker
sifilepicker); method overview void appendfilter(in astring title, in astring filter); void appendfilters(in long filtermask); void init(in nsidomwindow parent, in astring title, in short mode); void open(in nsifilepickershowncallback afilepickershowncallback); short show(); obsolete since gecko 57.0 attributes attribute type
description addtorecentdocs boolean if true, the file is added to the operating system's "recent documents" list (if the operating system has one; nothing happens if there is no such concept on the user's platform).
... constant value
description modeopen 0 load a file.
... constant value
description returnok 0 the file picker dialog was closed by the user hitting 'ok' returncancel 1 the file picker dialog was closed by the user hitting 'cancel' returnreplace 2 the user chose an existing file and acknowledged that they want to overwrite the file filter constants these constants are used to create filters for commonly-used file types.
... constant value
description filterall 0x001 corresponds to the *.* filter for file extensions.
nsIMemoryReporter
attributes attribute type
description amount print64 the numeric value reported by the memory reporter, specified in the units indicated by the units attribute.
...
description autf8string a human-readable
description of this memory usage report.
... constant value
description kind_mapped 0 this is deprecated synonym for kind_nonheap.
... constant value
description units_bytes 0 the amount is specified as a number of bytes.
Building an Account Manager Extension
the
description and ...
... devmoaccountmanagerextension.prototype.class
description = "devmo account manager extension"; // ...
...ext/css"?> <page xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul" onload="parent.onpanelloaded('am-devmo-account.xul');"> <script type="application/javascript" src="chrome://messenger/content/accountmanager.js"/> <script type="application/javascript" src="chrome://example@mozilla.org/content/am-devmo-account.js"/> <dialogheader title="devmo example panel"/> <
description> this panel is only shown in imap accounts...
... </
description> <vbox flex = "1"/> </page> as with the xul page, the content of the property file relies on a very strict naming.
nsINavHistoryQuery
ount)] out long long folders); void gettransitions([optional] out unsigned long count, [retval,array,size_is(count)] out unsigned long transitions); void setfolders([const,array, size_is(foldercount)] in long long folders, in unsigned long foldercount); void settransitions([const,array, size_is(count)] in unsigned long transitions, in unsigned long count); attributes attribute type
description absolutebegintime prtime read only: retrieves the begin time value that the currently loaded reference points + offset resolve to.
... constants constant value
description time_relative_epoch 0 default value.
...void gettransitions( out unsigned long count, optional [retval,array,size_is(count)] out unsigned long transitions ); parameters count optional the number of transitions transitions missing
description settransitions() when the set of transitions is nonempty, results are limited to pages which have at least one visit for each of the transition types.
...void settransitions( [const,array, size_is(count)] in unsigned long transitions, in unsigned long count ); parameters transitions missing
description.
nsISelectionController
void wordmove(in boolean forward, in boolean extend); attributes attribute type
description caretvisible boolean this is true if the caret is enabled, visible, and currently blinking.
... constants selection constants constant gecko version
description 1.7 - 1.9 1.9.1 - 1.9.2 2.0 selection_none 0 selection_normal 1 selection_spellcheck 2 selection_ime_rawinput 4 selection_ime_selectedrawtext 8 selection_ime_convertedtext 16 selection_ime_selectedconvertedtext 32 selection_accessibility 64 for accessibility api usage.
... selection_on 2 selection_disabled 3 selection_attention 4 scroll constants constant value
description scroll_synchronous 1<<1 if set scrolls the selection into view before returning.
... exceptions thrown missing exception missing
description selectall() will select the whole page.
nsISocketTransport
unsigned long gettimeout(in unsigned long atype); boolean isalive(); void settimeout(in unsigned long atype, in unsigned long avalue); attributes attribute type
description connectionflags unsigned long a bitmask that can be used to modify underlying behavior of the socket connection.
... constants timeout type this constants are used by gettransport() and settransport() to specify socket timeouts constant value
description timeout_connect 0 connecting timeout.
... constant value
description status_resolving 0x804b0003 transport is resolving the host.
... status_connecting_to 0x804b0007 status_connected_to 0x804b0004 status_sending_to 0x804b0005 status_waiting_for 0x804b000a status_receiving_from 0x804b0006 connection flags values for the connectionflags attribute constant value
description bypass_cache 0 when making a new connection bypass_cache will force the necko dns cache entry to be refreshed with a new call to nspr if it is set before opening the new stream.
nsITelemetry
void seteventrecordingenabled(in acstring acategory, in boolean aenabled); jsval snapshotevents(in uint32_t adataset, [optional] in boolean aclear); void registerevents(in acstring acategory, in jsval aeventdata); void registerscalars(in acstring acategoryname, in jsval ascalardata); void clearevents(); test only attributes attribute type
description canrecordbase boolean a flag indicating if telemetry can record base data (fhr data).
... constants histogram types constant value
description histogram_exponential 0 buckets increase exponentially.
... scalar types constant value
description scalar_type_count 0 for storing a numeric value.
... dataset types constant value
description dataset_release_channel_optout 0 the basic dataset that is on-by-default on all channels.
nsIWindowsRegKey
void startwatching(in boolean recurse); void stopwatching(); void writebinaryvalue(in astring name, in acstring data); void writeint64value(in astring name, in unsigned long long data); void writeintvalue(in astring name, in unsigned long data); void writestringvalue(in astring name, in astring data); attributes attribute type
description childcount unsigned long this attribute returns the number of child keys.
... constant value
description root_key_classes_root 0x80000000 root_key_current_user 0x80000001 root_key_local_machine 0x80000002 access constants values for the mode parameter passed to the open() and create() methods.
... constant value
description access_basic 0x00020000 access_query_value 0x00000001 access_set_value 0x00000002 access_create_sub_key 0x00000004 access_enumerate_sub_keys 0x00000008 access_notify 0x00000010 access_read access_basic | access_query_value | access_enumerate_sub_keys | access_notify access_write access_basic | access_set_value | access_create_sub_key access_all access_read | access_write wow64_32 0x00000200 ...
... constant value
description type_none 0 reg_none type_string 1 reg_sz type_binary 3 reg_binary type_int 4 reg_dword type_int64 11 reg_qword methods close() this method closes the key.
Theme Packaging
install.rdf your install.rdf manifest will look something like this: <?xml version="1.0"?> <rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <
description about="urn:mozilla:install-manifest"> <em:type>4</em:type> more properties </
description> </rdf> required install.rdf properties your install.rdf file must have the following properties.
... see the install.rdf reference for more information: em:id em:version em:type em:targetapplication em:name em:internalname optional install.rdf properties em:
description em:creator em:contributor em:homepageurl em:updateurl note that if your theme will be made available on the https://addons.mozilla.org website, it may not include an updateurl.
... sample install.rdf file <?xml version="1.0"?> <rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <
description about="urn:mozilla:install-manifest"> <em:id>{18b64b56-d42f-428d-a88c-baa413bc413f}</em:id> <em:version>1.0</em:version> <em:type>4</em:type> <!-- target application this extension can install into, with minimum and maximum supported versions.
... --> <em:targetapplication> <
description> <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id> <em:minversion>0.8</em:minversion> <em:maxversion>0.9</em:maxversion> </
description> </em:targetapplication> <!-- front end metadata --> <em:name>new theme 1</em:name> <em:
description>a test theme for thunderbird</em:
description> <em:creator>ben goodger</em:creator> <em:contributor>john doe</em:contributor> <em:homepageurl>http://www.bengoodger.com/</em:homepageurl> <!-- front end integration hooks (used by theme manager)--> <em:internalname>newtheme1</em:internalname> </
description> </rdf> the following are some common target application guids that you can use in your targetapplication properties: thunderbird {3550f703-e58...
ArrayType
properties property type
description elementtype ctype the data type of the elements in an array type.
... property type
description name string the type's name.
... arraytype cdata properties property type
description length number the length of the array.
... properties inherited from cdata property type
description constructor ctype the data type of the cdata object, as a ctype.
PointerType
examples creating a type "pointer to 32-bit integer" looks like this: var intptrtype = new ctypes.pointertype(ctypes.int32_t); properties property type
description targettype ctype the type of object the pointer points to.
... property type
description name string the type's name.
... pointertype cdata properties property type
description contents cdata reading this property returns a cdata object referring to the pointed-to contents of the object.
... properties inherited from cdata property type
description constructor ctype the data type of the cdata object, as a ctype.
Constants - Plugins
error codes code value
description nperr_no_error 0 no errors occurred.
... result codes constant value
description npres_done 0 (most common): completed normally; all data was sent to the instance.
... plug-in version constants constant value
description np_version_major 0 major version number; changes with major code release number.
... version feature constants npvers constant: version feature information value
description npvers_has_streamoutput 8 streaming data.
Network request details - Firefox Developer Tools
the screenshots and
descriptions in this section reflect firefox 78.
...(see referrer-policy for a
description of possible values) blocking: if the request is to a site that is associated with a known tracker, an icon and a message are shown; otherwise, this field is not shown.
... request timing the request timing section breaks a network request down into the following subset of the stages defined in the http archive specification: name
description blocked time spent in a queue waiting for a network connection.
... the header takes a series of
descriptions and durations, which can be anything you like.
DirectoryEntrySync - Web APIs
parameter none exceptions this method can raise a fileexception with the following codes: exception
description not_found_err the directory does not exist.
... exceptions this method can raise a fileexception with the following codes: exception
description encoding_err the path supplied is invalid.
... exceptions this method can raise a fileexception with the following codes: exception
description encoding_err the path supplied is invalid.
... void removerecursively ( ) raises (fileexception); parameter none returns void exceptions this method can raise a fileexception with the following codes: exception
description not_found_err the target directory does not exist.
IDBFactorySync - Web APIs
method overview idbdatabasesync open (in domstring name, in domstring
description, in optional boolean modifydatabase) raises (idbdatabaseexception); methods open() opens and returns a connection to a database.
...if there is already a database with the specified name, it uses that one; otherwise, it creates the database using the specified name and
description.
... idbdatabasesync open ( in domstring name, in domstring
description ) raises (idbdatabaseexception); parameters name the name for the database.
...
description the
description for the database.
RTCConfiguration - Web APIs
you may find in some cases that connections can be established more quickly by allowing the ice agent to start fetching ice candidates before you start trying to connect, so that they're already available for inspection when rtcpeerconnection.setlocal
description() is called.
... constant
description "balanced" the ice agent initially creates one rtcdtlstransport for each type of content added: audio, video, and data channels.
... constant
description "all" all ice candidates will be considered.
... constant
description "negotiate" instructs the ice agent to gather both rtp and rtcp candidates.
RTCPeerConnection.createAnswer() - Web APIs
successcallback an rtcsession
descriptioncallback which will be passed a single rtcsession
description object describing the newly-created answer.
... return value a promise whose fulfillment handler is called with an object conforming to the rtcsession
descriptioninit dictionary which contains the sdp answer to be delivered to the other peer.
...the contents of the object being passed to the sendtoserver() function, along with everything else in the promise fulfillment handler, depend entirely on your design pc.createanswer().then(function(answer) { return pc.setlocal
description(answer); }) .then(function() { // send the answer to the remote peer through the signaling server.
...in our promise handler, the returned answer is set as the
description of the local end of the connection by calling setlocal
description().
RTCPeerConnection: negotiationneeded event - Web APIs
see signaling transaction flow in signaling and video calling for a
description of the signaling process that begins with a negotiationneeded event.
... pc.addeventlistener("negotiationneeded", ev => { pc.createoffer() .then(offer => return pc.setlocal
description(offer)) .then(() => sendsignalingmessage({ type: "video-offer", sdp: pc.local
description })) .catch(err => { /* handle error */ ); }, false); after creating the offer, the local end is configured by calling rtcpeerconnection.setlocal
description(); then a signaling message is created and sent to the remote peer through the signaling server, to share that offer with the other peer.
... the other peer should recognize this message and follow up by creating its own rtcpeerconnection, setting the remote
description with setremote
description(), and then creating an answer to send back to the offering peer.
... you can also set an event handler for the negotiationneeded event by assigning the event handler function to the rtcpeerconnection.onnegotiationneeded property: pc.onnegotiationneeded = ev => { pc.createoffer() .then(offer => return pc.setlocal
description(offer)) .then(() => sendsignalingmessage({ type: "video-offer", sdp: pc.local
description })) .catch(err => { /* handle error */ ); }; for a more detailed example, see starting negotiation in signaling and video calling.
ARIA: img role - Accessibility
<div role="img" aria-label="
description of the overall image"> <img src="graphic1.png" alt=""> <img src="graphic2.png"> </div>
description any set of content that should be consumed as a single image (which could include images, video, audio, code snippets, emojis, or other content) can be identified using role="img".
... therefore, provide a comprehensive overall descriptive alt text for image, either in the surrounding text, or by using an aria-label attribute, with optional alt attributes for search engines or sighted users to be written to the page should an image fail: <div role="img" aria-label="
description of the overall image"> <img src="graphic1.png" alt=""> <img src="graphic2.png"> </div> if you wish to add a caption or label to your image that is visible on the page, you can do using: aria-labelledby when the text is a concise label.
... aria-describedby when the text is a longer
description.
...this will cause screen readers to just consider it as a single entity and describe it using the label, rather than trying to read out all the child nodes: <svg role="img" aria-label="
description of your svg image"> <!-- contents of the svg image --> </svg> using role="img" to confer meaning that is obscured or implied in certain cases, assistive technology users won't be able to get the meaning of content expressed in certain ways, through certain media, or implied in certain ways.
Implementing a Microsoft Active Accessibility (MSAA) Server - Accessibility
[important] get_acc
description: get a long
description of the current iaccessible.
... get_accdefaultaction: get a
description or name of the default action for this component, such as "jump" for links.
...portant] event_object_selection [important] event_object_selectionadd [important for multiple selection] event_object_selectionremove [important for multiple selection] event_object_selectionwithin [important for multiple selection] event_object_statechange [important for checkboxes and radio buttons] event_object_locationchange event_object_namechange event_object_
descriptionchange event_object_valuechange [important for sliders and progress meters] event_object_parentchange event_object_helpchange event_object_defactionchange event_object_acceleratorchange msaa states cheat sheet for information on what each state does, see the msdn state constants page.
...don't use accessible
description unless you really do have a long
description for the object you need to expose -- most assistive technology makes little use of it.
Understandable - Accessibility
your site should provide a glossary that contains definitions of such words/terms that you can then link to when they appear, or at the very least provide definitions somewhere in the surrounding text, or in a
description list at the bottom of the page.
... see video and audio content, and pronunciation guide for english dictionary note: also see the wcag
description for guideline 3.1 readable: make text content readable and understandable.
... note: also see the wcag
description for guideline 3.2 predictable: make web pages appear and operate in predictable ways.
... note: also see the wcag
description for guideline 3.3 input assistance: help users avoid and correct mistakes.
CSS values and units - CSS: Cascading Style Sheets
angle units angle values are represented by the type <angle> and accept the following values: unit name
description deg degrees there are 360 degrees in a full circle.
... unit name
description s seconds ms milliseconds there are 1,000 milliseconds in a second.
... unit name
description hz hertz represents the number of occurrences per second.
...it accepts the following values: unit
description dpi dots per inch.
<abbr>: The Abbreviation element - HTML: Hypertext Markup Language
the html abbreviation element (<abbr>) represents an abbreviation or acronym; the optional title attribute can provide an expansion or
description for the abbreviation.
... if present, title must contain this full
description and nothing else.
...the title attribute has a specific semantic meaning when used with the <abbr> element; it must contain a full human-readable
description or expansion of the abbreviation.
... examples marking up an abbreviation semantically to mark up an abbreviation without providing an expansion or
description, simply use <abbr> without any attributes, as seen in this example.
Microformats - HTML: Hypertext Markup Language
rd"> <img class="u-photo" src="http://example.org/photo.png" alt="" /> <a class="p-name u-url" href="http://example.org">joe bloggs</a> <a class="u-email" href="mailto:joebloggs@example.com">joebloggs@example.com</a>, <span class="p-street-address">17 austerstræti</span> <span class="p-locality">reykjavík</span> <span class="p-country-name">iceland</span> </p> property
description p-name the full/formatted name of the person or organization.
...developer</a> on <time class="dt-published" datetime="2013-06-13 12:00:00">13<sup>th</sup> june 2013</time></p> <p class="p-summary">in which i extoll the virtues of using microformats.</p> <div class="e-content"> <p>blah blah blah</p> </div> </article> properties property
description p-name entry name/title p-author who wrote the entry, optionally embedded h-card dt-published when the entry was published p-summary short entry summary e-content full content of the entry parsed reply h-entry example <div class="h-entry"> <p><span class="p-author h-card"> <a href="https://quickthoughts.jgregorymcverry.com/...
...developer</a> on <time class="dt-published" datetime="2013-06-13 12:00:00">13<sup>th</sup> june 2013</time> </p> <p class="p-summary">in which i extoll the virtues of using microformats.</p> <div class="e-content"> <p>blah blah blah</p> </div> </article> </div> properties property
description p-name name of the feed p-author author of the feed, optionally embed an h-card children nested h-entry objects representing the items of the feed h-event the h-event is for events on the web.
... <h1 class="p-name">microformats meetup</h1> <p>from <time class="dt-start" datetime="2013-06-30 12:00">30<sup>th</sup> june 2013, 12:00</time> to <time class="dt-end" datetime="2013-06-30 18:00">18:00</time> at <span class="p-location">some bar in sf</span></p> <p class="p-summary">get together and discuss all things microformats-related.</p> </div> properties property
description p-name event name (or title) p-summary short summary of the event dt-start datetime the event starts dt-end datetime the event ends p-location where the event takes place, optionally embedded h-card parsed h-event example <div class="h-event"> <h2 class="p-name">indieweb summit</h2> <time class="dt-start" datetime="2019-06-2...
Server-Timing - HTTP
the server-timing header communicates one or more metrics and
descriptions for a given request-response cycle.
... header type response header forbidden header name no syntax the syntax of the server-timing header allows you to communicate metrics in different ways: server metric name only, metric with value, metric with value and
description, and metric with
description.
... the specification advices that names and
descriptions should be kept as short as possible (use abbreviations and omit optional values where possible) to minimize the http overhead.
... // single metric without value server-timing: missedcache // single metric with value server-timing: cpu;dur=2.4 // single metric with
description and value server-timing: cache;desc="cache read";dur=23.2 // two metrics with value server-timing: db;dur=53, app;dur=47.2 // server-timing as trailer trailer: server-timing --- response body --- server-timing: total;dur=123.4 privacy and security the server-timing header may expose potentially sensitive application and infrastructure information.
Proxy Auto-Configuration (PAC) file - HTTP
description returns a string describing the configuration.
...
description true if and only if there is no domain name in the hostname (no dots).
...
description returns true if and only if the domain of hostname matches.
...
description is true if the hostname matches exactly the specified hostname, or if there is no domain name part in the hostname, but the unqualified hostname matches.
JavaScript data types and data structures - JavaScript
data property associates a key with a value, and has the following attributes: attributes of a data property attribute type
description default value [[value]] any javascript type the value retrieved by a get access of the property.
... false obsolete attributes (as of ecmascript 3, renamed in ecmascript 5) attribute type
description read-only boolean reversed state of the es5 [[writable]] attribute.
... accessor property associates a key with one of two accessor functions (get and set) to retrieve or store a value, and has the following attributes: attributes of an accessor property attribute type
description default value [[get]] function object or undefined the function is called with an empty argument list and retrieves the property value whenever a get access to the value is performed.
...the following table helps determine the equivalent c data types: type value range size in bytes
description web idl type equivalent c type int8array -128 to 127 1 8-bit two's complement signed integer byte int8_t uint8array 0 to 255 1 8-bit unsigned integer octet uint8_t uint8clampedarray 0 to 255 1 8-bit unsigned integer (clamped) octet uint8_t int16array -32768 to 32767 2 16-bit two's complement signed...
Numbers and dates - JavaScript
properties of number property
description number.max_value the largest representable number (±1.7976931348623157e+308) number.min_value the smallest representable number (±5e-324) number.nan special "not a number" value number.negative_infinity special negative infinite value; returned on overflow number.positive_infinity special positive infinite value; returned on overfl...
... number.epsilon difference between 1 and the smallest value greater than 1 that can be represented as a number (2.220446049250313e-16) number.min_safe_integer minimum safe integer in javascript (−253 + 1, or −9007199254740991) number.max_safe_integer maximum safe integer in javascript (+253 − 1, or +9007199254740991) methods of number method
description number.parsefloat() parses a string argument and returns a floating point number.
... methods of number.prototype method
description toexponential() returns a string representing the number in exponential notation.
... methods of math method
description abs() absolute value sin(), cos(), tan() standard trigonometric functions; with the argument in radians.
Regular expressions - JavaScript
the following pages provide lists of the different special characters that fit into each category, along with
descriptions and examples.
... methods that use regular expressions method
description exec() executes a search for a match in a string.
... object property or index
description in this example myarray the matched string and all remembered substrings.
... regular expression flags flag
description corresponding property g global search.
Symbol - JavaScript
description to create a new primitive symbol, you write symbol() with an optional string as its
description: let sym1 = symbol() let sym2 = symbol('foo') let sym3 = symbol('foo') the above code creates three new symbols.
... symbol.tostringtag a string value used for the default
description of an object.
... instance properties symbol.prototype.
description a read-only string containing the
description of the symbol.
... symbol.prototype.tostring() returns a string containing the
description of the symbol.
The "codecs" parameter in common media types - Web media technologies
av1 codec parameter string components component details p the one-digit profile number: av1 profile numbers profile number
description 0 "main" profile; supports yuv 4:2:0 or monochrome bitstreams with bit depth of 8 or 10 bits per component.
...both video and audio tracks can be described using the codecs parameter with the following mime types: base mime types supporting the iso bmff codecs parameter mime type
description audio/3gpp 3gp audio (rfc 3839: mime type registrations for 3rd generation partnership project (3gp) multimedia files) video/3gpp 3gp video (rfc 3839: mime type registrations for 3rd generation partnership project (3gp) multimedia files) audio/3gp2 3gp2 audio (rfc 4393: mime type registrations for 3gpp2 multimedia files) video/3gp2 3gp2 video (r...
...the table below shows some examples: examples of classic webm mime types with codecs parameter mime type
description video/webm;codecs="vp8" a webm video with vp8 video in it; no audio is specified.
... webm profile numbers profile
description 00 only 4:2:0 (chroma subsampled both horizontally and vertically).
Progressive web app structure - Progressive web apps (PWAs)
the folder structure looks like this: the html from the html point of view, the app shell is everything outside the content section: <!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>js13kgames a-frame entries</title> <meta name="
description" content="a list of a-frame entries submitted to the js13kgames 2017 competition, used as an example for the mdn articles about progressive web apps."> <meta name="author" content="end3r"> <meta name="theme-color" content="#b12a34"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta property="og:image" content="icons/icon-512.png"> <link rel="shortcut icon" href="favi...
...con.ico"> <link rel="stylesheet" href="style.css"> <link rel="manifest" href="js13kpwa.webmanifest"> <script src="data/games.js" defer></script> <script src="app.js" defer></script> </head> <body> <header> <p><a class="logo" href="http://js13kgames.com"><img src="img/js13kgames.png" alt="js13kgames"></a></p> </header> <main> <h1>js13kgames a-frame entries</h1> <p class="
description">list of games submitted to the <a href="http://js13kgames.com/aframe">a-frame category</a> in the <a href="http://2017.js13kgames.com">js13kgames 2017</a> competition.
...e.</p> <button id="notifications">request dummy notifications</button> <section id="content"> // content inserted in here </section> </main> <footer> <p>© js13kgames 2012-2018, created and maintained by <a href="http://end3r.com">andrzej mazur</a> from <a href="http://enclavegames.com">enclave games</a>.</p> </footer> </body> </html> the <head> section contains some basic info like title,
description and links to css, web manifest, games content js file, and app.js — that's where our javascript application is initialized.
... the <body> is split into the <header> (containing linked image), <main> page (with title,
description and place for a content), and <footer> (copy and links).
Structural overview of progressive web apps - Progressive web apps (PWAs)
<!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>js13kgames a-frame entries</title> <meta name="
description" content="a list of a-frame entries submitted to the js13kgames 2017 competition, used as an example for the mdn articles about progressive web apps."> <meta name="author" content="end3r"> <meta name="theme-color" content="#b12a34"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta property="og:image" content="icons/icon-512.png"> <link rel="shortcut icon" href="favi...
...con.ico"> <link rel="stylesheet" href="style.css"> <link rel="manifest" href="js13kpwa.webmanifest"> <script src="data/games.js" defer></script> <script src="app.js" defer></script> </head> <body> <header> <p><a class="logo" href="http://js13kgames.com"><img src="img/js13kgames.png" alt="js13kgames"></a></p> </header> <main> <h1>js13kgames a-frame entries</h1> <p class="
description">list of games submitted to the <a href="http://js13kgames.com/aframe"> a-frame category</a> in the <a href="http://2017.js13kgames.com">js13kgames 2017</a> competition.
...request dummy notifications</button> <section id="content"> // content inserted in here </section> </main> <footer> <p>© js13kgames 2012-2018, created and maintained by <a href="http://end3r.com"> andrzej mazur</a> from <a href="http://enclavegames.com">enclave games</a>.</p> </footer> </body> </html> the <head> section contains basic information about the app, including its title,
description, and the needed references to its css file, web manifest, the main application javascript file (app.js, in which the app is initialized) as well as an additional javascript code file.
...the app displays its title, a
description, and then a place for the app content to be shown (a <section> element with the id content.
Navigator.mozNotification - Archive of obsolete content
method overview notification createnotification(in domstring title, in domstring
description, in domstring iconurl optional); methods createnotification() creates and returns a notification object that can be used to display the specified message with an optional url.
... notification createnotification( in domstring title, in domstring
description, in domstring iconurloptional ); parameters title the notification title.
...
description the text to display in the notification.
Creating custom Firefox extensions with the Mozilla build system - Archive of obsolete content
topsrcdir = @top_srcdir@ srcdir = @srcdir@ vpath = @srcdir@ include $(depth)/config/autoconf.mk module = myextension dirs = public src xpi_name = myextension install_extension_id = myextension@mycompany.com xpi_pkgname = myextension dist_files = install.rdf include $(topsrcdir)/config/rules.mk a detailed
description of the make process, describing the key features of this makefile, can be found here.
...this file should be located in the main extension directory and look something like this: <?xml version="1.0"?> <rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <
description about="urn:mozilla:install-manifest"> <em:id>myextension@mycompany.com</em:id> <em:version>0.1</em:version> <em:targetapplication> <!-- firefox --> <
description> <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id> <em:minversion>1.0+</em:minversion> <em:maxversion>1.0+</em:maxversion> </
description> </em:targetapplication> <!-- fro...
...nt-end metadata --> <em:name>my first extension</em:name> <em:
description>just an example.</em:
description> <em:creator>allpeers.com</em:creator> <em:homepageurl>http://www.allpeers.com/blog/</em:homepageurl> </
description> </rdf> there's a detailed
description of the format of the install.rdf file.
Custom about: URLs - Archive of obsolete content
const {classes: cc, interfaces: ci, manager: cm, results: cr, utils: cu, constructor: cc} = components; cm.queryinterface(ci.nsicomponentregistrar); components.utils.import("resource://gre/modules/services.jsm"); // globals const aboutpage_
description = 'this is my custom about page'; const aboutpage_id = 'aa132730-2278-11e5-867f-0800200c9a66'; // make sure you generate a unique id from https://www.famkruithof.net/uuid/uuidgen const aboutpage_word = 'myaboutpage' const aboutpage_uri = 'data:text/html,hi this is the page that is shown when navigate to about:myaboutpage'; // const aboutpage_uri = 'chrome://myaboutaddon/content/index.html'; cla...
...ss aboutpage { static get classid() { return components.id(`{${aboutpage_id}}`); } static get class
description() { return aboutpage_
description; } static get contractid() { return `@mozilla.org/network/protocol/about;1?what=${aboutpage_word}`; } static get queryinterface() { return xpcomutils.generateqi([ci.nsiaboutmodule]); } constructor() { object.freeze(this); } geturiflags(auri) { return ci.nsiaboutmodule.allow_script; } newchannel(auri, asecurity_or_aloadinfo) { let channel; if (services.vc.compare(services.appinfo.version, '47.*') > 0) { const uri = services.io.newuri(aboutpage_uri, null, null); // greater than or equal to firefox48 so asecurity_or_aloadinfo is aloadinfo channel = services.io.newchannelfromuriwithloadinfo(uri, asecuri...
...i = auri; return channel; } } class factory { constructor(component) { this.component = component; this.register(); object.freeze(this); } createinstance(outer, iid) { if (outer) { throw cr.ns_error_no_aggregation; } return new this.component(); } register() { cm.registerfactory(this.component.classid, this.component.class
description, this.component.contractid, this); } unregister() { cm.unregisterfactory(this.component.prototype.classid, this); } } instantiation firefox 4+ now in the startup procedure of your bootstrapped addon make sure to do register the factory, for example: let factory; function startup(adata, areason) { // ...
Getting Started - Archive of obsolete content
<rdf:
description about="urn:mozilla:skin:myskin/1.0" chrome:displayname="my skin" chrome:accesskey="m" chrome:author="me" chrome:
description="this is my custom skin for mozilla" chrome:name="myskin/1.0" chrome:image="preview.png"> the blue areas are explained below.
... the
description shows up below the preview image.
...<rdf:
description chrome:skinversion="1.0" about="urn:mozilla:skin:myskin/1.0:communicator"/> <rdf:
description chrome:skinversion="1.0" about="urn:mozilla:skin:myskin/1.0:editor"/> <rdf:
description chrome:skinversion="1.0" about="urn:mozilla:skin:myskin/1.0:global"/> <rdf:
description chrome:skinversion="1.0" about="urn:mozilla:skin:myskin/1.0:messenger"/> <rdf:
description chrome:skinversion="1.0" about="urn:mozill...
contents.rdf - Archive of obsolete content
ext and paste it into a text file, then save that file as "contents.rdf": <?xml version="1.0"?> <rdf:rdf xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:chrome="http://www.mozilla.org/rdf/chrome#"> <!-- list all the skins being supplied by this theme --> <rdf:seq about="urn:mozilla:skin:root"> <rdf:li resource="urn:mozilla:skin:myskin/1.0" /> </rdf:seq> <rdf:
description about="urn:mozilla:skin:myskin/1.0" chrome:displayname="my skin" chrome:accesskey="m" chrome:author="me" chrome:
description="this is my custom skin for mozilla" chrome:name="myskin/1.0" chrome:image="preview.png"> <chrome:packages> <rdf:seq about="urn:mozilla:skin:myskin/1.0:packages"> <rdf:li resource="urn:mozilla:skin:myskin/1.0:...
...communicator"/> <rdf:li resource="urn:mozilla:skin:myskin/1.0:editor"/> <rdf:li resource="urn:mozilla:skin:myskin/1.0:global"/> <rdf:li resource="urn:mozilla:skin:myskin/1.0:messenger"/> <rdf:li resource="urn:mozilla:skin:myskin/1.0:navigator"/> </rdf:seq> </chrome:packages> </rdf:
description> <!-- version information.
...--> <rdf:
description chrome:skinversion="1.0" about="urn:mozilla:skin:myskin/1.0:communicator"/> <rdf:
description chrome:skinversion="1.0" about="urn:mozilla:skin:myskin/1.0:editor"/> <rdf:
description chrome:skinversion="1.0" about="urn:mozilla:skin:myskin/1.0:global"/> <rdf:
description chrome:skinversion="1.0" about="urn:mozilla:skin:myskin/1.0:messenger"/> <rdf:
description chrome:skinversion="1.0" about="urn:mozilla:skin:myskin/1.0:navigator"/> </rdf:rdf> ...
Menu - Archive of obsolete content
properties property type
description beforehide function a function invoked just before the menu is hidden.
...properties property type
description command function a function that will be called when the menuitem is clicked.
...they have the following properties: property
description node the dom node on which the menu is shown.
Sorting and filtering a custom tree view - Archive of obsolete content
n/javascript" src="sort.js"/> <hbox align="center" id="search-box"> <label accesskey="f" control="filter">filter</label> <textbox id="filter" oninput="inputfilter(event)" flex="1"/> <button id="clearfilter" oncommand="clearfilter()" label="clear" accesskey="c" disabled="true"/> </hbox> <tree id="tree" flex="1" persist="sortdirection sortresource" sortdirection="ascending" sortresource="
description"> <treecols> <treecol id="name" label="name" flex="1" persist="width ordinal hidden" onclick="sort(this)" class="sortdirectionindicator" sortdirection="ascending"/> <splitter class="tree-splitter"/> <treecol id="
description" label="
description" flex="1" persist="width ordinal hidden" onclick="sort(this)" class="sortdirectionindicator"/> <splitter class="tree-splitter"/> <treecol ...
...this way, we don't have to deal with //mapping between the two data.push({name: "leonardo",
description: "leader", weapon: "dual katanas"}); data.push({name: "michaelangelo",
description: "party dude", weapon: "nunchaku"}); data.push({name: "donatello",
description: "does machines", weapon: "bo"}); data.push({name: "raphael",
description: "cool, but rude", weapon: "sai"}); data.push({name: "splinter",
description: "rat", weapon: "walking stick"}); data.push({name: "shredder",
description:...
... "armored man", weapon: "blades"}); data.push({name: "casey jones",
description: "goalie masked man", weapon: "hockey stick"}); data.push({name: "april o'neil",
description: "journalist", weapon: "none"}); } if (filtertext == "") { //show all of them table = data; } else { //filter out the ones we want to display table = []; data.foreach(function(element) { //we'll match on every property for (var i in element) { if (prepareforcomparison(element[i]).indexof(filtertext) != -1) { table.push(element); break; } } }); } sort(); //restore scroll position if (topvisiblerow) { settopvisiblerow(topvisiblerow); } } //generic custom tree view stuff function treeview(table) { this.rowcount = table.length; this.getcelltext = function(row, col) { return ...
Attribute Substitution - Archive of obsolete content
it may be desirable to have longer text wrap by placing it as the content of a
description element.
...for instance, if the template contained: <
description><textnode value="?
description"/></
description> the resulting generated content might be: <
description>view from the top of the tower looking east of the doges palace</
description> note that the textnode has been replaced with the substituted value attribute.
...another possibilty is to rearrange the rdf such that the values, in this example, the
descriptions, are specified before the containers.
Sorting Results - Archive of obsolete content
for instance, if a list of photos was displayed in a two column tree showing the title and
description, you could sort by either title or
description.
...for instance, in the example the second column sorts by date, but if you were to use a different variable such as ?
description, the tree would sort by the value of the
description variable for each row.
...here is a sample of how to specify this in the rdf/xml datasource: <rdf:rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:r="http://www.xulplanet.com/rdf/" xmlns:nc="http://home.netscape.com/nc-rdf#"> <rdf:
description rdf:about="http://www.xulplanet.com/ndeakin/images/t/palace.jpg"> <r:date nc:parsetype="date">1125966767295<r:date> </rdf:
description> </rdf:rdf> you can also specify parsetype="integer" for numbers which will allow sorting numerically.
Localization - Archive of obsolete content
for japanese: <!entity findlabel "検索"> for example, the following text: <
description value="&findlabel;"/> is translated as: english version: <
description value="find"/> japanese version: <
description value="検索"/> you would declare an entity for each label or string of text that you use in your interface.
...ar> <toolbar id="findfiles-toolbar"> <toolbarbutton id="opensearch" label="&opencmdtoolbar.label;"/> <toolbarbutton id="savesearch" label="&savecmdtoolbar.label;"/> </toolbar> </toolbox> <tabbox> <tabs> <tab label="&searchtab;" selected="true"/> <tab label="&optionstab;"/> </tabs> <tabpanels> <tabpanel id="searchpanel" orient="vertical" context="editpopup"> <
description> &find
description; </
description> <spacer class="titlespace"/> <groupbox orient="horizontal"> <caption label="&findcriteria;"/> <menulist id="searchtype"> <menupopup> <menuitem label="&type.name;"/> <menuitem label="&type.size;"/> <menuitem label="&type.date;"/> </menupopup> </menulist> <spacer class="springspace"/> ...
... copycmd.label "copy"> <!entity pastecmd.label "paste"> <!entity cutcmd.accesskey "t"> <!entity copycmd.accesskey "c"> <!entity pastecmd.accesskey "p"> <!entity cutcmd.commandkey "x"> <!entity copycmd.commandkey "c"> <!entity pastecmd.commandkey "v"> <!entity opencmdtoolbar.label "open"> <!entity savecmdtoolbar.label "save"> <!entity searchtab "search"> <!entity optionstab "options"> <!entity find
description "enter your search criteria below and select the find button to begin the search."> <!entity findcriteria "search criteria"> <!entity type.name "name"> <!entity type.size "size"> <!entity type.date "date modified"> <!entity mode.is "is"> <!entity mode.isnot "is not"> <!entity casesensitive "case sensitive search"> <!entity matchfilename "match entire filename"> <!entity results.filename "filename...
RDF Datasources - Archive of obsolete content
resources added date http://home.netscape.com/nc-rdf#bookmarkadddate date the bookmark was added
description http://home.netscape.com/nc-rdf#
description bookmark
description last modified http://home.netscape.com/web-rdf#lastmodifieddate date of last modification last visited http://home.netscape.com/web-rdf#lastvisitdate date of last visit name http://home.netscape.com/nc-rdf#name bookmark name ...
...the attributes on the rule element will match if they match the attributes on an rdf
description element.
...you can see this attribute in the rdf file on each of the
description elements.
XUL accessibility guidelines - Archive of obsolete content
for labels that may wrap to a second line, do not use the
description element.
...users should be able to reference a complete
description of all major functionality of an application.
... human computer interaction checkpoint pass fail instruction help documentation is provided including a
description of keyboard shortcuts.
Accessibility/XUL Accessibility Reference - Archive of obsolete content
element enabled usage comments
description <
description value="<!-- text -->" /> <
description><!--label text--></
description> use for non-label text.
... although tutorials claim label and
description have the same underlying implementation,
description elements appear to not associate correctly with controls whereas labels do.
... firefox exposes the position, cardinality, and depth of each tree item through the accessible
description fixme: exact format?
dialogheader - Archive of obsolete content
the header may have a title and a
description.
... attributes crop,
description, title examples <?xml version="1.0"?> <?xml-stylesheet href="chrome://global/skin/global.css" type="text/css"?> <dialog id="donothing" title="dialog example" xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"> <dialogheader title="my dialog"
description="example dialog"/> <!-- other widgets --> </dialog> attributes crop type: one of the values below if the label of the element is too big to fit in its given space, the text will be cropped on the side specified by the crop attribute.
...for example, for a menuitem in a menu you can add the following css rule when you want to use the value none: menupopup > menuitem, menupopup > menu { max-width: none; }
description type: string descriptive text to appear in addition to the dialog title.
NPEvent - Archive of obsolete content
the event type may be any of the ollowing: graphicsexpose focusin focusout enternotify leavenotify motionnotify buttonpress buttonrelease keypress keyrelease
description microsoft windows
description the type npevent represents an event passed by npp_handleevent() to a windowless plug-in.
... mac os
description the npevent object represents an event passed by npp_handleevent() to a windowless plug-in.
... xwindows
description the npevent object represents an event passed by npp_handleevent() to a windowless plug-in.
title - Archive of obsolete content
netscape rss 0.91 revision 3 example <?xml version="1.0"?> <!doctype rss system "http://my.netscape.com/publish/formats/rss-0.91.dtd"> <rss version="0.91"> <channel> <title>advogato</title> <link>http://www.advogato.org/article/</link> <
description>recent advogato articles</
description> <language>en-us</language> <image> <link>http://www.advogato.org/</link> <title>advogato</title> <url>http://www.advogato.org/image/tinyadvogato.png</url> </image> <item> <title>why can i not get any tang?!</title> <link>http://www.
...advogato.org/article/10101.html</link> <
description>seriously.
... why can't i get any tang?</
description> </item> </channel> </rss> attributes none sub-elements none parent elements the table below shows a list of rss elements that this element can be a child of.
Building a Theme - Archive of obsolete content
create the install manifest open the file called install.rdf that you created at the top of your extension's folder hierarchy and put this inside: <?xml version="1.0"?> <rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <
description about="urn:mozilla:install-manifest"> <em:id>sample@example.net</em:id> <em:version>1.0</em:version> <em:type>4</em:type> <!-- target application this theme can install into, with minimum and maximum supported versions.
... --> <em:targetapplication> <
description> <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id> <em:minversion>29.0</em:minversion> <em:maxversion>39.*</em:maxversion> </
description> </em:targetapplication> <!-- front end metadata --> <em:name>my theme</em:name> <em:internalname>sample</em:internalname> <em:
description>a test extension</em:
description> <em:creator>your name here</em:creator> <em:homepageurl>http://www.example.com/</em:homepageurl> </
description> </rdf> sample@example.net - the id of the extension.
... note: your theme will be passed faster and downloaded more if you have a good
description and some screenshots of the theme in action.
contents.rdf - Archive of obsolete content
owing text and paste it into a text file, then save that file as "contents.rdf": <?xml version="1.0"?> <rdf:rdf xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:chrome="http://www.mozilla.org/rdf/chrome#"> <!-- list all the skins being supplied by this theme --> <rdf:seq about="urn:mozilla:skin:root"> <rdf:li resource="urn:mozilla:skin:my_theme"/> </rdf:seq> <rdf:
description about="urn:mozilla:skin:my_theme" chrome:displayname="my theme" chrome:accesskey="n" chrome:author="" chrome:authorurl="" chrome:
description="" chrome:name="my_theme" chrome:image="preview.png"> <chrome:packages> <rdf:seq about="urn:mozilla:skin:my_theme:packages"> <rdf:li resource="urn:mozilla:skin:my_theme:browser"/> ...
... <rdf:li resource="urn:mozilla:skin:my_theme:communicator"/> <rdf:li resource="urn:mozilla:skin:my_theme:global"/> <rdf:li resource="urn:mozilla:skin:my_theme:mozapps"/> <rdf:li resource="urn:mozilla:skin:my_theme:help"/> </rdf:seq> </chrome:packages> </rdf:
description> <!-- version information.
...--> <rdf:
description chrome:skinversion="1.5" about="urn:mozilla:skin:my_theme:browser"/> <rdf:
description chrome:skinversion="1.5" about="urn:mozilla:skin:my_theme:communicator"/> <rdf:
description chrome:skinversion="1.5" about="urn:mozilla:skin:my_theme:global"/> <rdf:
description chrome:skinversion="1.5" about="urn:mozilla:skin:my_theme:mozapps"/> <rdf:
description chrome:skinversion="1.5" about="urn:mozilla:skin:my_theme:help"/> </rdf:rdf> ...
JSException - Archive of obsolete content
summary the public class jsexception extends runtimeexception java.lang.object | +----java.lang.throwable | +----java.lang.exception | +----java.lang.runtimeexception | +----netscape.javascript.jsexception
description jsexception is an exception which is thrown when javascript code returns an error.
... declaration public object getwrappedexception()
description getwrappedexception() returns an object that represents the value that the javascript actually threw.
... declaration public int getwrappedexceptiontype()
description getwrappedexceptiontype() returns an int that matches one of the following static ints declared by the jsexception class: exception_type_empty exception_type_void exception_type_object exception_type_function exception_type_string exception_type_number exception_type_boolean ...
RDF in Fifty Words or Less - Archive of obsolete content
the resource
description framework, or "rdf", is really two things.
...the cgi script actually generatesserialized rdf, which is basically just a way of formatting a graph into xml: <rdf:rdf xmlns:rdf="http://www.w3.org/tr/wd-rdf-syntax#" xmlns:sm="http://www.mozilla.org/smart-mail/schema#"> <rdf:
description about="http://www.mozilla.org/smart-mail/get-mail.cgi?user=waterson&folder=inbox"> <sm:message id="4025293"> <sm:recipient> chris waterson "waterson@netscape.com" </sm:recipient> <sm:sender> aunt helga "helga@netcenter.net" </sm:sender> <sm:received-by>x-wing.mcom.com</sm:received-by> <sm:subject>great recipe for yam so...
...aterson@netscape.com" </sm:recipient> <sm:sender> sarah waterson "waterson.2@postbox.acs.ohio-state.edu" </sm:sender> <sm:received-by>x-wing.mcom.com</sm:received-by> <sm:subject>we won our ultimate game</sm:subject> <sm:body> http://www.mozilla.org/smart-mail/get-body.cgi?id=4025294 </sm:body> </sm:message> </rdf:
description> </rdf:rdf> upon receipt of the above monstrosity, the rdf engine folds the rdf into the graph at the appropriate place, and the tree control that actually implements the ui to the bookmarks is notified that it should begin drawing some icons for the latest message about yam soup from aunt helga.
Accessibility tree (AOM) - MDN Web Docs Glossary: Definitions of Web-related terms
for instance, a link with the text ‘read more’ will have ‘read more’ as its name (more on how names are computed in the accessible name and
description computation spec).
...
description how do we describe this element, if we want to add anything to the name?
... the
description of a table could explain what kind of info that table offers.
Accessible multimedia - Learn web development
audio
descriptions on occasions where there are visuals accompanying your audio, you'll need to provide audio
descriptions of some kind to describe that extra content.
...
descriptions — these include
descriptions for blind people who can't see the video, for example what the scene looks like.
...use the kind attribute to specify whether the cues are subtitles, captions, or
descriptions.
Video and audio content - Learn web development
captions synchronized transcriptions of dialog or
descriptions of significant sounds, to let people who can't hear the audio understand what is going on.
... timed
descriptions text which should be spoken by the media player in order to describe important visuals to blind or otherwise visually impaired users.
...use the kind attribute to specify whether the cues are subtitles, captions, or
descriptions.
Package management basics - Learn web development
description: a quick
description of the app's purpose.
...open it up and it should look something like this: { "name": "parcel-experiment", "version": "1.0.0", "
description": "a simple npm package to learn about using npm", "main": "index.js", "scripts": { "test": "echo \"error: no test specified\" && exit 1" }, "author": "chris mills", "license": "isc" } so this is the config file that defines your package.
... initialise a new project npm init yarn init as shown above, this will prompt and walk you through a series of questions to describe your project (name, license,
description and so on) then generate a package.json for you that contains meta information about your project and its dependencies.
A bird's-eye view of the Mozilla framework
a xul package consists of a xul
description of the ui widget cascading style sheets customizing appearance javascript services implementing the ui behavior a package (also known as chrome) is really just a bundling of a set of ui widgets and associated services implementing a particular application feature.
...the xpidl interface
description is independent of the programming language used to implement the object itself.
... let’s consider a resource
description framework (rdf) example, where rdf is a framework for describing and interchangingmetadata, that is, information about information.
Creating MozSearch plugins
the following xml is the bundled firefox 2 search plugin for searching using yahoo!: <searchplugin xmlns="http://www.mozilla.org/2006/browser/search/"> <shortname>yahoo</shortname> <
description>yahoo search</
description> <inputencoding>utf-8</inputencoding> <image width="16" height="16">data:image/x-icon;base64,r0lgodlheaaqajecap8aaaaaap///waaach5baeaaaialaaaaaaqabaaaaipli+py+0nogquybdened2khkffwuamezmpzsfmaihphrrguum/ft+uwaaow==</image> <url type="application/x-suggestions+json" method="get" template="http://ff.search.yahoo.com/gossip?output=fxjson&command={searchterms}" /> <u...
...firefox will use the above search engine
description to construct the following search url: http://search.yahoo.com/search?p=mozilla&ei=utf-8&fr=moz2 if the user clicks the magnifying glass icon in the search bar, or chooses the web search option in the tools menu when the search bar isn't visible, the browser will take them to http://search.yahoo.com/, the value of the <searchform> element.
... <searchplugin xmlns="http://www.mozilla.org/2006/browser/search/"> <shortname>mdc</shortname> <
description>mozilla developer center search</
description> <inputencoding>utf-8</inputencoding> <image width="16" height="16">data:image/x-icon;base64,ivborw0kggoaaaansuheugaaabaaaaaqcayaaaaf8%2f9haaaabgdbtueaak%2finwwk6qaaabl0rvh0u29mdhdhcmuaqwrvymugsw1hz2vszwfkexhjztwaaahwsurbvhjayvz%2f%2fz8djqaggjiqoe%2ffv2fv7oz8rays%2fn%2bvkfg%2fiynjfyd%2f1%2brvq7ffu3dpfpsbaaheahibcj85c8bn2nj4vwsdw%2f8zqlwkio8ccroqu0dxqlwrdshuwzbaaigjmtnnpgya9j8uqhfelwpxf2mideirksn9fwsjorkaeeam0dd4dzmaypi%2fg%2bqky4hh5waxgf8pdq0fgwj22d27cjadaaiirlmjo%2bmxa9r2kahvgba2wwx6b8w7od6ceqcggkcmcel8bgwxycbuigtdvkhdbia%2bcuotgaccued3tdqn75d4xmavcok...
Creating a spell check dictionary add-on
<?xml version="1.0"?> <rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <
description about="urn:mozilla:install-manifest"> <em:id>locale-code@dictionaries.addons.mozilla.org</em:id> <em:version>version number</em:version> <em:type>64</em:type> <em:unpack>true</em:unpack> <em:name>name</em:name> <!-- other install.rdf metadata such as em:localized, em:
description, em:creator, em:developer, em:translator, em:contributor or em:homepageurl ...
... --> <!-- firefox --> <em:targetapplication> <
description> <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id> <em:minversion>18.0a1</em:minversion> <em:maxversion>46.0</em:maxversion> </
description> </em:targetapplication> <!-- thunderbird --> <em:targetapplication> <
description> <em:id>{3550f703-e582-4d05-9a08-453d09bdfdc6}</em:id> <em:minversion>18.0a1</em:minversion> <em:maxversion>22.0</em:maxversion> </
description> </em:targetapplication> <!-- seamonkey --> <em:targetapplication> <
description> <em:id>{92650c4d-4b8e-4d2a-b7eb-24ecf4f6b63a}</em:id> <em:minversion>2.15a1</em:minversion> <em:maxversion>2.49</em:maxversion> </d...
...escription> </em:targetapplication> </
description> </rdf> there are some rules about how you should adapt the install.rdf file: if you are creating a new dictionary add-on, we recommend that the em:id consists of your locale code followed by @dictionaries.addons.mozilla.org, but if there is more than one dictionary for your language (for example the german "old spelling" versus "new spelling" dictionaries), you may need to choose another id, that follows the rules of em:id.
NSPR Contributor Guide
header file
descriptions.
... provide header file
descriptions that fully document your public typedefs, enums, macros and functions.
...source file
descriptions.
PR_Open
name value
description pr_rdonly 0x01 open for reading only.
... name value
description pr_irwxu 0700 read, write, execute/search by owner.
...
description pr_open creates a file descriptor (prfiledesc) for the file with the pathname name and sets the file status flags of the file descriptor according to the value of flags.
Function_Name
one-line
description of what the function does (more than just what it returns).
... syntax #include <headers.h> returntype function_name( paramtype paramname, paramtype paramname, ); parameters paramname sample: in pointer to a certcertdbhandle representing the certificate database to look in paramname sample: in pointer to an secitem whose type must be sidercertbuffer and whose data contains a der-encoded certificate
description long
description of this function, what it does, and why you would use it.
... returns full
description of the return value, for example: a pointer to a certcertificate representing the certificate in the database that matched the dercert, or null if none was found.
NSS Key Functions
description nss_init opens the certificate, key, and security module databases that you specify for use with nss.
...
description certificate and key structures are shared objects.
...the use of the word "destroy" in function names or in the
description of a function implies reference counting.
sslerr.html
ssl error codes sec error codes ssl error codes table 8.1 error codes defined in sslerr.h constant value
description ssl_error_export_only_server -12288 "unable to communicate securely.
... ssl_error_rx_unknown_record_type -12233 "ssl received a record with an unknown content type." ssl_error_rx_unknown_handshake -12232 "ssl received a handshake message with an unknown message type." ssl_error_rx_unknown_alert -12231 "ssl received an alert record with an unknown alert
description." received an alert report: all the error codes in the following block indicate that the local socket received an ssl3 or tls alert record from the remote peer, reporting some issue that it had with an ssl record or handshake message it received.
... ssl_error_decompression_failure -12177 "ssl received a compressed record that could not be decompressed." sec error codes table 8.2 security error codes defined in secerr.h constant value
description sec_error_io -8192 an i/o error occurred during authentication; or an error occurred during crypto operation (other than signature verification).
sslkey.html
description nss_init opens the certificate, key, and security module databases that you specify for use with nss.
...
description certificate and key structures are shared objects.
...the use of the word "destroy" in function names or in the
description of a function implies reference counting.
JS::AutoIdArray
syntax autoidarray(jscontext *cx, jsidarray *ida); name type
description cx jscontext * the context in which to add the root.
... methods method
description bool operator!() const return true if this has no owned array.
...
description js::autoidarray takes the ownership of jsidarray, and frees it in destructor by calling js_destroyidarray.
JS::HandleValueArray
ovaluevector& values); js::handlevaluearray(const js::autovaluearray<n>& values); js::handlevaluearray(const js::callargs& args); js::handlevaluearray::frommarkedlocation(size_t len, const js::value *elements); js::handlevaluearray::subarray(const js::handlevaluearray& values, size_t startindex, size_t len); js::handlevaluearray::empty(); name type
description value js::rootedvalue & an element of newly created 1-length array.
... methods method
description size_t length() const returns the length of the array.
...
description js::handlevaluearray is a handle to an array of rooted values.
JS::PersistentRooted
syntax js::persistentrooted<t> var; // added in spidermonkey 38 js::persistentrooted<t> var(cx); js::persistentrooted<t> var(cx, initial); js::persistentrooted<t> var(rt); js::persistentrooted<t> var(rt, initial); name type
description cx jscontext * the context to get the runtime in which to add the root rt jsruntime * the runtime in which to add the root.
... method
description void init(jscontext* cx) initialize with optional initial value (if not provided, it will be initialized with the initial value of the type).
... bool operator==(const t& other) const
description js::persistentrooted<t> declares a variable of type t whose value is always rooted.
JS::Rooted
syntax js::rooted<t> var(cx); js::rooted<t> var(cx, initial); js::rooted<t> var(rt); js::rooted<t> var(rt, initial); name type
description cx jscontext * the context in which to add the root.
... method
description t &get() returns ptr.
... bool operator==(const t &other) const
description js::rooted<t> declares a local variable of type t whose value is always rooted.
JS::SetLargeAllocationFailureCallback
syntax void js::setlargeallocationfailurecallback(jsruntime *rt, js::largeallocationfailurecallback afc, void *data); name type
description rt jsruntime * the jsruntime for which to set the gc callback.
...added in spidermonkey 38 callback syntax typedef void (* js::largeallocationfailurecallback)(void *data); name type
description data void * data parameter passed to js::setlargeallocationfailurecallback.
... added in spidermonkey 38
description if a large allocation fails when calling pod_{calloc,realloc}cangc, the js engine may call the large-allocation- failure callback, if set, to allow the embedding to flush caches, possibly perform shrinking gcs, etc.
JS::SetOutOfMemoryCallback
syntax void js::setoutofmemorycallback(jsruntime *rt, js::outofmemorycallback cb, void *data); name type
description rt jsruntime * the jsruntime for which to set the gc callback.
...added in spidermonkey 38 callback syntax typedef void (* outofmemorycallback)(jscontext *cx, void *data); name type
description data void * data parameter passed to js::setoutofmemorycallback.
... added in spidermonkey 38
description unlike the error reporter, which is only called if the exception for an oom bubbles up and is not caught, the js::outofmemorycallback is called immediately at the oom site to allow the embedding to capture the current state of heap allocation before anything is freed.
JS::SourceBufferHolder
constructor enum ownership { noownership, giveownership }; js::sourcebufferholder(const char16_t *data, size_t datalength, ownership ownership); name type
description data const char16_t * source buffer containing the script to compile.
... ownership ownership see
description.
...
description js::sourcebufferholder is the container class for passing in script source buffers to the js engine.
JSAutoByteString
syntax jsautobytestring str; jsautobytestring(jscontext *cx, jsstring *str); name type
description cx jscontext * the context in which to add the root.
... methods method
description void initbytes(char *bytes) take ownership of the given byte array.
...
description jsautobytestring takes the ownership of string and frees it in destructor.
JSErrorReport
syntax jserrorreport(); properties name type
description filename const char * indicates the source file or url that produced the error condition.
...
description jserrorreport describes a single error that occurs in the execution of script.
...macros name
description jsreport_is_warning(flags) returns true if flags has jsreport_warning.
JSFreeOp
syntax jsfreeop(jsruntime *rt); name type
description rt jsruntime * a runtime to store in this structure.
... methods method
description jsruntime *runtime() const returns a pointer to jsruntime passed to constructor.
...
description various finalization api takes not jscontext * but rather either jsfreeop structure or its library-private counterpart freeop.
JSObjectOps.getAttributes
syntax typedef jsbool (*jsattributesop)(jscontext *cx, jsobject *obj, jsid id, jsproperty *prop, unsigned int *attrsp); name type
description cx jscontext * pointer to the js context in which the property access is happening.
...see the
description section below.
...
description get or set attributes of the property obj[id].
JSObjectOps.getProperty
syntax typedef jsbool (*jspropertyidop)( jscontext *cx, jsobject *obj, jsid id, jsval *vp); name type
description cx jscontext * pointer to the js context in which the property access is happening.
...see the
description section below.
...
description get, set, or delete obj[id], returning js_false on error or exception, js_true on success.
JSPrincipals
properties name type
description refcount mozilla::atomic<int32_t> reference count.
...obsolete since jsapi 13 methods name
description void dump() this is not defined by the js engine but should be provided by the embedding.
... added in spidermonkey 17
description jsprincipals is the abstract base class of all principals objects, the objects that identify the source of a function or script and are used to determine its privileges.
JS_AddExternalStringFinalizer
syntax int js_addexternalstringfinalizer(jsstringfinalizeop finalizer); name type
description finalizer jsstringfinalizeop pointer to a callback function, described below.
... callback syntax typedef void (*jsstringfinalizeop)(jscontext *cx, jsstring *str); name type
description cx jscontext * pointer to a jscontext which the finalizer may use for certain very limited operations (not documented).
...
description add a finalizer for external strings created by js_newexternalstring using a type-code returned from this function, and that understands how to free or release the memory pointed at by js_getstringchars(str).
JS_BeginRequest
syntax void js_beginrequest(jscontext *cx); void js_endrequest(jscontext *cx); name type
description cx jscontext * the context in which the calling thread intends to call jsapi functions.
...
description when your multithreaded application wants to use a jscontext, it must use js_beginrequest and js_endrequest to bracket maximal non-blocking hunks of native code that call the jsapi.
...in this reference, the cx parameter of such functions is documented with the phrase “requires request”, like this: name type
description cx jscontext * the context to use.
JS_CheckAccess
syntax jsbool js_checkaccess(jscontext *cx, jsobject *obj, jsid id, jsaccessmode mode, jsval *vp, unsigned int *attrsp); name type
description cx jscontext * the context in which to perform the access check.
...
description js_checkaccess determines whether the property of obj given by id can be accessed by the code currently running in the context cx.
...it is one of the following values: value
description jsacc_proto check for permission to read to obj's prototype.
JS_CompareStrings
syntax bool js_comparestrings(jscontext *cx, jsstring *str1, jsstring *str2, int32_t *result); name type
description cx jscontext * the context to which both strings must belong.
...see
description for value of *result.
...
description js_comparestrings compares two js strings, str1 and str2.
JS_CompileFileHandleForPrincipals
this article covers features introduced in spidermonkey 1.8.5 please provide a
description of this function.
... syntax jsobject * js_compilefilehandleforprincipals(jscontext *cx, jsobject *obj, const char *filename, file *fh, jsprincipals *principals); name type
description cx jscontext * the context.
... obj jsobject * filename const char fh file * principals jsprincipals *
description please provide a
description.
JS_CompileFileHandleForPrincipalsVersion
this article covers features introduced in spidermonkey 1.8.5 please provide a
description for this function.
... syntax jsobject * js_compilefilehandleforprincipalsversion(jscontext *cx, jsobject *obj, const char *filename, file *fh, jsprincipals *principals, jsversion version); name type
description cx jscontext * the context.
... obj jsobject * filename const char fh file * principals jsprincipals * version jsversion
description please provide a
description.
JS_ConvertArguments
syntax bool js_convertarguments(jscontext *cx, const js::callargs &args, const char *format, ...); // added in spidermonkey 31 bool js_convertarguments(jscontext *cx, unsigned argc, jsval *argv, const char *format, ...); // obsolete since jsapi 30 name type
description cx jscontext * the context in which to perform any necessary conversions.
...(if conversion creates a new gc thing, the corresponding jsval is written back to argv, which is rooted.)
description js_convertarguments provides a convenient way to translate a series of js values into their corresponding js types with a single function call.
...format can contain one or more instances of the following characters, as appropriate: character c type
description b bool boolean c uint16_t ecma uint16_t, unicode character i int32_t ecma int32_t j int32_t ecma int32_t (used to be different, behaves like i now) obsolete since jsapi 28 u uint32_t ecma uint32_t d double ieee double i double integral ieee double s char * (c string) bug 60729...
JS_DecompileScriptObject
this article covers features introduced in spidermonkey 1.8.5 fixme: please provide a
description for this function.
... syntax jsstring * js_decompilescriptobject(jscontext *cx, jsobject *scriptobj, const char *name, unsigned int indent); name type
description cx jscontext * the context.
... scriptobj jsobject * name const char * indent unsigned int
description fixme: please provide a
description.
JS_DefineFunctions
name type
description cx jscontext * the context in which to define functions.
...added in spidermonkey 38 enum propertydefinitionbehavior { defineallproperties, onlydefinelateproperties, dontdefinelateproperties }; name
description defineallproperties define all properties regardless of their flags.
...
description js_definefunctions creates zero or more functions and makes them properties (methods) of a specified object, obj, as if by calling js_definefunction repeatedly.
JS_DefineOwnProperty
this article covers features introduced in spidermonkey 1.8.5 please provide a
description for this function.
... syntax bool js_defineownproperty(jscontext *cx, js::handleobject obj, js::handleid id, js::handlevalue descriptor, bool *bp); name type
description cx jscontext * the context.
...
description js_defineownproperty implements the ecmascript defined function object.defineproperty.
JS_DumpNamedRoots
syntax void js_dumpnamedroots(jsruntime *rt, void (*dump)(const char *name, void *rp, void *data), void *data); name type
description rt jsruntime * pointer to a jsruntime from which to dump named roots.
...
description each call to js_addnamedroot creates a record in a table of named roots maintained by the garbage collector.
...when js_dumpnamedroots calls it, it passes three arguments: argument type
description name const char * the name of the named root.
JS_EnumerateDiagnosticMemoryRegions
syntax void js_enumeratediagnosticmemoryregions(jsenumeratediagnosticmemorycallback callback); name type
description callback jsenumeratediagnosticmemorycallback pointer to the new callback function to use.
... callback syntax typedef bool (* jsenumeratediagnosticmemorycallback)(void *ptr, size_t length); name type
description ptr void * pointer to the allocated memory.
...
description js_enumeratediagnosticmemoryregions enumerates memory regions that contain diagnostic information intended to be included in crash report minidumps.
JS_GetCompartmentPrivate
this article covers features introduced in spidermonkey 1.8.5 please provide a
description for this function.
... syntax void js_setcompartmentprivate(jscompartment *compartment, void *data); void * js_getcompartmentprivate(jscompartment *compartment); name type
description compartment jscompartment * any compartment data void * (in js_setcompartmentprivate) pointer to application-defined data to be associated with the compartment.
...
description each jscompartment has a field of type void * which the application may use for any purpose.
JS_GetGCParameter
syntax uint32_t js_getgcparameter(jsruntime *rt, jsgcparamkey key); void js_setgcparameter(jsruntime *rt, jsgcparamkey key, uint32_t value); uint32_t js_getgcparameterforthread(jscontext *cx, jsgcparamkey key); // added in spidermonkeysidebar 17 void js_setgcparameterforthread(jscontext *cx, jsgcparamkey key, uint32_t value); // added in spidermonkeysidebar 17 name type
description rt jsruntime * the runtime to configure.
...tion_enabled, jsgc_allocation_threshold_factor, jsgc_allocation_threshold_factor_avoid_interrupt, jsgc_nursery_free_threshold_for_idle_collection, jsgc_pretenure_threshold, jsgc_pretenure_group_threshold, jsgc_nursery_free_threshold_for_idle_collection_percent, jsgc_min_nursery_bytes, jsgc_min_last_ditch_gc_period, } jsgcparamkey; value (c++/js shell)
description jsgc_max_bytes / "maxbytes" maximum nominal heap before last ditch gc.
...
description js_getgcparameter returns the current parameter of the garbage collection.
JS_GetLocaleCallbacks
syntax jslocalecallbacks * js_getlocalecallbacks(jsruntime *rt); void js_setlocalecallbacks(jsruntime *rt, jslocalecallbacks *callbacks); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...rc, js::mutablehandlevalue rval); typedef bool (* jslocaletolowercase)(jscontext *cx, js::handlestring src, js::mutablehandlevalue rval); typedef bool (* jslocalecompare)(jscontext *cx, js::handlestring src1, js::handlestring src2, js::mutablehandlevalue rval); typedef bool (* jslocaletounicode)(jscontext *cx, const char *src, js::mutablehandlevalue rval); type
description jslocaletouppercase implementation of string.prototype.tolocaleuppercase() function.
...
description js_setlocalecallbacks establishes locale callbacks.
JS_GetSecurityCallbacks
const jssecuritycallbacks * js_getsecuritycallbacks(jsruntime *rt); /* obsolete since jsapi 13 */ jssecuritycallbacks * js_setcontextsecuritycallbacks(jscontext *cx, jssecuritycallbacks *callbacks); jssecuritycallbacks * js_getruntimesecuritycallbacks(jsruntime *rt); jssecuritycallbacks * js_setruntimesecuritycallbacks(jsruntime *rt, jssecuritycallbacks *callbacks); name type
description rt jsruntime * a runtime to get/set the security callbacks.
...ontentsecuritypolicyallows; // added in spidermonkey 1.8.5 jssubsumesop subsumes; // added in spidermonkey 31 jscheckaccessop checkobjectaccess; // obsolete since jsapi 29 jsprincipalstranscoder principalstranscoder; // obsolete since jsapi 13 jsobjectprincipalsfinder findobjectprincipals; // obsolete since jsapi 13 }; name type
description contentsecuritypolicyallows jscspevalchecker a pointer to the function which checks if a csp instance wants to disable eval() and friends.
...
description js_setsecuritycallbacks sets the runtime's security callbacks to callbacks.
JS_GetTypeName
returns a pointer to the string literal
description of a specified js data type.
... syntax const char * js_gettypename(jscontext *cx, jstype type); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_gettypename returns a pointer to a string literal
description of a specified js data type, type.
JS_IterateCompartments
syntax void js_iteratecompartments(jsruntime *rt, void *data, jsiteratecompartmentcallback compartmentcallback); name type
description cx jsruntime * the runtime of the compartments to iterate over.
... callback function typedef void (*jsiteratecompartmentcallback)(jsruntime *rt, void *data, jscompartment *compartment); name type
description cx jsruntime * the runtime of the compartments.
...
description js_iteratecompartments calls compartmentcallback on every compartment.
JS_NewRegExpObject
object obj, const char16_t *chars, size_t length, unsigned flags); jsobject * js_newregexpobjectnostatics(jscontext *cx, char *bytes, size_t length, unsigned flags); jsobject * js_newucregexpobjectnostatics(jscontext *cx, char16_t *chars, size_t length, unsigned flags); name type
description cx jscontext * the context in which to create the new object.
... flags name
description regexp constructor flag jsreg_fold fold uppercase to lowercase.
... y
description js_newregexpobject and js_newucregexpobject create a new regexp instance.
JS_ReportErrorNumber
jserrorcallback errorcallback, void *userref, const unsigned errornumber, ...); void js_reporterrornumberucarray(jscontext *cx, jserrorcallback errorcallback, void *userref, const unsigned errornumber, const char16_t **args); // added in spidermonkey 19 name type
description cx jscontext * the context in which to report the error.
... callback syntax typedef const jserrorformatstring * (* jserrorcallback)(void *userref, const unsigned errornumber); name type
description userref void * the userref pointer that was passed to the reporterrornumber api.
...
description these functions create a jserrorreport, populate it with an error message obtained from the given jserrorcallback, and either report it to the current error reporter callback or create an error object and set it as the pending exception.
JS_SetBranchCallback
syntax jsbranchcallback js_setbranchcallback(jscontext *cx, jsbranchcallback cb); name type
description cx jscontext * the context to hook.
... callback syntax jsbool (*jsbranchcallback)(jscontext *cx, jsscript *script); name type
description cx jscontext * pointer to a jscontext which the callback may use to call into jsapi functions.
...
description js_setbranchcallback specifies a callback function that is automatically called when a script branches backward during execution, when a function returns, and at the end of the script.
JS_SetCompartmentNameCallback
syntax void js_setcompartmentnamecallback(jsruntime *rt, jscompartmentnamecallback callback); name type
description cx jsruntime * the runtime to set the callback function.
... callback function typedef void (* jscompartmentnamecallback)(jsruntime *rt, jscompartment *compartment, char *buf, size_t bufsize); name type
description cx jsruntime * the runtime of the compartments.
...
description js_setcompartmentnamecallback sets callback function which will be called to name the compartment.
JS_SetContextCallback
syntax void js_setcontextcallback(jsruntime *rt, jscontextcallback cxcallback, void *data); name type
description rt jsruntime * pointer to a js runtime.
...added in spidermonkey 31 callback syntax typedef bool (* jscontextcallback)(jscontext *cx, unsigned contextop, void *data); name type
description cx jscontext * pointer to a jscontext which the callback may use to call into jsapi functions.
...
description js_setcontextcallback specifies a callback function that is automatically called when jscontexts are created or destroyed.
JS_SetDestroyCompartmentCallback
syntax void js_setdestroycompartmentcallback(jsruntime *rt, jsdestroycompartmentcallback callback); name type
description cx jsruntime * the runtime to set the callback function.
... callback function typedef void (* jsdestroycompartmentcallback)(jsfreeop *fop, jscompartment *compartment); name type
description cx jsruntime * the runtime of the compartments.
...
description js_setdestroycompartmentcallback sets callback function which will be called when sweeping each compartment of the runtime, before deleting the compartment.
JS_SetErrorReporter
syntax jserrorreporter js_geterrorreporter(jsruntime *rt); jserrorreporter js_seterrorreporter(jsruntime *rt, jserrorreporter er); name type
description cx jsruntime * pointer to a js runtime whose errors should be reported via your function.
... callback syntax typedef void (* jserrorreporter)(jscontext *cx, const char *message, jserrorreport *report); name type
description cx jscontext * the context in which the error happened.
...
description js_seterrorreporter enables you to define and use your own error reporting mechanism in your applications.
JS_SetFunctionCallback
syntax void js_setfunctioncallback(jscontext *cx, jsfunctioncallback fcb); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_setfunctioncallback sets a c function to be called each time a javascript function is invoked or exits.
... this function, because it is invoked when the javascript stack is guaranteed to be in a consistent state (and therefore it is valid to inspect and modify local variables, generate stack traces, and set breakpoints.) callback syntax typedef void (* jsfunctioncallback)(const jsfunction *fun,const jsscript *scr, const jscontext *cx, int entering); name type
description fun const jsfunction * the javascript function being invoked or exited.
JS_SetGCCallback
syntax void js_setgccallback(jsruntime *rt, jsgccallback cb, void *data); jsgccallback js_setgccallback(jscontext *cx, jsgccallback cb); // obsolete since jsapi 13 jsgccallback js_setgccallbackrt(jsruntime *rt, jsgccallback cb); // obsolete since jsapi 13 name type
description cx jscontext * (for the old js_setgccallback) any jscontext.
... callback syntax typedef enum jsgcstatus { jsgc_begin, jsgc_end, jsgc_mark_end, // obsolete since jsapi 13 jsgc_finalize_end // obsolete since jsapi 13 } jsgcstatus; typedef void (* jsgccallback)(jsruntime *rt, jsgcstatus status, void *data); name type
description cx jscontext * the context in which garbage collection is happening.
...
description js_setgccallback sets a callback function which the garbage collector calls at several points during garbage collection.
JS_SetGCZeal
syntax void js_setgczeal(jscontext *cx, uint8_t zeal, uint32_t frequency); name type
description cx jscontext * a context.
...
description js_setgczeal sets the level of additional garbage collection to perform for a runtime, for the purpose of finding or reproducing bugs.
... there are several different levels which have different functions: zeal level
description 0 normal amount of collection.
JS_SetInterruptCallback
syntax jsinterruptcallback js_setinterruptcallback(jsruntime *rt, jsinterruptcallback callback); jsinterruptcallback js_getinterruptcallback(jsruntime *rt); void js_requestinterruptcallback(jsruntime *rt); name type
description rt jsruntime * the runtime.
... callback syntax bool (* jsinterruptcallback)(jscontext *cx); name type
description cx jscontext * pointer to a jscontext in which this callback was installed.
...
description these functions allow setting an interrupt callback that will be called from the js thread some time after any thread triggered the callback using js_requestinterruptcallback.
JS_SetOperationCallback
syntax void js_setoperationcallback(jscontext *cx, jsoperationcallback callback); jsoperationcallback js_getoperationcallback(jscontext *cx); void js_triggeroperationcallback(jsruntime *rt); name type
description cx jscontext * a context.
... callback syntax jsbool (*jsoperationcallback)(jscontext *cx); name type
description cx jscontext * pointer to a jscontext in which this callback was installed.
...
description these functions allow setting an operation callback that will be called from the js thread some time after any thread triggered the callback using js_triggeroperationcallback.
JS_SetOptions
syntax uint32 js_setoptions(jscontext *cx, uint32 options); name type
description cx jscontext * a context on which to set options.
...
description js_setoptions sets the option flags of a given js context cx.
...ual options on or off, use js_setoptions with js_getoptions: // turn on warnings for dubious practices js_setoptions(cx, js_getoptions(cx) | jsoption_extra_warnings); // turn off those extra warnings js_setoptions(cx, js_getoptions(cx) & ~jsoption_extra_warnings); the options parameter and the return value are the logical or of zero or more constants from the following table: option
description jsoption_extra_warnings warn on dubious practice.
JS_SetParent
syntax bool js_setparent(jscontext *cx, js::handleobject obj, js::handleobject parent); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...see the
description for details.
...
description js_setparent sets an object's parent.
JS_TracerInit
syntax void js_tracerinit(jstracer *trc, jsruntime *rt, jstracecallback callback); name type
description trc jstracer * the tracer to be initialized.
... callback syntax typedef void (*jstracecallback)(jstracer *trc, void *thing, uint32 kind); name type
description trc jstracer * the tracer visiting obj.
...
description js_tracechildren and other tracing apis call the tracer callback for each traceable thing directly referenced by a particular object or runtime structure.
Gecko events
event_
description_change an object's
description property has changed.
...event_table_row_
description_changed a table's row
description changed.
...event_table_row_insert event_table_row_delete event_table_row_reorder event_table_column_
description_changed a table's column
description changed.
IAccessibleImage
some examples are: the accessible name and
description() are not enough to fully describe the image, for example when the accessible
description() is used to define the behavior of an actionable image and the image itself conveys semantically significant information.
... method overview [propget] hresult
description([out] bstr
description ); [propget] hresult imageposition([in] enum ia2coordinatetype coordinatetype, [out] long x, [out] long y ); [propget] hresult imagesize([out] long height, [out] long width ); methods
description() returns the localized
description of the image.
... [propget] hresult
description( [out] bstr
description ); parameters
description the localized
description of the image.
mozIStorageConnection
orageprogresshandler removeprogresshandler(); void rollbacktransaction(); void setgrowthincrement(in print32 aincrement, in autf8string adatabasename); mozistorageprogresshandler setprogresshandler(in print32 agranularity, in mozistorageprogresshandler ahandler); boolean tableexists(in autf8string atablename); attributes attribute type
description connectionready boolean indicates if the connection is open and ready to use.
... constant value
description transaction_deferred 0 no database lock is obtained until the first statement is run.
... sqlite database page size constant constant value
description default_page_size 32768 the default size for sqlite database pages.
nsIAccessibleStates
constant value
description state_unavailable 0x00000001 the object is unavailable, that is disabled.
... state_selfvoicing 0x00080000 the object or child uses text-to-speech (tts) technology for
description purposes.
... state_checkable state_marqueed extended state constants extended state flags (for now non-msaa, for java and gnome/atk support) constant value
description ext_state_supports_autocompletion 0x00000001 for editable areas that have any kind of auto completion.
nsIAppStartup
oid exitlastwindowclosingsurvivalarea(); void getstartupinfo(); void hidesplashscreen(); obsolete since gecko 1.9.1 void initialize(in nsisupports nativeappsupportorsplashscreen); obsolete since gecko 1.9.1 void quit(in pruint32 amode); void restartinsafemode(in pruint32 aquitmode); void run(); attributes attribute type
description interrupted boolean true if the startup process was interrupted by an interactive prompt.
... constant value
description econsiderquit 0x01 attempt to quit if all windows are closed.
... event identifier (key)
description main time at which main application core was loaded.
nsIApplicationCache
unsigned long count, [array, size_is(count)] out string keys); nsiapplicationcachenamespace getmatchingnamespace(in acstring key); unsigned long gettypes(in acstring key); void initashandle(in acstring groupid, in acstring clientid); void markentry(in acstring key, in unsigned long typebits); void unmarkentry(in acstring key, in unsigned long typebits); attributes attribute type
description active boolean true if the cache is the active cache for this group, otherwise false.
... constants constant value
description item_manifest 1 this item is the application manifest.
...void initashandle( in acstring groupid, in acstring clientid ); parameters groupid missing
description clientid missing
description markentry() adds item types to a given entry.
nsIContentFrameMessageManager
parameters name type
description astr string the message to log.
... parameters name type
description aasciistring string ascii string to decode.
... parameters name type
description abase64data string binary data to encode as base64.
nsIDOMFontFace
attribute type
description fromfontgroup boolean indicates whether or not the font was located in a font group.
... attribute type
description cssfamilyname domstring 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).
... attribute type
description format domstring the font format.
nsIDOMSimpleGestureEvent
ablearg, in nsidomabstractview viewarg, in long detailarg, in long screenxarg, in long screenyarg, in long clientxarg, in long clientyarg, in boolean ctrlkeyarg, in boolean altkeyarg, in boolean shiftkeyarg, in boolean metakeyarg, in unsigned short buttonarg, in nsidomeventtarget relatedtargetarg, in unsigned long directionarg, in double deltaarg); attributes attribute type
description delta double the delta value indicating how far the gesture moved.
... constants direction constants constant value
description direction_up 1 upward swipe.
... rotation constants constant value
description rotation_counterclockwise 1 counter-clockwise rotation.
nsIDirIndex
inherits from: nsisupports last changed in gecko 1.7 attributes attribute type
description contenttype string the content type; may be null if it is unknown.
...
description wstring a
description for the filename, which should be displayed by a viewer.
... constants constant value
description type_unknown 0 the type is unknown.
nsIDownloadManager
ytimeframe(in long long abegintime, in long long aendtime); void removelistener(in nsidownloadprogresslistener alistener); void resumedownload(in unsigned long aid); void retrydownload(in unsigned long aid); void savestate(); obsolete since gecko 1.8 void startbatchupdate(); obsolete since gecko 1.9.1 attributes attribute type
description activedownloadcount long the number of files currently being downloaded.
... constants constant value
description download_notstarted -1 the download has not been started yet.
... adisplayname a user-readable
description of the transfer.
nsIExternalProtocolService
method overview boolean externalprotocolhandlerexists(in string aprotocolscheme); astring getapplication
description(in autf8string ascheme); nsihandlerinfo getprotocolhandlerinfo(in acstring aprotocolscheme); nsihandlerinfo getprotocolhandlerinfofromos(in acstring aprotocolscheme, out boolean afound); boolean isexposedprotocol(in string aprotocolscheme); void loaduri(in nsiuri auri, [optional] in nsiinterfacerequestor awindowcontext); void loadurl(in nsiuri aurl); void setprotocolhandlerdefault...
...getapplication
description() gets a human-readable
description for the application responsible for handling a specific protocol.
... astring getapplication
description( in autf8string ascheme ); parameters ascheme the scheme to look up.
nsIFeed
1.0 66 introduced gecko 1.8 inherits from: nsifeedcontainer last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) attributes attribute type
description cloud nsiwritablepropertybag2 the cloud element on a feed is used to identify the api endpoint of an rsscloud ping server, which distributes notifications of changes to this feed.
... subtitle nsifeedtextconstruct returns a subtitle for the feed, based on its
description, subtitle, and appropriate extensions.
... constants constant value
description type_feed 0 a standard text-based feed.
nsIHttpActivityObserver
1.0 66 introduced gecko 1.8 inherits from: nsisupports last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) method overview void observeactivity(in nsisupports ahttpchannel, in pruint32 aactivitytype, in pruint32 aactivitysubtype, in prtime atimestamp, in pruint64 aextrasizedata, in acstring aextrastringdata); attributes attribute type
description isactive boolean true when the interface is active and should observe http activity, otherwise false.
... constants activity type constants constant value
description activity_type_socket_transport 0x0001 socket transport activity has occurred.
... activity subtype constants constant value
description activity_subtype_request_header 0x5001 the http request is about to be queued for sending.
nsIMemoryMultiReporterCallback
1.0 66 introduced gecko 7.0 inherits from: nsisupports last changed in gecko 7.0 (firefox 7.0 / thunderbird 7.0 / seamonkey 2.4) method overview void callback(in acstring process, in autf8string path, in print32 kind, in print32 units, in print64 amount, in autf8string
description, in nsisupports closure); methods callback() called to provide information from a multi-reporter.
...void callback( in acstring process, in autf8string path, in print32 kind, in print32 units, in print64 amount, in autf8string
description, in nsisupports closure ); parameters process the value of the process attribute for the memory reporter.
...
description the value of the
description attribute.
nsIMimeHeaders
add brief
description of interface ???
...rs = components.classes["@mozilla.org/????????????????????????????"] .createinstance(components.interfaces.nsimimeheaders); method overview string extractheader([const] in string headername, in boolean getallofthem); void initialize([const] in string allheaders, in long allheaderssize); attributes attribute type
description allheaders string read only.
... methods extractheader() string extractheader( [const] in string headername, in boolean getallofthem ); parameters headername missing
description getallofthem missing
description return value missing
description exceptions thrown missing exception missing
description initialize() void initialize( [const] in string allheaders, in long allheaderssize ); parameters allheaders insert the complete message content allheaderssize length of the passed in content exceptions thrown missing exception missing
description remarks see also ...
nsINavHistoryContainerResultNode
toolkit/components/places/public/nsinavhistoryservice.idlscriptable a foundation for the interfaces that provide a
description of a query result on the places service that describes a container (which is any kind of grouping, including bookmark folders).
...istoryresultnode last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview nsinavhistoryresultnode findnodebydetails(in autf8string auristring, in prtime atime, in long long aitemid, in boolean arecursive); nsinavhistoryresultnode getchild(in unsigned long aindex); unsigned long getchildindex(in nsinavhistoryresultnode anode); attributes attribute type
description childcount unsigned long the number of child nodes; accessing this throws an ns_error_not_available exception of containeropen is false.
... constants state constants constant value
description state_closed 0 the container is closed.
nsIPermissionManager
void removeall(); pruint32 testexactpermission(in nsiuri uri, in string type); pruint32 testexactpermissionfromprincipal(in nsiprincipal principal, in string type); pruint32 testpermission(in nsiuri uri, in string type); pruint32 testpermissionfromprincipal(in nsiprincipal principal, in string type); attributes attribute type
description enumerator nsisimpleenumerator enumerates all stored permissions.
... constants permission type constants constant value
description unknown_action 0 default permission when no entry is found for a host.
... permission expiration constants constant value
description expire_never 0 permission never expires.
nsIScreen
s.interfaces.nsiscreen); method overview void getavailrect(out long left, out long top, out long width, out long height); void getrect(out long left, out long top, out long width, out long height); void lockminimumbrightness(in unsigned long brightness); void unlockminimumbrightness(in unsigned long brightness); attributes attribute type
description colordepth long the screen's color depth; this is the number of bits used to represent a color.
... constants screen brightness constants constant value
description brightness_dim 0 the screen is fully dimmed (that is, off).
... screen rotation constants requires gecko 13.0(firefox 13.0 / thunderbird 13.0 / seamonkey 2.10) constant value
description rotation_0_deg 0 0° of rotation (that is, no rotation, or default orientation).
nsISearchEngine
nherits from: nsisupports method overview void addparam(in astring name, in astring value, in astring responsetype); nsisearchsubmission getsubmission(in astring data, [optional] in astring responsetype, [optional] in astring purpose); boolean supportsresponsetype(in astring responsetype); attributes attribute type
description alias astring an optional shortcut alias for the engine.
...
description astring a text
description describing the engine.
... constants search engine type constants constant value
description type_mozsearch 1 type_sherlock 2 type_opensearch 3 search engine data type constants constant value
description data_xml 1 data type is xml data_text 2 data type is text.
nsIWebNavigation
overview void goback void goforward void gotoindex( in long index ) void loaduri(in wstring uri , in unsigned long loadflags , in nsiuri referrer , in nsiinputstream postdata, in nsiinputstream headers) void reload(in unsigned long reloadflags) void stop(in unsigned long stopflags) constants load flags constant value
description load_flags_mask 65535 this flag defines the range of bits that may be specified.
... note for valid load flag combinations look here nsdocshellloadtypes.h stop flags constant value
description stop_network 1 this flag specifies that all network activity should be stopped.
... attributes attribute type
description cangoback prbool indicates if the object can go back.
nsIWebProgress
last changed in gecko 1.8.0 inherits from: nsisupports method overview void addprogresslistener(in nsiwebprogresslistener alistener, in unsigned long anotifymask); void removeprogresslistener(in nsiwebprogresslistener alistener); attributes attribute type
description domwindow nsidomwindow the dom window associated with this nsiwebprogress instance.
... constant value
description notify_state_request 0x00000001 only receive the nsiwebprogresslistener.onstatechange() event if the astateflags parameter includes nsiwebprogresslistener::state_is_request.
... constant value
description notify_progress 0x00000010 receive nsiwebprogresslistener.onprogresschange() events.
Address Book examples
see an overview of thunderbird components for a general
description of the thunderbird user interface and related programmatic interfaces.
... a mailing list first create a mailing list object and initialize it: var maillist = components.classes["@mozilla.org/addressbook/directoryproperty;1"] .createinstance(components.interfaces.nsiabdirectory); maillist.ismaillist = true; now fill in the details you want to store: maillist.dirname = "my mailing list"; maillist.listnickname = "nickname for list"; maillist.
description = "list
description"; add the cards you want to include in the list: for (let i = 0; i < numcards; i++) maillist.addresslists.appendelement(card[i], false); now save the list: var parentdirectory = ...; // an nsiabdirectory for the parent of the mailing list.
...once you have the nsiabcard object you can modify the names and
description of it like this: maillistcard.displayname = "new list name"; maillistcard.lastname = maillistcard.displayname; maillistcard.setproperty("nickname", "new nickname for list"); maillistcard.setproperty("notes", "new list
description"); then you need to get the equivalent mailing list object that implements nsiabdirectory: let abmanager = components.classes["@mozilla.org/abmanager;1"] .getservice(components.interfaces.nsiabmanager); let maillistdirectory = abmanager.getdirectory(maill...
Index
see an overview of thunderbird components for a general
description of the thunderbird user interface and related programmatic interfaces.
...see an overview of thunderbird components for a general
description of the thunderbird user interface and related programmatic interfaces.
...see the activity manager page for a general
description of the component.
Building a Thunderbird extension 3: install manifest
open the file called install.rdf that you created at the top of your extension's directory hierarchy and paste the following text into the file: <?xml version="1.0"?> <rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <
description about="urn:mozilla:install-manifest"> <em:id>myfirstext@jen.zed</em:id> <em:name>my first extension</em:name> <em:version>1.0</em:version> <em:creator>jenzed</em:creator> <em:targetapplication> <
description> <em:id>{3550f703-e582-4d05-9a08-453d09bdfdc6}</em:id> <em:minversion>1.5</em:minversion> <em:maxversion>5.0.*</em:maxversion> </descri...
...ption> </em:targetapplication> </
description> </rdf> the following items (shown in bold) should be customized for your application: <em:id>myfirstext@jen.zed</em:id>: this is the id of the extension.
...note that elements can be specified in any order, as long as they are children of the <
description> node.
Add to iPhoto
in c, the callback structure, and the predefined callback record, look like this: typedef const void * (*cfarrayretaincallback)(cfallocatorref allocator, const void *value); typedef void (*cfarrayreleasecallback)(cfallocatorref allocator, const void *value); typedef cfstringref (*cfarraycopy
descriptioncallback)(const void *value); typedef boolean (*cfarrayequalcallback)(const void *value1, const void *value2); typedef struct { cfindex version; cfarrayretaincallback retain; cfarrayreleasecallback release; cfarraycopy
descriptioncallback copy
description; cfarrayequalcallback equal; } cfarraycallbacks; cf_export const cfarraycallbacks kcftypearraycallbacks; the kcftype...
...to do that, we first need to declare the cfarraycallbacks structure: this.cfarraycallbacks = new ctypes.structtype("cfarraycallbacks", [ {'version': cfindex}, {'retain': ctypes.voidptr_t}, {'release': ctypes.voidptr_t}, {'copy
description': ctypes.voidptr_t}, {'equal': ctypes.voidptr_t} ]); having done this, we can then import the kcftypearraycallbacks structure.
...osstatus, // returns osstatus corefoundation.cfarrayref, // array of files to open in the app optionbits, // roles mask ctypes.voidptr_t, // inaeparam this.struct_lsapplicationparameters.ptr, //
description of the app to launch ctypes.voidptr_t, // psn array pointer cfindex); // max psn count this function returns an osstatus indicating the result of the launch attempt, and accepts these parameters: a cfarrayref providing a list of cfurl objects for the files to open in the application.
StructType
a complete field descriptor list might look like this: [ {'serialnumber': ctypes.int}, {'username': ctypes.char.ptr} ] properties property type
description fields ctype[] a sealed array of field descriptors.
... property type
description name string the type's name.
... properties inherited from cdata property type
description constructor ctype the data type of the cdata object, as a ctype.
ContentIndex.getAll() - Web APIs
return value returns a promise that resolves with an array of content
description items.
... content
description each item returned is an object containing the following data: id: a unique string identifier.
...
description: a string
description of the item.
LocalFileSystem - Web APIs
4*1024,oninitfs,errorhandler); method overview void requestfilesystem (in unsigned short type, in unsigned long long size, in filesystemcallback successcallback, in optional errorcallback errorcallback); void resolvelocalfilesystemurl (in domstring url, in entrycallback successcallback, in optional errorcallback errorcallback); constants constant value
description temporary 0 transient storage that can be be removed by the browser at its discretion.
... returns void exceptions this method can raise an fileerror with the following code: exception
description security_error the application does not have permission to access the file system interface.
... returns void exceptions this method can raise an fileerror with the following code: exception
description encoding_err the syntax of the url was invalid.
LocalFileSystemSync - Web APIs
method overview filesystemsync requestfilesystemsync (in unsigned short type, in long long size) raises fileexception; entrysync resolvelocalfilesystemsyncurl (in domstring url) raises fileexception; constants constant value
description temporary 0 transient storage that can be be removed by the browser at its discretion.
... exceptions this method can raise an fileexception with the following code: exception
description security_error the application does not have permission to access the file system interface.
... exceptions this method can raise a fileexception with the following codes: exception
description encoding_err the syntax of the url was invalid.
Pointer events - Web APIs
the following sub-sections contain short
descriptions of each interface and property.
... below is a short
description of each event type and its associated global event handler.
... event on event handler
description pointerover onpointerover fired when a pointer is moved into an element's hit test boundaries.
RTCIceTransport - Web APIs
getlocalparameters() returns a rtciceparameters object describing the ice parameters established by a call to the rtcpeerconnection.setlocal
description() method.
... getremoteparameters() returns a rtciceparameters object containing the ice parameters for the remote device, as set by a call to rtcpeerconnection.setremote
description().
... if setremote
description() hasn't been called yet, the return value is null.
RTCPeerConnection.canTrickleIceCandidates - Web APIs
this property is only set after having called rtcpeerconnection.setremote
description().
... note: this property's value is determined once the local peer has called rtcpeerconnection.setremote
description(); the provided
description is used by the ice agent to determine whether or not the remote peer supports trickled ice candidates.
...pc.setremote
description(remoteoffer) .then(_ => pc.createanswer()) .then(answer => pc.setlocal
description(answer)) .then(_ => if (pc.cantrickleicecandidates) { return pc.local
description; } return new promise(r => { pc.addeventlistener('icegatheringstatechange', e => { if (e.target.icegatheringstate === 'complete') { r(pc.local
description); } }); }); }) .then(answer => sendanswertopeer(answer)) // signaling message .catch(e => handleerror(e)); pc.addeventlistener('icecandidate', e => { if (pc.cantrickleicecandidates) { sendcandidatetopeer(e.candidate); // s...
RTCPeerConnection.onsignalingstatechange - Web APIs
the function receives as input the event object of type event; this event is sent when the peer connection's signalingstate changes, which may happen either because of a call to setlocal
description() or to setremote
description().
...tlistener("signalingstatechange", mysignalingstatechangehandler); or, using an anonymous (inline) handler: myrtcpeerconnection.addeventlistener("signalingstatechange", event => { /* handle the event here */ }); example this snippet shows a handler for signalingstatechange that looks for the "have-local-pranswer" signaling state—indicating that a remote offer has been received and a local
description of type "pranswer" has been applied in response.
... pc.onsignalingstatechange = function(event) { if (pc.signalingstate === "have-local-pranswer") { // setlocal
description() has been called with an answer } }; specifications specification status comment webrtc 1.0: real-time communication between browsersthe definition of 'rtcpeerconnection.onsignalingstatechange' in that specification.
RTCPeerConnection.peerIdentity - Web APIs
note: the promise returned by setremote
description() cannot resolve until any target peer identity that's been set is validated.
... if the identity hasn't been validated yet, the promise returned by setremote
description() will be rejected.
... if there's no target peer identity, setremote
description() doesn't need to wait for validation to occur before it resolves.
SVGLength - Web APIs
1" width="1cm" height="1cm" /> </svg> results on a desktop monitor (pixel units will be dpi-dependent): value: 37.7952766418457, valueinspecifiedunits: 6: 1, valueasstring: 1cm value: 26.66666603088379, valueinspecifiedunits 9: 20, valueasstring: 20pt value: 26.66666603088379, valueinspecifiedunits 8: 0.277777761220932, valueasstring: 0.277778in constants name value
description svg_lengthtype_unknown 0 the unit type is not one of predefined unit types.
... properties name type
description unittype unsigned short the type of the value as specified by one of the svg_lengthtype_* constants defined on this interface.
... methods name & arguments return
description newvaluespecifiedunits(in unsigned short unittype, in float valueinspecifiedunits) void reset the value as a number with an associated unittype, thereby replacing the values for all of the attributes on the object.
SVGMarkerElement - Web APIs
gle = 2 svg_markerunits_unknown = 0 svg_markerunits_userspaceonuse = 1 svg_markerunits_strokewidth = 2 normative document svg 1.1 (2nd edition) constants orientation name value
description svg_marker_orient_unknown 0 the marker orientation is not one of predefined types.
... units name value
description svg_markerunits_unknown 0 the marker unit type is not one of predefined types.
... name type
description refx svganimatedlength corresponds to attribute refx on the given marker element.
SVGTransform - Web APIs
ly float angle readonly svgmatrix matrix constants svg_transform_unknown = 0 svg_transform_matrix = 1 svg_transform_translate = 2 svg_transform_scale = 3 svg_transform_rotate = 4 svg_transform_skewx = 5 svg_transform_skewy = 6 normative document svg 1.1 (2nd edition) constants name value
description svg_transform_unknown 0 the unit type is not one of predefined unit types.
...(…) transformation svg_transform_translate 2 a translate(…) transformation svg_transform_scale 3 a scale(…) transformation svg_transform_rotate 4 a rotate(…) transformation svg_transform_skewx 5 a skewx(…) transformation svg_transform_skewy 6 a skewy(…) transformation properties name type
description type unsigned short the type of the value as specified by one of the svg_transform_* constants defined on this interface.
... methods name & arguments return
description setmatrix(in svgmatrix matrix) void sets the transform type to svg_transform_matrix, with parameter matrix defining the new transformation.
WebGLRenderingContext.getParameter() - Web APIs
constant returned type
description gl.active_texture glenum gl.aliased_line_width_range float32array (with 2 elements) gl.aliased_point_size_range float32array (with 2 elements) gl.alpha_bits glint gl.array_buffer_binding webglbuffer gl.blend glboolean gl.blend_color float32array (with 4 values) gl.blend_dst...
... constant returned type
description gl.copy_read_buffer_binding webglbuffer or null see bindbuffer.
... webgl extensions you can query the following pname parameters when using webgl extensions: constant returned type extension
description ext.max_texture_max_anisotropy_ext glfloat ext_texture_filter_anisotropic maximum available anisotropy.
WebGL types - Web APIs
type web idl type
description glenum unsigned long used for enums.
... type web idl type
description glint64 long long signed 64-bit integer number.
... type web idl type
description gluint64ext long long unsigned 64-bit integer number.
Introduction to WebRTC protocols - Web APIs
sdp session
description protocol (sdp) is a standard for describing the multimedia content of the connection such as resolution, formats, codecs, encryption, etc.
... structure sdp consists of one or more lines of utf-8 text, each beginning with a one-character type, followed by an equals sign ("="), followed by structured text comprising a value or
description, whose format depends on the type.
...for example, lines providing media
descriptions have the type "m", so those lines are referred to as "m-lines." for more information to learn more about sdp, see the following useful resources: specification: rfc 4566: sdp: session
description protocol iana registry of sdp parameters ...
Window.sidebar - Web APIs
methods the sidebar object returned has the following methods: method
description (seamonkey)
description (firefox) addpanel(title, contenturl, "") adds a sidebar panel.
... addsearchprovider(
descriptionurl) dummy function; does nothing.
... issearchproviderinstalled(
descriptionurl) indicates if a specific search provider (opensearch) is installed.
Using the alertdialog role - Accessibility
description this technique demonstrates how to use the alertdialog role.
...this means that most of the instructions provided in the 'using the dialog role' technique are applicable to the alertdialog role as well: the alert dialog must always be given an accessible name (through aria-labelledby or aria-label) , and in most cases the alert text will have to be marked up as the alert dialog's accessible
description (using aria-describedby).
... when the alert dialog is correctly labeled and focus is moved to a control inside the dialog, screen readers should announce the dialog's accessible role, name and optionally
description before announcing the focused element.
ARIA: figure role - Accessibility
<div role="figure" aria-labelledby="caption"> <img src="image.png" alt="full alternative image
description"> <p id="caption">figure 1: the caption</p> </div> in the above example, we have a figure that consists of two separate content items — an image and a caption.
...
description any content that should be grouped together and consumed as a figure (which could include images, video, audio, code snippets, or other content) can be identified as a figure using role="figure".
... use aria-describedby when the text is a longer
description.
ARIA: Navigation Role - Accessibility
description the navigation role is a landmark role.
... associated wai-aria roles, states, and properties aria-label a brief
description of the purpose of the navigation, omitting the term "navigation", as the screen reader will read both the role and the contents of the label.
... <footer> <nav id="footer-nav" aria-label="main"> <!-- list of links to main website locations --> </nav> </footer> redundant
descriptions screen readers will announce the type of role the landmark is.
ARIA: dialog role - Accessibility
<div role="dialog" aria-labelledby="dialog1title" aria-describedby="dialog1desc"> <h2 id="dialog1title">your personal details were successfully updated</h2> <p id="dialog1desc">you can change your details at any time in the user account section.</p> <button>close</button> </div>
description marking up a dialog element with the dialog role helps assistive technology identify the dialog's content as being grouped and separated from the rest of the page content.
...this approach is shown in the code snippet below: <div role="dialog" aria-labelledby="dialog1title" aria-describedby="dialog1desc"> <h2 id="dialog1title">your personal details were successfully updated</h2> <p id="dialog1desc">you can change your details at any time in the user account section.</p> <button>close</button> </div> keep in mind that a dialog's title and
description text do not have to be focusable in order to be perceived by screen readers operating in a non-virtual mode.
... when the dialog is correctly labeled and focus is moved to an element (often an interactive element, such as a button) inside the dialog, screen readers should announce the dialog's accessible role, name and optionally
description, along with announcing the focused element.
Basic form hints - Accessibility
role="presentation" src="radio-unchecked.gif" /> thai </li> <li id="r2" tabindex="-1" role="radio" aria-checked="false"> <img role="presentation" src="radio-unchecked.gif" /> subway </li> <li id="r3" tabindex="0" role="radio" aria-checked="true"> <img role="presentation" src="radio-checked.gif" /> radio maria </li> </ul> describing with aria form controls sometimes have a
description associated with them, in addition to the label.
... aria provides the aria-describedby attribute to directly associate the
description with the control.
... <button aria-describedby="
descriptionrevert">revert</button> <div id="
descriptionrevert">reverting will undo any changes that have been made since the last save.</div> note: the aria-describedby attribute is used for other purposes, in addition to form controls.
appearance (-moz-appearance, -webkit-appearance) - CSS: Cascading Style Sheets
appearance: listbox; appearance: meter; appearance: progress-bar; /* partial list of available values in gecko */ -moz-appearance: scrollbarbutton-up; -moz-appearance: button-bevel; /* partial list of available values in webkit/blink (as well as gecko and edge) */ -webkit-appearance: media-mute-button; -webkit-appearance: caret; values standard keywords value demo browser
description none div{ color: black; -moz-appearance:none; -webkit-appearance:none; appearance:none; } <div>lorem</div> firefox chrome safari edge no special styling is applied.
... value demo browser
description attachment div{ color: black; -moz-appearance: attachment; -webkit-appearance: attachment; } <div>lorem</div> safari borderless-attachment div{ color: black; -moz-appearance: borderless-attachment; -webkit-appearance: borderless-attachment; } <div>lorem</div> safari button-bevel div ...
... value browser
description button-arrow-down firefox removed in firefox 64 button-arrow-next firefox removed in firefox 64 button-arrow-previous firefox removed in firefox 64 button-arrow-up firefox removed in firefox 64 button-focus firefox removed in firefox 64 dualbutton firefox removed in firefox 64 ...
<pre>: The Preformatted Text element - HTML: Hypertext Markup Language
example html <p>using css to change the font color is easy.</p> <pre> body { color: red; } </pre> result accessibility concerns it is important to provide an alternate
description for any images or diagrams created using preformatted text.
... the alternate
description should clearly and concisely describe the image or diagram's content.
... a combination of the <figure> and <figcaption> elements, supplemented by a combination of an id and the aria role and aria-labelledby attributes allow the preformatted text to be announced as an image, with the figcaption serving as the image's alternate
description.
<td>: The Table Data Cell element - HTML: Hypertext Markup Language
deprecated attributes abbr this attribute contains a short abbreviated
description of the cell's content.
... some user-agents, such as speech readers, may present this
description before the content itself.
...alternatively, you can put the abbreviated
description inside the cell and place the long content in the title attribute.
<track>: The Embed Text Track element - HTML: Hypertext Markup Language
descriptions textual
description of the video content.
... usage notes track data types the type of data that track adds to the media is set in the kind attribute, which can take values of subtitles, captions,
descriptions, chapters or metadata.
...change event handler: let texttrackelem = document.getelementbyid("texttrack"); texttrackelem.oncuechange = (event) => { let cues = event.target.track.activecues; }); examples <video controls poster="/images/sample.gif"> <source src="sample.mp4" type="video/mp4"> <source src="sample.ogv" type="video/ogv"> <track kind="captions" src="samplecaptions.vtt" srclang="en"> <track kind="
descriptions" src="sample
descriptions.vtt" srclang="en"> <track kind="chapters" src="samplechapters.vtt" srclang="en"> <track kind="subtitles" src="samplesubtitles_de.vtt" srclang="de"> <track kind="subtitles" src="samplesubtitles_en.vtt" srclang="en"> <track kind="subtitles" src="samplesubtitles_ja.vtt" srclang="ja"> <track kind="subtitles" src="samplesubtitles_oz.vtt" srclang="oz"> <...
An overview of HTTP - HTTP
a complete document is reconstructed from the different sub-documents fetched, for instance text, layout
description, images, videos, scripts, and more.
...although important to diagnose network problems, the underlying layers are mostly irrelevant to the
description of http.
... a status message, a non-authoritative short
description of the status code.
Intl.Locale.prototype.calendar - JavaScript
description the calendar property returns the part of the locale that indicates the locale's calendar era.
...the following table shows all the valid unicode calendar key strings, along with a
description of the calendar era they represent.
... unicode calendar keys unicode calendar keys calendar key (name)
description buddhist thai buddhist calendar chinese traditional chinese calendar coptic coptic calendar dangi traditional korean calendar ethioaa ethiopic calendar, amete alem (epoch approx.
Symbol() constructor - JavaScript
syntax symbol([
description]) parameters
description optional a string.
... a
description of the symbol which can be used for debugging but not to access the symbol itself.
... examples creating symbols to create a new primitive symbol, you write symbol() with an optional string as its
description: let sym1 = symbol() let sym2 = symbol('foo') let sym3 = symbol('foo') the above code creates three new symbols.
Symbol.for() - JavaScript
the key for the symbol (and also used for the
description of the symbol).
...
description in contrast to symbol(), the symbol.for() function creates a symbol available in a global symbol registry list.
... examples using symbol.for symbol.for('foo'); // create a new global symbol symbol.for('foo'); // retrieve the already created symbol // same global symbol, but not locally symbol.for('bar') === symbol.for('bar'); // true symbol('bar') === symbol('bar'); // false // the key is also used as the
description var sym = symbol.for('mario'); sym.tostring(); // "symbol(mario)" to avoid name clashes with your global symbol keys and other (library code) global symbols, it might be a good idea to prefix your symbols: symbol.for('mdn.foo'); symbol.for('mdn.bar'); specifications specification ecmascript (ecma-262)the definition of 'symbol.for' in that specification.
Lexical grammar - JavaScript
unicode format-control characters code point name abbreviation
description u+200c zero width non-joiner <zwnj> placed between characters to prevent being connected into ligatures in certain languages (wikipedia).
... white space characters code point name abbreviation
description escape sequence u+0009 character tabulation <ht> horizontal tabulation \t u+000b line tabulation <vt> vertical tabulation \v u+000c form feed <ff> page breaking control character (wikipedia).
... line terminator characters code point name abbreviation
description escape sequence u+000a line feed <lf> new line character in unix systems.
How to make PWAs installable - Progressive web apps (PWAs)
the content of the file looks like this: { "name": "js13kgames progressive web app", "short_name": "js13kpwa", "
description": "progressive web app that lists games submitted to the a-frame category in the js13kgames 2017 competition.", "icons": [ { "src": "icons/icon-32.png", "sizes": "32x32", "type": "image/png" }, // ...
...
description: a sentence or two explaining what your app does.
...beyond that, everything is optional, though the
description, short_name, and start_url fields are recommended.
context-menu - Archive of obsolete content
declarative contexts you can specify some simple, declarative contexts when you create a menu item by setting the context property of the options object passed to its constructor, like this: var cm = require("sdk/context-menu"); cm.item({ label: "my menu item", context: cm.urlcontext("*.mozilla.org") }); constructor
description pagecontext() the page context.
...context object properties: property
description documenttype the mime type of the document the menu was invoked in.
Bootstrapped extensions - Archive of obsolete content
the reason constants are: constant value
description app_startup 1 the application is starting up.
...the data is a simple javascript object with the following properties: property type
description id string the id of the add-on being bootstrapped.
JavaScript Daemons Management - Archive of obsolete content
date.parse(vdate) : vdate; if (isfinite(ntime) && ntime > date.now()) { this.length = math.floor((ntime - date.now()) / this.rate) + this.index; this.pause(); this.start(); } return this.length; }; manual the constructor syntax var mydaemon = new daemon(thisobject, callback[, rate[, length[, init[, onstart]]]]);
description constructs a javascript object containing all information needed by an animation (like the this object, the callback function, the length, the frame rate, the number of cycles, and the init and onstart functions).
... daemon.safe() [optional module daemon-safe.js] syntax var mydaemon = new daemon.safe(thisobject, callback[, rate[, length[, init[, onstart]]]]);
description daemon.safe is a clone of the daemon constructor based on recursive invocations of settimeout rather than on a single invocation of setinterval.
Deploying a Plugin as an Extension - Archive of obsolete content
here's what a basic install.rdf file looks like: <rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <
description about="urn:mozilla:install-manifest"> <em:id>rhapsodyplayerengine@rhapsody.com</em:id> <em:name>rhapsody player engine</em:name> <em:version>1.0.0.487</em:version> <em:targetapplication> <
description> <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id> <em:minversion>1.5</em:minversion> <em:maxversion>1.5.0.*</em:maxversion> </
description> ...
... </em:targetapplication> </
description> </rdf> you can get more detailed information about this file at install.rdf.
Displaying web content in an extension without security issues - Archive of obsolete content
for example, your template document might have this code: <style type="text/css"> #entrytemplate { display: none; } </style> <div id="entrytemplate"> <div class="title"></div> <div class="
description"></div> </div> now to insert a new entry in the document you would do the following: var template = doc.getelementbyid("entrytemplate"); var entry = template.clonenode(true); entry.removeattribute("id"); entry.getelementsbyclassname("title")[0].textcontent = title; entry.getelementsbyclassname("
description")[0].textcontent =
description; template.parentnode.appendchild(entry); the important dif...
...instead, nsiscriptableunescapehtml.parsefragment() method should be used that is meant for just that scenario: var target = entry.getelementsbyclassname("
description")[0]; var fragment = components.classes["@mozilla.org/feed-unescapehtml;1"] .getservice(components.interfaces.nsiscriptableunescapehtml) .parsefragment(
description, false, null, target); target.appendchild(fragment); this will add the html code to the specified node — minus all the potentially dangerous content.
Extension Etiquette - Archive of obsolete content
descriptions use something that is descriptive, but that would fit in the default add-on manager width.
...don't hesitate to give long
descriptions for each preference, as long as they are easy to understand, even for non-computer-savvy users.
Inline options - Archive of obsolete content
to set a
description, either use the desc attribute, or a text node as a child of the <setting> tag.
... some examples: <!-- boolean examples --> <setting pref="extensions.myaddon.bool1" type="bool" title="boolean 1"/> <setting pref="extensions.myaddon.bool2" type="bool" title="boolean 2">
description of boolean 2 </setting> <!-- boolean stored as an integer --> <setting pref="extensions.myaddon.boolint" type="boolint" title="boolean 3" on="1" off="2"/> <!-- integer example --> <setting pref="extensions.myaddon.int" type="integer" title="integer"/> <!-- string examples --> <setting pref="extensions.myaddon.text" type="string" title="text"/> <setting pref="extensions.myaddon.password" type="string" title="password" inputtype="password"/> <!-- color example --> <setting pref="extensions.myaddo...
Multiple item extension packaging - Archive of obsolete content
<rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:nc="http://home.netscape.com/nc-rdf#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <
description about="urn:mozilla:install-manifest"> <!-- nsiupdateitem type for a multiple item package --> <em:type nc:parsetype="integer">32</em:type> ...
...<rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <
description about="urn:mozilla:install-manifest"> <!-- nsiupdateitem type for a multiple item package --> <em:type>32</em:type> ...
Index of archived content - Archive of obsolete content
file i/o finding window handles forms related code snippets html in xul for rich tooltips html to dom isdefaultnamespace js xpcom javascript debugger service javascript timers javascript daemons management label and
description lookupnamespaceuri lookupprefix miscellaneous modules on page load page loading post data to window preferences progress listeners queryselector rosetta running applications svg animation svg general scrollbar ...
...npp_streamasfile npp_urlnotify npp_write npp_writeready npprint npprintcallbackstruct nprect npregion npsaveddata npsetwindowcallbackstruct npstream npstring nputf8 npvariant npvarianttype npwindow np_getmime
description np_getvalue np_initialize np_port np_shutdown samples and test cases shipping a plugin as a toolkit bundle supporting private browsing in plugins the first install problem writing a plugin for mac os x xembed extension for mozilla plugins sa...
List of Former Mozilla-Based Applications - Archive of obsolete content
applications that switched to another technology name
description additional information angelsoft tools for startups, vcs, and angel investors switched from xulrunner-based client to a web application autodesk maya 3d modeling tool switched off of gecko for help browser in version 8.5 blam feed reader switched to webkit in version 1.8.6 boxee media center software switched to webkit in version 1.0 epiphany browser switched from gecko to webkit flock social browsing flock...
...xulrunner app initially but now uses adobe air rift technologies software installation over internet no longer using mozilla technology -- need confirmation and details second life virtual world desktop client switched from embedded mozilla browser to a plugin architecture with a qtwebkit plugin applications that are no longer being developed name
description additional information aphrodite browser inactive aol client for mac internet software no longer available beonex communicator internet software last news item on site from 2004 chameleon theme builder inactive civil netizen p2p file delivery (email attachment replacement) site not updated since 2006 compuserve...
Creating a Firefox sidebar extension - Archive of obsolete content
install.rdf <?xml version="1.0" encoding="utf-8"?> <rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <
description about="urn:mozilla:install-manifest"> <em:id>emptysidebar@yourdomain.com</em:id> <em:name>emptysidebar extension</em:name> <em:version>1.0</em:version> <em:creator>your name</em:creator> <em:
description>example extension for creation and registration of a sidebar.</em:
description> <em:targetapplication> <
description> <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e973...
...84}</em:id> <!-- firefox --> <em:minversion>1.5</em:minversion> <em:maxversion>2.0.0.*</em:maxversion> </
description> </em:targetapplication> </
description> </rdf> the other manifest file is chrome.manifest, the chrome manifest file.
Getting Started - Archive of obsolete content
<
description about="urn:mozilla:install-manifest"> <em:id>{themes_uuid}</em:id> <em:version>themes_version</em:version> the first section requires that you establish a uuid for your theme and that you give your theme a version number.
...you will also have to update the minimum and maximum compatible versions for the target application (seamonkey) in the following section: <em:targetapplication> <
description> <!-- seamonkey's uuid --> <em:id>{92650c4d-4b8e-4d2a-b7eb-24ecf4f6b63a}</em:id> <em:minversion>min_sm_version</em:minversion> <em:maxversion>max_sm_version</em:maxversion> </
description> </em:targetapplication> establishing both minimum and maximum compatible versions lets you avoid conflicts with versions of seamonkey your theme wasn't designed for -- or wasn't tested on.
install.rdf - Archive of obsolete content
copy the following text and paste it into a text file, then save that file as "install.rdf": <?xml version="1.0"?> <rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <
description about="urn:mozilla:install-manifest"> <em:id>author@oftheme.com</em:id> <em:version>2.0b1</em:version> <!-- seamonkey --> <em:targetapplication> <
description> <em:id>{92650c4d-4b8e-4d2a-b7eb-24ecf4f6b63a}</em:id> <em:minversion>2.0b1pre</em:minversion> <em:maxversion>2.0b2pre</em:maxversion> </
description> </em:targetapplication> <!-- front end metadata --> <em:name>my_theme</em:name> <em:
description>my first theme</em:
description> <!-- front end integration hooks (used by theme ma...
...nager)--> <em:creator>john johnson</em:creator> <em:contributor>john johnson</em:contributor> <em:homepageurl>https://mycoolskin.com/</em:homepageurl> <em:updateurl>https://mycoolskin.com/</em:updateurl> <em:abouturl>https://mycoolskin.com/</em:abouturl> <em:internalname>my_theme</em:internalname> </
description> </rdf> ...
Creating a Skin for Firefox/Getting Started - Archive of obsolete content
<
description about="urn:mozilla:install-manifest"> <em:id>{themes_uuid}</em:id> <em:version>themes_version</em:version> the first section requires that you establish a uuid for your theme and that you give your theme a version number.
... you will also have to update the minimum and maximum compatible versions for the target application (firefox) in the following section: <em:targetapplication> <
description> <!-- firefox's uuid --> <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id> <em:minversion>min_ff_version</em:minversion> <em:maxversion>max_ff_version</em:maxversion> </
description> </em:targetapplication> establishing both minimum and maximum compatible versions lets you avoid conflicts with versions of firefox your theme wasn't designed for -- or wasn't tested on.
generateCRMFRequest() - Archive of obsolete content
argument
description "requesteddn" an rfc 1485 formatted dn to include in the certificate request.
...the possible error strings are: error string
description "error:invalidparameter:xxx" the parameter xxx was an invalid value.
importUserCertificates - Archive of obsolete content
resultstring = crypto.importusercertificates("nicknamestring","certstring",forcebackup); argument
description "nicknamestring" this is the nickname that will be used to describe the certificate in the client's certificate management ui.
...if it fails, one of the following error strings will be returned: error string
description "error:usercancel" the user canceled the import operation "error:invalidcertificate" one of the certificate packages was incorrectly formatted "error:internalerror" the software encountered some internal error, such as out of memory "error:invalidrequestid" the request id in the response message does not match any outstanding request ...
popChallengeResponse - Archive of obsolete content
resultstring = crypto.popchallengeresponse("challengestring"); argument
description "challengestring" a base-64 encoded cmmf popodeckeychallcontent message.
... the resultstring will either be a base-64 encoded popodeckeyrespcontent message, or one of the following error strings: error string
description "error:invalidparameter:xxx" the parameter xxx was an invalid value.
Makefile.mozextension.2 - Archive of obsolete content
9bdfdc6} #nvu {136c295a-4a5a-41cf-bf24-5cee526720d5} #mozilla suite {86c18b42-e466-45a9-ae7a-9b95ba6f5640} #seamonkey {92650c4d-4b8e-4d2a-b7eb-24ecf4f6b63a} #sunbird {718e30fb-e89b-41dd-9da7-e25a45638b28} #netscape browser {3db10fab-e461-4c80-8b97-957ad5f8ea47} ###### define install_rdf <rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <
description about="urn:mozilla:install-manifest"> <id>$(project_id)</id> <name>$(project_name)</name> <version>$(project_version)</version> <
description>$(project_desc)</
description> <creator>$(project_author)</creator> <contributor>here is a place for you who helped me</contributor> <homepageurl>http://$(project).mozdev.org/</homepageurl> <optionsurl>chrome://$(project)/content/settings.xul</optionsurl> ...
...<abouturl>chrome://$(project)/content/about.xul</abouturl> <iconurl>chrome://$(project)/skin/mainicon.png</iconurl> <updateurl>http://$(project).mozdev.org/update.rdf</updateurl> <type>2</type> <targetapplication> <
description> <id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</id> <minversion>2.0</minversion> <maxversion>9.0</maxversion> </
description> </targetapplication> </
description> </rdf> endef export install_rdf install.rdf: @echo generating $(project)/install.rdf @echo "$$install_rdf" > $(project)/install.rdf ###### define overlay_xul <overlay id="$(project)-overlay" xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"><script src="overlay.js"/></overlay> ...
Tamarin Acceptance Test Template - Archive of obsolete content
* * ***** end license block ***** */ var section = "test"; // provide a document reference (ie, actionscript section) var version = "as3"; // version of ecmascript or actionscript var title = "test"; // provide ecma section title or a
description var bugnumber = ""; starttest(); // leave this alone /** * calls to addtestcase here.
... addtestcase is a function that is defined * in shell.as and takes three arguments: * - a string representation of what is being tested * - the expected result * - the actual result * * for example, a test might look like this: * * var helloworld = "hello world"; * * addtestcase( * "var helloworld = 'hello world'", //
description of the test * "hello world", // expected result * helloworld ); // actual result * */ // add your tests here var helloworld = "hello world"; addtestcase( "var helloworld = 'hello world'", "hello world", helloworld ); test(); // leave this alone.
Tamarin Build System Documentation - Archive of obsolete content
create a user repository, instructions are https://developer.mozilla.org/en/publishing_mercurial_clones go to the request a sandbox build page http://tamarin-builds.mozilla.org/build_trigger/requestbuild.cfm enter the repository url, revision number, email address, and
description.
... the
description appears in the buildbot status page, please describe what you are trying to build and test after submitting a sandbox build view the build status page or the queue (if buildbot is busy) how do i view and change the queue?
windowsShortcut - Archive of obsolete content
method of file object syntax int windowsshortcut( folderobject atarget, folderobject ashortcutpath, string a
description, folderobject aworkingpath, string aparams, folderobject aicon, number aiconid); parameters the windowsshortcut method has the following parameters: atarget a filespecobject representing the absolute path (including filename) to file that the shortcut will be created for.
... a
description string
description for the shortcut to be used as the shortcut name with a .lnk extension (do not include .lnk in the string).
getFolder - Archive of obsolete content
see the list in the
description section for the two sets of locations.
...
description the getfolder method obtains an object representing one of netscape's standard directories, for use with the addfile and getwinprofile methods.
initInstall - Archive of obsolete content
the client version registry is a hierarchical
description of the software registered for use with netscape 6.
...
description the initinstall method initializes the installation of the specified software.
createKey - Archive of obsolete content
for information on this parameter, see the
description of regcreatekeyex in your windows api documentation.
...
description the createkey method adds a key to the registry.
Menus - Archive of obsolete content
firefox menus element id
description main-menubar the menubar element.
... firefox context menu element id
description relevant context contentareacontextmenu the popup for the context menu when a web page is displayed in the browser area.
menulist.appendItem - Archive of obsolete content
« xul reference home appenditem( label, value,
description ) return type: element creates a new menuitem element and adds it to the end of the menulist.
... you may optionally set a value and
description.
Providing Command-Line Options - Archive of obsolete content
* @param aargument an argument to pass to the window (may be null) */ function openwindow(achromeurispec, aargument) { services.ww.openwindow(null, achromeurispec, "_blank", "chrome,menubar,toolbar,status,resizable,dialog=no", aargument); } // command line handler function commandlinehandler() { }; commandlinehandler.prototype = { class
description: "myapphandler", // changeme: generate a unique id classid: components.id('{2991c315-b871-42cd-b33f-bfee4fcbf682}'), // changeme: change the type in the contractid to be unique to your application contractid: "@mozilla.org/commandlinehandler/general-startup;1?type=myapp", _xpcom_categories: [{ category: "command-line-handler", // changeme: // category names are sorted alphab...
... parameter passed to -viewapp on the command line."); } // changeme: change "myapp" to your command line flag (no argument) if (cmdline.handleflag("myapp", false)) { openwindow(chrome_uri, null); cmdline.preventdefault = true; } }, // changeme: change the help info as appropriate, but // follow the guidelines in nsicommandlinehandler.idl // specifically, flag
descriptions should start at // character 24, and lines should be wrapped at // 72 characters with embedded newlines, // and finally, the string should end with a newline helpinfo : " -myapp open my application\n" + " -viewapp <uri> view and edit the uri in my application,\n" + " wrapping this
description\n" }; var nsgetfactory = ...
Additional Navigation - Archive of obsolete content
g/dc/elements/1.1/" xmlns:r="http://www.xulplanet.com/rdf/"> <rdf:seq rdf:about="http://www.xulplanet.com/rdf/myphotos"> <rdf:li rdf:resource="http://www.xulplanet.com/ndeakin/images/t/palace.jpg"/> <rdf:li rdf:resource="http://www.xulplanet.com/ndeakin/images/t/canal.jpg"/> <rdf:li rdf:resource="http://www.xulplanet.com/ndeakin/images/t/obelisk.jpg"/> </rdf:seq> <rdf:
description rdf:about="http://www.xulplanet.com/ndeakin/images/t/palace.jpg" dc:title="palace from above"> <r:country resource="http://www.daml.org/2001/09/countries/iso#it"/> </rdf:
description> <rdf:
description rdf:about="http://www.xulplanet.com/ndeakin/images/t/canal.jpg" dc:title="canal"> <r:country resource="http://www.daml.org/2001/09/countries/iso#nl"/...
...> </rdf:
description> <rdf:
description rdf:about="http://www.xulplanet.com/ndeakin/images/t/obelisk.jpg" dc:title="obelisk"> <r:country resource="http://www.daml.org/2001/09/countries/iso#it"/> </rdf:
description> <rdf:
description about="http://www.daml.org/2001/09/countries/iso#it" dc:title="italy"/> <rdf:
description about="http://www.daml.org/2001/09/countries/iso#nl" dc:title="netherlands"/> </rdf:rdf> a new country predicate has been added to each photo pointing to another resource.
Result Generation - Archive of obsolete content
<?xml version="1.0"?> <rdf:rdf xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:rel="http://www.xulplanet.com/rdf/"> <rdf:
description rdf:about="http://www.xulplanet.com/rdf/a"> <rel:relateditem rdf:resource="http://www.xulplanet.com/rdf/b"/> <rel:relateditem rdf:resource="http://www.xulplanet.com/rdf/c"/> <rel:relateditem rdf:resource="http://www.xulplanet.com/rdf/d"/> </rdf:
description> <rdf:
description rdf:about="http://www.xulplanet.com/rdf/c"> <rel:relateditem rdf:resource="http://www.xulplanet.com/rdf...
.../d"/> </rdf:
description> </rdf:rdf> for a xul template query, you first need to select a starting point in the rdf graph.
Using Multiple Queries to Generate More Results - Archive of obsolete content
if we add the following data about people to the neighbourhood datasource: <rdf:
description rdf:about="http://www.xulplanet.com/rdf/myneighbourhood"> <r:people> <rdf:seq> <rdf:li rdf:resource="http://www.xulplanet.com/rdf/person/1"/> <rdf:li rdf:resource="http://www.xulplanet.com/rdf/person/2"/> </rdf:seq> </r:people> </rdf:
description> <rdf:
description rdf:about="http://www.xulplanet.com/rdf/person/1" dc:title="nathan"/> <r...
...df:
description rdf:about="http://www.xulplanet.com/rdf/person/2" dc:title="karen"/> we can then use two queries to generate results from different parts of the datasource.
Custom toolbar button - Archive of obsolete content
paste it into the new file: <?xml version="1.0"?> <rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <
description about="urn:mozilla:install-manifest" em:name="custom button" em:
description="my custom toolbar button" em:creator="my name" em:id="custom-toolbar-button@example.com" em:version="1.0" em:homepageurl="http://developer.mozilla.org/en/docs/custom_toolbar_button" em:iconurl="chrome://custombutton/content/icon.png" > <em:targetapplication><!-- firefox --> <...
...
description em:id="{ec8030f7-c20a-464f-9b0e-13a3a9e97384}" em:minversion="1.4" em:maxversion="*" /> </em:targetapplication> <em:targetapplication><!-- thunderbird --> <
description em:id="{3550f703-e582-4d05-9a08-453d09bdfdc6}" em:minversion="1.5" em:maxversion="51.0" /> </em:targetapplication> <em:targetapplication><!-- sunbird --> <
description em:id="{718e30fb-e89b-41dd-9da7-e25a45638b28}" em:minversion="0.2.9" em:maxversion="99" /> </em:targetapplication> <em:file> <
description about="urn:mozilla:extension:custombutton" em:package="content/custombutton/" /> </em:file> </
description> </rdf> optionally customize the file by changing the name,
description and c...
Adding Methods to XBL-defined Elements - Archive of obsolete content
for example: xul: <box id="outer" class="container"> <button label="one"/> <button label="two"/> <button label="three"/> <button label="four"/> </box> xbl: <binding id="labeledbutton"> <content> <
description value="a stack:"/> <stack> <children/> </stack> </content> </binding> if you use the dom functions such as childnodes to get the children of the the xul box element with the id of outer, you willl find that it has has 4 children.
...the length of the anonymous array of the outer box is two, the first element the
description element and the second the stack element.
Creating Dialogs - Archive of obsolete content
?> <dialog id="donothing" title="dialog example" xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul" buttons="accept,cancel" ondialogaccept="return dook();" ondialogcancel="return docancel();"> <script> function dook(){ alert("you pressed ok!"); return true; } function docancel(){ alert("you pressed cancel!"); return true; } </script> <
description value="select a button"/> </dialog> you may place any elements that you wish in a dialog.
... buttons="accept,cancel" buttonlabelaccept="set favourite" buttonaccesskeyaccept="s" ondialogaccept="return dosave();" buttonlabelcancel="cancel" buttonaccesskeycancel="n" ondialogcancel="return docancel();"> <script> function dosave(){ //dosomething() return true; } function docancel(){ return true; } </script> <dialogheader title="my dialog"
description="example dialog"/> <groupbox flex="1"> <caption label="select favourite fruit"/> <radio id="orange" label="oranges because they are fruity"/> <radio id="violet" selected="true" label="strawberries because of their colour"/> <radio id="yellow" label="bananas because they are pre-packaged"/> </groupbox> </dialog> the buttons elements can be accessed with the following javascript // the ...
Creating a Wizard - Archive of obsolete content
an example wizard source <?xml version="1.0"?> <?xml-stylesheet href="chrome://global/skin/" type="text/css"?> <wizard id="example-window" title="select a dog wizard" xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"> <wizardpage> <
description> this wizard will help you select the type of dog that is best for you." </
description> <label value="why do you want a dog?"/> <menulist> <menupopup> <menuitem label="to scare people away"/> <menuitem label="to get rid of a cat"/> <menuitem label="i need a best friend"/> </menupopup> </menulist> </wizardpage> <wizardpage
description=...
... the
description attribute may optionally be placed on a wizardpage element to provide a sub-caption for that page.
Element Positioning - Archive of obsolete content
examples of setting widths and heights <button label="1" style="width: 100px;"/> <button label="2" style="width: 100em; height: 10px;"/> <button label="3" flex="1" style="min-width: 50px;"/> <button label="4" flex="1" style="min-height: 2ex; max-width: 100px"/> <textbox flex="1" style="max-width: 10em;"/> <
description style="max-width: 50px">this is some boring but simple wrapping text.</
description> example 1 the first button will be displayed with a width of 100 pixels (px means pixels).
... example 6 the
description element is constrained to have a maximum width of 50 pixels.
More Button Features - Archive of obsolete content
for example, the following will create a button where two of the words are red: example 4 : source view <button> <
description value="this is a"/> <
description value="rather strange" style="color: red;"/> <
description value="button"/> </button> any xul element may be placed inside the button.
... html elements will be ignored, so you need to wrap them inside a
description element.
Popup Menus - Archive of obsolete content
this type of popup is usually used to provide a
description of a button in more detail than can be provided on the button itself.
... example 2 : source view <button label="save" tooltiptext="click here to save your stuff"/> <popupset> <tooltip id="moretip" orient="vertical" style="background-color: #33dd00;"> <
description value="click here to see more information"/> <
description value="really!" style="color: red;"/> </tooltip> </popupset> <button label="more" tooltip="moretip"/> these two buttons each have a tooltip.
Tabboxes - Archive of obsolete content
<vbox flex="1"> <tabbox selectedindex="1"> <tabs> <tab label="search"/> <tab label="options"/> </tabs> <tabpanels> <tabpanel id="searchpanel" orient="vertical"> <
description> enter your search criteria below and select the find button to begin the search.
... </
description> <spacer style="height: 10px"/> <groupbox orient="horizontal"> <caption label="search criteria"/> <menulist id="searchtype"> <menupopup> <menuitem label="name"/> <menuitem label="size"/> <menuitem label="date modified"/> </menupopup> </menulist> <spacer style="width: 10px;"/> <menulist id="searchmode"> <menupopup> <menuitem label="is"/> <menuitem label="is not"/> </menupopup> </menulist> <spacer style="height: 10px"/> <textbox id="find-text" flex="1" style="min-width: 15em;"/> </groupbox> </tabpanel> <tabpanel id="optionspanel" orient="vertical"> <checkbox id="casecheck" label="case sensitive search"/> <checkbox id="wordsc...
Templates - Archive of obsolete content
you can use a similar technique for any attribute that might be on an rdf
description element.
...in the case of an rdf file, the resources would be the
description elements.
The Box Model - Archive of obsolete content
<vbox flex="1"> <
description> enter your search criteria below and select the find button to begin the search.
... </
description> <hbox> <label value="search for:" control="find-text"/> <textbox id="find-text"/> </hbox> <hbox> <spacer flex="1"/> <button id="find-button" label="find"/> <button id="cancel-button" label="cancel"/> </hbox> </vbox> the vertical box causes the main text, the box with the textbox and the box with the buttons to orient vertically.
XBL Attribute Inheritance - Archive of obsolete content
for example, to create a labeled textbox (a textbox with a text
description beside it) out of a label and a textbox element, the label will need to inherit its text from the value attribute and the textbox will also need to inherit its default value from the value attribute as well.
...if you need to map an attribute to the text content of the node, use "xbl:text" as the inner attribute, eg: <xul:
description xbl:inherits="xbl:text=value"/> in the next section, we look at adding properties, methods and events to a binding.
XBL Example - Archive of obsolete content
conveniently, we can change the page using the custom 'page' property that was just added: <xul:button xbl:inherits="label=previoustext" oncommand="parentnode.parentnode.parentnode.page--;"/> <xul:
description flex="1"/> <xul:button xbl:inherits="label=nexttext" oncommand="parentnode.parentnode.parentnode.page++;"/> because the 'page' property is only on the outer xul element, we need to to use the parentnode property to get to it.
... the final code the final code is as follows: example 2 : source <binding id="slideshow"> <content> <xul:vbox flex="1"> <xul:deck xbl:inherits="selectedindex" selectedindex="0" flex="1"> <children/> </xul:deck> <xul:hbox> <xul:button xbl:inherits="label=previoustext" oncommand="parentnode.parentnode.parentnode.page--;"/> <xul:
description flex="1"/> <xul:button xbl:inherits="label=nexttext" oncommand="parentnode.parentnode.parentnode.page++;"/> </xul:hbox> </xul:vbox> </content> <implementation> <constructor> var totalpages=this.childnodes.length; document.getanonymousnodes(this)[0].childnodes[1].childnodes[1] .setattribute("value",(this.page+1)+" of "+total...
XUL Changes for Firefox 1.5 - Archive of obsolete content
<menulist> items in a <menulist> support the
description attribute to allow for extra descriptive text to appear beside an item's label.
... the menulist modification methods appenditem and insertitemat take an extra
description argument when creating items this way.
XUL Reference - Archive of obsolete content
« xul reference « alphabetical list of all xul elements action arrowscrollbox assign bbox binding bindings box broadcaster broadcasterset button browser checkbox caption clicktoscroll colorpicker column columns commandset command conditions content datepicker deck
description dialog dialogheader dropmarker editor grid grippy groupbox hbox iframe image key keyset label listbox listcell listcol listcols listhead listheader listitem member menu menubar menuitem menulist menupopup menuseparator notification notificationbox observes overlay page panel param popupset preference preferences prefpane prefwindow progressmeter query queryset radio radiogroup resizer richlistbox richlistitem row rows rule scale script scr...
...bar toolbarbutton toolbargrippy toolbaritem toolbarpalette toolbarseparator toolbarset toolbarspacer toolbarspring toolbox tabbox tabs tab tabpanels tabpanel groupbox caption separator spacer button checkbox colorpicker datepicker menulist progressmeter radio radiogroup scale splitter textbox textbox (firefox autocomplete) textbox (mozilla autocomplete) timepicker
description label image listbox listitem listcell listcol listcols listhead listheader richlistbox richlistitem tree treecell treechildren treecol treecols treeitem treerow treeseparator box hbox vbox bbox deck stack grid columns column rows row scrollbox action assign binding bindings conditions content member param query queryset rule template textnode triple w...
XUL Template Primer - Bindings - Archive of obsolete content
<?xml version="1.0"?> <rdf:rdf xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:nc="http://home.netscape.com/nc-rdf#"> <rdf:
description about="urn:root"> <nc:friends> <rdf:seq> <rdf:li> <rdf:
description nc:name="alison appel"> <nc:address resource="#home"/> </rdf:
description> </rdf:li> <rdf:li> <rdf:
description nc:name="jack"> <nc:address resource="#doghouse"/> </rdf:
description> </rdf:li> <rdf:li> <rdf:desc...
...ription nc:name="lumpy"/> </rdf:li> </rdf:seq> </nc:friends> </rdf:
description> <rdf:
description id="home" nc:street="437 hoffman"/> <rdf:
description id="doghouse" nc:street="435 hoffman"/> </rdf:rdf> the rdf model that this file creates can be represented with the following graph.
menuitem - Archive of obsolete content
attributes acceltext, accesskey, allowevents, autocheck, checked, closemenu, command, crop,
description, disabled, image, key, label, name, selected, tabindex, type, validate, value properties accessibletype, accesskey, command, control, crop, disabled, image, label, labelelement, parentcontainer, selected, tabindex, value style classes menuitem-iconic, menuitem-non-iconic examples <menulist> <menupopup> <menuitem label="option 1" value="1"/> <menuitem label="option 2" value="2"/> <menuitem label="option 3" value="3"/> ...
...for example, for a menuitem in a menu you can add the following css rule when you want to use the value none: menupopup > menuitem, menupopup > menu { max-width: none; }
description type: string descriptive text to appear in addition to the dialog title.
panel - Archive of obsolete content
<panel id="thepanel"> <hbox align="start"> <image src="warning.png"/> <vbox> <
description value="you have 6 new messages."/> <hbox> <button label="read mail"/> <button label="new message"/> </hbox> </vbox> </hbox> </panel> <
description value="6 new messages" popup="thepanel"/> attributes backdrag type: boolean setting the backdrag attribute on a xul panel lets the user move the panel by clicking and dragging anywhere on its background area.
...check positioning of the popup guide for a precise
description of the effect of the different values.
window - Archive of obsolete content
--> <window id="rootwnd" title="register online!" xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"> <vbox> <hbox> <image src="application_form.png"/> <
description>register online!</
description> </hbox> <groupbox align="start"> <caption label="your information"/> <radiogroup> <vbox> <hbox> <label control="your-fname" value="enter first name:"/> <textbox id="your-fname" value="johan"/> </hbox> <hbox> <label control="your-lname" value="enter last name:"/> ...
... <textbox id="your-lname" value="hernandez"/> </hbox> <hbox> <button oncommand="alert('save!')"> <
description>save</
description> </button> </hbox> </vbox> </radiogroup> </groupbox> </vbox> </window> attributes accelerated type: booleanset this attribute to true to allow hardware layer managers to accelerate the window.
Creating a Windows Inno Setup installer for XULRunner applications - Archive of obsolete content
a.org/en/docs/getting_started_with_xulrunner appupdatesurl=http://developer.mozilla.org/en/docs/getting_started_with_xulrunner defaultdirname={pf}\my app defaultgroupname=my app allownoicons=yes outputdir=..\build\output outputbasefilename=myapp-1.0-win32 ; setupiconfile= compression=lzma solidcompression=yes [languages] name: english; messagesfile: compiler:default.isl [components] name: main;
description: my app; types: full compact custom; flags: fixed name: runtime;
description: xul runner runtime; types: full custom [tasks] name: desktopicon;
description: {cm:createdesktopicon}; group
description: {cm:additionalicons}; flags: unchecked name: quicklaunchicon;
description: {cm:createquicklaunchicon}; group
description: {cm:additionalicons}; flags: unchecked [files] source: c:\develop\xulrunnerin...
...gnoreversion" on any shared system files [icons] name: {group}\my app; filename: {app}\myapp.exe name: {group}\{cm:uninstallprogram,xul explorer}; filename: {uninstallexe} name: {userdesktop}\my app; filename: {app}\myapp.exe; tasks: desktopicon name: {userappdata}\microsoft\internet explorer\quick launch\my app; filename: {app}\myapp.exe; tasks: quicklaunchicon [run] filename: {app}\myapp.exe;
description: {cm:launchprogram,my app}; onlybelowversion: 0,6; flags: nowait postinstall skipifsilent step 4: building an installer once your script is ready, start the inno setup compiler, load the script file, and compile it.
Getting started with XULRunner - Archive of obsolete content
.0"?> <?xml-stylesheet href="chrome://global/skin/" type="text/css"?> <window id="main" title="my app" width="300" height="300" xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"> <script type="application/javascript" src="chrome://myapp/content/main.js"/> <caption label="hello world"/> <separator/> <button label="more >>" oncommand="showmore();"/> <separator/> <
description id="more-text" hidden="true">this is a simple xulrunner application.
... xul is simple to use and quite powerful and can even be used on mobile devices.</
description> </window> note: make sure there is no extra whitespace at the beginning of the xml/xul file the application also has a javascript file.
calIFileType - Archive of obsolete content
defined in calendar/base/public/caliimportexport.idl interface code [scriptable, uuid(efef8333-e995-4f45-bdf7-bfcabbd9793e)] interface califiletype : nsisupports { readonly attribute astring defaultextension; readonly attribute astring extensionfilter; readonly attribute astring
description; }; attributes defaultextension the default extension that should be associated with files of this type.
...
description the
description to show to the user in the filter list.
NPN_GetURLNotify - Archive of obsolete content
notifydata plug-in-private value for associating the request with the subsequent npp_urlnotify() call, which passes this value (see
description below).
...
description npn_geturlnotify() works just like npn_geturl(), with one exception: npn_geturlnotify() notifies the plug-in instance upon successful or unsuccessful completion of the request by calling the plug-in's npp_urlnotify() function and passing it the notifydata value.
NPN_PostURLNotify - Archive of obsolete content
notifydata plug-in-private value for associating the request with the subsequent npp_urlnotify call, which returns this value (see
description below).
...
description npn_posturlnotify functions identically to npn_posturl, with these exceptions: npn_posturlnotify supports specifying headers when posting a memory buffer.
NPN_Status - Archive of obsolete content
description you can use this function to make your plug-in display status information in the browser window, in the same place the browser does.
... if your plug-in has a button or other object that acts as a link when clicked, you can call npn_status() to display a
description or url when the user moves the cursor over it.
NP_GetValue - Archive of obsolete content
values: nppvpluginnamestring: gets the name of the plug-in nppvplugin
descriptionstring: gets the
description string of the plug-in value plug-in name, returned by the function.
...
description none.
Shipping a plugin as a Toolkit bundle - Archive of obsolete content
for a plugin the manifest only needs to be very simple: <rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <
description about="urn:mozilla:install-manifest"> <em:id>mypluginid@myplugin.com</em:id> <em:name>my plugin</em:name> <em:version>1.0</em:version> <em:targetapplication> <
description> <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id> <em:minversion>1.5</em:minversion> <em:maxversion>4.0.*</em:maxversion> </
description> </em:targetapplication> <e...
...m:unpack>true</em:unpack> </
description> </rdf> this contains 5 required pieces of information.
Introduction to Public-Key Cryptography - Archive of obsolete content
see "certificate-based authentication" for a
description of the way client ssl certificates are used for client authentication.
...for a more detailed
description of the signature verification process in the context of ssl client and server authentication, see "introduction to ssl." managing certificates certificates are used in many applications, from encrypting email to accessing websites.
Sunbird Theme Tutorial - Archive of obsolete content
copy and paste the content from here, making sure that you scroll to get all of it: <?xml version="1.0"?> <rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <
description about="urn:mozilla:install-manifest" em:id="just-testing@example.com" em:name="just testing" em:creator="rod whiteley" em:
description="a test theme for sunbird" em:homepageurl="http://developer.mozilla.org/" em:version="0.1" em:internalname="testing" em:type="4" > <em:targetapplication><!-- sunbird --> <
description em:id="{718e30fb-e89b-41dd-9d...
...a7-e25a45638b28}" em:minversion="0.2.9" em:maxversion="0.4" /> </em:targetapplication> </
description> </rdf> in the line that starts <tt>em:id</tt>, paste your identifier between the double-quote characters, replacing the identifier that is there now.
install.rdf - Archive of obsolete content
copy the following text and paste it into a text file, then save that file as "install.rdf": <?xml version="1.0"?> <rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#"> <
description about="urn:mozilla:install-manifest"> <em:id>{themes_uuid}</em:id> <em:version>themes_version</em:version> <!-- target application this extension can install into, with minimum and maximum supported versions.
... --> <em:targetapplication> <
description> <!-- firefox's uuid --> <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id> <em:minversion>min_ff_version</em:minversion> <em:maxversion>max_ff_version</em:maxversion> </
description> </em:targetapplication> <!-- front end metadata --> <!-- my_theme --> <em:name>my_theme</em:name> <em:
description>my_theme</em:
description> <em:creator>your_name</em:creator> <em:contributor>contributors_names</em:contributor> <em:homepageurl>themes_homepage</em:homepageurl> <em:updateurl> url_of_update_location </em:updateurl> <em:abouturl> url_of_about_page </em:abouturl> <!-- front end integration hooks (used by theme manager)--> <em:internalname>my_theme</em:internalname> </
description> </rdf> ...
Theme changes in Firefox 2 - Archive of obsolete content
file
description of change browser/bookmarks/addbookmark.css updated to include microsummary-related css changes.
... preferences/preferences.css the following styles are no longer used in firefox 2 and should be removed from your theme: #browserstartuphomepage #browserstartuphomepage #panedownloads
description #panegeneral
description radio[pane=panedownloads] radio[pane=panedownloads]:active the following styles need to be added to your theme to make it compatible with firefox 2: #panecontent
description #panemain
description #panesecurity
description radio[pane=paneadvanced]:hover radio[pane=paneadvanced][selected="true"] radio[pane=panecontent]:hover radio[pane=panecontent][selected="t...
Theme changes in Firefox 3 - Archive of obsolete content
all file list all platforms file
description of change browser/themes/*/browser/browser.css the width of the drag and drop indicator is no longer calculated during the drag (tabbrowser.xml).
... mac os x file
description of change browser/themes/pinstripe/browser/tabbrowser/tabdragindicator.png removed superfluous blank pixels from the edges, so that the image is smaller.
Updating an extension to support multiple Mozilla applications - Archive of obsolete content
this is done by adding new <targetapplication> tags to the install.rdf file, like this: <!-- describe the thunderbird versions we support --> <em:targetapplication> <
description> <em:id>{3550f703-e582-4d05-9a08-453d09bdfdc6}</em:id> <em:minversion>1.5</em:minversion> <em:maxversion>2.0.0.*</em:maxversion> </
description> </em:targetapplication> <!-- describe the sunbird versions we support --> <em:targetapplication> <
description> <em:id> {718e30fb-e89b-41dd-9da7-e25a45638b28}</em:id> <em:minversion>0.2</em:...
...minversion> <em:maxversion>0.4.*</em:maxversion> </
description> </em:targetapplication> these two blocks indicate that the extension supports thunderbird versions 1.5 through 2.0.0.x, sunbird versions 0.2 through 0.4.x.
E4X for templating - Archive of obsolete content
, <toolbarbutton label={$s('mytoolbar.label')}/> conditionals function _if (cond, h, _else) { if (cond && cond != undefined) { // we need undefined condition for e4x return h(cond); } else if (_else) { return _else(cond); } return ''; // empty string allows conditions in attribute as well as element content } for example: {_if(elems.length(), function () <
description>{elems[0]}</
description>, function _else () <label>no data</label> )} note that the simple xmllist() constructor (<></>) may be useful to still be able to use an expression closure (i.e., without needing return statements and braces): {_if(elems.length(), function () <> <markup/> <markup/> </>)} note that, while it is convenient to store such e4x in separate file templates...
... } if (it > max) { break; } ret+=h(k, arr[k], it, lev); ++it; } } return ret; } the following real case example iterates over an array of the lines in an e4x child element to produce an xmllist of multiple vbox's representing each line: <vbox> {foreach(e(someel.somechild[0]).split('\n'), function (line) <
description>{line}</
description> )} </vbox> the following example shows iteration over an e4x object itself: {foreach(elems, function (k, elem, iter) <> <row>{k}: {elem}</row> <row><image src="chrome://myext/skin/images/fillerrow.jpg" /></row> </>)} or if the e4x child element had its own children and text: {foreach(elems, function (k, elem, iter) <> <row>{k}: {elem.text()} {elem.somechild}...
Debug - Archive of obsolete content
constants async callback status codes contant
description value debug.ms_async_callback_status_assign_delegate the synchronous work item assigned a callback or continuation to be run by an asynchronous operation.
... 4 async operation status codes contant
description value debug.ms_async_op_status_success the asynchronous operation was successful.
New in JavaScript 1.8.5 - Archive of obsolete content
new features in javascript 1.8.5 new functions function
description object.create() creates a new object with the specified prototype object and properties.
... new objects object
description old proxy api offers support for creating object and function proxies that enable meta-programming in javascript.
Old Proxy API - Archive of obsolete content
fundamental traps emulated javascript code handler method
description object.getownpropertydescriptor(proxy, name) getownpropertydescriptor: function(name) -> propertydescriptor | undefined should return a valid property descriptor object, or undefined to indicate that no property with name exists in the emulated object.
... emulated javascript code handler method default implementation
description name in proxy has: function(name) -> boolean function(name) { return !!this.getpropertydescriptor(name); } object.prototype.hasownproperty.call(proxy, name) hasown: function(name) -> boolean function(name) { return !!this.getownpropertydescriptor(name); } proxy.name (in the context of "getting the value") receiver.
XForms Config Variables - Archive of obsolete content
a
description of the about:config preferences that xforms uses.
... preference default
description xforms.disablepopup false disables xforms engine popup error messages xforms.enableexperimentalfeatures false enable experimental features.
Visual typescript game engine - Game development
*/ private addson: addson = [ { name: "cache", enabled: true, scriptpath: "externals/cacheinit.ts", }, { name: "hackertimer", enabled: true, scriptpath: "externals/hack-timer.js", }, { name: "dragging", enabled: true, scriptpath: "externals/drag.ts", }, ]; /** * @
description this is main coordinary types of positions * can be "diametric-fullscreen" or "frame".
... * default value is 9001 */ private broadcasterport: number = 9001; /** * @
description important note for this property: if you * disable (false) you cant use account system or any other * network.
Debugging CSS - Learn web development
the layout view shows you a diagram of the box model on the selected element, along with a
description of the properties and values that change how the element is laid out.
... this includes a
description of properties that you may not have explicitly used on the element, but which do have initial values set.
Attribute selectors - Learn web development
selector example
description [attr] a[title] matches elements with an attr attribute (whose name is the value in square brackets).
... selector example
description [attr^=value] li[class^="box-"] matches elements with an attr attribute (whose name is the value in square brackets), whose value begins with value.
Pseudo-classes and pseudo-elements - Learn web development
pseudo-classes selector
description :active matches when the user activates (for example clicks on) an element.
... pseudo-elements selector
description ::after matches a stylable element appearing after the originating element's actual content.
Basic native form controls - Learn web development
for maximum usability/accessibility, you are advised to surround each list of related items in a <fieldset>, with a <legend> providing an overall
description of the list.
...you've met some of these already, but below is a list of those common attributes, for your reference: attribute name default value
description autofocus false this boolean attribute lets you specify that the element should automatically have input focus when the page loads.
Getting started with HTML - Learn web development
title: the title attribute specifies extra information about the link, such as a
description of the page that is being linked to.
...this includes keywords and a page
description that would appear in search results, css to style content, character set declarations, and more.
Index - Learn web development
231 advanced text formatting beginner, codingscripting, guide, html, learn, text, abbreviation,
description list, quote, semantic that marks the end of our study of html text semantics.
...dictionaries and glossaries formally associate keywords with one or more
descriptions, as in this case: 255 tips for authoring fast-loading html pages advanced, guide, html, needsupdate, performance, web, web performance these tips are based on common knowledge and experimentation.
Making asynchronous programming easier with async and await - Learn web development
status: ${response.status}`); } else { if(type === 'blob') { content = await response.blob(); } else if(type === 'text') { content = await response.text(); } return content; } } async function displaycontent() { let coffee = fetchanddecode('coffee.jpg', 'blob'); let tea = fetchanddecode('tea.jpg', 'blob'); let
description = fetchanddecode('
description.txt', 'text'); let values = await promise.all([coffee, tea,
description]); let objecturl1 = url.createobjecturl(values[0]); let objecturl2 = url.createobjecturl(values[1]); let desctext = values[2]; let image1 = document.createelement('img'); let image2 = document.createelement('img'); image1.src = objecturl1; image2.src = objecturl2; document.bo...
...see the promise.all() line: let values = await promise.all([coffee, tea,
description]); by using await here we are able to get all the results of the three promises returned into the values array, when they are all available, in a way that looks very much like sync code.
Vue conditional rendering: editing existing todos - Learn web development
font-smoothing: grayscale; color: #0b0c0c; display: block; margin-bottom: 5px; } input { display: inline-block; margin-top: 0.4rem; width: 100%; min-height: 4.4rem; padding: 0.4rem 0.8rem; border: 2px solid #565656; } form { display: flex; flex-direction: row; flex-wrap: wrap; } form > * { flex: 0 0 100%; } </style> note: walk through the above code then read the below
description to make sure you understand everything the component is doing before moving on.
...to understand this better, it is a good idea to write out a flow chart,
description, or diagram of what events are emitted where, where they are being listened for, and what happens as a result of them firing.
Accessible Toolkit Checklist
note, you can use the accessible
description to expose the current tab position, such as "3 of 5" in order to provide ease of access for the user.
...note, you can use the accessible
description to expose the current tree view level and position, such as "l3, 6 of 9" in order to provide ease of access for the user.
Lightweight themes
describe your theme — write a short
description of your theme.
... keep in mind that a reviewer may reject your theme if your
description is not an accurate representation of your theme.
Theme concepts
full detais of the alignment and tiling options can be found in the "theme" key
description.
...full details of the alignment options can be found in the "theme" key
description.
What to do and what not to do in Bugzilla
include a link to your bugzilla activity page in the bug
description.
... resolving bugs as duplicate in general newer bugs should be marked as duplicates of older bugs, except when the newer bug contains more information (bug
description clearer, patch already attached, lots of people already cc'ed, etc.).
Reviewer Checklist
the first line should be a short
description (since only the first line is shown in the log), and additional
description, if needed, should be present, properly wrapped, in later lines.
... [fennec: make sure content
description is set for parts of the ui that should be accessible] ...
Displaying Places information using views
the following table shows the mappings between these magic column id values and their corresponding nsinavhistoryresultnode properties: treecol id or anonid corresponding nsinavhistoryresultnode property title title url uri date time visitcount accesscount keyword *
description * dateadded dateadded lastmodified lastmodified tags tags ** icon *keyword and
description are looked up in the places database using the nsinavhistoryresultnode property itemid.
... property type
description flatlist boolean if true the view does not recurse into containers.
mozbrowseropensearch
when an instance of <link rel="search" type="application/opensearch
description+xml"> is encountered.
... general info specification non standard interface customevent bubbles yes cancelable yes target <iframe> default action none properties property type
description target read only eventtarget the browser iframe type read only domstring the type of event.
HTTP Cache
api here is a detailed
description of the http cache v2 api, examples included.
...disk cache memory pool) this is a
description of this feature status that is currently only a patch in bug 986179.
How Mozilla determines MIME Types
if one of these lookups succeed, this is where the application in the "open with" field comes from, and also where the
description of the type comes from.
... if this also failed, the extras are searched again, and will supply the extension-list and a
description of the mime type.
API-provided widgets
properties property
description id the id of the widget (required).
... showinprivatebrowsing whether to show the widget in private browsing mode (optional, default: true) event handlers you can also define several event handlers which will be called at various stages in a widget's lifetime: event handler name
description onbuild(adoc) only useful for custom widgets (and required there); a function that will be invoked with the document in which to build a widget.
Widget Wrappers
attribute
description id the widget's id type the type of widget (button, view, custom).
... attribute
description id the widget's id type the type of widget (button, view, custom).
Downloads.jsm
e module into your javascript scope: components.utils.import("resource://gre/modules/downloads.jsm"); method overview promise<download> createdownload(object aproperties); promise<void> fetch(asource, atarget, [optional] object aoptions); promise<downloadlist> getlist(atype); promise<downloadsummary> getsummary(atype); constants constant
description public work on downloads that were not started from a private browsing window.
... properties attribute type
description error read only constructor constructor for a downloaderror object.
NetUtil.jsm
e, nsioutputstream asink, [optional] acallback) void asyncfetch(asource, acallback) nsichannel newchannel(awhattoload, [optional] aorigincharset, [optional] nsiuri abaseuri) nsiuri newuri(atarget, [optional] aorigincharset, [optional] nsiuri abaseuri) string readinputstreamtostring(ainputstream, acount, aoptions) attributes attribute type
description ioservice nsiioservice returns a reference to nsiioservice.
... options the aoptions parameter is a javascript object which can have any or all of the following fields: field name
description charset the character encoding to use when interpreting the input stream.
Creating localizable web applications
bad: <p class="
description"><?= _("<strong>
description:</strong>");?></p> snippet 8.
... good: <p class="
description"><strong><?= _("
description:");?></strong></p> snippet 9.
Mozilla DOM Hacking Guide
in this document i will try to outline the main aspects of the implementation, beginning with the class info mechanism, which lies at the heart of the dom, then with the
description of various interfaces and classes.
...here is the
description of the structure: const char *mname: c-style string that is passed as second argument to the macro.
Mozilla Quirks Mode Behavior
[this may have been an accurate
description when written in june 2001, but no longer appears accurate.
...[this may have been an accurate
description when written in june 2001, but it no longer appears correct.
about:memory
hover over any button to see a
description of what it does.
... hover over any measurement to see a
description of what it means.
PRIOMethods
description you don't need to know the type declaration for each function listed in the method table unless you are implementing a layer.
... for information about each function, see the corresponding function
description in this document.
PR_LOG
returns nothing
description this macro formats the specified arguments and writes the output to the log file, if logging is enabled for the specified module and level.
... for a
description of formatting and format strings, see "formatted printing".
PR_LogPrint
returns nothing
description this function unconditionally writes a message to the log using the specified format string.
... for a
description of formatting and format strings, see "formatted printing".
nss tech note1
the main non-streaming apis for these two decoders have an identical prototype : secstatus sec_asn1decodeitem(prarenapool *pool, void *dest, const sec_asn1template *t, secitem *item); secstatus sec_quickderdecodeitem(prarenapool* arena, void* dest, const sec_asn1template* templateentry, secitem* src); here is a
description of the arguments : secitem* src† is a structure containing a pointer to the binary data to be decoded, as well as its size.
...it is only required for dynamically allocating memory for the structure if the template is being included from an asn.1 sequence or sequence of, or if dynamic allocation was requested from the parent template using the sec_asn1_pointer modifier here is a
description of the various tags and modifiers that apply to the <tt style="color: rgb(0,0,0);">kind field.
NSS release notes template
new functions in ___.h function -
description new types in ___.h type -
description.
... new macros in ___.h macro -
description notable changes in nss 3.xx ...
FC_Initialize
description fc_initialize initializes the nss cryptographic module for the fips mode of operation.
...th no databases: "configdir='' certprefix='' keyprefix='' secmod='' flags=readonly,nocertdb,nomod db,forceopen,optimizespace " mozilla firefox initializes nss with this string (on windows): "configdir='c:\\documents and settings\\wtc\\application data\\mozilla\\firefox\\profiles\\default.7tt' certprefix='' keyprefix='' secmod='secmod.db' flags=optimizespace manufacturerid='mozilla.org' library
description='psm internal crypto services' cryptotoken
description='generic crypto services' dbtoken
description='software security device' cryptoslot
description='psm internal cryptographic services' dbslot
description='psm private keys' fipsslot
description='psm internal fips-140-1 cryptographic services' fipstoken
description='psm fips-140-1 user private key services' minps=0" see pkcs #11 module specs for com...
NSS environment variables
variable type
description introduced in version nsrandcount integer (byte count) sets the maximum number of bytes to read from the file named in the environment variable nsrandfile (see below).
... variable type
description introduced in version build_opt boolean (1 to enable) do an optimized (not debug) build.
NSS tools : modutil
please contribute to the initial review in mozilla nss bug 836477[1]
description the security module database tool, modutil, is a command-line utility for managing pkcs #11 module information both within secmod.db files and within hardware tokens.
...for example: modutil -list "nss internal pkcs #11 module" -dbdir sql:/home/my/sharednssdb ----------------------------------------------------------- name: nss internal pkcs #11 module library file: **internal only module** manufacturer: mozilla foundation
description: nss internal crypto services pkcs #11 version 2.20 library version: 3.11 cipher enable flags: none default mechanism flags: rsa:rc2:rc4:des:dh:sha1:md5:md2:ssl:tls:aes slot: nss internal cryptographic services slot mechanism flags: rsa:rc2:rc4:des:dh:sha1:md5:md2:ssl:tls:aes manufacturer: mozilla foundation type: software version number: 3.11 firmware version: 0.0 status: enabled tok...
NSS tools : modutil
synopsis modutil [options] arguments
description the security module database tool, modutil, is a command-line utility for managing pkcs #11 module information both within secmod.db files and within hardware tokens.
...for example: modutil -list "nss internal pkcs #11 module" -dbdir sql:/home/my/sharednssdb ----------------------------------------------------------- name: nss internal pkcs #11 module library file: **internal only module** manufacturer: mozilla foundation
description: nss internal crypto services pkcs #11 version 2.20 library version: 3.11 cipher enable flags: none default mechanism flags: rsa:rc2:rc4:des:dh:sha1:md5:md2:ssl:tls:aes slot: nss internal cryptographic services slot mechanism flags: rsa:rc2:rc4:des:dh:sha1:md5:md2:ssl:tls:aes manufacturer: mozilla foundation type: software version number: 3.11 firmware version: 0.0 statu...
NSS tools : signtool
-m -v -w -g nickname -s size -b basename [[-c compression level] ] [[-d cert-dir] ] [[-i installer script] ] [[-m metafile] ] [[-x name] ] [[-f filename] ] [[-t|--token tokenname] ] [[-e extension] ] [[-o] ] [[-z] ] [[-x] ] [[--outfile] ] [[--verbose value] ] [[--norecurse] ] [[--leavearc] ] [[-j directory] ] [[-z jarfile] ] [[-o] ] [[-p password] ] [directory-tree] [archive]
description the signing tool, signtool, creates digital signatures and uses a java archive (jar) file to associate the signatures with files in a directory.
...for more details, see the
description of -m that follows.
Creating JavaScript jstest reftests
reportcompare reportcompare(expected, actual,
description) is somewhat like asserteq(actual, expected,
description) except that the first two arguments are swapped, failures are reported via stdout rather than by throwing exceptions, and the matching is fuzzy in an unspecified way.
... expected = 3; actual = 1 + 2; reportcompare(expected, actual, '3==1+2'); comparesource comparesource(expected, actual,
description) is used to test if the decompilation of a javascript object (conversion to source code) matches an expected value.
Hacking Tips
debugging tips getting help (from js shell) use the help function to get the list of all primitive functions of the shell with their
description.
...each root has the form "0xabcd1234 <color> <
description>", where <color> is the color of the given gc thing (b for black, g for gray, w for white) and <
description> is a string.
BOOLEAN_TO_JSVAL
syntax jsval boolean_to_jsval(bool b); name type
description b bool c integer value to be converted to a boolean jsval.
...
description boolean_to_jsval converts a bool argument, b, to a boolean jsval.
DOUBLE_TO_JSVAL
syntax jsval double_to_jsval(double d); name type
description d double c double to convert to a jsval.
...
description double_to_jsval is the inverse of js::tonumber.
INT_FITS_IN_JSVAL
*/ name type
description i jsint the c integer value to check.
...
description determines if a specified c integer value, i, lies within the range allowed for integer jsvals.
INT_TO_JSVAL
syntax jsval int_to_jsval(int32_t i); name type
description i any integer type c integer to convert to a jsval.
...
description int_to_jsval converts a c integer, i, to a jsval.
JS::Add*Root
const char *name); bool js::addnamedstringroot(jscontext *cx, js::heap<jsstring *> *rp, const char *name); bool js::addnamedobjectroot(jscontext *cx, js::heap<jsobject *> *rp, const char *name); bool js::addnamedscriptroot(jscontext *cx, js::heap<jsscript *> *rp, const char *name); name type
description cx jscontext * the context in which to add the new root.
...
description the js::add*root and functions add a c/c++ variable to the garbage collector's root set, the set of variables used as starting points each time the collector checks to see what memory is reachable.
JS::AutoSaveExceptionState
syntax js::autosaveexceptionstate(jscontext *cx); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js::autosaveexceptionstate saves and later restores the current exception state of a given jscontext.
JS::AutoValueArray
syntax js::autovaluearray<n> vp(cx); name type
description cx jscontext * the context in which to add the root.
...
description js::autovaluearray<n> holds a rooted array of js::value.
JS::AutoVectorRooter
syntax js::autovectorrooter(jscontext* cx); methods method
description size_t length() const returns the length of the array.
...
description js::autovectorrooter<t> holds a variable-size rooted array of type t.
JS::BooleanValue
syntax js::value js::booleanvalue(bool boo) name type
description boo bool c bool to convert.
...
description js::booleanvalue converts a c boolean of type bool to js::value, the type of javascript values.
JS::Call
, const js::handlevaluearray& args, js::mutablehandlevalue rval); bool js::call(jscontext *cx, js::handlevalue thisv, js::handlevalue fun, const js::handlevaluearray& args, js::mutablehandlevalue rval); bool js::call(jscontext *cx, js::handlevalue thisv, js::handleobject funobj, const js::handlevaluearray& args, js::mutablehandlevalue rval); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js::call calls a specified function, fun, on an object, thisobj.
JS::CloneFunctionObject
syntax jsobject * js::clonefunctionobject(jscontext *cx, js::handleobject funobj); jsobject * js::clonefunctionobject(jscontext *cx, js::handleobject funobj, js::autoobjectvector &scopechain); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js::clonefunctionobject creates a new function object from funobj.
JS::Compile
mutablehandlescript script); bool js::compile(jscontext *cx, js::handleobject obj, const js::readonlycompileoptions &options, file *file, js::mutablehandlescript script); bool js::compile(jscontext *cx, js::handleobject obj, const js::readonlycompileoptions &options, const char *filename, js::mutablehandlescript script); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js::compile compiles a script, srcbuf, chars, bytes, or file, for execution.
JS::CompileFunction
js::sourcebufferholder &srcbuf, js::mutablehandlefunction fun); bool js::compilefunction(jscontext *cx, js::autoobjectvector &scopechain, const js::readonlycompileoptions &options, const char *name, unsigned nargs, const char *const *argnames, const char *bytes, size_t length, js::mutablehandlefunction fun); name type
description cx jscontext * the context in which to compile the function.
...
description js::compilefunction compiles a function from a text string chars, bytes, or srcbuf.
JS::CompileOffThread
fthread(jscontext *cx, const js::readonlycompileoptions &options, const char16_t *chars, size_t length, js::offthreadcompilecallback callback, void *callbackdata); jsscript * js::finishoffthreadscript(jscontext *maybecx, jsruntime *rt, void *token); typedef void (*js::offthreadcompilecallback)(void *token, void *callbackdata); name type
description cx / maybe jscontext * pointer to a js context from which to derive runtime information.
...
description js::compileoffthread compiles a script, chars for execution.
JS::Construct
syntax bool js::construct(jscontext *cx, js::handlevalue fun, const js::handlevaluearray& args, js::mutablehandlevalue rval); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js::construct calls a specified function as a constructor, fun.
JS::CreateError
columnnumber, jserrorreport *report, handlestring message, mutablehandlevalue rval); // obsolete since jsapi 39 bool js::createerror(jscontext *cx, jsexntype type, handlestring stack, handlestring filename, uint32_t linenumber, uint32_t columnnumber, jserrorreport *report, handlestring message, mutablehandlevalue rval); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js::createerror creates an error object with specified properties.
JS::CurrentGlobalOrNull
syntax jsobject * js::currentglobalornull(jscontext *cx); name type
description cx jscontext * the context for which to return the global object.
...
description js::currentglobalornull() returns the global object for whatever function is currently running on the context.
JS::DeflateStringToUTF8Buffer
syntax // new in jsapi 52 void deflatestringtoutf8buffer(jsflatstring* src, mozilla::rangedptr<char> dst, size_t* dstlenp = nullptr, size_t* numcharsp = nullptr); // obsolete in spidermonkey 49 void deflatestringtoutf8buffer(jsflatstring* src, mozilla::rangedptr<char> dst); name type
description src jsflatstring * the pointer to the string to deflate.
...
description js::deflatestringtoutf8buffer encodes src as utf8.
JS::DoubleValue
syntax js::value js::doublevalue(double dbl) name type
description dbl double c double to convert.
...
description js::doublevalue converts a c floating-point number of type double to js::value, the type of javascript values.
JS::Evaluate
rval); bool js::evaluate(jscontext *cx, js::handleobject obj, const js::readonlycompileoptions &options, const char *bytes, size_t length, js::mutablehandlevalue rval); bool js::evaluate(jscontext *cx, js::handleobject obj, const js::readonlycompileoptions &options, const char *filename, js::mutablehandlevalue rval); name type
description cx jscontext * the context in which to run the script.
...
description js::evaluate compiles and executes a script in the specified scope, obj or scopechain.
JS::Float32Value
syntax js::value js::float32value(float f) name type
description f float c float to convert.
...
description js::float32value converts a c floating-point number of type float to js::value, the type of javascript values.
JS::GetDeflatedUTF8StringLength
syntax size_t getdeflatedutf8stringlength(jsflatstring* s); name type
description s jsflatstring * the pointer to the string to calculate the length.
...
description js::getdeflatedutf8stringlength returns the length of the char buffer required to encode s as utf8.
JS::GetFirstArgumentAsTypeHint
syntax bool js::getfirstargumentastypehint(jscontext* cx, callargs args, jstype *result); name type
description cx jscontext * the context in which to define functions.
...
description js::getfirstargumentastypehint converts first argument of @@toprimitive method to jstype.
JS::GetSelfHostedFunction
syntax jsfunction* js::getselfhostedfunction(jscontext* cx, const char* selfhostedname, js::handle<jsid> id, unsigned nargs); name type
description cx jscontext* the context from which to get the function.
...
description js::getselfhostedfunction creates a new javascript function implemented in self-hosted javascript.
JS::Handle
method
description const t *address() const returns a pointer to ptr.
... bool operator==(const t &other) const
description js::handle<t> is a const reference to a js::rooted<t>.
JS::IdentifyStandardInstance
syntax jsprotokey js::identifystandardinstance(jsobject *obj); jsprotokey js::identifystandardprototype(jsobject *obj); jsprotokey js::identifystandardinstanceorprototype(jsobject *obj); jsprotokey js::identifystandardconstructor(jsobject *obj); // added in spidermonkey 38 name type
description obj jsobject * pointer to the instance/prototype/constructor object to determine.
...
description js::identifystandardinstance determines if the given object is an instance for a standard class.
JS::Int32Value
syntax js::value js::int32value(int32_t i32) name type
description i32 int32_t c integer to convert.
...
description js::int32value converts a c signed 32-bit integer of type int32_t to js::value, the type of javascript values.
JS::IsCallable
syntax bool js::iscallable(jsobject *obj); bool js::isconstructor(jsobject *obj); name type
description obj jsobject * pointer to the function.
...
description js::iscallable returns whether the given function object is callable.
JS::MutableHandle
method
description const t &get() const returns *ptr.
...
description js::mutablehandle<t> is a non-const reference to js::rooted<t>.
JS::NewFunctionFromSpec
syntax jsfunction* js::newfunctionfromspec(jscontext* cx, const jsfunctionspec* fs, handleid id); name type
description cx jscontext * the context in which to define functions.
...
description js::newfunctionfromspec creates a new function based on the given jsfunctionspec, *fs.
JS::NumberValue
syntax js::value js::numbervalue(float f) js::value js::numbervalue(double dbl) js::value js::numbervalue(int8_t i) js::value js::numbervalue(uint8_t i) js::value js::numbervalue(int16_t i) js::value js::numbervalue(uint16_t i) js::value js::numbervalue(int32_t i) js::value js::numbervalue(uint32_t i) name type
description f or dbl or i any c integer or floating-point value to convert.
...
description js::numbervalue converts a c integer or floating-point value to js::value, the type of javascript values.
JS::ObjectOrNullValue
syntax js::value js::objectornullvalue(jsobject* obj) name type
description str jsobject* a pointer to a jsobject or null to convert.
...
description js::objectvalue converts a given jsobject to js::value.
JS::ObjectValue
syntax js::value js::objectvalue(jsobject& obj) name type
description str jsobject& a reference to a jsobject to convert.
...
description js::objectvalue converts a given jsobject to js::value.
JS::OrdinaryToPrimitive
syntax bool js::ordinarytoprimitive(jscontext *cx, js::handleobject obj, jstype type, js::mutablehandlevalue vp); name type
description cx jscontext * the context in which to perform the conversion.
...
description js::ordinarytoprimitive converts a javascript object to a specified type value, by the algorithm specified in es6 draft rev 28 (2014 oct 14) 7.1.1, second algorithm.
JS::PropertySpecNameEqualsId
syntax bool js::propertyspecnameequalsid(const char *name, js::handleid id); name type
description name const char * jspropertyspec::name or jsfunctionspec::name.
...
description js::propertyspecnameequalsid determines if the given jspropertyspec::name or jsfunctionspec::name value equals the given jsid, and returns true if so.
JS::PropertySpecNameIsSymbol
syntax bool js::propertyspecnameissymbol(const char *name); name type
description name const char * the pointer of the name, actually the uintptr_t type, and not a pointer to any string.
...
description js::propertyspecnameissymbol determines if the given jspropertyspec::name or jsfunctionspec::name value is actually a symbol code and not a string, and returns true if so.
JS::PropertySpecNameToPermanentId
syntax bool js::propertyspecnametopermanentid(jscontext *cx, const char *name, jsid *idp); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js::propertyspecnametopermanentid creates a jsid that does not need to be marked for gc from jspropertyspec::name or jsfunctionspec::name.
JS::ProtoKeyToId
syntax void js::protokeytoid(jscontext *cx, jsprotokey key, js::mutablehandleid idp); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js::protokeytoid converts a specified js prototype key key, to a js id.
JS::Remove*Root
jscontext *cx, js::heap<jsobject *> *rp); void removescriptroot(jscontext *cx, js::heap<jsscript *> *rp); void removevaluerootrt(jsruntime *rt, js::heap<js::value> *vp); void removestringrootrt(jsruntime *rt, js::heap<jsstring *> *rp); void removeobjectrootrt(jsruntime *rt, js::heap<jsobject *> *rp); void removescriptrootrt(jsruntime *rt, js::heap<jsscript *> *rp); name type
description cx jscontext * the context from which to remove the root.
...
description js::remove*root removes the variable that rp points to from the garbage collector's root set.
JS::StringValue
syntax js::value js::stringvalue(jsstring* str) name type
description str jsstring* a pointer to a jsstring to convert.
...
description js::stringvalue converts a given jsstring to js::value.
JS::SymbolValue
syntax js::value js::symbolvalue(js::symbol* sym) name type
description sym js::symbol* a pointer to a js::symbol to convert.
...
description js::symbolvalue converts a given js::symbol to js::value.
JS::ToBoolean
syntax bool js::toboolean(js::handlevalue v) name type
description v js::handlevalue the value to convert.
...
description js::toboolean converts a javascript value to a boolean.
JS::ToInt32
syntax bool js::toint32(jscontext *cx, js::handlevalue v, int32_t *out); name type
description cx jscontext * the context in which to perform the conversion.
...
description js::toint32 converts a javascript value to a signed 32bit integer.
JS::ToInt64
syntax bool js::toint64(jscontext *cx, js::handlevalue v, int64_t *out); name type
description cx jscontext * the context in which to perform the conversion.
...
description js::toint64 converts a javascript value to a signed 64bit integer.
JS::ToNumber
syntax bool js::tonumber(jscontext *cx, js::handlevalue v, double *out); name type
description cx jscontext * the context in which to perform the conversion.
...
description js::tonumber converts a javascript value to a number.
JS::ToPrimitive
syntax bool js::toprimitive(jscontext *cx, js::handleobject obj, jstype hint, js::mutablehandlevalue vp); name type
description cx jscontext * the context in which to perform the conversion.
...
description js::toprimitive converts a javascript object, obj, to a primitive value using ecmascript 6 toprimitive.
JS::ToString
syntax #include "js/conversions.h" // as of spidermonkey 38; previously in jsapi.h jsstring* js::tostring(jscontext *cx, js::handlevalue v) name type
description cx jscontext * the context in which to perform the conversion.
...
description js::tostring returns a string representation of a javascript value.
JS::ToUint16
syntax bool js::touint16(jscontext *cx, js::handlevalue v, uint16_t *out); name type
description cx jscontext * the context in which to perform the conversion.
...
description js::toint16 converts a javascript value to an unsigned 16bit integer.
JS::ToUint32
syntax bool js::touint32(jscontext *cx, js::handlevalue v, int32_t *out); name type
description cx jscontext * the context in which to perform the conversion.
...
description js::touint32 converts a javascript value to an unsigned 32bit integer.
JS::ToUint64
syntax bool js::touint64(jscontext *cx, js::handlevalue v, uint64_t *out); name type
description cx jscontext * the context in which to perform the conversion.
...
description js::toint64 converts a javascript value to an unsigned 64bit integer.
JSAutoCompartment
syntax jsautocompartment(jscontext *cx, jsobject *target); jsautocompartment(jscontext *cx, jsscript *target); name type
description cx jscontext * the context on which a cross-compartment call is needed.
...
description every jscontext has a current compartment.
JSCheckAccessOp
(it is also the type of the callback set by js_setcheckobjectaccesscallback.) syntax typedef jsbool (* jscheckaccessop)(jscontext *cx, jsobject *obj, jsval id, jsaccessmode mode, jsval *vp); name type
description cx jscontext * the js context in which the property access attempt is occurring.
...
description check whether obj[id] may be accessed per mode, returning js_false on error/exception, js_true on success with obj[id]'s stored value in *vp.
JSClass
jshasinstanceop hasinstance; jsnative construct; jsxdrobjectop xdrobject; /* obsolete since spidermonkey 13 */ jstraceop trace; /* added in spidermonkey 17 */ jsclassinternal reserved1; /* obsolete since spidermonkey 13 */ void *reserved[n]; /* sizeof 'reserved' depends on version */ }; name type
description name const char * class name flags uint32_t class flags.
...
description use jsclass to define a custom class of javascript objects.
JSConstDoubleSpec
syntax template<typename t> struct jsconstscalarspec { const char *name; t val; /* uint8_t flags; // obsolete from jsapi 35 uint8_t spare[3]; // obsolete from jsapi 35 */ }; typedef jsconstscalarspec<double> jsconstdoublespec; typedef jsconstscalarspec<int32_t> jsconstintegerspec; // added in spidermonkey 38 name type
description val double or int32_t value for the double or integer.
...obsolete since jsapi 35
description jsconstdoublespecs is used to define a set of double values that are assigned as properties to an object using js_defineconstdoubles.
JSConvertOp
syntax typedef bool (* jsconvertop)(jscontext *cx, js::handleobject obj, jstype type, js::mutablehandlevalue vp); name type
description cx jscontext * the context in which the convert is taking place.
...
description jsconvertop callback specifies conversion behavior for objects having this class, implementing the ecmascript [[defaultvalue]] behavior for them.
JSDeletePropertyOp
syntax typedef bool (* jsdeletepropertyop)(jscontext *cx, js::handleobject obj, js::handleid id, bool *succeeded); name type
description cx jscontext * the context in which the property access is taking place.
...
description jsdeletepropertyop callback is a hook that applications may install to be called at some point during property access.
JSEnumerateOp
syntax typedef bool (* jsenumerateop)(jscontext *cx, js::handleobject obj); name type
description cx jscontext * pointer to the js context in which the enumeration is taking place.
...
description jsenumerateop is called just before an object is enumerated (via a for...in statement, an array comprehension, or a call to js_enumerate).
JSErrorFormatString
syntax typedef struct jserrorformatstring { const char *format; uint16_t argcount; int16_t exntype; } jserrorformatstring; name type
description format const char * the error format string in ascii.
...
description jserrorformatstring is a struct to represent error message and type, returned by js_reporterrornumber function.
JSExtendedClass.outerObject
callback syntax typedef jsobject * (*jsobjectop)(jscontext *cx, jsobject *obj); name type
description cx jscontext * a context.
...
description see split objects.
JSExtendedClass
}; name type
description base jsclass the basic class information and callbacks for this class.
...
description to implement a custom class that uses any of the jsextendedclass callbacks: create a jsextendedclass and populate both the base fields and the extended fields.
JSExtendedClass.wrappedObject
syntax typedef jsobject * (*jsobjectop)(jscontext *cx, jsobject *obj); name type
description cx jscontext * the context in which the object is being unwrapped.
...
description if a class has the jsclass_is_extended bit set in its jsclass.flags and has a non-null jsextendedclass.wrappedobject, then objects of that class may be wrappers.
JSFastNative
syntax typedef jsbool (*jsfastnative)(jscontext *cx, unsigned int argc, jsval *vp); name type
description cx jscontext * the context in which the fast native is being called.
...
description the callback should use the following macros to access the fields of vp: macro name
description js_callee(cx, vp) returns the function object that was called, as a jsval.
JSFinalizeOp
syntax typedef void (* jsfinalizeop)(jsfreeop *fop, jsobject *obj); name type
description cx jscontext * the js context in which garbage collection is taking place.
...
description the jsfinalizeop is analogous to java finalizers or c++ destructors.
JSFunctionSpec
syntax struct jsfunctionspec { const char *name; jsnativewrapper call; uint16_t nargs; uint16_t flags; const char *selfhostedname; }; typedef struct jsnativewrapper { jsnative op; const jsjitinfo *info; } jsnativewrapper; name type
description name const char * the function's name.
...
description jsfunctionspec defines the attributes for a single js function to associate with an object.
JSGetObjectOps
jsgetobjectops is the type for jsclass.getobjectops callback syntax typedef jsobjectops * (* jsgetobjectops)(jscontext *cx, jsclass *clasp); name type
description cx jscontext * the js context in which the new object is being created.
...
description jsobjectops is used by js_newobject's internals to discover the set of high-level object operations to use for new objects of the given class.
JSHasInstanceOp
syntax typedef bool (* jshasinstanceop)(jscontext *cx, js::handleobject obj, js::mutablehandlevalue vp, bool *bp); name type
description cx jscontext * the js context in which the type check is occurring.
...
description jshasinstanceop is called to check whether v is an instance of obj.
JSID_IS_EMPTY
syntax bool jsid_is_empty(jsid id); name type
description id jsid the property identifier to test.
...
description jsid_is_empty tests whether a specified js id, id, is jsid_empty.
JSID_IS_GCTHING
syntax bool jsid_is_gcthing(jsid id); js::gccellptr jsid_to_gcthing(jsid id); name type
description id jsid the property identifier to test or convert.
...
description jsid_is_gcthing tests whether a specified js id, id, is a gc thing, and returns true if it's a gc thing.
JSID_IS_INT
syntax bool jsid_is_int(jsid id); int32_t jsid_to_int(jsid id); bool int_fits_in_jsid(int32_t i); jsid int_to_jsid(int32_t i); name type
description id jsid the property identifier to test or convert.
...
description jsid_is_int tests whether a specified js id, id, is an integer, and returns true if it's an integer.
JSID_IS_STRING
syntax bool jsid_is_string(jsid id); jsstring * jsid_to_string(jsid id); jsid interned_string_to_jsid(jscontext *cx, jsstring *str); // added in spidermonkey 38 jsflatstring * jsid_to_flat_string(jsid id); // added in spidermonkey 17 name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description jsid_is_string tests whether a specified js id, id, is a string, and returns true if it's a string.
JSID_IS_SYMBOL
syntax bool jsid_is_symbol(jsid id); js::symbol * jsid_to_symbol(jsid id); jsid symbol_to_jsid(js::symbol *sym); name type
description id jsid the property identifier to test or convert.
...
description jsid_is_symbol tests whether a specified js id, id, is a js symbol, and returns true if it's a js symbol.
JSID_IS_VOID
syntax bool jsid_is_void(jsid id); name type
description id jsid the property identifier to test.
...
description jsid_is_void tests whether a specified js id, id, is jsid_void.
JSID_IS_ZERO
syntax bool jsid_is_zero(jsid id); name type
description id jsid the property identifier to test.
...
description jsid_is_zero tests whether a specified js id, id, is zero (0 in its integer representation).
JSIteratorOp
syntax typedef jsobject * (*jsiteratorop)(jscontext *cx, jsobject *obj, jsbool keysonly); name type
description cx jscontext * pointer to the js context in which the iterator creation should take place.
...
description the javascript engine calls the jsextendedclass.iteratorobject callback to create an iterator object for a given object.
JSMarkOp
syntax typedef uint32 (* jsmarkop)(jscontext *cx, jsobject *obj, void *arg); name type
description cx jscontext * the js context in which the mark phase of garbage collection is occurring.
...
description call js_markgcthing for each gc thing directly reachable from obj.
JSNative
syntax typedef bool (* jsnative)(jscontext *cx, unsigned argc, js::value *vp); name type
description cx jscontext * the context in which the native function is being called.
...
description jsnative is the type of native implementations of javascript functions.
JSNewResolveOp
syntax typedef bool (* jsnewresolveop)(jscontext *cx, js::handleobject obj, js::handleid id, js::mutablehandleobject objp); name type
description cx jscontext * pointer to the js context in which the property access is taking place.
...
description like jsresolveop, but flags provide contextual information about the property access.
JSObjectOps.defaultValue
syntax typedef jsbool (*jsconvertop)(jscontext *cx, jsobject *obj, jstype type, jsval *vp); name type
description cx jscontext * pointer to the js context in which the conversion is needed.
...
description the jsobjectops.defaultvalue callback corresponds to the [[defaultvalue]] method defined in ecma 262-3 §8.6.2.6.
JSObjectOps.defineProperty
syntax jsbool (*jsdefinepropop)(jscontext *cx, jsobject *obj, jsid id, jsval value, jspropertyop getter, jspropertyop setter, unsigned int attrs); name type
description cx jscontext * pointer to the js context in which the property is being defined.
...
description define obj[id], an own property of obj named id, having the given initial value, with the specified getter, setter, and attributes.
JSObjectOps.dropProperty
syntax typedef void (*jspropertyrefop)(jscontext *cx, jsobject *obj, jsproperty *prop); name type
description cx jscontext * a context that was the cx argument to an earlier call to jsobjectops.lookupproperty that found a property.
...
description the following contract governs jsobjectops callers and implementations: whenever jsobjectops.lookupproperty returns a jsproperty pointer, the property is locked.
JSObjectOps.getRequiredSlot
syntax typedef jsval (*jsgetrequiredslotop)(jscontext *cx, jsobject *obj, uint32 slot); typedef jsbool (*jssetrequiredslotop)(jscontext *cx, jsobject *obj, uint32 slot, jsval v); name type
description cx jscontext * the js context in which we access the slot.
...
description get and set a required slot, one that should already have been allocated.
JSObjectOps.lookupProperty
syntax typedef jsbool (*jslookuppropop)(jscontext *cx, jsobject *obj, jsid id, jsobject **objp, jsproperty **propp); name type
description cx jscontext * pointer to the js context in which the property lookup is happening.
...
description look for id in obj and its prototype chain, returning js_false on error or exception, js_true on success.
JSObjectOps.newObjectMap
syntax typedef jsobjectmap * (*jsnewobjectmapop)(jscontext *cx, jsrefcount nrefs, jsobjectops *ops, jsclass *clasp, jsobject *obj); name type
description cx jscontext * pointer to the js context in which the new object is being created.
...
description note: the jsapi does not expose the data structure that would be necessary to develop new jsobjectmap subclasses.
JSObjectOps.setProto
syntax typedef jsbool (*jssetobjectslotop)(jscontext *cx, jsobject *obj, uint32 slot, jsobject *pobj); name type
description cx jscontext * pointer to the js context in which the object's prototype or parent is being modified.
...
description these hooks must check for cycles without deadlocking, and otherwise take special steps.
JSObjectPrincipalsFinder
callback syntax typedef jsprincipals * (* jsobjectprincipalsfinder)(jscontext *cx, jsobject *obj); name type
description cx jscontext * the context in which to find principals.
...
description the javascript engine calls this callback to obtain principals for a jsprincipals.subsume check.
JSPRINCIPALS_HOLD
syntax jsprincipals_hold(cx, principals) jsprincipals_drop(cx, principals) name type
description cx jscontext * a context.
...
description jsprincipals_hold and jsprincipals_drop are used to manage memory for jsprincipals objects.
JSPrincipalsTranscoder
callback syntax typedef jsbool (*jsprincipalstranscoder)(jsxdrstate *xdr, jsprincipals **principalsp); name type
description xdr jsxdrstate * the xdr reader/writer.
...
description the javascript engine uses this callback to serialize and deserialize principals.
JSPropertyDescriptor
properties a descriptor is an object that can have the following key values field name
description getter the get syntax binds an object property to a function that will be called when that property is looked up.
... writable declare whether the specified attribute can be rewritten
description a descriptor is a property that describes an object's properties.
JSPropertyOp
syntax typedef bool (* jspropertyop)(jscontext *cx, js::handleobject obj, js::handleid id, js::mutablehandlevalue vp); typedef bool (* jsstrictpropertyop)(jscontext *cx, js::handleobject obj, js::handleid id, bool strict, js::mutablehandlevalue vp); // added in spidermonkey 1.9.3 name type
description cx jscontext * the context in which the property access is taking place.
...
description jspropertyop and jsstrictpropertyop callbacks are hooks that applications may install to be called at some point during property access.
JSPropertySpec
n { jsnativewrapper native; selfhostedwrapper selfhosted; } getter; union { jsnativewrapper native; selfhostedwrapper selfhosted; } setter; /* obsolete since jsapi 29 */ /* added in jsapi 28 */ const char *selfhostedgetter; const char *selfhostedsetter; }; name type
description name const char * name to assign the property.
...
description jspropertyspec defines the attributes for a single js property to associate with an object.
JSReserveSlotsOp
syntax typedef uint32 (* jsreserveslotsop)(jscontext *cx, jsobject *obj); name type
description cx jscontext * the js context in which the new object is being created.
...
description warning: jsapi applications should not use this hook.
JSResolveOp
syntax typedef bool (* jsresolveop)(jscontext *cx, js::handleobject obj, js::handleid id, bool *resolvedp); // added in jsapi 36 typedef bool (* jsresolveop)(jscontext *cx, js::handleobject obj, js::handleid id); // obsolete since jsapi 36 name type
description cx jscontext * pointer to the js context in which the property access is taking place.
...
description jsresolveop callback is a hook which is called when a property is not found on an object.
JSSecurityCallbacks.contentSecurityPolicyAllows
(it is also the type of the callback set by js_setcheckobjectaccesscallback.) syntax typedef jsbool (*jscspevalchecker)(jscontext *cx); name type
description cx jscontext * the js context in which the property access attempt is occurring.
...
description check whether runtime code generation is allowed for the current global.
JSStringFinalizer
syntax struct jsstringfinalizer { void (*finalize)(const jsstringfinalizer *fin, char16_t *chars); }; name type
description fin jsstringfinalizer the finalizer itself.
...
description jsstringfinalizer::finalize finalizes external strings created by js_newexternalstring.
JSTraceOp
syntax typedef void (* jstraceop)(jstracer *trc, jsobject *obj); name type
description trc jstracer * the tracer visiting obj.
...
description jstraceop is the function type for trace operation of the class called to enumerate all traceable things reachable from obj's private data structure.
JSXDRObjectOp
syntax typedef jsbool (* jsxdrobjectop)(jsxdrstate *xdr, jsobject **objp); name type
description xdr jsxdrstate * the xdr reader or writer.
...
description serialize or deserialize an object, given an xdr state record representing external data.
JS_ASSERT_STRING_IS_FLAT
syntax static moz_always_inline jsflatstring * js_assert_string_is_flat(jsstring *str) { moz_assert(js_stringisflat(str)); return (jsflatstring *)str; } name type
description str jsstring * string to examine.
...
description js_assert_string_is_flat asserts the string is flattened, and returns a pointer to jsflatstring.
JS_Add*Root
bject **opp); jsbool js_addgcthingroot(jscontext *cx, void **rp); jsbool js_addnamedvalueroot(jscontext *cx, jsval *vp, const char *name); jsbool js_addnamedstringroot(jscontext *cx, jsstring **spp, const char *name); jsbool js_addnamedobjectroot(jscontext *cx, jsobject **opp, const char *name); jsbool js_addnamedgcthingroot(jscontext *cx, void **rp, const char *name); name type
description cx jscontext * the context in which to add the new root.
...
description the js_add*root and functions add a c/c++ variable to the garbage collector's root set, the set of variables used as starting points each time the collector checks to see what memory is reachable.
JS_AliasElement
syntax jsbool js_aliaselement(jscontext *cx, jsobject *obj, const char *name, jsint alias); name type
description cx jscontext * the context in which to create the alias.
...
description js_aliaselement assigns an alternate index number for an element or numeric property associated with a native object.
JS_AliasProperty
syntax jsbool js_aliasproperty(jscontext *cx, jsobject *obj, const char *name, const char *alias); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_aliasproperty assigns an alternate name for a property associated with a native object.
JS_AlreadyHasOwnProperty
ject obj, const char16_t *name, size_t namelen, bool *foundp); boo js_alreadyhasownpropertybyid(jscontext *cx, js::handleobject obj, js::handleid id, bool *foundp); // added in spidermonkey 1.8.1 boo js_alreadyhasownelement(jscontext *cx, js::handleobject obj, uint32_t index, bool *foundp); name type
description cx jscontext * pointer to a js context.
...
description these functions attempt to determine whether a property already exists on a specific jsobject without modifying the object.
JS_BindCallable
syntax jsobject* js_bindcallable(jscontext *cx, js::handle<jsobject*> callable, js::handle<jsobject*> newthis); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_bindcallable binds the given callable to use the given object as this.
JS_BufferIsCompilableUnit
syntax bool js_bufferiscompilableunit(jscontext *cx, js::handle<jsobject*> obj, const char *utf8, size_t length); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description given a buffer, return false if the buffer might become a valid javascript statement with the addition of more lines.
JS_CallFunction
jscontext *cx, jsobject *obj, jsfunction *fun, unsigned argc, jsval *argv, jsval *rval); bool js_callfunctionname(jscontext *cx, jsobject *obj, const char *name, unsigned argc, jsval *argv, jsval *rval); bool js_callfunctionvalue(jscontext *cx, jsobject *obj, jsval fval, unsigned argc, jsval *argv, jsval *rval); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_callfunction calls a specified function, fun, on an object, obj.
JS_CheckForInterrupt
syntax bool js_checkforinterrupt(jscontext* cx); name type
description cx </code>jscontext *<code> the context.
...
description js_checkforinterrupt checks for the interrupt, and handle it if it's pending.
JS_ClearContextThread
syntax jsword js_clearcontextthread(jscontext *cx); jsword js_setcontextthread(jscontext *cx); name type
description cx jscontext * the context to transfer from one thread to another.
...
description an application that creates or uses a jscontext in one thread, then uses or destroys it in another thread, must use js_clearcontextthread and js_setcontextthread to transfer the jscontext safely from one thread to the other.
JS_ClearDateCaches
syntax void js_cleardatecaches(jscontext *cx); name type
description cx jscontext * pointer to a javascript context from which to derive runtime information.
...
description js_cleardatecaches clears the cache of calculated local time from each date object.
JS_ClearNewbornRoots
syntax void js_clearnewbornroots(jscontext *cx); name type
description cx jscontext * the context to clear.
...
description the last gc thing of each type (object, string, double, external string types) created on a given context is kept alive until another thing of the same type is created, using a newborn root in the context.
JS_ClearNonGlobalObject
syntax void js_clearnonglobalobject(jscontext *cx, jsobject *obj); name type
description cx jscontext * the context in which to clear the object.
...
description js_clearnonglobalobject removes all of obj's own properties, except the special __proto__ and __parent__ properties, in a single operation.
JS_ClearPendingException
syntax void js_clearpendingexception(jscontext *cx); name type
description cx jscontext * the context in which the exception was thrown.
...
description js_clearpendingexception cancels the currently pending exception in cx, if any.
JS_ClearRegExpStatics
syntax bool js_clearregexpstatics(jscontext *cx, handleobject obj); name type
description cx jscontext * the context.
...
description js_clearregexpstatics clears the pending input string and flags of the built-in regexp object.
JS_ClearScope
syntax void js_clearscope(jscontext *cx, jsobject *obj); name type
description cx jscontext * the context in which to clear the object.
...
description js_clearscope removes all of obj's own properties, except the special __proto__ and __parent__ properties, in a single operation.
JS_CloneFunctionObject
syntax jsobject * js_clonefunctionobject(jscontext *cx, jsobject *funobj, jsobject *parent); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_clonefunctionobject creates a new function object from funobj.
JS_CompileFunction
*obj, const char *name, unsigned int nargs, const char **argnames, const char *body, size_t length, const char *filename, unsigned int lineno); jsfunction * js_compileucfunction(jscontext *cx, jsobject *obj, const char *name, unsigned int nargs, const char **argnames, const jschar *body, size_t length, const char *filename, unsigned int lineno); name type
description cx jscontext * the context in which to compile the function.
...
description js_compilefunction compiles a function from a text string, bytes, and optionally associates it with a js object, obj.
JS_CompileFunctionForPrincipals
d int nargs, const char **argnames, const char *body, size_t length, const char *filename, unsigned int lineno); jsfunction * js_compileucfunctionforprincipals(jscontext *cx, jsobject *obj, jsprincipals *principals, const char *name, unsigned int nargs, const char **argnames, const jschar *body, size_t length, const char *filename, unsigned int lineno); name type
description cx jscontext * the context in which to compile the function.
...
description js_compilefunctionforprincipals compiles a security-enabled function from a text string, bytes, and associates it with a js object, obj.
JS_CompileScript
const char *ascii, size_t length, const js::compileoptions &options, js::mutablehandlescript script); bool js_compileucscript(jscontext *cx, js::handleobject obj, const char16_t *chars, size_t length, const js::compileoptions &options, js::mutablehandlescript script); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_compilescript compiles a script, source, for execution.
JS_CompileScriptForPrincipals
pals, const char *src, size_t length, const char *filename, unsigned int lineno, jsversion version); // obsoleted since jsapi 19 jsobject * js_compileucscriptforprincipalsversion(jscontext *cx, jsobject *obj, jsprincipals *principals, const jschar *src, size_t length, const char *filename, unsigned int lineno, jsversion version); // obsoleted since jsapi 19 name type
description cx jscontext * the context in which to compile the script.
...
description js_compilescriptforprincipals compiles a security-enabled script, src, for execution.
JS_CompileUTF8File
syntax jsobject * js_compileutf8file(jscontext *cx, jsobject *obj, const char *filename); name type
description cx jscontext * the context in which to compile the script.
...
description js_compileutf8file compiles the text of script in an external file location for execution by the js engine.
JS_CompileUTF8FileHandle
syntax jsobject * js_compileutf8filehandle(jscontext *cx, jsobject *obj, const char *filename, file *file); jsobject * js_compileutf8filehandleforprincipals( jscontext *cx, jsobject *obj, const char *filename, file *file, jsprincipals *principals); name type
description cx jscontext * the context in which to compile the script.
...
description js_compileutf8filehandle reads a script from a stdio file handle and compiles the script for execution by the javascript engine.
JS_ConcatStrings
syntax jsstring * js_concatstrings(jscontext *cx, js::handlestring left, js::handlestring right); name type
description cx jscontext * the context in which both the strings have been created.
...
description js_concatstrings concatenates two js strings, str1 and str2, and returns the result.
JS_ConstructObject
syntax jsobject * js_constructobject(jscontext *cx, jsclass *clasp, jsobject *proto, jsobject *parent); jsobject * js_constructobjectwitharguments(jscontext *cx, jsclass *clasp, jsobject *proto, jsobject *parent, unsigned int argc, jsval *argv); name type
description cx jscontext * the context in which to create the new object.
...
description js_constructobject creates a new object of the specified class, with the specified prototype and parent, then invokes a constructor function to initialize the new object.
JS_ContextIterator
syntax jscontext * js_contextiterator(jsruntime *rt, jscontext **iterp); name type
description rt jsruntime * the runtime to walk.
...
description js_contextiterator steps through the set of contexts associated with the runtime rt.
JS_ConvertArgumentsVA
syntax bool js_convertargumentsva(jscontext *cx, const js::callargs &args, const char *format, va_list ap); bool js_convertargumentsva(jscontext *cx, unsigned argc, jsval *argv, const char *format, va_list ap); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_convertargumentsva is to js_convertarguments as vprintf is to printf.
JS_ConvertValue
syntax bool js_convertvalue(jscontext *cx, js::handlevalue v, jstype type, js::mutablehandlevalue vp); name type
description cx jscontext * the context in which to perform the conversion.
...
description js_convertvalue converts a javascript value, v, to the specified type.
JS_DecompileFunction
syntax jsstring * js_decompilefunction(jscontext *cx, js::handle<jsfunction*> fun); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_decompilefunction generates the complete source code of a function declaration from a function's compiled form, fun.
JS_DecompileFunctionBody
syntax jsstring * js_decompilefunctionbody(jscontext *cx, js::handle<jsfunction*> fun, unsigned indent); name type
description cx jscontext * the context in which to decompile the function.
...
description js_decompilefunctionbody generates the source code of a function's body, minus the function keyword, name, parameters, and braces, from a function's compiled form, fun.
JS_DecompileScript
syntax jsstring * js_decompilescript(jscontext *cx, js::handle<jsscript*> script); name type
description cx jscontext * the context to use to decompile the script.
...
description js_decompilescript returns the source code of script.
JS_DeepFreezeObject
syntax bool js_deepfreezeobject(jscontext *cx, js::handle<jsobject*> obj); name type
description cx jsruntime * the context.
...
description js_deepfreezeobject freezes obj, and all objects it refers to, recursively.
JS_DefaultValue
syntax bool js_defaultvalue(jscontext *cx, js::handle<jsobject*> obj, jstype hint, js::mutablehandle<js::value> vp); name type
description cx jscontext * the context in which to perform the conversion.
...
description js_defaultvalue converts a javascript object, obj, to a primitive value using that object's [[defaultvalue]] hook.
JS_DefineConstDoubles
syntax bool js_defineconstdoubles(jscontext *cx, js::handleobject obj, const jsconstdoublespec *cds); bool js_defineconstintegers(jscontext *cx, js::handleobject obj, const jsconstintegerspec *cis); // added in spidermonkey 38 name type
description cx jscontext * the context in which to define the new properties.
...
description js_defineconstdoubles creates one or more properties for a specified object, obj, where each property consists of a double value.
JS_DefineElement
text *cx, js::handleobject obj, uint32_t index, double value, unsigned attrs, jsnative getter = nullptr, jsnative setter = nullptr); /* obsolete since jsapi 32 */ js_defineelement(jscontext *cx, jsobject *obj, uint32_t index, jsval value, jspropertyop getter, jsstrictpropertyop setter, unsigned attrs); name type
description cx jscontext * the context in which to create the new property.
...obsolete since jsapi 32
description js_defineelement defines a numeric property for a specified object, obj.
JS_DefineFunction
, js::handle<jsobject*> obj, const char16_t *name, size_t namelen, jsnative call, unsigned nargs, unsigned attrs); jsfunction * js_definefunctionbyid(jscontext *cx, js::handle<jsobject*> obj, js::handle<jsid> id, jsnative call, unsigned nargs, unsigned attrs); // added in spidermonkey 17 name type
description cx jscontext * the context in which to define the function.
...
description js_definefunction exposes a c/c++ function to scripts by defining a new method on an existing javascript object.
JS_DefineObject
syntax jsobject * js_defineobject(jscontext *cx, js::handleobject obj, const char *name, const jsclass *clasp = nullptr, unsigned attrs = 0); name type
description cx jscontext * the context in which to create the new object.
...
description js_defineobject creates a new object of the class clasp and assigns it to a new property of an existing object, obj.
JS_DefineProperties
syntax bool js_defineproperties(jscontext *cx, js::handleobject obj, const jspropertyspec *ps); name type
description cx jscontext * the context in which to define the properties.
...
description js_defineproperties creates properties on a specified object, obj.
JS_DefineProperty
leobject obj, js::handleid id, uint32_t value, unsigned attrs, jsnative getter = nullptr, jsnative setter = nullptr); bool js_definepropertybyid(jscontext *cx, js::handleobject obj, js::handleid id, double value, unsigned attrs, jsnative getter = nullptr, jsnative setter = nullptr); name type
description cx jscontext * the context in which to define the property.
...
description js_defineproperty defines a single property in a specified object, obj.
JS_DefinePropertyWithTinyId
opertywithtinyid( jscontext *cx, jsobject *obj, const char *name, int8 tinyid, jsval value, jspropertyop getter, jspropertyop setter, unsigned int attrs); jsbool js_defineucpropertywithtinyid( jscontext *cx, jsobject *obj, const jschar *name, size_t namelen, int8 tinyid, jsval value, jspropertyop getter, jspropertyop setter, unsigned int attrs); name type
description cx jscontext * the context in which to define the property.
...
description js_definepropertywithtinyid defines an object property with a tiny id.
JS_DeleteElement
syntax bool js_deleteelement(jscontext *cx, js::handleobject obj, uint32_t index); // added in spidermonkey 45 bool js_deleteelement(jscontext *cx, js::handleobject obj, uint32_t index, js::objectopresult &result); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_deleteelement removes a specified element or numeric property, index, from an object, obj.
JS_DeleteElement2
renamed to js_deleteelement in jsapi 39 syntax bool js_deleteelement2(jscontext *cx, js::handleobject obj, uint32_t index, bool *succeeded); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_deleteelement2 removes a specified element or numeric property, index, from an object, obj.
JS_DeleteProperty
, js::handleobject obj, const char *name, js::objectopresult &result); bool js_deletepropertybyid(jscontext *cx, js::handleobject obj, js::handleid id, js::objectopresult &result); bool js_deleteucproperty(jscontext *cx, js::handleobject obj, const char16_t *name, size_t namelen, js::objectopresult &result); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_deleteproperty removes a specified property, name, from an object, obj.
JS_DeleteProperty2
js::handleobject obj, const char *name, bool *succeeded); bool js_deleteucproperty2(jscontext *cx, js::handleobject obj, const char16_t *name, size_t namelen, bool *succeeded); bool js_deletepropertybyid2(jscontext *cx, js::handleobject obj, js::handleid id, bool *succeeded); // added in spidermonkey 1.8.1 name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_deleteproperty2 removes a specified property, name, from an object, obj, and stores true or false in *succeeded.
JS_DestroyContext
syntax void js_destroycontext(jscontext *cx); void js_destroycontextnogc(jscontext *cx); void js_destroycontextmaybegc(jscontext *cx); // obsolete since jsapi 14 name type
description cx jscontext * the context to destroy.
...
description these functions destroy a context, cx.
JS_DestroyIdArray
syntax void js_destroyidarray(jscontext *cx, jsidarray *ida); name type
description cx jscontext * a context.
...
description js_destroyidarray frees the id array pointed to by ida.
JS_DestroyRuntime
syntax void js_destroyruntime(jsruntime *rt); name type
description rt jsruntime * the runtime to destroy.
...
description js_destroyruntime frees the specified the javascript runtime environment, rt.
JS_DestroyScript
syntax void js_destroyscript(jscontext *cx, jsscript *script); name type
description cx jscontext * the context in which to destroy the script.
...
description js_destroyscript destroys the given compiled script, freeing the memory allocated to it.
JS_DoubleToInt32
syntax int32_t js_doubletoint32(double d); uint32_t js_doubletouint32(double d); name type
description d double the numeric value to convert.
...
description js_doubletoint32 converts a c floating-point number of type double to int32, a signed 32-bit integer.
JS_DropExceptionState
syntax void js_dropexceptionstate(jscontext *cx, jsexceptionstate *state); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description this function destroys the specified jsexceptionstate object, unrooting as necessary any attached exception object and freeing the memory resources associated with the jsexceptionstate object.
JS_DumpHeap
syntax bool js_dumpheap(jsruntime *rt, file *fp, void* startthing, jsgctracekind kind, void *thingtofind, size_t maxdepth, void *thingtoignore); name type
description cx jscontext * pointer to a js context.
... jstrace_base_shape = 0x0f, jstrace_jitcode = 0x1f, jstrace_lazy_script = 0x2f, jstrace_type_object = 0x3f, jstrace_last = jstrace_type_object };
description see bug 378261 for detail.
JS_EncodeCharacters
syntax jsbool js_encodecharacters(jscontext *cx, const jschar *src, size_t srclen, char *dst, size_t *dstlen); name type
description cx jscontext * a context.
...
description js_encodecharacters copies the characters of a jschar array into a char array, converting the 16-bit values to 8-bit values.
JS_EncodeString
syntax char * js_encodestring(jscontext *cx, jsstring *str); char * js_encodestringtoutf8(jscontext *cx, js::handlestring str); // added in spidermonkey 24 name type
description cx jscontext * a context.
...
description js_encodestring and js_encodestringtoutf8 convert the specified javascript str to a c string (an array of 8-bit chars).
JS_EncodeStringToBuffer
syntax size_t js_encodestringtobuffer(jscontext *cx, jsstring *str, char *buffer, size_t length); name type
description cx jscontext * a context.
...
description js_encodestringtobuffer converts the specified javascript str to a c string (an array of 8-bit chars) and fills the specified buffer with up to length bytes of the string.
JS_EnterCompartment
syntax jscompartment * js_entercompartment(jscontext *cx, jsobject *target); name type
description cx jscontext * the context on which a cross-compartment call is needed.
...
description every jscontext has a current compartment.
JS_EnterCrossCompartmentCall
syntax jscrosscompartmentcall * js_entercrosscompartmentcall(jscontext *cx, jsobject *target); name type
description cx jscontext * the context on which a cross-compartment call is needed.
...
description every jscontext has a current compartment.
JS_EnterLocalRootScope
syntax jsbool js_enterlocalrootscope(jscontext *cx); name type
description cx jscontext * pointer to the context.
...
description scoped local root management allows native functions, getter/setters, etc.
JS_Enumerate
syntax jsidarray * js_enumerate(jscontext *cx, js::handleobject obj); name type
description cx jscontext * the context in which to enumerate object properties.
...
description js_enumerate gets the ids of all own properties of the specified object, obj, that have the jsprop_enumerate attribute.
JS_EnumerateStandardClasses
syntax bool js_enumeratestandardclasses(jscontext *cx, js::handleobject obj); name type
description cx jscontext * pointer to the executable script context for which to initialize js function and object classes.
...
description the global object's class's enumerate op should call js_enumeratestandardclasses(cx, obj), to define eagerly during for...in loops any classes not yet resolved lazily.
JS_ErrorFromException
syntax jserrorreport * js_errorfromexception(jscontext *cx, js::handleobject obj); name type
description cx jscontext * pointer to a js context whose errors should be reported via your function.
...
description if obj is an exception object, the exception will have (or be able to lazily create) an error report struct, and js_errorfromexception will return the address of that struct.
JS_EvaluateScript
syntax jsbool js_evaluatescript(jscontext *cx, jsobject *obj, const char *src, unsigned int length, const char *filename, unsigned int lineno, jsval *rval); jsbool js_evaluateucscript(jscontext *cx, jsobject *obj, const jschar *src, unsigned int length, const char *filename, unsigned int lineno, jsval *rval); name type
description cx jscontext * the context in which to run the script.
...
description js_evaluatescript compiles and executes a script in the specified scope, obj.
JS_EvaluateScriptForPrincipals
ncipals *principals, const char *bytes, unsigned int length, const char *filename, unsigned int lineno, jsval *rval, jsversion version); jsbool js_evaluateucscriptforprincipalsversion(jscontext *cx, jsobject *obj, jsprincipals *principals, const jschar *chars, unsigned int length, const char *filename, unsigned int lineno, jsval *rval, jsversion version); name type
description cx jscontext * the context in which to run the script.
...
description js_evaluatescriptforprincipals compiles and executes a script in the specified scope, obj.
JS_ExecuteRegExp
bject reobj, char16_t *chars, size_t length, size_t *indexp, bool test, js::mutablehandlevalue rval); bool js_executeregexpnostatics(jscontext *cx, js::handleobject reobj, char16_t *chars, size_t length, size_t *indexp, bool test, js::mutablehandlevalue rval); name type
description cx jscontext * the context.
...
description js_executeregexp and js_newregexpobjectnostatics execute the regexp object, reobj, to the specified input string, chars, from *indexp index.
JS_ExecuteScript
t *cx, js::handleobject obj, js::handlescript script); // obsolete since jsapi 39 bool js::cloneandexecutescript(jscontext *cx, js::handle<jsscript*> script); // added in spidermonkey 45 bool js::cloneandexecutescript(jscontext *cx, js::handle<jsobject*> obj, js::handle<jsscript*> script); // added in spidermonkey 31, obsoleted since jsapi 39 name type
description cx jscontext * the context in which to execute the script.
...
description js_executescript executes a previously-compiled script, script.
JS_ExecuteScriptPart
syntax typedef enum jsexecpart { jsexec_prolog, jsexec_main } jsexecpart; jsbool js_executescriptpart( jscontext *cx, jsobject *obj, jsscript *script, jsexecpart part, jsval *rval); name type
description cx jscontext * the context in which to execute the script.
...
description js_executescriptpart executes part of a previously compiled script, script.
JS_ExecuteScriptVersion
syntax jsbool js_executescriptversion(jscontext *cx, jsobject *obj, jsobject *scriptobj, jsval *rval, jsversion version); name type
description cx jscontext * the context in which to execute the script.
...
description js_executescript executes a previously-compiled script, script.
JS_FS
name type
description name const char * the javascript name for the function.
...
description use these macros to define an array of jsfunctionspecs to pass to js_definefunctions or js_initclass.
JS_FileEscapedString
syntax bool js_fileescapedstring(file *fp, jsstring *str, char quote); name type
description fp file * a file pointer to write into.
...
description js_fileescapedstring writes str into file fp escaping any non-printable or non-ascii character.
JS_Finish
syntax void js_finish(jsruntime *rt); name type
description rt jsruntime * pointer to a js runtime to destroy.
...
description js_finish is obsolete.
JS_FlattenString
syntax jsflatstring * js_flattenstring(jscontext *cx, jsstring *str); name type
description cx jscontext * the context.
...
description js_flattenstring flattens a string str and returns a pointer to jsflatstring.
JS_FlushCaches
syntax void js_flushcaches(jscontext *cx); name type
description cx jscontext * the context.
...
description .
JS_ForgetLocalRoot
syntax void js_forgetlocalroot(jscontext *cx, void *thing); name type
description cx jscontext * pointer to the context in which the caller is running.
...
description this function is used to interact with scoped local root management.
JS_ForwardGetPropertyTo
syntax bool js_forwardgetpropertyto(jscontext *cx, js::handleobject obj, js::handleid id, js::handleobject onbehalfof, js::mutablehandlevalue vp); bool js_forwardgetelementto(jscontext *cx, js::handleobject obj, uint32_t index, js::handleobject onbehalfof, js::mutablehandlevalue vp); name type
description cx jscontext * a context.
...
description js_forwardgetpropertyto is the base implementation of js_getproperty, js_getucproperty, js_getpropertybyid etc, where onbehalfof is same to obj.
JS_FreezeObject
syntax bool js_freezeobject(jscontext *cx, js::handle<jsobject*> obj); name type
description cx jscontext * the context.
...
description freezes an object.
JS_GC
syntax void js_gc(jscontext *cx); // added in spidermonkey 52 void js_gc(jsruntime *rt); // obsolete since jsapi 50 void js_gc(jscontext *cx); // obsolete since jsapi 14 name type
description cx jscontext * the context to for which to perform garbage collection.
...obsolete since jsapi 50
description js_gc performs garbage collection of js objects, strings and other internal data structures that are no longer reachable in the specified context or runtime.
JS_GET_CLASS
syntax #ifdef js_threadsafe #define js_get_class(cx,obj) js_getclass(cx, obj) #else #define js_get_class(cx,obj) js_getclass(obj) #endif parameter type
description cx jscontext * any context associated with the runtime in which obj exists.
...
description js_get_class returns a pointer to the jsclass associated with a specified js object, obj.
JS_GetArrayLength
syntax bool js_getarraylength(jscontext *cx, js::handle<jsobject*> obj, uint32_t *lengthp); name type
description cx jscontext * the context in which to look up the array's length.
...
description js_getarraylength gets the .length property of obj as though by calling js_getproperty and converts it to a 32-bit unsigned integer.
JS_GetArrayPrototype
syntax jsobject * js_getarrayprototype(jscontext *cx, js::handleobject forobj); name type
description cx jscontext * pointer to a javascript context from which to derive runtime information.
...
description js_getarrayprototype() retrieves the original array.prototype of a specified object, obj.
JS_GetClass
syntax const jsclass * js_getclass(jsobject *obj); name type
description cx jscontext * any context associated with the runtime in which obj exists.
...
description js_getclass returns a pointer to the jsclass associated with a specified js object, obj.
JS_GetClassObject
syntax bool js_getclassobject(jscontext *cx, jsprotokey key, js::mutablehandle<jsobject*> objp); name type
description cx jscontext * a context.
...
description js_getclassobject gets the builtin class costructor for the specified prototype key.
JS_GetClassPrototype
syntax bool js_getclassprototype(jscontext *cx, jsprotokey key, js::mutablehandle<jsobject*> objp); name type
description cx jscontext * a context.
...
description js_getclassprototype gets the builtin class costructor for the specified prototype key.
JS_GetConstructor
syntax jsobject * js_getconstructor(jscontext *cx, js::handle<jsobject*> proto); name type
description cx jscontext * a context.
...
description js_getconstructor retrieves the constructor property of a given object, obj.
JS_GetContextPrivate
syntax void * js_getcontextprivate(jscontext *cx); void js_setcontextprivate(jscontext *cx, void *data); void * js_getsecondcontextprivate(jscontext *cx); // added in spidermonkey 17 void js_setsecondcontextprivate(jscontext *cx, void *data); // added in spidermonkey 17 name type
description cx jscontext * any context.
...
description each jscontext has two fields of type void * which the application may use for any purpose.
JS_GetContextThread
syntax int js_getcontextthread(jscontext *cx); name type
description cx jscontext * the context to examine.
...
description js_getcontextthread returns the id of the thread currently associated with this context.
JS_GetDefaultFreeOp
syntax jsfreeop * js_getdefaultfreeop(jsruntime *rt); name type
description rt jsruntime * a pointer to the runtime.
...
description js_getdefaultfreeop returns default jsfreeop for the runtime.
JS_GetElement
syntax bool js_getelement(jscontext *cx, js::handleobject obj, uint32_t index, js::mutablehandlevalue vp); name type
description cx jscontext * the context in which to perform the property lookup.
...
description js_getelement examines a specified js object, obj, and its prototype chain, for an element or numeric property numbered index.
JS_GetEmptyString
syntax jsstring * js_getemptystring(jsruntime *rt); name type
description rt jsruntime * the runtime for which to return the empty string.
...
description the returned empty string has the length 0.
JS_GetEmptyStringValue
syntax // added in spidermonkey 42 js::value js_getemptystringvalue(jscontext *cx); // obsolete since spidermonkey 42 jsval js_getemptystringvalue(jscontext *cx); name type
description cx jscontext * a context.
...
description js_getemptystringvalue returns the empty string as a js::value.
JS_GetErrorPrototype
syntax jsobject * js_geterrorprototype(jscontext *cx); name type
description cx jscontext * pointer to a js context whose errors should be reported via your function.
...
description js_geterrorprototype returns the original value of error.prototype from the global object of the current compartment of cx.
JS_GetExternalStringClosure
syntax void * js_getexternalstringclosure(jscontext *cx, jsstring *str); name type
description cx jscontext * the context from which to retrieve the closure for a string.
...
description to determine if a string was created as an external string, you can call js_isexternalstring.
JS_GetExternalStringFinalizer
syntax const jsstringfinalizer * js_getexternalstringfinalizer(jsstring *str); name type
description str jsstring * a string to get finalizer.
...
description js_getexternalstringfinalizer returns the fin parameter passed to js_newexternalstring.
JS_GetFlatStringChars
syntax const jschar * js_getflatstringchars(jsflatstring *str); name type
description str jsflatstring * the flattended string returned by js_flattenstring.
...
description jsflatstring *fstr = js_flattenstring(cx, str); if (!fstr) return js_false; const jschar *chars = js_getflatstringchars(fstr) js_assert(chars); see also js_flattenstring bug 1037869 ...
JS_GetFunctionArity
syntax uint16_t js_getfunctionarity(jsfunction *fun); name type
description fun jsfunction * a javascript function.
...
description js_getfunctionarity returns the number of formal parameters of a function, fun.
JS_GetFunctionCallback
syntax jsfunctioncallback js_getfunctioncallback(jscontext *cx); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_getfunctioncallback returns the current function invocation callback, or null if there isn't one set up.
JS_GetFunctionFlags
syntax unsigned int js_getfunctionflags(jsfunction *fun); name type
description fun jsfunction * the function to examine.
...
description js_getfunctionflags retrieves the function flags of a given javascript function, fun.
JS_GetFunctionId
syntax jsstring * js_getfunctionid(jsfunction *fun); jsstring * js_getfunctiondisplayid(jsfunction *fun); // added in spidermonkey 17 name type
description fun jsfunction * a javascript function.
...
description js_getfunctionid returns the name of a function, fun, as a jsstring, or null if fun is unnamed.
JS_GetFunctionName
syntax const char * js_getfunctionname(jsfunction *fun); name type
description fun jsfunction * a pointer to a javascript function.
...
description js_getfunctionname retrieves the function name associated with a function pointer, fun.
JS_GetFunctionObject
syntax jsobject * js_getfunctionobject(jsfunction *fun); name type
description fun jsfunction * pointer to a js function.
...
description js_getfunctionobject returns the javascript function object for a specified function pointer, fun.
JS_GetFunctionPrototype
syntax jsobject * js_getfunctionprototype(jscontext *cx, js::handleobject forobj); name type
description cx jscontext * pointer to a javascript context from which to derive runtime information.
...
description js_getfunctionprototype() retrieves the original function.prototype of a specified object, obj.
JS_GetFunctionScript
syntax jsscript * js_getfunctionscript(jscontext *cx, js::handlefunction fun); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_getfunctionscript returns a pointer to jsscript for the specified function, fun.
JS_GetGlobalForCompartmentOrNull
syntax jsobject * js_getglobalforcompartmentornull(jscontext *cx, jscompartment *c); name type
description cx jscontext * the context for which to return the global object.
...
description js_getglobalforcompartmentornull() returns the global object for the context and the compartment.
JS_GetGlobalForObject
syntax jsobject * js_getglobalforobject(jscontext *cx, jsobject *obj); name type
description cx jscontext * a context.
...
description js_getglobalforobject returns the last non-null object on the parent chain of the input object.
JS_GetGlobalForScopeChain
syntax jsobject * js_getglobalforscopechain(jscontext *cx); name type
description cx jscontext * the context for which to return the global object.
...
description js_getglobalforscopechain() returns the global object for whatever function is currently running on the context.
JS_GetGlobalObject
(in javascript, global variables are stored as properties of the global object.) syntax jsobject * js_getglobalobject(jscontext *cx); name type
description cx jscontext * the context from which to retrieve the global object.
...
description this function is obsolete: use js_getglobalforobject or js_getglobalforscopechain instead.
JS_GetInstancePrivate
syntax void * js_getinstanceprivate(jscontext *cx, js::handle<jsobject*> obj, const jsclass *clasp, js::callargs *args); // added in jsapi 32 void * js_getinstanceprivate(jscontext *cx, js::handle<jsobject*> obj, const jsclass *clasp, jsval *argv); // obsolete since jsapi 32 name type
description cx jscontext * a context.
...
description js_getinstanceprivate determines if a javascript object, obj, is an instance of a given jsclass, clasp, and if it is, returns a pointer to the object's private data.
JS_GetInternedStringChars
syntax const jschar * js_getinternedstringchars(jsstring *str); const jschar * js_getinternedstringcharsandlength(jsstring *str, size_t *length); name type
description str jsstring * the interned string.
...
description js_getinternedstringchars returns a pointer to the interned string.
JS_GetLatin1FlatStringChars
syntax const js::latin1char * js_getlatin1flatstringchars(const js::autocheckcannotgc &nogc, jsflatstring *str); const char16_t * js_gettwobyteflatstringchars(const js::autocheckcannotgc &nogc, jsflatstring *str); name type
description cx jscontext * a context.
...
description js_getlatin1flatstringchars and js_gettwobyteflatstringchars return a pointer to the string.
JS_GetLatin1InternedStringChars
syntax const js::latin1char * js_getlatin1internedstringchars(const js::autocheckcannotgc &nogc, jsstring *str); const char16_t * js_gettwobyteinternedstringchars(const js::autocheckcannotgc &nogc, jsstring *str); name type
description cx jscontext * a context.
...
description js_getlatin1internedstringchars and js_gettwobyteinternedstringchars gets the characters of the string, str.
JS_GetLatin1StringCharsAndLength
syntax const js::latin1char * js_getlatin1stringcharsandlength(jscontext *cx, const js::autocheckcannotgc &nogc, jsstring *str, size_t *length); const char16_t * js_gettwobytestringcharsandlength(jscontext *cx, const js::autocheckcannotgc &nogc, jsstring *str, size_t *length); name type
description cx jscontext * a context.
...
description js_getlatin1stringcharsandlength and js_gettwobytestringcharsandlength get the characters and the length of the string, str.
JS_GetNaNValue
syntax // added in spidermonkey 42 js::value js_getnanvalue(jscontext *cx); // obsolete since spidermonkey 42 jsval js_getnanvalue(jscontext *cx); name type
description cx jscontext * a context.
...
description js_getnanvalue returns a value of type js::value that represents an ieee floating-point quiet not-a-number (nan).
JS_GetObjectPrototype
syntax jsobject * js_getobjectprototype(jscontext *cx, js::handleobject forobj); name type
description cx jscontext * pointer to a javascript context from which to derive runtime information.
...
description js_getobjectprototype() retrieves the original object.prototype of a specified object, obj.
JS_GetObjectRuntime
syntax jsruntime * js_getobjectruntime(jsobject *obj); name type
description obj jsobject * the object to query.
...
description js_getobjectruntime retrieves a pointer to the jsruntime for a specified jsobject.
JS_GetOptions
syntax uint32 js_getoptions(jscontext *cx); name type
description cx jscontext * the context from which to read options.
...
description js_getoptions retrieves the option flags of a given js context cx.
JS_GetParent
syntax jsobject * js_getparent(jsobject *obj); name type
description obj jsobject * object for which to retrieve the parent.
...
description js_getparent retrieves the parent object of obj, or null if obj does not have a parent.
JS_GetParentRuntime
syntax jsruntime * js_getparentruntime(jscontext *cx); name type
description cx jscontext * the context to query.
...
description js_getparentruntime retrieves a pointer to the parent jsruntime of the runtime for a specified jscontext.
JS_GetPendingException
syntax bool js_getpendingexception(jscontext *cx, js::mutablehandlevalue vp); name type
description cx jscontext * pointer to the js context in which the exception was thrown.
...
description if an exception has been thrown in the context cx, and it has not yet been caught or cleared, js_getpendingexception stores the exception object in *vp and returns true.
JS_GetPositiveInfinityValue
syntax // added in spidermonkey 42 js::value js_getpositiveinfinityvalue(jscontext *cx); js::value js_getnegativeinfinityvalue(jscontext *cx); // obsolete since spidermonkey 42 jsval js_getpositiveinfinityvalue(jscontext *cx); jsval js_getnegativeinfinityvalue(jscontext *cx); name type
description cx jscontext * a context.
...
description js_getpositiveinfinityvalue returns a js::value that represents an ieee floating-point positive infinity.
JS_GetPrivate
syntax void * js_getprivate(jsobject *obj); name type
description obj jsobject * an object whose jsclass has the jsclass_has_private flag.
...
description js_getprivate accesses an object's private data field.
JS_GetProperty
char *name, js::mutablehandlevalue vp); bool js_getucproperty(jscontext *cx, js::handleobject obj, const char16_t *name, size_t namelen, js::mutablehandlevalue vp); bool js_getpropertybyid(jscontext *cx, js::handleobject obj, js::handleid id, js::mutablehandlevalue vp); // added in spidermonkey 1.8.1 name type
description cx jscontext * a context.
...
description js_getproperty examines a specified js object obj and its prototype chain for a property with the specified name.
JS_GetPropertyAttributes
syntax jsbool js_getpropertyattributes(jscontext *cx, jsobject *obj, const char *name, unsigned int *attrsp, jsbool *foundp); jsbool js_getucpropertyattributes(jscontext *cx, jsobject *obj, const jschar *name, size_t namelen, unsigned int *attrsp, jsbool *foundp); name type
description cx jscontext * the context in which to look up property attributes.
...
description js_getpropertyattributes retrieves the property attributes of the property with the given name on a given object, obj.
JS_GetPropertyAttrsGetterAndSetter
jscontext *cx, jsobject *obj, const jschar *name, size_t namelen, unsigned int *attrsp, jsbool *foundp, jspropertyop *getterp, jspropertyop *setterp); jsbool js_getpropertyattrsgetterandsetterbyid(jscontext *cx, jsobject *obj, jsid id, unsigned int *attrsp, jsbool *foundp, jspropertyop *getterp, jspropertyop *setterp); // added in spidermonkey 1.8.1 name type
description cx jscontext * the context in which to perform the property lookup.
...
description see js_getpropertyattributes for details about these functions.
JS_GetPropertyDefault
syntax bool js_getpropertydefault(jscontext *cx, jsobject *obj, const char *name, jsval def, js::mutablehandle<js::value> vp); bool js_getpropertybyiddefault(jscontext *cx, jsobject *obj, jsid id, jsval def, js::mutablehandle<js::value> vp); name type
description cx jscontext * a context.
...
description js_getpropertydefault examines a specified js object obj and its prototype chain for a property with the specified name.
JS_GetPrototype
syntax bool js_getprototype(jscontext *cx, js::handleobject obj, js::mutablehandleobject protop); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_getprototype retrieves the prototype of a specified object, obj.
JS_GetRegExpFlags
syntax unsigned js_getregexpflags(jscontext *cx, handleobject obj) name type
description cx jscontext * a context.
...
description js_getregexpflags returns flags of the specified object, obj.
JS_GetRegExpSource
syntax jsstring * js_getregexpsource(jscontext *cx, js::handleobject obj); name type
description cx jscontext * a context.
...
description js_getregexpsource returns a source string of the specified object, obj.
JS_GetReservedSlot
syntax // added in spidermonkey 42 js::value js_getreservedslot(jsobject *obj, uint32_t index); void js_setreservedslot(jsobject *obj, uint32_t index, js::value v); // obsolete since spidermonkey 42 jsval js_getreservedslot(jsobject *obj, uint32_t index); void js_setreservedslot(jsobject *obj, uint32_t index, jsval v); name type
description obj jsobject * an object that has reserved slots.
...
description if a jsclass has jsclass_has_reserved_slots(n) in its flags, with n > 0, or has a non-null jsclass.reserveslots callback, then objects of that class have n reserved slots in which the application may store data.
JS_GetRuntime
syntax jsruntime * js_getruntime(jscontext *cx); name type
description cx jscontext * the context to query.
...
description js_getruntime retrieves a pointer to the jsruntime with which a specified jscontext, cx, is associated.
JS_GetRuntimePrivate
syntax void * js_getruntimeprivate(jsruntime *rt); void js_setruntimeprivate(jsruntime *rt, void *data); name type
description rt jsruntime * any js runtime.
...
description each jsruntime has a field of type void * which the application may use for any purpose.
JS_GetScopeChain
syntax jsobject * js_getscopechain(jscontext *cx); name type
description cx jscontext * the context to query.
...
description js_getscopechain returns the first jsobject on the scope chain for the javascript code currently running in the given context, cx.
JS_GetStringBytes
syntax char * js_getstringbytes(jsstring *str); const char * js_getstringbytesz(jscontext *cx, jsstring *str); // added in jsapi 1.8.2 name type
description cx jscontext * (js_getstringbytesz and js_encodestring only) a context.
...
description js_getstringbytes and js_getstringbytesz convert the specified javascript string, str, to a c string (an array of 8-bit chars).
JS_GetStringCharAt
syntax bool js_getstringcharat(jscontext *cx, jsstring *str, size_t index, char16_t *res); char16_t js_getflatstringcharat(jsflatstring *str, size_t index); name type
description cx jscontext * the context in which to create the new string.
...
description js_getstringcharat and js_getflatstringcharat get the specified character from the string str.
JS_GetStringChars
syntax jschar * js_getstringchars(jsstring *str); // obsolete since jsapi 1.8.5 const jschar * js_getstringcharsz(jscontext *cx, jsstring *str); // added in spidermonkey 1.8.2, obsolete since jsapi 33 name type
description cx jscontext * (in js_getstringcharsz only) a context.
...
description js_getstringchars obsolete since javascript 1.8.5 returns a pointer to the first element of an array of jschars.
JS_GetStringCharsAndLength
syntax const jschar * js_getstringcharsandlength(jscontext *cx, jsstring *str, size_t *length); name type
description cx jscontext * the context.
...
description js_getstringcharsandlength gets the characters and the length of the string, str if successful, js_getstringcharsandlength returns a pointer to the string, and store the length to *length, otherwise returns null see also bug 1037869 ...
JS_GetStringEncodingLength
syntax size_t js_getstringencodinglength(jscontext *cx, jsstring *str); name type
description cx jscontext * a context.
...
description js_getstringencodinglength returns the length of the specified string in bytes, regardless of its encoding.
JS_GetStringLength
syntax size_t js_getstringlength(jsstring *str); name type
description str jsstring * the string to examine.
...
description js_getstringlength reports the length, in 16-bit code units, of the string str.
JS_GetTwoByteExternalStringChars
syntax const char16_t * js_gettwobyteexternalstringchars(jsstring *str); name type
description str jsstring * a string to get characters.
...
description js_gettwobyteexternalstringchars gets the characters of the string, str.
JS_GetVersion
syntax jsversion js_getversion(jscontext *cx); name type
description cx jscontext * the context to query.
...
description js_getversion returns the javascript version currently used by the given jscontext, cx.
JS_HasArrayLength
syntax jsbool js_hasarraylength(jscontext *cx, jsobject *obj, jsuint *lengthp); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_hasarraylength determines if an object, obj, has a length property.
JS_HasElement
syntax bool js_haselement(jscontext *cx, js::handleobject obj, uint32_t index, bool *foundp); name type
description cx jscontext * the context in which to perform the property lookup.
...
description js_haselement examines a specified js object, obj, and its prototype chain, for an element or numeric property numbered index.
JS_HasInstance
syntax bool js_hasinstance(jscontext *cx, js::handle<jsobject*> obj, js::handle<js::value> v, bool *bp); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_hasinstance determines if a specified js value, v, is an instance of js object, obj.
JS_HasOwnProperty
syntax bool js_hasownproperty(jscontext* cx, handleobject obj, const char* name, bool* foundp) bool js_hasownpropertybyid(jscontext* cx, handleobject obj, handleid id, bool* foundp) name type
description cx jscontext * a context.
...
description js_hasownproperty searches an object, obj, for an own property with the specified name.
JS_HasProperty
y(jscontext *cx, js::handleobject obj, const char *name, bool *foundp); bool js_hasucproperty(jscontext *cx, js::handleobject obj, const char16_t *name, size_t namelen, bool *vp); bool js_haspropertybyid(jscontext *cx, js::handleobject obj, js::handleid id, bool *foundp); // added in spidermonkey 1.8.1 name type
description cx jscontext * a context.
...
description js_hasproperty searches an object, obj, and its prototype chain, for a property with the specified name.
JS_IdArrayGet
syntax jsid js_idarrayget(jscontext *cx, jsidarray *ida, unsigned index) name type
description cx jscontext * a context.
...
description js_idarrayget gets the item in the specified index of the id array pointed to by ida.
JS_IdArrayLength
syntax int js_idarraylength(jscontext *cx, jsidarray *ida); name type
description cx jscontext * a context.
...
description js_idarraylength gets the length of the id array pointed to by ida.
JS_IdToProtoKey
syntax jsprotokey js_idtoprotokey(jscontext *cx, js::handleid id); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_idtoprotokey converts a specified js id, id, to a prototype key.
JS_IdToValue
syntax bool js_idtovalue(jscontext *cx, jsid id, js::mutablehandle<js::value> vp); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_idtovalue converts a specified js id, id, to a js value.
JS_InitCTypesClass
syntax jsbool js_initctypesclass(jscontext *cx, jsobject *global); name type
description cx jscontext * the context.
...
description ctypes capability is disabled in a build by default.
JS_InitClass
syntax jsobject * js_initclass(jscontext *cx, js::handleobject obj, js::handleobject parent_proto, const jsclass *clasp, jsnative constructor, unsigned nargs, const jspropertyspec *ps, const jsfunctionspec *fs, const jspropertyspec *static_ps, const jsfunctionspec *static_fs); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...(this is the javascript equivalent of public static methods in c++ or java.)
description js_initclass initializes a jsclass and (optionally) makes it visible to javascript code.
JS_InitStandardClasses
syntax bool js_initstandardclasses(jscontext *cx, js::handle<jsobject*> obj); name type
description cx jscontext * pointer to the executable script context for which to initialize js function and object classes.
...
description js_initstandardclasses initializes the built-in javascript global properties.
JS_InstanceOf
syntax bool js_instanceof(jscontext *cx, js::handle<jsobject*> obj, const jsclass *clasp, js::callargs *args); // added in spidermonkey 38 bool js_instanceof(jscontext *cx, js::handle<jsobject*> obj, const jsclass *clasp, jsval *argv); // obsolete since jsapi 32 name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...obsolete since jsapi 32
description js_instanceof can be used to check whether an object obj is of a particular jsclass.
JS_InternJSString
syntax jsstring * js_internjsstring(jscontext *cx, js::handlestring str); name type
description cx jscontext * the context.
...
description js_internjsstring converts a string str to interned string (interned atom) and returns the result string as jsstring *.
JS_InternString
syntax jsstring * js_internstring(jscontext *cx, const char *s); jsstring * js_internstringn(jscontext *cx, const char *s, size_t length); jsstring * js_internucstring(jscontext *cx, const char16_t *s); jsstring * js_internucstringn(jscontext *cx, const char16_t *s, size_t length); name type
description cx jscontext * a context.
...
description js_internstring and js_internstringn return an interned javascript string with a specified value, s.
JS_IsArrayObject
syntax bool js_isarrayobject(jscontext *cx, js::handlevalue value, bool *isarray); bool js_isarrayobject(jscontext *cx, js::handleobject obj, bool *isarray); // obsolete since jsapi 44 bool js_isarrayobject(jscontext *cx, js::handlevalue value); bool js_isarrayobject(jscontext *cx, js::handleobject obj); name type
description cx jscontext * a context.
...
description js_isarrayobject determines if a specified object, obj or value, is an array object.
JS_IsBuiltinEvalFunction
syntax bool js_isbuiltinevalfunction(jsfunction *fun); name type
description obj jsfunction * pointer to the function to test.
...
description js_isbuiltinevalfunction returns whether the given function is the global eval function.
JS_IsBuiltinFunctionConstructor
syntax bool js_isbuiltinfunctionconstructor(jsfunction *fun); name type
description obj jsfunction * pointer to the function to test.
...
description js::iscallable returns whether the given function is the global function constructor.
JS_IsConstructing
syntax jsbool js_isconstructing(jscontext *cx, jsval *vp); name type
description cx jscontext * the cx parameter passed to the jsnative.
...
description js_isconstructing must be called only from a jsnative called from the engine.
JS_IsConstructing_PossiblyWithGivenThisObject
syntax static jsbool js_isconstructing_possiblywithgiventhisobject(jscontext *cx, const jsval *vp, jsobject **maybethis); name type
description cx jscontext * the context.
... vp const jsval * maybethis jsobject **
description in the case of a constructor called from js_constructobject and js_initclass where the class has the jsclass_construct_prototype flag set, spidermonkey passes the constructor a non-standard this object.
JS_IsConstructor
syntax bool js_isconstructor(jsfunction *fun); name type
description fun jsfunction * the function to examine.
...
description js_isconstructor determines if a specified function, fun is a valid constructor object.
JS_IsExceptionPending
syntax bool js_isexceptionpending(jscontext *cx); name type
description cx jscontext * pointer to a js context to check for pending exceptions.
...
description js_isexceptionpending returns true if an exception has been thrown in the context cx and the exception has not yet been caught or cleared.
JS_IsExtensible
syntax bool js_isextensible(jscontext *cx, js::handleobject obj, bool *extensible); name type
description cx jscontext * the context.
...
description js_isextensible queries [[extensible]] property of the specified object, obj.
JS_IsExternalString
syntax bool js_isexternalstring(jsstring *str); name type
description str jsstring * the string to check.
...
description js_isexternalstring returns true if the string is an external string; otherwise it's false.
JS_IsGlobalObject
syntax bool js_isglobalobject(jsobject *obj); name type
description obj jsobject * the object to examine.
...
description js_isglobalobject returns true if obj is a global object, false otherwise.
JS_IsIdentifier
syntax bool js_isidentifier(jscontext *cx, js::handlestring str, bool *isidentifier); bool js_isidentifier(const char16_t *chars, size_t length); // added in spidermonkey 38 name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_isidentifier tests if the given string is a valid ecmascript identifier.
JS_IsNative
syntax bool js_isnative(jsobject *obj); name type
description str jsobject * the object to check.
...
description js_isnative returns true if the object is a native object.
JS_IsNativeFunction
syntax bool js_isnativefunction(jsobject *funobj, jsnative call); name type
description funobj jsobject * the function object to examine.
...
description js_isnativefunction determines if a specified function object, funobj equals a specified native function, call.
JS_IsRunning
syntax bool js_isrunning(jscontext *cx); name type
description cx jscontext * the context to query.
...
description js_isrunning determines if a script or function is currently executing in a specified jscontext, cx.
JS_IsStopIteration
syntax // added in spidermonkey 42 bool js_isstopiteration(js::value v); // obsolete since spidermonkey 42 bool js_isstopiteration(jsval v); name type
description v js::value the value to check.
...
description js_isstopiteration returns true if v is stopiteration, otherwise false.
JS_LeaveCompartment
syntax void js_leavecompartment(jscontext *cx, jscompartment *oldcompartment); name type
description cx jscontext * the context in which to leave the compartment.
...
description every jscontext has a current compartment.
JS_LeaveCrossCompartmentCall
syntax void js_leavecrosscompartmentcall(jscrosscompartmentcall *call); name type
description call jscrosscompartmentcall * value returned by previous call to js_entercrosscompartmentcall.
...
description every jscontext has a current compartment.
JS_LeaveLocalRootScope
syntax void js_leavelocalrootscope(jscontext *cx); name type
description cx jscontext * pointer to the context.
...
description see js_enterlocalrootscope for an explanation of local root scopes.
JS_LeaveLocalRootScopeWithResult
syntax void js_leavelocalrootscopewithresult(jscontext *cx, jsval rval); name type
description cx jscontext * pointer to the context.
...
description see js_enterlocalrootscope for an explanation of local root scopes.
JS_LinkConstructorAndPrototype
syntax bool js_linkconstructorandprototype(jscontext *cx, js::handle<jsobject*> ctor, js::handle<jsobject*> proto); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_linkconstructorandprototype sets the prototype property of class constructor function, ctor, to prototype object, proto with jsprop_permanent | jsprop_readonly flags, and sets the constructor property of proto to ctor with no flag.
JS_Lock
syntax void js_lock(jsruntime *rt); name type
description rt jsruntime * pointer to the runtime to lock.
...
description js_lock is a deprecated api; don't use it.
JS_LockGCThing
syntax jsbool js_lockgcthing(jscontext *cx, void *thing); // obsolete since jsapi 21 jsbool js_unlockgcthing(jscontext *cx, void *thing); // obsolete since jsapi 21 jsbool js_lockgcthingrt(jsruntime *rt, void *thing); jsbool js_unlockgcthingrt(jsruntime *rt, void *thing); name type
description cx jscontext * a context.
...
description js_lockgcthing is a deprecated function that protects a specified item, thing, associated with an executable script context, cx, from garbage collection.
JS_LookupElement
syntax bool js_lookupelement(jscontext *cx, js::handleobject obj, uint32_t index, js::mutablehandlevalue vp); name type
description cx jscontext * the context in which to look up the property.
...
description js_lookupelement examines a specified javascript object, obj, for a numeric property numbered index.
JS_LookupProperty
kuppropertywithflags(jscontext *cx, js::handleobject obj, const char *name, unsigned flags, js::mutablehandlevalue vp); bool js_lookuppropertywithflagsbyid(jscontext *cx, js::handleobject obj, js::handleid id, unsigned flags, js::mutablehandleobject objp, js::mutablehandlevalue vp); // added in spidermonkey 1.8.1 name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description the functions js_lookupproperty, js_lookupucproperty, js_lookuppropertybyid, js_lookuppropertywithflags, and js_lookuppropertywithflagsbyid search a specified object, obj, for a property with the given name.
JS_LooselyEqual
syntax bool js_looselyequal(jscontext *cx, js::handle<js::value> v1, js::handle<js::value> v2, bool *equal); name type
description cx jscontext * the context in which to perform the conversion.
...
description js_looselyequal determines if v1 is loosely equal to v2 under the javascript == operator, as specified in ecma 262-3 §11.9.3.
JS_MakeStringImmutable
syntax jsbool js_makestringimmutable(jscontext *cx, jsstring *str); name type
description cx jscontext * a context.
...
description a string's characters can never be changed, but spidermonkey uses two string optimization techniques behind the scenes: a growable string (see js_newgrowablestring ) has a buffer that the javascript engine can reallocate so that concatenating it with another string is much faster.
JS_MaybeGC
syntax void js_maybegc(jscontext *cx); name type
description cx jscontext * the context in which to perform garbage collection, if needed.
...
description js_maybegc tries to determine whether garbage collection in cx's runtime would free up enough memory to be worth the amount of time it would take.
JS_New
syntax jsobject * js_new(jscontext *cx, js::handleobject ctor, const js::handlevaluearray& args); // added in jsapi 32 jsobject * js_new(jscontext *cx, jsobject *ctor, unsigned argc, jsval *argv); // obsolete since jsapi 32 name type
description cx jscontext * the context in which to create the new object.
...obsolete since jsapi 32
description js_new creates a new object as though by using the new operator, as described in ecma 262-3 §11.2.2.
JS_NewArrayObject
syntax jsobject * js_newarrayobject(jscontext *cx, const js::handlevaluearray& contents); // added in spidermonkey 31 jsobject * js_newarrayobject(jscontext *cx, size_t length); // added in spidermonkey 31 jsobject * js_newarrayobject(jscontext *cx, int length, jsval *vector); // obsolete since jsapi 30 name type
description cx jscontext * the context in which to create the new array.
...obsolete since jsapi 30
description js_newarrayobject with contents parameter creates a new array object with the specified contents elements.
JS_NewCompartmentAndGlobalObject
syntax jsobject * js_newcompartmentandglobalobject(jscontext *cx, jsclass *clasp, jsprincipals *principals); name type
description cx jscontext * the context in which to create the new global object.
...
description js_newcompartmentandglobalobject creates a new compartment, and then creates a new global object as the first object in that compartment.
JS_NewContext
syntax jscontext * js_newcontext(jsruntime *rt, size_t stackchunksize); name type
description rt jsruntime * parent runtime for the new context.
...
description js_newcontext creates a new jscontext in the runtime rt.
JS_NewDateObject
syntax jsobject * js_newdateobject(jscontext *cx, int year, int mon, int mday, int hour, int min, int sec); name type
description cx jscontext * the context in which to create the new date object.
...
description creates and returns a new jsobject representing a javascript date object, which is pre-configured using the specified values.
JS_NewDateObjectMsec
syntax jsobject * js_newdateobjectmsec(jscontext *cx, double msec); name type
description cx jscontext * the context.
...
description the returned jsobject is a standard javascript date.
JS_NewDependentString
syntax jsstring * js_newdependentstring(jscontext *cx, js::handlestring str, size_t start, size_t length); name type
description cx jscontext * the context in which to create the new string.
...
description js_newdependentstring creates a new string as a substring of an existing javascript string, str.
JS_NewDouble
syntax jsdouble * js_newdouble(jscontext *cx, jsdouble d); name type
description cx jscontext * the context in which to create the new number.
...
description js_newdouble allocates a copy of the number d on the javascript garbage collection heap.
JS_NewDoubleValue
create a floating-point jsval syntax jsbool js_newdoublevalue(jscontext *cx, jsdouble d, jsval *rval); name type
description cx jscontext * the context in which to create the new number.
...
description js_newdoublevalue creates a floating-point jsval.
JS_NewExternalString
syntax jsstring * js_newexternalstring(jscontext *cx, const char16_t *chars, size_t length, const jsstringfinalizer *fin); jsstring * js_newexternalstringwithclosure(jscontext *cx, jschar *chars, size_t length, int type, void *closure); // obsolete since jsapi 13 name type
description cx jscontext * the context in which to create the new string.
...obsolete since jsapi 13
description js_newexternalstring and js_newexternalstringwithclosure create a new jsstring whose characters are stored in external memory, i.e., memory allocated by the application, not the javascript engine.
JS_NewFunction
obsolete since jsapi 39 jsfunction * js_newfunction(jscontext *cx, jsnative call, unsigned nargs, unsigned flags, js::handle<jsobject*> parent, const char *name); jsfunction * js_newfunctionbyid(jscontext *cx, jsnative call, unsigned nargs, unsigned flags, js::handle<jsobject*> parent, js::handle<jsid> id); // added in spidermonkey 17 name type
description cx jscontext * the context in which to create the new function.
...added in spidermonkey 17
description js_newfunction creates a new javascript function implemented in c/c++.
JS_NewGlobalObject
syntax jsobject * js_newglobalobject(jscontext *cx, const jsclass *clasp, jsprincipals *principals, js::onnewglobalhookoption hookoption, const js::compartmentoptions &options = js::compartmentoptions()); name type
description cx jscontext * the context in which to create the new global object.
...added in spidermonkey 31
description js_newglobalobject creates a new global object based on the specified class.
JS_NewNumberValue
syntax jsbool js_newnumbervalue(jscontext *cx, jsdouble d, jsval *rval); name type
description cx jscontext * the context in which to create the new number.
...
description js_newnumbervalue converts a c floating-point number of type jsdouble to jsval, the type of javascript values.
JS_NewObject
t*> proto); // obsolete since spidermonkey 38 jsobject * js_newobject(jscontext *cx, const jsclass *clasp, js::handle<jsobject*> proto, js::handle<jsobject*> parent); jsobject * js_newobjectwithgivenproto(jscontext *cx, const jsclass *clasp, js::handle<jsobject*> proto, js::handle<jsobject*> parent); // added in spidermonkey 1.8 name type
description cx jscontext * the context in which to create the new object.
...obsolete since jsapi 39
description js_newobject creates a new object based on a specified class.
JS_NewObjectForConstructor
syntax jsobject * js_newobjectforconstructor(jscontext *cx, const jsclass *clasp, const js::callargs& args); // added in jsapi 32 jsobject * js_newobjectforconstructor(jscontext *cx, jsclass *clasp, const jsval *vp); // added in jsapi 14, obsolete since jsapi 32 jsobject * js_newobjectforconstructor(jscontext *cx, const jsval *vp); // obsolete since jsapi 14 name type
description cx jscontext * the context in which to create the new object.
...added in spidermonkey 38
description js_newobjectforconstructor creates a new object exactly as the given constructor would if invoked with new.
JS_NewPlainObject
syntax jsobject * js_newplainobject(jscontext *cx); name type
description cx jscontext * the context in which to create the new object.
...
description js_newplainobject creates a new plain object, like new object(), with object.prototype as [[prototype]].
JS_NewPropertyIterator
syntax jsobject * js_newpropertyiterator(jscontext *cx, js::handle<jsobject*> obj); name type
description cx jscontext * the js context in which to enumerate properties.
...
description create an object to iterate over the enumerable own properties of obj, in arbitrary order.
JS_NewRuntime
syntax jsruntime * js_newruntime(uint32_t maxbytes, uint32_t maxnurserybytes = js::defaultnurserybytes, jsruntime *parentruntime = nullptr); jsruntime * js_newruntime(uint32_t maxbytes, jsusehelperthreads usehelperthreads, jsruntime *parentruntime = nullptr); // deprecated since jsapi 32 name type
description maxbytes uint32 maximum number of allocated bytes after which garbage collection is run.
...added in spidermonkey 31
description js_newruntime initializes the javascript runtime environment.
JS_NewScriptObject
syntax jsobject * js_newscriptobject(jscontext *cx, jsscript *script); name type
description cx jscontext * the context in which to create the new script object.
...
description js_newscriptobject returns the script object associated with the given jsscript.
JS_NewUCString
syntax jsstring * js_newucstring(jscontext *cx, char16_t *chars, size_t length); jsstring * js_newstring(jscontext *cx, char *buf, size_t length); // obsolete since jsapi 1.8.5 name type
description cx jscontext * the context in which to create the new string.
...
description js_newstring creates and returns a new string, using the memory starting at buf and ending at buf + length as the character storage.
JS_NewStringCopyN
syntax jsstring * js_newstringcopyn(jscontext *cx, const char *s, size_t n); jsstring * js_newucstringcopyn(jscontext *cx, const char16_t *s, size_t n); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_newstringcopyn allocates space for a javascript string and its underlying storage, and copies n characters from a c character array, s, into the new jsstring.
JS_NewStringCopyZ
syntax jsstring * js_newstringcopyz(jscontext *cx, const char *s); jsstring * js_newucstringcopyz(jscontext *cx, const char16_t *s); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_newstringcopyz allocates space for a new javascript string and its underlying storage, and then copies the contents of a null-terminated character array, s, into the new string.
JS_NextProperty
syntax bool js_nextproperty(jscontext *cx, js::handleobject iterobj, js::mutablehandleid idp); name type
description cx jscontext * the js context in which to enumerate properties.
...
description on success, js_nextproperty returns true, with *idp containing the id of the next enumerable own property to visit using iterobj, or jsid_void if there is no such property left to visit.
JS_NumberValue
syntax // added in spidermonkey 42 js::value js_numbervalue(double d); // obsolete since spidermonkey 42 jsval js_numbervalue(double d); name type
description d double the numeric value to convert.
...
description js_numbervalue converts a c floating-point number of type double to js::value, the type of javascript values.
JS_ObjectIsDate
syntax bool js_objectisdate(jscontext *cx, js::handleobject obj); name type
description cx jscontext * pointer to a javascript context from which to derive runtime information.
...
description js_objectisdate() can be used to check if you are dealing with a date object, or a date object used across compartments (or windows or sites, in the browser embedding).
JS_ObjectIsFunction
syntax bool js_objectisfunction(jscontext *cx, jsobject *obj); name type
description cx jscontext * a context.
...
description js_objectisfunction tests whether obj is a function object (faster than comparing obj's class name to function, but equivalent unless someone has overwritten the function identifier with a different constructor and then created instances using that constructor that might be passed in as obj).
JS_ObjectIsRegExp
syntax bool js_objectisregexp(jscontext *cx, js::handleobject obj); name type
description cx jscontext * a context.
...
description js_objectisregexp determines if a specified object, obj, is a regexp object.
JS_PSGS
name type
description name const char * the javascript name for the property.
...
description these macros encapsulate the definition of jsnative-backed jspropertyspecs, by defining the jsnativewrappers for them.
JS_ParseJSON
syntax jsbool js_parsejson(jscontext *cx, const jschar *chars, uint32 len, jsval *vp); jsbool js_parsejsonwithreviver(jscontext *cx, const jschar *chars, uint32 len, jsval reviver, jsval *vp); name type
description cx jscontext * pointer to a js context.
...
description use these functions to parse a sequence of characters as json.
JS_PopArguments
syntax void js_poparguments(jscontext *cx, void *mark); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_poparguments frees the stack frame pointer previously allocated by js_pusharguments and unroots the jsvals which have been associated with it (those returned by js_pusharguments as well).
JS_PreventExtensions
syntax // added in spidermonkey 45 bool js_preventextensions(jscontext *cx, js::handleobject obj, js::objectopresult &result); // obsolete since jsapi 39 bool js_preventextensions(jscontext *cx, js::handleobject obj, bool *succeeded); name type
description cx jscontext * the context.
...obsolete since jsapi 39
description all javascript objects recognize the concept of extensibility: whether new properties may be added to the object.
JS_PushArguments
syntax jsval * js_pusharguments(jscontext *cx, void **markp, const char *format, ...); jsval * js_pushargumentsva(jscontext *cx, void **markp, const char *format, va_list ap); name type
description cx jscontext * the context in which to perform any necessary conversions.
...
description js_pusharguments provides a convenient way to translate a series of native c/c++ values to jsvals with a single function call.
JS_PutEscapedString
syntax size_t js_putescapedstring(jscontext *cx, char *buffer, size_t size, jsstring *str, char quote); size_t js_putescapedflatstring(char *buffer, size_t size, jsflatstring *str, char quote); name type
description cx jscontext * a context.
...
description js_putescapedstring and js_putescapedstring write str into buffer escaping any non-printable or non-ascii character using \escapes for js string literals.
JS_RemoveExternalStringFinalizer
syntax int js_removeexternalstringfinalizer(jsstringfinalizeop finalizer); name type
description finalizer jsstringfinalizeop the finalizer to remove.
...
description remove finalizer from the global gc finalizers table, returning its type code if found, -1 if not found.
JS_Remove*Root
syntax jsbool js_removevalueroot(jscontext *cx, jsval *vp); jsbool js_removestringroot(jscontext *cx, jsstring **spp); jsbool js_removeobjectroot(jscontext *cx, jsobject **opp); jsbool js_removegcthingroot(jscontext *cx, void **rp); name type
description cx jscontext * a context.
...
description js_removeroot removes the variable that rp points to from the garbage collector's root set.
JS_RemoveRootRT
syntax jsbool js_removerootrt(jsruntime *rt, void *rp); name type
description rt jsruntime * pointer to the runtime with which the root was registered.
...
description js_removerootrt removes the gc thing that rp points to from the list of gc things that are protected from garbage collection.
JS_ReportError
syntax void js_reporterror(jscontext *cx, const char *format, ...); bool js_reportwarning(jscontext *cx, const char *format, ...); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_reporterror is the simplest jsapi function for reporting errors.
JS_ReportOutOfMemory
syntax void js_reportoutofmemory(jscontext *cx); void js_reportallocationoverflow(jscontext *cx); // added in spidermonkey 1.8 name type
description cx jscontext * the context in which to report the error.
...
description call js_reportoutofmemory to report that an operation failed because the system is out of memory.
JS_ReportPendingException
syntax bool js_reportpendingexception(jscontext *cx); name type
description cx jscontext * the context in which the exception was thrown.
...
description if an exception is pending in the context cx, js_reportpendingexception converts the exception to a string and reports it to the current error reporter.
JS_ResolveStandardClass
syntax bool js_resolvestandardclass(jscontext *cx, js::handleobject obj, js::handleid id, bool *resolved); name type
description cx jscontext * pointer to the executable script context for which to initialize js function and object classes.
...
description js_resolvestandardclass resolves id, which must contain either a string or an int, to a standard class name in obj if possible, defining the class's constructor and/or prototype and storing true in *resolved.
JS_RestoreExceptionState
syntax void js_restoreexceptionstate(jscontext *cx, jsexceptionstate *state); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description this function permits to restore any previously saved exception state which was saved into a jsexceptionstate object created by the js_saveexceptionstate function.
JS_SameValue
if (v1 === 0 && v2 === 0) return 1 / v1 === 1 / v2; if (v1 !== v1 && v2 !== v2) return true; return v1 === v2; } syntax // added in spidermonkey 45 bool js_samevalue(jscontext *cx, js::handle<js::value> v1, js::handle<js::value> v2, bool *same); // obsolete since jsapi 39 bool js_samevalue(jscontext *cx, jsval v1, jsval v2, bool *same); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_samevalue determines whether two values are the same, returning true or false accordingly.
JS_SaveExceptionState
syntax jsexceptionstate * js_saveexceptionstate(jscontext *cx); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description saves the current exception state (that is, any pending exception, or a cleared exception state) associated with the specified context cx, and returns a jsexceptionstate object holding this state.
JS_SaveFrameChain
syntax bool js_saveframechain(jscontext *cx); void js_restoreframechain(jscontext *cx); name type
description cx jscontext * the context to query.
...
description these two functions are used to set aside cx's call stack while that stack is inactive.
JS_ScheduleGC
syntax void js_schedulegc(jscontext *cx, uint32_t count); name type
description cx jscontext * a context.
...
description js_schedulegc sets the nextscheduled parameter of gc.
JS_SealObject
syntax jsbool js_sealobject(jscontext *cx, jsobject *obj, jsbool deep); name type
description cx jscontext * a context.
...
description js_sealobject prevents all write access to the object, either to add a new property, delete an existing property, or set the value or attributes of an existing property.
JS_SetAllNonReservedSlotsToUndefined
syntax void js_setallnonreservedslotstoundefined(jscontext *cx, jsobject *objarg); name type
description cx jscontext * the context in which to clear the object.
...
description js_setallnonreservedslotstoundefined assignes undefined to all of obj's own properties, except the special __proto__ and __parent__ properties, in a single operation.
JS_SetArrayLength
syntax bool js_setarraylength(jscontext *cx, js::handle<jsobject*> obj, uint32_t length); name type
description cx jscontext * the context in which to change the length of the array.
...
description js_setarraylength sets the .length property of an object obj.
JS_SetCallReturnValue2
syntax void js_setcallreturnvalue2(jscontext *cx, jsval v); name type
description cx jscontext * the context in which the native function is running.
...
description calling js_setcallreturnvalue2 indicates to the runtime that the native will return a value of type reference.
JS_SetCheckObjectAccessCallback
syntax jscheckaccessop js_setcheckobjectaccesscallback( jsruntime *rt, jscheckaccessop acb); name type
description rt jsruntime * the runtime to configure.
...
description js_setcheckobjectaccesscallback sets the runtime-wide check-object-access callback, which is used as the fallback jsclass.checkaccess method for all classes that leave the checkaccess field null.
JS_SetDefaultLocale
syntax bool js_setdefaultlocale(jsruntime *rt, const char *locale); void js_resetdefaultlocale(jsruntime *rt); name type
description rt jsruntime * pointer to a js runtime locale const char * string represents locale.
...
description js_setdefaultlocale sets the default locale for the ecmascript internationalization api (intl.collator, intl.numberformat, intl.datetimeformat).
JS_SetElement
ex, int32_t v); bool js_setelement(jscontext *cx, js::handleobject obj, uint32_t index, uint32_t v); bool js_setelement(jscontext *cx, js::handleobject obj, uint32_t index, double v); /* obsolete since jsapi 29 */ bool js_setelement(jscontext *cx, js::handleobject obj, uint32_t index, js::mutablehandlevalue vp); name type
description cx jscontext * the context in which to set the element.
...obsolete since jsapi 29
description js_setelement assigns a value to a numeric property of an object.
JS_SetGCParametersBasedOnAvailableMemory
syntax void js_setgcparametersbasedonavailablememory(jsruntime *rt, uint32_t availmem); name type
description rt jsruntime * the runtime to configure.
...
description js_setgcparametersbasedonavailablememory adjusts the parameters of the garbage collection based on available memory.
JS_SetGlobalObject
syntax void js_setglobalobject(jscontext *cx, jsobject *obj); name type
description cx jscontext * the context to configure.
...
description this function is obsolete; see also js_getglobalobject.
JS_SetICUMemoryFunctions
syntax bool js_seticumemoryfunctions(js_icuallocfn allocfn, js_icureallocfn reallocfn, js_icufreefn freefn); type
description allocfn js_icuallocfn an allocation function.
...
description js_seticumemoryfunctions sets the allocator functions used by the icu internationalization library.
JS_SetNativeStackQuota
syntax void js_setnativestackquota(jsruntime *cx, size_t systemcodestacksize, size_t trustedscriptstacksize = 0, size_t untrustedscriptstacksize = 0); name type
description rt jsruntime * the runtime.
...added in spidermonkey 31
description js_setnativestackquota sets the size of the native stack that should not be exceeded.
JS_SetObjectPrincipalsFinder
syntax jsobjectprincipalsfinder js_setobjectprincipalsfinder(jsruntime *rt, jsobjectprincipalsfinder fop); name type
description rt jsruntime * the runtime to configure.
...
description js_setobjectprincipalsfinder allows the application to set a callback that the javascript engine uses to obtain an object's principals.
JS_SetPendingException
syntax void js_setpendingexception(jscontext *cx, js::handlevalue v); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_setpendingexception sets the current exception being thrown within a context.
JS_SetPrincipalsTranscoder
syntax jsprincipalstranscoder js_setprincipalstranscoder(jsruntime *rt, jsprincipalstranscoder px); name type
description rt jsruntime * the runtime to configure.
...
description js_setprincipalstranscoder sets a runtime-wide callback which the javascript engine uses to serialize and deserialize principals.
JS_SetPrivate
syntax void js_setprivate(jsobject *obj, void *data); name type
description obj jsobject * object for which to set private data.
...
description if a jsclass has the jsclass_has_private flag, each object of that class has a private field of type void * which the application may use for any purpose.
JS_SetProperty
:handleobject obj, const char *name, js::handlevalue v); bool js_setucproperty(jscontext *cx, js::handleobject obj, const char16_t *name, size_t namelen, js::handlevalue v); bool js_setpropertybyid(jscontext *cx, js::handleobject obj, js::handleid id, js::handlevalue v); // added in spidermonkey 1.8.1 name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_setproperty assigns the value v to the property name of the object obj.
JS_SetPropertyAttributes
syntax jsbool js_setpropertyattributes(jscontext *cx, jsobject *obj, const char *name, unsigned int attrs, jsbool *foundp); jsbool js_setucpropertyattributes(jscontext *cx, jsobject *obj, const jschar *name, size_t namelen, unsigned int attrs, jsbool *foundp); name type
description cx jscontext * the context in which to set the property attributes.
...
description js_setpropertyattributes sets the attributes for a specified property, name of an object obj.
JS_SetPrototype
syntax bool js_setprototype(jscontext *cx, js::handleobject obj, js::handleobject proto); name type
description cx jscontext * the context in which to set the object's prototype.
...
description js_setprototype sets the prototype object for a specified object.
JS_SetRegExpInput
syntax bool js_setregexpinput(jscontext *cx, js::handleobject obj, js::handlestring input, bool multiline); name type
description cx jscontext * the context.
...
description js_setregexpinput sets the pending input string of the built-in regexp object to the specified input string.
JS_SetScriptStackQuota
syntax void js_setscriptstackquota(jscontext *cx, size_t quota); name type
description cx jscontext * the context to configure.
...
description set the quota on the number of bytes that stack-like data structures can use when the runtime compiles and executes scripts.
JS_SetThreadStackLimit
syntax void js_setthreadstacklimit(jscontext *cx, jsuword limitaddr) name type
description cx jscontext * the context to configure.
...
description js_setthreadstacklimit sets the maximum (if stack grows upward) or minimum (downward) legal stack byte address in limitaddr for the thread or process stack used by cx.
JS_SetVersion
syntax jsversion js_setversion(jscontext *cx, jsversion version); name type
description cx jscontext * pointer to a js context from which to derive runtime information.
...
description js_setversion attempts to set the version of javascript to version for a specified executable script context, cx.
JS_SetVersionForCompartment
syntax void js_setversionforcompartment(jscompartment *compartment, jsversion version); name type
description compartment jscompartment * pointer to a js compartment.
...
description js_setversionforcompartment attempts to set the version of javascript to version for a specified compartment, compartment.
JS_StrictlyEqual
syntax // added in spidermonkey 45 bool js_strictlyequal(jscontext *cx, js::handle<js::value> v1, js::handle<js::value> v2, bool *equal); // obsolete since jsapi 39 bool js_strictlyequal(jscontext *cx, jsval v1, jsval v2, bool *equal); name type
description cx jscontext * the context in which to perform the conversion.
...
description js_strictlyequal determines if v1 is strictly equal to v2 under the javascript === operator, as specified in ecma 262-3 §11.9.6.
JS_StringEqualsAscii
syntax bool js_stringequalsascii(jscontext *cx, jsstring *str, const char *asciibytes, bool *match); bool js_flatstringequalsascii(jsflatstring *str, const char *asciibytes); name type
description cx jscontext * a context.
...
description js_stringequalsascii and js_flatstringequalsascii compare string str and ascii string asciibytes.
JS_StringHasBeenInterned
syntax bool js_stringhasbeeninterned(jscontext *cx, jsstring *str); name type
description str jsstring * a string to examine.
...
description js_stringhasbeeninterned returns true if the string str is interned.
JS_StringHasLatin1Chars
syntax bool js_stringhaslatin1chars(jsstring *str); name type
description str jsstring * string to examine.
...
description js_stringhaslatin1chars returns true iff the string's characters are stored as latin1.
JS_StringIsFlat
syntax bool js_stringisflat(jsstring *str); name type
description str jsstring * string to examine.
...
description js_stringisflat returns true if the string is flattened.
JS_StringToVersion
syntax jsversion js_stringtoversion(const char *string); name type
description string const char * version string to convert.
...
description js_stringtoversion attempts to convert the version string to a jsversion value.
JS_SuspendRequest
syntax jsrefcount js_suspendrequest(jscontext *cx); void js_resumerequest(jscontext *cx, jsrefcount savedepth); name type
description cx jscontext * the context whose current request is to be suspended or resumed.
...
description in js_threadsafe builds, when a multi-threaded application is in a request but needs to block or perform lengthy computation that can race safely with the garbage collector, it should call js_suspendrequest before the time-consuming operation and js_resumerequest after.
JS_THREADSAFE
in this reference, these jsapi functions are marked with the words "requires request", like this: name type
description cx jscontext * the context to use.
...these callbacks are (unreliably!) documented with the words "provides request", like this: name type
description cx jscontext * the context in which the event ocurred.
JS_ThrowStopIteration
syntax bool js_throwstopiteration(jscontext *cx); name type
description cx jscontext * the context in which to throw the stopiteration object.
...
description js_throwstopiteration throws the appropriate stopiteration object for the function currently executing in cx.
JS_ToggleOptions
syntax uint32 js_toggleoptions(jscontext *cx, uint32 options); name type
description cx jscontext * a context on which to modify options.
...
description js_toggleoptions toggles context-wide options.
JS_TypeOfValue
syntax jstype js_typeofvalue(jscontext *cx, js::handle<js::value> v); name type
description cx jscontext * the context in which to perform the type check.
...
description js_typeofvalue examines a specified js value, v, and returns its js data type.
JS_Unlock
syntax void js_unlock(jsruntime *rt); name type
description rt jsruntime * pointer to the runtime to unlock.
...
description js_unlock is a deprecated api; don't use it.
JS_ValueToBoolean
syntax jsbool js_valuetoboolean(jscontext *cx, jsval v, jsbool *bp); name type
description cx jscontext * the context in which to perform the conversion.
...
description js_valuetoboolean converts a specified javascript value, v, to a boolean value.
JS_ValueToECMAInt32
syntax jsbool js_valuetoecmaint32(jscontext *cx, jsval v, int32 *ip); jsbool js_valuetoecmauint32(jscontext *cx, jsval v, uint32 *ip); jsbool js_valuetouint16(jscontext *cx, jsval v, uint16 *ip); name type
description cx jscontext * the context in which to perform the conversion.
...
description js_valuetoecmaint32, js_valuetoecmauint32, and js_valuetouint16 convert a javascript value to various integer types as specified in the ecmascript specification.
JS_ValueToFunction
syntax jsfunction * js_valuetofunction(jscontext *cx, js::handlevalue v); jsfunction * js_valuetoconstructor(jscontext *cx, js::handlevalue v); name type
description cx jscontext * the context in which to perform the conversion.
...
description js_valuetofunction converts a specified javascript value, v, to a function.
JS_ValueToId
utablehandleid idp); // added in spidermonkey 38 bool js_indextoid(jscontext *cx, uint32_t index, js::mutablehandleid idp); // added in spidermonkey 17 bool js_charstoid(jscontext* cx, js::twobytechars chars, js::mutablehandleid idp); // added in spidermonkey 24 void js::protokeytoid(jscontext *cx, jsprotokey key, js::mutablehandleid idp); // added in spidermonkey 38 name type
description cx jscontext * a context.
...
description js_valuetoid converts a specified js::value, v, to a jsid.
JS_ValueToInt32
syntax jsbool js_valuetoint32(jscontext *cx, jsval v, int32 *ip); name type
description cx jscontext * the context in which to perform the conversion.
...
description js_valuetoint32 converts a specified js value, v, to a 32-bit signed integer (-2147483648 to 2147483647).
JS_ValueToNumber
syntax jsbool js_valuetonumber(jscontext *cx, jsval v, jsdouble *dp); name type
description cx jscontext * the context in which to perform the conversion.
...
description js_valuetonumber converts a javascript value to a number.
JS_ValueToObject
syntax bool js_valuetoobject(jscontext *cx, js::handlevalue v, js::mutablehandleobject objp); name type
description cx jscontext * the context in which to convert the value.
...
description js_valuetoobject converts a specified javascript value, v, to an object.
JS_ValueToSource
syntax jsstring * js_valuetosource(jscontext *cx, js::handle<js::value> v); name type
description cx jscontext * the context in which to perform the conversion.
...
description js_valuetosource converts a specified javascript value, v, to a javascript source.
JS_ValueToString
syntax jsstring * js_valuetostring(jscontext *cx, jsval v); name type
description cx jscontext * the context in which to perform the conversion.
...
description js_valuetostring converts a specified javascript value, v, to a string.
JS_VersionToString
syntax const char * js_versiontostring(jsversion version); name type
description version jsversion version value to convert.
...
description js_versiontostring attempts to convert the version to a const char * string representation.
JS_YieldRequest
syntax void js_yieldrequest(jscontext *cx); name type
description cx jscontext * the jscontext that is currently in a request on the calling thread.
...
description for more information about thread safety and requests, see js_threadsafe.
JS_freeop
syntax void js_freeop(jsfreeop *fop, void *p); name type
description fop jsfreeop * a pointer to jsfreeop structure to be used to get the implementation of free.
...
description js_freeop is a wrapper for js_free(p) that may delay js_free(p) invocation as a performance optimization as specified by the given jsfreeop instance.
JS_malloc
syntax void * js_malloc(jscontext *cx, size_t nbytes); void * js_realloc(jscontext *cx, void *p, size_t oldbytes, size_t newbytes); char * js_strdup(jscontext *cx, const char *s); void js_free(jscontext *cx, void *p); name type
description cx jscontext * pointer to a js context.
...
description js_malloc allocates a region of memory nbytes in size.
JS_updateMallocCounter
syntax void js_updatemalloccounter(jscontext *cx, size_t nbytes); name type
description cx jscontext * pointer to a js context to decrement the malloc counter.
...
description js_updatemalloccounter decrements malloc counter of gc and the zone of the context.
OBJECT_TO_JSVAL
syntax jsval object_to_jsval(jsobject *obj); name type
description obj jsobject * a pointer to a javascript object to convert to a jsval.
...
description object_to_jsval casts obj from type jsobject * to jsval.
STRING_TO_JSVAL
syntax jsval string_to_jsval(jsstring *str) name type
description obj jsstring * a pointer to a js string to convert to a jsval.
...
description string_to_jsval casts a given jsstring * to jsval.
XForms Accessibility
description it is formed from value of child xforms hint element if the element doesn't have describedby attribute.
...the value of hint element is used as
description of accessible object.
extIApplication
method overview boolean quit() boolean restart() void getextensions(extiextensionscallback acallback) attributes the following interfaces are available to all applications: attribute type
description id readonly attribute astring the id of the application.
...supports: "load", "ready", "quit", "unload" the following interfaces are only available to firefox: attribute type
description bookmarks readonly attribute fuelibookmarkroots the root bookmarks object for the application.
Preface
a full
description of the component in this tutorial can be found in the what we'll be working on section of the tutorial.
... format
description bold component names appear in bold in the text monospace code listings, interface names and members of interfaces (e.g., createinstance()) appear in monospaced font.
Components.interfaces
it reflects only those interfaces which have been designated in their .idl
description as scriptable, that is the interfaces which xpconnect is capable of reflecting into javascript.
... accessing constants defined in an interface interface
descriptions (cf.
Components.utils
please keep this list in sync with the components object page methods method
description cloneinto() create a structured clone of an object in a different javascript context.
... properties property type
description sandbox nsixpccomponents_utils_sandbox creates sandbox objects for use with evalinsandbox().
IAccessibleText
[propget] hresult ncharacters( [out] long ncharacters ); parameters ncharacters missing
description return value s_ok.
...[propget] hresult nselections( [out] long nselections ); parameters nselections missing
description return value s_ok.
imgIRequest
gecko 8.0 (firefox 8.0 / thunderbird 8.0 / seamonkey 2.5) method overview void cancelandforgetobserver(in nsresult astatus); imgirequest clone(in imgidecoderobserver aobserver); void decrementanimationconsumers(); imgirequest getstaticrequest(); void incrementanimationconsumers(); void lockimage(); void requestdecode(); void unlockimage(); attributes attribute type
description corsmode long the cors mode that this image was loaded with.
... constants constant value
description status_none 0x0 nothing to report.
mozIStorageError
last changed in gecko 1.9.1 (firefox 3.5 / thunderbird 3.0 / seamonkey 2.0) inherits from: nsisupports attributes attribute type
description message autf8string a human readable error string with details; this may be null if no details are available.
... constants constant value
description error 1 general sql error, or missing database ioerr 10 a disk i/o error occurred.
mozIStorageStatement
r(in unsigned long aparamindex); void bindblobparameter(in unsigned long aparamindex, [array,const,size_is(avaluesize)] in octet avalue, in unsigned long avaluesize); mozistoragependingstatement executeasync(mozistoragestatementcallback acallback); boolean executestep(); boolean step(); void execute(); attributes attribute type
description columncount unsigned long number of columns returned.
... statement status constants constant value
description moz_storage_statement_invalid 0 the sql statement is invalid.
mozIStorageValueArray
g aindex); double getdouble(in unsigned long aindex); autf8string getutf8string(in unsigned long aindex); astring getstring(in unsigned long aindex); void getblob(in unsigned long aindex, out unsigned long adatasize, [array,size_is(adatasize)] out octet adata); boolean getisnull(in unsigned long aindex); attributes attribute type
description numentries unsigned long the number of entries in the array.
... constants constant value
description value_type_null 0 null data type.
nsIAccessibleHyperText
inherits from: nsisupports last changed in gecko 1.9 (firefox 3) method overview nsiaccessiblehyperlink getlink(in long linkindex); long getlinkindex(in long charindex); long getselectedlinkindex(); obsolete since gecko 1.9 attributes attribute type
description linkcount long the number of links contained within this hypertext object.
... return value missing
description exceptions thrown ns_error_failure indicates that the accessible is unattached from the accessible tree.
nsIAccessibleRole
1.0 66 introduced gecko 1.9 inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) constants constant value
description role_nothing 0 used when accessible has no strong defined role.
...is is used for xul:label, xul:
description, html:label, role="label", or xforms:output.
nsIAccessibleSelectable
inherits from: nsisupports last changed in gecko 1.7 method overview void addchildtoselection(in long index); void clearselection(); nsiarray getselectedchildren(); boolean ischildselected(in long index); nsiaccessible refselection(in long index); void removechildfromselection(in long index); boolean selectallselection(); attributes attribute type
description selectioncount long the number of accessible children currently selected.
... constants constant value
description eselection_add 0 eselection_remove 1 eselection_getstate 2 methods addchildtoselection() adds the specified accessible child of the object to the object's selection.
nsIAppShellService
attributes attribute type
description applicationprovidedhiddenwindow boolean return true if the application hidden window was provided by the application.
...obsolete since gecko 1.8 constants constant value
description size_to_content -1 create a window, which will be initially invisible.
nsIApplicationCacheNamespace
method overview void init(in unsigned long itemtype, in acstring namespacespec, in acstring data); attributes attribute type
description data acstring data associated with the namespace, such as a fallback.
... constants constant value
description namespace_bypass 1 items matching this namespace can be fetched from the network when loading from this cache.
nsIAuthInformation
attributes attribute type
description authenticationscheme autf8string the authentication scheme used for this request, if applicable.
... constants constant value
description auth_host 1 this dialog belongs to a network host.
nsICacheEntryDescriptor
string key); void markvalid(); nsiinputstream openinputstream(in unsigned long offset); nsioutputstream openoutputstream(in unsigned long offset); void setdatasize(in unsigned long size); void setexpirationtime(in pruint32 expirationtime); void setmetadataelement(in string key, in string value); void visitmetadata(in nsicachemetadatavisitor visitor); attributes attribute type
description accessgranted nscacheaccessmode get the access granted to this descriptor.
... see nsicache for the definitions of the access modes and a thorough
description of their corresponding meanings.
nsICacheService
ean streambased); acstring createtemporaryclientid(in nscachestoragepolicy storagepolicy); obsolete since gecko 1.9.2 void evictentries(in nscachestoragepolicy storagepolicy); void init(); obsolete since gecko 1.8 void shutdown(); obsolete since gecko 1.8 void visitentries(in nsicachevisitor visitor); attributes attribute type
description cacheiotarget nsieventtarget the event target for cache i/o operation notifications.
... exceptions thrown missing exception missing
description shutdown() obsolete since gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) shutdown() the cache service.
nsICachingChannel
method overview boolean isfromcache(); obsolete since gecko 2.0 attributes attribute type
description cacheasfile boolean specifies whether or not the data should be cached to a file.
... constants constant value
description load_no_network_io 1 << 26 this load flag inhibits fetching from the net.
nsIChannel
method overview void asyncopen(in nsistreamlistener alistener, in nsisupports acontext); nsiinputstream open(); attributes attribute type
description contentcharset acstring the character set of the channel's content if available and if applicable.
... constant value
description load_document_uri 16 set (for example by the docshell) to indicate whether or not the channel corresponds to a document uri.
nsIClassInfo
inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview nsisupports gethelperforlanguage(in pruint32 language); void getinterfaces(out pruint32 count, [array, size_is(count), retval] out nsiidptr array); attributes attribute type
description class
description string a human readable string naming the class, or null.
... constant value
description singleton 1 << 0 the class is a singleton that must be accessed via nsiservicemanager.
nsICommandLine
astring aflag, in boolean acasesensitive); astring getargument(in long aindex); boolean handleflag(in astring aflag, in boolean acasesensitive); astring handleflagwithparam(in astring aflag, in boolean acasesensitive); void removearguments(in long astart, in long aend); nsifile resolvefile(in astring aargument); nsiuri resolveuri(in astring aargument); attributes attribute type
description length long number of arguments in the command line.
... constants state constants constant value
description state_initial_launch 0 the first launch of the application instance.
nsICommandLineHandler
command-line-handler m-edit @mozilla.org/composer/clh;1 command-line-handler m-irc @mozilla.org/chatzilla/clh;1 command-line-handler y-final @mozilla.org/browser/clh-final;1 method overview void handle(in nsicommandline acommandline); attributes attribute type
description helpinfo autf8string when the application is launched with the -help argument, this attribute is retrieved and displayed to the user (on stdout).
...by convention, the right column which contains flag
descriptions begins at the 24th character.
nsICookie
last changed in gecko 1.7 inherits from: nsisupports attributes attribute type
description expires pruint64 expiration time in seconds since midnight (00:00:00), january 1, 1970 utc.
... constants constant value
description status_unknown 0 the cookie collected in a previous session, and its information no longer exists.
nsICookieManager
it is implemented by the @mozilla.org/cookiemanager;1 component, but should generally be accessed via services.cookies method overview void remove(in autf8string ahost, in acstring aname, in autf8string apath, in boolean ablocked, in jsval aoriginattributes); void removeall(); attributes attribute type
description enumerator nsisimpleenumerator called to enumerate through each cookie in the cookie list.
...see nsicookiemanager2.add() for a
description of acceptable host strings.
nsIDNSService
method overview nsicancelable asyncresolve(in autf8string ahostname, in unsigned long aflags, in nsidnslistener alistener, in nsieventtarget alistenertarget); void init(); obsolete since gecko 1.8 nsidnsrecord resolve(in autf8string ahostname, in unsigned long aflags); void shutdown(); obsolete since gecko 1.8 attributes attribute type
description myhostname autf8string read only.
... constant value
description resolve_bypass_cache (1 << 0) this flag suppresses the internal dns lookup cache.
nsIDOMChromeWindow
ko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview void beginwindowmove(in nsidomevent mousedownevent); void getattention(); void getattentionwithcyclecount(in long acyclecount); void maximize(); void minimize(); void notifydefaultbuttonloaded(in nsidomelement defaultbutton); void restore(); void setcursor(in domstring cursor); attributes attribute type
description browserdomwindow nsibrowserdomwindow the related nsibrowserdomwindow instance which provides access to yet another layer of utility functions by chrome script.
... constants constant value
description state_maximized 1 the window is maximized.
nsIDOMEvent
void stopimmediatepropagation(); void stoppropagation(); attributes attribute type
description bubbles boolean used to indicate whether or not an event is a bubbling event.
... constants constant value
description none 0 the event is not being dispatched.
nsIDOMFileException
last changed in gecko 1.9 (firefox 3) attributes attribute type
description code unsigned short the error code describing the error condition that took place; see the constants list for details.
... constants constant value
description not_found_err 0 the specified file wasn't found.
nsIDOMGeoPositionError
last changed in gecko 1.9.2 (firefox 3.6 / thunderbird 3.1 / fennec 1.0) inherits from: nsisupports attributes attribute type
description code short numerical error code; see error constants for a complete list.
... error constants constant value
description permission_denied 1 the user denied permission to retrieve location data.
nsIDOMMouseScrollEvent
learg, in boolean cancelablearg, in nsidomabstractview viewarg, in long detailarg, in long screenxarg, in long screenyarg, in long clientxarg, in long clientyarg, in boolean ctrlkeyarg, in boolean altkeyarg, in boolean shiftkeyarg, in boolean metakeyarg, in unsigned short buttonarg, in nsidomeventtarget relatedtargetarg, in long axis); attributes attribute type
description axis long indicates which mouse wheel axis changed; this will be either horizontal_axis or vertical_axis.
... constants constant value
description horizontal_axis 1 the horizontal (x) axis.
nsIDOMMozNetworkStatsManager
nsidomdomrequest getallalarms([optional] in nsisupports network); nsidomdomrequest removealarms([optional] in long alarmid); nsidomdomrequest clearstats(in nsisupports network); nsidomdomrequest clearallstats(); nsidomdomrequest getavailablenetworks(); nsidomdomrequest getavailableservicetypes(); attributes attribute type
description samplerate long minimum time in milliseconds between samples stored in the database.
... constants constant type
description wifi long constant for wifi, set to 0 mobile long constant for mobile, set to 1 methods getsamples() asynchronously queries network interface statistics.
nsIDOMNode
e clonenode(in boolean deep); boolean hasattributes(); boolean haschildnodes(); nsidomnode insertbefore(in nsidomnode newchild, in nsidomnode refchild) boolean issupported(in domstring feature, in domstring version); void normalize(); nsidomnode removechild(in nsidomnode oldchild) nsidomnode replacechild(in nsidomnode newchild, in nsidomnode oldchild) attributes attribute type
description attributes nsidomnamednodemap read only.
... constants constant value
description element_node 1 attribute_node 2 text_node 3 cdata_section_node 4 entity_reference_node 5 entity_node 6 processing_instruction_node 7 comment_node 8 document_node 9 document_type_node 10 document_fragment_node 11 notation_node 12 methods appendchild() nsidomnode appendchild( in nsidomnode newchild ); parameters newchild return value cloneno...
nsIDOMOfflineResourceList
hanged in gecko 1.9.2 (firefox 3.6 / thunderbird 3.1 / fennec 1.0) inherits from: nsisupports method overview void mozadd(in domstring uri); boolean mozhasitem(in domstring uri); domstring mozitem(in unsigned long index); void mozremove(in domstring uri); void swapcache(); void update(); attributes attribute type
description mozitems nsidomofflineresourcelist the list of dynamically-managed entries in the offline resource list.
... constants application cache state constants constant value
description uncached 0 the object isn't associated with an application cache.
nsIDOMWindowUtils
t aypx, in float awidthpx, in float aheightpx); void setresolution(in float axresolution, in float ayresolution); void startpccountprofiling(); void stoppccountprofiling(); void suppresseventhandling(in boolean asuppress); void suspendtimeouts(); nsidomfile wrapdomfile(nsifile afile); attributes attribute type
description currentinnerwindowid unsigned long long the id of the window's current inner window.
... constants constant value
description modifier_alt 0x0001 getmodifierstate("alt") of the send event will return true if this is specified for amodifiers of send*event() except sendnative*event().
nsIDOMXPathException
inherits from: nsisupports last changed in gecko 1.7 attributes attribute type
description code unsigned short the error code; see error codes for details.
... constants error codes constant value
description invalid_expression_err 51 an invalid xpath expression was used.
nsIDOMXPathResult
dom/interfaces/xpath/nsidomxpathresult.idlscriptable this interface describes an xpath result returned by nsidomxpathevaluator or document.evaluate inherits from: nsisupports last changed in gecko 1.7 method overview nsidomnode iteratenext(); nsidomnode snapshotitem(in unsigned long index); attributes attribute type
description booleanvalue boolean if resulttype is boolean_type, the boolean value.
... constants type constants constant value
description any_type 0 used when evaluating an xpath expression; the evaluator will return the most appropriate type.
nsIDeviceMotionData
attributes attribute type
description type unsigned long the type of motion data reported by this object; see motion type constants for possible values.
...constants motion type constants constant value
description type_acceleration 0 the motion data describes device acceleration.
nsIDownload
attributes attribute type
description amounttransferred long long the number of bytes downloaded so far.
... displayname astring a user-readable
description of the transfer.
nsIDownloadManagerUI
1.0 66 introduced gecko 1.9 inherits from: nsisupports last changed in gecko 1.9 (firefox 3) method overview void getattention(); void show([optional] in nsiinterfacerequestor awindowcontext, [optional] in unsigned long aid, [optional] in short areason); attributes attribute type
description visible boolean true if the download manager ui is visible; otherwise false.
... constants constant value
description reason_user_interacted 0 when opening the download manager user interface, this value indicates that it's being done at the user's request.
nsIFeedEntry
1.0 66 introduced gecko 1.8 inherits from: nsifeedcontainer last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) attributes attribute type
description content nsifeedtextconstruct the full text of the entry's content.
...this is generated automatically using the entry's
description, subtitle, summary, content, and appropriate extensions.
nsIFile
rmalize(); file openansifiledesc(in string mode); prfiledescstar opennsprfiledesc(in long flags, in long mode); void renameto(in nsifile newparentdir, in astring newname); void remove(in boolean recursive); void reveal(); void setrelativedescriptor(in nsifile fromfile, in acstring relativedesc); attributes attribute type
description directoryentries nsisimpleenumerator returns an enumeration of the elements in a directory.
... constants constant value
description normal_file_type 0 a normal file.
nsIFileView
to create an instance, use: var fileview = components.classes["@mozilla.org/filepicker/fileview;1"] .createinstance(components.interfaces.nsifileview); method overview void setdirectory(in nsifile directory); void setfilter(in astring filterstring); void sort(in short sorttype, in boolean reversesort); attributes attribute type
description reversesort boolean if true results will be sorted in ascending order.
... constants constant value
description sortname 0 sort by file name.
nsIFocusManager
attributes attribute type
description activewindow nsidomwindow the most active (frontmost) window, or null if no window that is part of the application is active.
... constants constant value
description flag_raise 1 flag_noscroll 2 do not scroll the element to focus into view.
nsIFrameScriptLoader
parameters name type
description aurl string url for the script to load.
... parameters name type
description aurl string url for the script to remove.
nsIHTMLEditor
lement); void setcssinlineproperty(in nsiatom aproperty, in astring aattribute, in astring avalue); void setdocumenttitle(in astring atitle); void setinlineproperty(in nsiatom aproperty, in astring aattribute, in astring avalue); void setparagraphformat(in astring aparagraphformat); void updatebaseurl(); attributes attribute type
description iscssenabled boolean a boolean which is true is the htmleditor has been instantiated with css knowledge and if the css pref is currently checked.
... constants constant value
description eleft 0 ecenter 1 eright 2 ejustify 3 methods adddefaultproperty() registers a default style property with the editor.
nsIHttpChannel
ing aheader, in acstring avalue, in boolean amerge); void setresponseheader(in acstring header, in acstring value, in boolean merge); void visitoriginalresponseheaders(in nsihttpheadervisitor avisitor); void visitrequestheaders(in nsihttpheadervisitor avisitor); void visitresponseheaders(in nsihttpheadervisitor avisitor); constants constant
description referrer_policy_no_referrer_when_downgrade default; indicates not to pass on the referrer when downgrading from https to http referrer_policy_no_referrer indicates no referrer will be sent referrer_policy_origin only send the origin of the referring uri referrer_policy_origin_when_xorigin same as the default; only send the origin of the referring ur...
...i for cross-origin requests referrer_policy_unsafe_url always send the referrer, even when downgrading from https to http attributes attribute type
description allowpipelining boolean this attribute is a hint to the channel to indicate whether or not the underlying http transaction should be allowed to be pipelined with other transactions.
nsIInstallLocation
lllocation("add-on id") method overview astring getidforlocation(in nsifile file); nsifile getitemfile(in astring id, in astring path); nsifile getitemlocation(in astring id); nsifile getstagefile(in astring id); boolean itemismanagedindependently(in astring id); void removefile(in nsifile file); nsifile stagefile(in nsifile file, in astring id); attributes attribute type
description canaccess boolean whether or not the user can write to the install location with the current access privileges.
... constant value
description priority_app_profile 0 priority_app_system_user 10 priority_xre_system_user 100 priority_app_system_global 1000 priority_xre_system_global 10000 methods getidforlocation() retrieves the guid for an item at the specified location.
nsIJumpListBuilder
method overview void abortlistbuild(); boolean addlisttobuild(in short acattype, in nsiarray items optional, in astring catname optional); boolean commitlistbuild(); boolean deleteactivelist(); boolean initlistbuild(in nsimutablearray removeditems); attributes attribute type
description available short indicates whether jump list taskbar features are supported by the current host.
... constants constant value
description jumplist_category_tasks 0 tasks are common actions performed by users within the application.
nsIJumpListItem
method overview boolean equals(in nsijumplistitem item); attributes attribute type
description type short retrieves the jump list item type.
... constants constant value
description jumplist_item_empty 0 empty list item.
nsILocalFile
void reveal(); void setrelativedescriptor(in nsilocalfile fromfile, in acstring relativedesc); attributes attribute type
description diskspaceavailable print64 the number of bytes available to non-superuser on the disk volume containing the nsilocalfile.
... constants constant value
description delete_on_close 0x80000000 optional parameter used by opennsprfiledesc().
nsILocalFileMac
ean ispackage(); void launchwithdoc(in nsilocalfile adoctoload, in boolean alaunchinbackground); void opendocwithapp(in nsilocalfile aapptoopenwith, in boolean alaunchinbackground); void setfiletypeandcreatorfromextension(in string aextension); obsolete since gecko 1.9.2 void setfiletypeandcreatorfrommimetype(in string amimetype); obsolete since gecko 1.9.2 attributes attribute type
description bundledisplayname astring returns the display name of the application bundle (usually the human readable name of the application) read only.
... constants constant value
description current_process_creator 0x8000000 use with setfiletype() to specify the signature of current process.
nsIMessageBroadcaster
parameters name type
description messagename string the name of the message.
...parameters name type
description aindex number the index of the subordinate message manager to retrieve.
nsIMessenger
attributes attribute type
description transactionmanager nsitransactionmanager readonly: the transaction manager for this nsimessenger instance.
... constants name value
description eunknown 0 unknown transaction type.
nsIMsgFolder
void addkeywordstomessages(in nsisupportsarray amessages, in acstring akeywords); void removekeywordsfrommessages(in nsisupportsarray amessages, in acstring akeywords); autf8string getmsgtextfromstream(in nsimsgdbhdr amsghdr, in nsiinputstream astream, in long abytestoread, in long amaxoutputlen, in boolean acompressquotes); attributes attribute type
description supportsoffline boolean readonly offlinestoreoutputstream nsioutputstream readonly offlinestoreinputstream nsiinputstream readonly retentionsettings nsimsgretentionsettings downloadsettings nsimsgdownloadsettings sortorder long used for order in the folder pane, folder pickers, etc.
... constants constant value
description nsmsgbiffstate_newmail 0 user has new mail waiting.
nsIMsgSearchSession
void resumesearch(); [noscript] nsmsgsearchtype setsearchparam(in nsmsgsearchtype type, in voidptr param); [noscript] void addresultelement(in nsmsgresultelement element); boolean matchhdr(in nsimsgdbhdr amsghdr, in nsimsgdatabase adatabase); void addsearchhit(in nsimsgdbhdr header, in nsimsgfolder folder); attributes attribute type
description searchterms nsisupportsarray readonly: numsearchterms unsigned long readonly: runningadapter nsimsgsearchadapter readonly: searchparam voidptr not scriptable and readonly: searchtype nsmsgsearchtype readonly: numresults long readonly: window nsimsgwindow constants name...
... value
description booleanor 0 booleanand 1 methods addsearchterm() void addsearchterm(in nsmsgsearchattribvalue attrib, in nsmsgsearchopvalue op, in nsimsgsearchvalue value, in boolean booleanand, in string arbitraryheader); parameters attrib attribute for this term.
nsINavBookmarksService
ied(in long long aitemid, in prtime alastmodified); void setitemtitle(in long long aitemid, in autf8string atitle); void setkeywordforbookmark(in long long aitemid, in astring akeyword); obsolete since gecko 40.0 void setkeywordforuri(in nsiuri uri, in astring keyword); obsolete since gecko 1.9 obsolete since gecko 40.0 attributes attribute type
description bookmarksmenufolder long long the item id of the bookmarks menu folder.
... constants constant value
description default_index -1 this is the default index; this value should be used for apis that allow passing in an index where the index is not known or is not required to be specified, such as when appending an item to a folder.
nsINavHistoryResultNode
1.0 66 introduced gecko 1.9 inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) attributes attribute type
description accesscount unsigned long total number of times the uri has been accessed.
...obsolete since gecko 1.9.2 constants constant value
description result_type_uri 0 nsinavhistoryresultnode.
nsINavHistoryResultTreeViewer
method overview nsinavhistoryresultnode nodefortreeindex(in unsigned long aindex); unsigned long treeindexfornode(in nsinavhistoryresultnode anode); attributes attribute type
description collapseduplicates boolean controls whether duplicate adjacent elements are collapsed into a single item in the tree.
...obsolete since gecko 1.9 constants constant value
description index_invisible 0xffffffff returned by treeindexfornode() when the requested node isn't visible (such as when its parent is collapsed).
nsINavHistoryService
n boolean ownsweak); void removeobserver(in nsinavhistoryobserver observer); void runinbatchmode(in nsinavhistorybatchcallback acallback, in nsisupports aclosure); void importhistory(in nsifile file); astring getcharsetforuri(in nsiuri auri); astring setcharsetforuri(in nsiuri auri, in astring acharset); attributes attribute type
description hashistoryentries boolean true if there is any history.
... constants transition type constants constant value
description transition_link 1 this transition type means the user followed a link and got a new toplevel window.
nsINetworkLinkService
inherits from: nsisupports last changed in gecko 8.0 (firefox 8.0 / thunderbird 8.0 / seamonkey 2.5) implemented by: @mozilla.org/network/network-link-service;1 as a service: var networklinkservice = components.classes["@mozilla.org/network/network-link-service;1"] .getservice(components.interfaces.nsinetworklinkservice); attributes attribute type
description islinkup boolean this is set to true when the system is believed to have a usable network connection.
... constants constant value
description link_type_unknown 0 we were unable to determine the network connection type.
nsIParentalControlsService
e); method overview void log(in short aentrytype, in boolean aflag, in nsiuri asource, [optional] in nsifile atarget); boolean requesturioverride(in nsiuri atarget, [optional] in nsiinterfacerequestor awindowcontext); boolean requesturioverrides(in nsiarray atargets, [optional] in nsiinterfacerequestor awindowcontext); attributes attribute type
description blockfiledownloadsenabled boolean true if the current user account's parental controls restrictions include the blocking of all file downloads.
... constants constant value
description epclog_urivisit 1 this log entry type represents an access to web content.
Component; nsIPrefBranch
void setcharpref(in string aprefname, in string avalue); requires gecko 58 void setstringpref(in string aprefname, in utf8string avalue); void setcomplexvalue(in string aprefname, in nsiidref atype, in nsisupports avalue); void setintpref(in string aprefname, in long avalue); void unlockpref(in string aprefname); attributes attribute type
description root string called to get the root on which this branch is based, such as "browser.startup." read only.
... constants constant value
description pref_invalid 0 long pref_string 32 long data type.
nsIProcessScriptLoader
for example: let ppmm = services.ppmm.getchildat(1); ppmm.loadprocessscript('data:,dump("foo\n");', true); parameters name type
description aurl string url for the script to load.
... parameters name type
description aurl string url for the script to remove.
nsIProfile
n wstring name, in boolean candeletefiles); void getprofilelist(out unsigned long length, [retval, array, size_is(length)] out wstring profilenames); boolean profileexists(in wstring profilename); void renameprofile(in wstring oldname, in wstring newname); void shutdowncurrentprofile(in unsigned long shutdowntype); attributes attribute type
description currentprofile wstring the name of the profile currently in use.
... constants profile shutdown types constant value
description shutdown_persist 0x00000001 when shutting down the profile, save all changes.
nsIProtocolHandler
inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview boolean allowport(in long port, in string scheme); nsichannel newchannel(in nsiuri auri); nsiuri newuri(in autf8string aspec, in string aorigincharset, in nsiuri abaseuri); attributes attribute type
description defaultport long the default port is the port the protocol uses by default.
... constants constant value
description uri_std 0 a standard full uri with authority component and understanding relative uris; this includes http and ftp, for example.
nsIProxyInfo
last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) inherits from: nsisupports attributes attribute type
description failoverproxy nsiproxyinfo this attribute specifies the proxy to failover to when this proxy fails.
... constant value
description transparent_proxy_resolves_host 1 << 0 this flag is set if the proxy is to perform name resolution itself.
nsIScriptError
ne, in pruint32 linenumber, in pruint32 columnnumber, in pruint32 flags, in string category); void initwithwindowid(in wstring message, in wstring sourcename, in wstring sourceline, in pruint32 linenumber, in pruint32 columnnumber, in pruint32 flags, in string category, in unsigned long long innerwindowid); autf8string tostring(); attributes attribute type
description category string a string indicating the category of error that occurred see categories for a list.
... flag constants constant value
description errorflag 0x0 error messages.
nsIScrollable
constant value
description scrollorientation_x 1 horizontal scrolling.
... constant value
description scrollbar_auto 1 scrollbars visible only when needed.
nsISelection
add brief
description of interface ???
...e getrangeat(in long index); void modify(in domstring alter, in domstring direction, in domstring granularity); void removeallranges(); void removerange(in nsidomrange range); void selectallchildren(in nsidomnode parentnode); void selectionlanguagechange(in boolean langrtl); domstring tostring(); attributes attribute type
description anchornode nsidomnode returns the node in which the selection begins.
nsISelectionPrivate
void startbatchchanges(); wstring tostringwithformat(in string formattype, in unsigned long flags, in print32 wrapcolumn); attributes attribute type
description cancacheframeoffset boolean frame offset cache can be used just during calling nseditor::endplaceholdertransaction.
... constants constant value
description endofprecedingline 0 startofnextline 1 tableselection_none 0 tableselection_cell 1 tableselection_row 2 tableselection_column 3 tableselection_table 4 tableselection_allcells 5 methods addselectionlistener() void addselectionlistener( in nsiselectionli...
nsISessionStartup
to use this service, use: var sessionstartup = components.classes["@mozilla.org/browser/sessionstartup;1"] .getservice(components.interfaces.nsisessionstartup); method overview boolean dorestore(); attributes attribute type
description sessiontype unsigned long the type of session being restored; this will be one of the session type constants.
... constants session type constants constant value
description no_session 0 there's no data available from the previous session.
nsIStandardURL
to create an instance, use: var standardurl = components.classes["@mozilla.org/network/standard-url;1"] .createinstance(components.interfaces.nsistandardurl); method overview void init(in unsigned long aurltype, in long adefaultport, in autf8string aspec, in string aorigincharset, in nsiuri abaseuri); attributes attribute type
description mutable boolean control whether or not this url can be modified.
... constant value
description urltype_standard 1 blah:foo/bar => blah://foo/bar blah:/foo/bar => blah:///foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah:///foo/bar urltype_authority 2 blah:foo/bar => blah://foo/bar blah:/foo/bar => blah://foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah://foo/bar urltype_no_authority 3 blah:foo/bar => blah:///foo/bar blah:/foo/bar => blah:///foo/bar blah://foo/bar => blah://foo/bar blah:///foo/bar => blah:///foo/bar methods init() normalizes a given url to an standard url.
nsISupports
remarks the method
descriptions above were taken from essential com by don box.
... the point of those
descriptions is to highlight the fact that addref() and release() do not necessarily correspond to incrementing and decrementing a counter, respectively, even though that is how they are usually implemented.
nsISupportsPrimitive
inherits from: nsisupports last changed in gecko 1.7 attributes attribute type
description type unsigned short this attribute provides access to the type represented by the nsisupportsprimitive instance.
... constants constant value
description type_id 1 corresponding to nsisupportsid.
nsISupportsPriority
method overview void adjustpriority(in long delta); attributes attribute type
description priority long the object's priority.
... constants constant value
description priority_highest -20 the highest priority.
nsISyncMessageSender
parameters name type
description messagename string the name of the message.
...parameters name type
description messagename string the name of the message.
nsITaskbarWindowPreview
method overview nsitaskbarpreviewbutton getbutton(in unsigned long index); attributes attribute type
description enablecustomdrawing boolean if true, the nsitaskbarpreviewcontroller object's nsitaskbarpreviewcontroller.drawpreview() and nsitaskbarpreviewcontroller.drawthumbnail() methods will be called to draw the preview.
... constants constant value
description num_toolbar_buttons 7 the maximum number of toolbar buttons supported by the windows taskbar api.
nsITextInputProcessor
in unsigned long akeyflags); void setcaretinpendingcomposition(in unsigned long aoffset); void setpendingcompositionstring(in domstring astring); void sharemodifierstateof(in nsitextinputprocessor aother); boolean startcomposition([optional] in nsidomkeyevent adomkeyevent, [optional] in unsigned long akeyflags); attributes attribute type
description hascomposition boolean whether the instance has composition or not.
... constants constant value
description attr_raw_clause 0x02 a clause attribute.
nsITimer
attributes attribute type
description callback nsitimercallback the nsitimercallback object passed to initwithcallback().
... constants constant value
description type_one_shot 0 type of a timer that fires once only.
nsITransaction
inherits from: nsisupports last changed in gecko 1.7 method overview void dotransaction(); boolean merge(in nsitransaction atransaction); void redotransaction(); void undotransaction(); attributes attribute type
description istransient boolean the transaction's transient state.
... return value missing
description redotransaction() executes the transaction again.
nsITransactionList
inherits from: nsisupports last changed in gecko 1.7 method overview nsitransactionlist getchildlistforitem(in long aindex); nsitransaction getitem(in long aindex); long getnumchildrenforitem(in long aindex); boolean itemisbatch(in long aindex); attributes attribute type
description numitems long the number of transactions contained in this list.
... return value missing
description getnumchildrenforitem() returns the number of child (auto-aggreated) transactions the item at aindex has.
nsITransport
constant value
description open_blocking 1<<0 open flags.
... constant value
description status_reading 0x804b0008 status_writing 0x804b0009 methods close() close the transport and any open streams.
nsITransportSecurityInfo
inherits from: nsisupports last changed in gecko 1.9 (firefox 3) attributes attribute type
description errormessage wstring error message on connection failure.
... shortsecurity
description wstring for secure connections (ssl) gives the common name (cn) of the certifying authority.
nsITreeColumn
nsitreecolumn getnext(); nsitreecolumn getprevious(); void invalidate(); attributes attribute type
description atom nsiatom the atom attribute of nsitreecolumn which returns an nsiatom for the column, making it fast to do comparisons.
... constants constant value
description type_text 1 text column type.
nsITreeView
void performactiononrow(in wstring action, in long row); void selectionchanged(); void setcelltext(in long row, in nsitreecolumn col, in astring value); void setcellvalue(in long row, in nsitreecolumn col, in astring value); void settree(in nsitreeboxobject tree); void toggleopenstate(in long index); attributes attribute type
description rowcount long the total number of rows in the tree (including the offscreen rows).
... constants constant value
description progress_normal 1 note: renamed from progressnormal in gecko 1.8 progress_undetermined 2 note: renamed from progressundetermined in gecko 1.8 progress_none 3 note: renamed from progressnone in gecko 1.8 drop_before -1 drop_on 0 drop_after 1 indropbefore 0 obsolete since gecko 1.8 indropon 1 obsolete since gecko 1.8 indropafter 2 obsolete since gecko 1.8 methods candrop() methods used by the drag feedback code to determine if a drag is allowable at the current location.
nsIUpdateItem
method overview void init(in astring id, in astring version, in astring installlocationkey, in astring minappversion, in astring maxappversion, in astring name, in astring downloadurl, in astring xpihash, in astring iconurl, in astring updateurl, in astring updatekey, in long type, in astring targetappid); attributes attribute type
description iconurl astring the url of the icon that can be shown for this item.
... constant gecko version
description 1.8 1.8.1 1.9 1.9.1 1.9.2 type_app 0x01 type_extension 0x02 type_theme 0x04 type_locale 0x08 type_multi_xpi 0x20 type_addon type_extension + type_theme + type_locale + type_plugin type_extension + type_theme + type_locale type_any type_app + type_addon 0xff ...
nsIWebBrowserChrome
rits from: nsisupports last changed in gecko 0.9.6 method overview void destroybrowserwindow(); void exitmodaleventloop(in nsresult astatus); boolean iswindowmodal(); void setstatus(in unsigned long statustype, in wstring status); void showasmodal(); void sizebrowserto(in long acx, in long acy); attributes attribute type
description chromeflags unsigned long the chrome flags for this browser chrome.
... constants constant value
description status_script 1 flag for setstatus() status_script_default 2 flag for setstatus() status_link 3 flag for setstatus() chrome_default 1 value for the chromeflags attribute.
nsIWebBrowserPersist
areferrerpolicy, in nsiinputstream apostdata, in string aextraheaders, in nsisupports afile, in nsiloadcontext aprivacycontext); void saveprivacyawareuri(in nsiuri auri, in nsisupports acachekey, in nsiuri areferrer, in long areferrerpolicy, in nsiinputstream apostdata, in string aextraheaders, in nsisupports afile, in boolean aisprivate); attributes attribute type
description currentstate unsigned long current state of the persister object.
... constants constant value
description persist_flags_none 0 no special persistence behavior.
nsIWebPageDescriptor
inherits from: nsisupports last changed in gecko 1.7 method overview void loadpage(in nsisupports apagedescriptor, in unsigned long adisplaytype); attributes attribute type
description currentdescriptor nsisupports retrieves the page descriptor for the current document.
... constants display type constants constant value
description display_as_source 0x0001 generates an optionally syntax-highlighted (for xml/html documents) source of the original page.
nsIWebSocketChannel
instance(components.interfaces.nsiwebsocketchannel); method overview void asyncopen(in nsiuri auri, in acstring aorigin, in nsiwebsocketlistener alistener, in nsisupports acontext); void close(in unsigned short acode, in autf8string areason); void sendbinarymsg(in acstring amsg); void sendmsg(in autf8string amsg); attributes attribute type
description extensions acstring sec-websocket-extensions response header value.
... status code name
description 0-999 reserved and not used.
nsIWindowsShellService
inherits from: nsishellservice last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview string getregistryentry(in long ahkeyconstant, in string asubkeyname, in string avaluename); obsolete since gecko 1.8 void restorefilesettings(in boolean aforallusers); obsolete since gecko 1.9 void shortcutmaintenance(); attributes attribute type
description desktopbackgroundcolor unsigned long the desktop background color, visible when no background image is used, or if the background image is centered and does not fill the entire screen.
... constant value
description hkcr 0 hkey_classes_root.
nsIXPCScriptable
pconnectwrappednative wrapper, in jscontextptr cx, in jsobjectptr obj, in jsval val); jsobjectptr outerobject(in nsixpconnectwrappednative wrapper, in jscontextptr cx, in jsobjectptr obj); jsobjectptr innerobject(in nsixpconnectwrappednative wrapper, in jscontextptr cx, in jsobjectptr obj); void postcreateprototype(in jscontextptr cx, in jsobjectptr proto); attributes attribute type
description classname string scriptableflags pruint32 the bitwise or'd set of flags (define below) that indicate the behavior of this object.
... constants constant value
description want_precreate 1 << 0 want_create 1 << 1 want_postcreate 1 << 2 want_addproperty 1 << 3 want_delproperty 1 << 4 want_getproperty 1 << 5 want_setproperty 1 << 6 want_enumerate 1 << 7 want_newenumerate 1 << 8 indicates that the object wants to have its newenumerate method called.
nsIXULRuntime
to get an instance, use: var xulruntime = components.classes["@mozilla.org/xre/app-info;1"] .getservice(components.interfaces.nsixulruntime); method overview void invalidatecachesonrestart(); attributes attribute type
description accessibilityenabled boolean if true, the accessibility service is running.
... constants process type constants constant value
description process_type_default 0 the default (chrome) process.
nsIXULWindow
hromeflagsarefrozen(); void center(in nsixulwindow arelative, in boolean ascreen, in boolean aalert); nsixulwindow createnewwindow(in print32 achromeflags, in nsiappshell aappshell); nsidocshelltreeitem getcontentshellbyid(in wstring id); void removechildwindow(in nsixulwindow achild); void showmodal(); attributes attribute type
description chromeflags pruint32 chromeflags are from nsiwebbrowserchrome.
... constants constant value
description lowestz 0 loweredz 4 the z level of an independent window opened with the "alwayslowered" chrome flag.
nsIXmlRpcClient
username, in string password); void clearauthentication(in string username, in string password); void setencoding(in string encoding); void setencoding(in unsigned long type, out nsiidref uuid, out nsqiresult result); void asynccall (in nsixmlrpcclientlistener listener, in nsisupports ctxt, in string methodname, in nsisupports arguments, in pruint32 count); attributes attribute type
description serverurl readonly nsiurl the url of the xml-rpc server inprogress readonly boolean whether or not a call is in progress fault readonly nsixmlrpcfault the most recent xml-rpc fault from returned from this server.
... constants constant type
description int unsigned long nsisupportsprint32 boolean unsigned long nsisupportsprbool string unsigned long nsisupportscstring double unsigned long nsisupportsdouble datetime unsigned long nsisupportsprtime array readonly unsigned long nsisupportsarray struct readonly unsigned long nsisupportsdictionary methods init() set server url.
nsIZipReader
file); obsolete since gecko 1.9 void open(in nsifile zipfile); void openinner(in nsizipreader zipreader, in autf8string zipentry); void openinner(in nsizipreader zipreader, in string zipentry); obsolete since gecko 10 void test(in autf8string aentryname); void test(in string aentryname); obsolete since gecko 10 attributes attribute type
description file nsifile the file that represents the zip with which this zip reader was initialized.
... nsiprincipal getcertificateprincipal( in string aentryname ); parameters aentryname missing
description return value an nsiprincipal.
nsIZipWriter
void close(); nsizipentry getentry(in autf8string azipentry); boolean hasentry(in autf8string azipentry); void open(in nsifile afile, in print32 aioflags); void processqueue(in nsirequestobserver aobserver, in nsisupports acontext); void removeentry(in autf8string azipentry, in boolean aqueue); attributes attribute type
description comment acstring gets or sets the comment associated with the currently open zip file.
... constants constant value
description compression_none 0 do not compress the file.
XPCOM
here is the interface, and a
description of its use.</t>how to build a binary xpcom component using visual studiothis is a simple tutorial for building xpcom objects in c++ using visual studio.
...rkings of xpcom look elsewhere.how to pass an xpcom object to a new windowif you want to be able to call functions within an xpcom object from a xul window's code, you can do so if you pass the xpcom object as one of the arguments to the window creation method.interfacing with the xpcom cycle collectorthis is a quick overview of the cycle collector introduced into xpcom for firefox 3, including a
description of the steps involved in modifying an existing c++ class to participate in xpcom cycle collection.
XPIDL
xpidl is an interface
description language used to specify xpcom interface classes.
... interface
description languages (idl) are used to describe interfaces in a language- and machine-independent way.
nsIMsgCloudFileProvider
); void createnewaccount(in acstring aemailaddress, in acstring apassword, in acstring afirstname, in acstring alastname, in nsirequestobserver acallback); void createexistingaccount(in nsirequestobserver acallback); acstring providerurlforerror(in unsigned long aerror); attributes attribute type
description type acstring readonly: the type is a unique string identifier which can be used by interface elements for styling.
... constant value
description offlineerr 0x80550014 returned when it appears that there is no active network connection.
MailNews fakeserver
the server presents the following api to the handler: <caption> server api </caption> name arguments returns
description closesocket none nothing closes the socket and stops the test.
...the server provides the following api to xpcshell tests: <caption> nsmailserver xpcshell api </caption> name arguments returns
description performtest none nothing runs until the test is forcibly aborted or stopped normally isstopped none if the server is stopped helper for performtest istestfinished none if the test is finished helper for performtest playtransaction none the transaction the transaction is an object with two properties: us, and them; us is an array of responses we sent, them an array of commands received r...
customDBHeaders Preference
rlay.xul \ install.rdf superfluous.xpi: ${deps} zip $@ ${deps} chrome.manifest: content superfluous chrome/content/ overlay chrome://messenger/content/messenger.xul chrome://superfluous/content/superfluous_overlay.xul install.rdf: <?xml version='1.0' encoding='utf-8'?> <rdf xmlns='http://www.w3.org/1999/02/22-rdf-syntax-ns#' xmlns:em='http://www.mozilla.org/2004/em-rdf#'> <
description about='urn:mozilla:install-manifest'> <em:id>superfluous@yoursite.com</em:id> <em:version>0.1.1</em:version> <em:type>2</em:type> <!-- 2 is type 'extension' --> <em:targetapplication> <
description> <!-- this next line identifies tbird as target --> <em:id>{3550f703-e582-4d05-9a08-453d09bdfdc6}</em:id> <em:minversion>2*</em:minversion...
...> <em:maxversion>3.0.0.*</em:maxversion> </
description> </em:targetapplication> <em:name>superfluous</em:name> <em:
description>test superfluous extension</em:
description> <em:creator>garrett comeaux</em:creator> </
description> </rdf> build process: [gcomeaux@kyle tbird-ext]$ cd superfluous/ [gcomeaux@kyle superfluous]$ make zip superfluous.xpi chrome/ chrome.manifest chrome/content/ chrome/content/superfluous.js chrome/content/superfluous_overlay.xul install.rdf adding: chrome/ (stored 0%) adding: chrome.manifest (deflated 44%) adding: chrome/content/ (stored 0%) adding: chrome/content/superfluous.js (deflated 57%) adding: chrome/content/superfluous_overlay.xul (deflated 44%) adding: install.rdf (deflated 50%) end result ultimately, you want to...
WebIDL bindings
for example, this webidl: dictionary dict { long foo = 5; domstring bar; }; interface test { void initsomething(optional dict arg = {}); }; will correspond to this c++ function declaration: void initsomething(const dict& arg); and the dict struct will look like this: struct dict { bool init(jscontext* acx, js::handle<js::value> aval, const char* asource
description = "value"); optional<nsstring> mbar; int32_t mfoo; } note that the dictionary members are sorted in the struct in alphabetical order.
... components.utils.import("resource://gre/modules/xpcomutils.jsm"); function mynumberinner() { this.value = 111; this.invisiblevalue = 12345; } mynumberinner.prototype = { class
description: "get my number xpcom component", classid: components.id("{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"), // dummy uuid contractid: "@mozilla.org/my-number;1", queryinterface: xpcomutils.generateqi([components.interfaces.nsisupports]), donothing: function() {}, get othervalue() { return this.invisiblevalue - 4; }, __init: function(firstnumber) { if (arguments.length > 0) { this.va...
FunctionType
properties property type
description abi one of the abi constants the abi of the function.
... property type
description name string the type's name.
Plug-in Basics - Plugins
the installed plug-ins page lists each installed plug-in along with its mime type or types,
description, file extensions, and the current state (enabled or disabled) of the plug-in for each mime type assigned to it.
... for a
description of each plug-in display mode, and which html element to use to achieve it, go on to plug-in display modes.
Debugger - Firefox Developer Tools
if the uncaught exception hook itself throws an exception,uncaught-hook-exception, spidermonkey throws a new error object,confess-to-debuggee-exception, to the debuggee whose message blames the debugger, and includes textual
descriptions ofuncaught-hook-exception and the originaldebugger-exception.
... if uncaughtexceptionhook’s value is null, spidermonkey throws an exception to the debuggee whose message blames the debugger, and includes a textual
description ofdebugger-exception.
DevTools API - Firefox Developer Tools
method
description new toolsidebar(xul:tabbox, toolpanel, uid, showtabstripe=true) toolsidebar constructor void addtab(tabid, url, selected=false) add a tab in the sidebar void select(tabid) select a tab void hide() hide the sidebar void show() show the sidebar void toggle() toggle the sidebar void getwindowfortab(tabid) get the ifr...
...ame containing the tab content tabid getcurrenttabid() return the id of tabid of the current tab tabbox gettab(tabid) return a tab given its id destroy() destroy the toolsidebar object events
description new-tab-registered a new tab has been added {tabid}-ready tab is loaded and can be used {tabid}-selected tab has been selected and is visible {tabid}-unselected tab has been unselected and is not visible show the sidebar has been opened.
Network request list - Firefox Developer Tools
the types can be found in the
description of the cause column.
... context menu context-clicking on a row in the list displays a context menu with the following options: menuitem
description copy > copy url copies the url.
AddressErrors - Web APIs
ngaddresserrors = {}; let updatedetails = {}; if (!validcountries.includes(shippingaddress.country)) { ev.target.shippingoptions = []; shippingaddresserrors.country = invalidcountryerror; updatedetails = { error: genericaddresserror, shippingaddresserrors, ...defaultpaymentdetails }; } ev.updatewith(updatedetails); } see handling address changes for a
description of how this code works.
...a
description of the total amount being requested (including a label and the currency used), a list of the line items (in this case only one, "original donation amount"), and a list of shipping options available; in this case only one.
AudioTrack.kind - Web APIs
"
descriptions" an audio track providing audible
descriptions of the action depicted in a video track.
... "main-desc" the primary audio track with audio
descriptions mixed into it.
CSSPrimitiveValue.getFloatValue() - Web APIs
valid values are: constant
description css_cm the value is a <length> in centimeters.
... exceptions type
description domexception an invalid_access_err is raised if the css value doesn't contain a float value or if the float value can't be converted into the specified unit.
CSSPrimitiveValue.setFloatValue() - Web APIs
valid values are: constant
description css_cm the value is a <length> in centimeters.
... exceptions type
description domexception an invalid_access_err is raised if the css value doesn't contain a float value or if the string value can't be converted into the specified unit.
CSSPrimitiveValue.setStringValue() - Web APIs
possible values are: constant
description css_attr the value is an attr() function.
... exceptions type
description domexception an invalid_access_err is raised if the css value doesn't contain a string value or if the string value can't be converted into the specified unit.
DOMError - Web APIs
domerror.message read only returns a domstring representing a message or
description associated with the given error type name.
... error types type
description indexsizeerror the index is not in the allowed range (e.g.
FileEntrySync - Web APIs
returns filewritersync exceptions this method can raise a fileexception with the following codes: exception
description not_found_err the file does not exist.
... returns file exceptions this method can raise a fileexception with the following codes: exception
description not_found_err the file does not exist.
FileError - Web APIs
attribute attribute type
description code unsigned short the most appropriate error code for the condition.
... constant value
description encoding_err 5 the url is malformed.
FileException - Web APIs
var fileentry = fs.root.getfile('log.txt', {create: true, exclusive:true}0; } catch (e) { onerrror(e); } the sample code was borrowed from html5rocks attribute attribute type
description code unsigned short the most appropriate error code for the condition.
... constant value
description encoding_err 5 the url is malformed.
msAudioCategory - Web APIs
value include a
description of the property's value, including data type and what it represents.
... value
description background capable?
msAudioDeviceType - Web APIs
value include a
description of the property's value, including data type and what it represents.
... value
description console specifies that the audio output will be sent to the console device.
HTMLTrackElement - Web APIs
possible values are: subtitles, captions,
descriptions, chapters, or metadata.
... htmltrackelement.readystate read only returns an unsigned short that show the readiness state of the track: constant value
description none 0 indicates that the text track's cues have not been obtained.
IDBCursorSync - Web APIs
method overview bool continue (in optional any key); void remove () raises (idbdatabaseexception); attributes attribute type
description count readonly unsigned long long the total number of objects that share the current key.
... constants constant value
description next 0 this cursor includes duplicates, and its direction is monotonically increasing in the order of keys.
IDBDatabase.createObjectStore() - Web APIs
it includes the following properties: attribute
description keypath the key path to be used by the new object store.
... exceptions this method may raise a domexception with a domerror of one of the following types: exception
description invalidstateerror occurs if the method was not called from a versionchange transaction callback.
IDBDatabaseException - Web APIs
attributes attribute type
description code unsigned short the most appropriate error code for the condition.
... constant value
description abort_err 8 a request was aborted, for example, through a call to idbtransaction.abort.
IDBObjectStore.createIndex() - Web APIs
objectparameters optional an idbindexparameters object, which can include the following properties: attribute
description unique if true, the index will not allow duplicate values for a single key.
... exceptions this method may raise a domexception of one of the following types: exception
description constrainterror occurs if an index with the same name already exists in the database.
IDBObjectStoreSync - Web APIs
on) raises (idbdatabaseexception); idbindexsync openindex (in domstring name) raises (idbdatabaseexception); any put (in any value, in optional any key) raises (idbdatabaseexception); void remove (in any key) raises (idbdatabaseexception); void removeindex (in domstring indexname) raises (idbdatabaseexception); attributes attribute type
description indexnames readonly domstringlist a list of the names of the indexes on this object store.
... constants mode constants constant value
description read_only 1 modification operations are not allowed on this object store.
MSSiteModeEvent - Web APIs
dom information inheritance hierarchy event mssitemodeevent methods method
description initevent initializes a new generic event that the createevent method created.
... properties property
description actionurl gets the url of a jump list item that is removed.
MouseScrollEvent - Web APIs
olean canbubblearg, in boolean cancelablearg, in nsidomabstractview viewarg, in long detailarg, in long screenxarg, in long screenyarg, in long clientxarg, in long clientyarg, in boolean ctrlkeyarg, in boolean altkeyarg, in boolean shiftkeyarg, in boolean metakeyarg, in unsigned short buttonarg, in nsidomeventtarget relatedtargetarg, in long axis); attributes attribute type
description axis read only long indicates scroll direction.
... constants delta modes constant value
description horizontal_axis 0x01 the event is caused by horizontal wheel operation.
NavigatorPlugins.plugins - Web APIs
in chrome) return flash.
description.replace(/shockwave flash /,""); } } the following example displays information about the installed plugin(s).
... var pluginslength = navigator.plugins.length; document.body.innerhtml = pluginslength + " plugin(s)<br>" + '<table id="plugintable"><thead>' +'<tr><th>name</th><th>filename</th><th>
description</th><th>version</th></tr>' +'</thead><tbody></tbody></table>'; var table = document.getelementbyid('plugintable'); for(var i = 0; i < pluginslength; i++) { let newrow = table.insertrow(); newrow.insertcell().textcontent = navigator.plugins[i].name; newrow.insertcell().textcontent = navigator.plugins[i].filename; newrow.insertcell().textcontent = navigator.plugins[i].
description; newrow.insertcell().textcontent = navigator.plugins[i].version?navigator.plugins[i].version:""; } notes the plugin object exposes a small interface for getting information about the various plugins installed in yo...
Node.nodeType - Web APIs
constants node type constants constant value
description node.element_node 1 an element node like <p> or <div>.
... constant value
description node.attribute_node 2 an attribute of an element.
PerformanceServerTiming - Web APIs
properties performanceservertiming.
descriptionread only a domstring value of the server-specified metric
description, or an empty string.
... => { response.end(); }, 1000) }; http.createserver(requesthandler).listen(3000).on('error', console.error); the performanceservertiming entries are now observable from javascript via the performanceresourcetiming.servertiming property: let entries = performance.getentriesbytype('resource'); console.log(entries[0].servertiming); // 0: performanceservertiming {name: "cache", duration: 23.2,
description: "cache read"} // 1: performanceservertiming {name: "db", duration: 53,
description: ""} // 2: performanceservertiming {name: "app", duration: 47.2,
description: ""} specifications specification status comment server timingthe definition of 'performanceservertiming' in that specification.
PluginArray - Web APIs
var pluginslength = navigator.plugins.length; document.body.innerhtml = pluginslength + " plugin(s)<br>" + '<table id="plugintable"><thead>' +'<tr><th>name</th><th>filename</th><th>
description</th><th>version</th></tr>' +'</thead><tbody></tbody></table>'; var table = document.getelementbyid('plugintable'); for(var i = 0; i < pluginslength; i++) { let newrow = table.insertrow(); newrow.insertcell().textcontent = navigator.plugins[i].name; newrow.insertcell().textcontent = navigator.plugins[i].filename; newrow.insertcell().textcontent = navigator.plugins[i].
description; new...
... var pluginslength = navigator.plugins.length; document.write( pluginslength.tostring() + " plugin(s)<br>" + "name | filename |
description<br>" ); for(var i = 0; i < pluginslength; i++) { document.write( navigator.plugins[i].name + " | " + navigator.plugins[i].filename + " | " + navigator.plugins[i].
description + " | " + navigator.plugins[i].version + "<br>" ); } specifications specification status comment html living standardthe definition of 'pluginarray' in that specification.
RTCOfferOptions.iceRestart - Web APIs
pc.oniceconnectionstatechange = function(evt) { if (pc.iceconnectionstate === "failed") { if (pc.restartice) { pc.restartice(); } else { pc.createoffer({ icerestart: true }) .then(pc.setlocal
description) .then(sendoffertoserver); } } } if the state changes to failed, this handler starts by looking to see if the rtcpeerconnection includes the restartice() method; if it does, we call that to request an ice restart.
... otherwise, we call back to the older technique: we manually create a new offer with icerestart set to true, then that offer is set as the new local
description for the connection.
RTCPeerConnection: icecandidate event - Web APIs
an icecandidate event is sent to an rtcpeerconnection when an rtcicecandidate has been identified and added to the local peer by a call to rtcpeerconnection.setlocal
description().
... bubbles no cancelable no interface rtcpeerconnectioniceevent event handler property rtcpeerconnection.onicecandidate
description there are three reasons why the icecandidate event is fired on an rtcpeerconnection.
RTCPeerConnection.onaddstream - Web APIs
the event is sent immediately after the call setremote
description() and doesn't wait for the result of the sdp negotiation.
...the first time an event occurs may be nearly immediately after the remote end of the connection is set using rtcpeerconnection.setremote
description(); it doesn't wait for a particular stream to be accepted or rejected using sdp negotiation.
RTCPeerConnection.onnegotiationneeded - Web APIs
pc.onnegotiationneeded = function() { pc.createoffer().then(function(offer) { return pc.setlocal
description(offer); }) .then(function() { // send the offer to the remote peer through the signaling server }); }) .catch(reporterror); } first, it creates the offer by calling createoffer().
... when that succeeds, the offer is passed into setlocal
description() to set the local
description for the connection.
RTCPeerConnection.setConfiguration() - Web APIs
r restartconfig = { iceservers: [{ urls: "turn:asia.myturnserver.net", username: "allie@oopcode.com", credential: "topsecretpassword" }] }; mypeerconnection.setconfiguration(restartconfig); mypeerconnection.createoffer({"icerestart": true}).then(function(offer) { return mypeerconnection.setlocal
description(offer); }) .then(function() { // send the offer to the other peer using the signaling server }) .catch(reporterror); first, a new rtcconfiguration is created, restartconfig, specifying the new ice server and its credentials.
...from there, we handle the process as usual, by setting the local
description to the returned offer and then sending that offer to the other peer.
RTCRtpTransceiver - Web APIs
this association is established, when possible, whenever either a local or remote
description is applied.
... this field is null if neither a local or remote
description has been applied, or if its associated m-line is rejected by either a remote offer or any answer.
SVGFETurbulenceElement - Web APIs
"65" width="220" height="50" fill="#f4f7f8" stroke="#d4dde4" stroke-width="2px" /><text x="371" y="94" font-size="12px" font-family="consolas,monaco,andale mono,monospace" fill="#4d4e53" text-anchor="middle" alignment-baseline="middle">svgfeturbulenceelement</text></a></svg></div> a:hover text { fill: #0095dd; pointer-events: all;} constants turbulence types name value
description svg_turbulence_type_unknown 0 the type is not one of predefined types.
... stitch options name value
description svg_stitchtype_unknown 0 the type is not one of predefined types.
SVGLengthList - Web APIs
long index) svglength replaceitem(in svglength newitem, in unsigned long index) svglength removeitem(in unsigned long index) svglength appenditem(in svglength newitem) properties readonly unsigned long numberofitems readonly unsigned long length normative document svg 1.1 (2nd edition) properties name type
description numberofitems unsigned long the number of items in the list.
... methods name & arguments return
description clear() void clears all existing current items from the list, with the result being an empty list.
SVGNumberList - Web APIs
dex) svgnumber replaceitem(in svgnumber newitem, in unsigned long index) svgnumber removeitem(in unsigned long index) svgnumber appenditem(in svgnumber newitem) properties readonly unsigned long numberofitems readonly unsigned long length normative document svg 1.1 (2nd edition) properties name type
description numberofitems unsigned long the number of items in the list.
... methods name & arguments return
description clear() void clears all existing current items from the list, with the result being an empty list.
SVGPathSeg - Web APIs
o_cubic_smooth_abs = 16 pathseg_curveto_cubic_smooth_rel = 17 pathseg_curveto_quadratic_smooth_abs = 18 pathseg_curveto_quadratic_smooth_rel = 19 normative document svg 1.1 (2nd edition) constants name value
description pathseg_unknown 0 the unit type is not one of predefined types.
... properties name type
description pathsegtype unsigned short the type of the path segment as specified by one of the constants defined on this interface.
SVGPointList - Web APIs
n unsigned long index) svgpoint appenditem(in svgpoint newitem) properties readonly unsigned long numberofitems normative document svg 1.1 (2nd edition) properties name type
description numberofitems unsigned long the number of items in the list.
... methods name & arguments return
description clear() void clears all existing current items from the list, with the result being an empty list.
SVGPreserveAspectRatio - Web APIs
tratio_xmidymid = 6 svg_preserveaspectratio_xmaxymid = 7 svg_preserveaspectratio_xminymax = 8 svg_preserveaspectratio_xmidymax = 9 svg_preserveaspectratio_xmaxymax = 10 svg_meetorslice_unknown = 0 svg_meetorslice_meet = 1 svg_meetorslice_slice = 2 normative document svg 1.1 (2nd edition) constants name value
description svg_preserveaspectratio_unknown 0 the enumeration was set to a value that is not one of predefined types.
... properties name type
description align unsigned short the type of the alignment value as specified by one of the svg_preserveaspectratio_* constants defined on this interface.
SVGStringList - Web APIs
ndex) domstring replaceitem(in domstring newitem, in unsigned long index) domstring removeitem(in unsigned long index) domstring appenditem(in domstring newitem) properties readonly unsigned long numberofitems readonly unsigned long length normative document svg 1.1 (2nd edition) properties name type
description numberofitems unsigned long the number of items in the list.
... methods name & arguments return
description clear() void clears all existing current items from the list, with the result being an empty list.
SVGStylable - Web APIs
interface overview also implement none methods cssvalue getpresentationattribute(in domstring name) properties readonly svganimatedstring classname readonly cssstyledeclaration style normative document svg 1.1 (2nd edition) properties name type
description classname svganimatedstring corresponds to attribute class on the given element.
... methods name & arguments return
description getpresentationattribute(in domstring name) cssvalue returns the base (i.e., static) value of a given presentation attribute as an object of type cssvalue.
SVGTextPathElement - Web APIs
-169" y="65" width="180" height="50" fill="#f4f7f8" stroke="#d4dde4" stroke-width="2px" /><text x="-79" y="94" font-size="12px" font-family="consolas,monaco,andale mono,monospace" fill="#4d4e53" text-anchor="middle" alignment-baseline="middle">svgtextpathelement</text></a></svg></div> a:hover text { fill: #0095dd; pointer-events: all;} constants method types name value
description textpath_methodtype_unknown 0 the type is not one of predefined types.
... spacing types name value
description textpath_spacingtype_unknown 0 the type is not one of predefined types.
SVGTransformList - Web APIs
item(in unsigned long index) svgtransform appenditem(in svgtransform newitem) svgtransform createsvgtransformfrommatrix(in svgmatrix) svgtransform consolidate() properties readonly unsigned long numberofitems readonly unsigned long length normative document svg 1.1 (2nd edition) properties name type
description numberofitems unsigned long the number of items in the list.
... methods name & arguments return
description clear() void clears all existing current items from the list, with the result being an empty list.
ServiceWorkerContainer.register() - Web APIs
the service worker code in this case, if included in example.com/index.html, will control example.com/index.html, as well as pages underneath it, like example.com/product/
description.html.
... alternatively, if this code were included in a page at example.com/product/
description.html, with the javascript file residing at example.com/product/sw.js, then the service worker would only apply to resources under example.com/product.
WebGLRenderingContext.disable() - Web APIs
possible values: constant
description gl.blend deactivates blending of the computed fragment color values.
... when using a webgl 2 context, the following values are available additionally: constant
description gl.rasterizer_discard deactivates that primitives are discarded immediately before the rasterization stage, but after the optional transform feedback stage.
WebGLRenderingContext.enable() - Web APIs
possible values: constant
description gl.blend activates blending of the computed fragment color values.
... when using a webgl 2 context, the following values are available additionally: constant
description gl.rasterizer_discard primitives are discarded immediately before the rasterization stage, but after the optional transform feedback stage.
WebGLRenderingContext.isEnabled() - Web APIs
possible values: constant
description gl.blend blending of the computed fragment color values.
... when using a webgl 2 context, the following values are available additionally: constant
description gl.rasterizer_discard primitives are discarded immediately before the rasterization stage, but after the optional transform feedback stage.
WebGLRenderingContext.pixelStorei() - Web APIs
pixel storage parameters parameter name (for pname)
description type default value allowed values (for param) specified in gl.pack_alignment packing of pixel data into memory glint 4 1, 2, 4, 8 opengl es 2.0 gl.unpack_alignment unpacking of pixel data from memory.
... glenum gl.browser_default_webgl gl.browser_default_webgl, gl.none webgl when using a webgl 2 context, the following values are available additionally: constant
description type default value allowed values (for param) specified in gl.pack_row_length number of pixels in a row.
Introduction to the Real-time Transport Protocol (RTP) - Web APIs
async function holdrequested(offer) { try { await peerconnection.setremote
description(offer); await audiotransceiver.sender.replacetrack(null); audiotransceiver.direction = "recvonly"; await sendanswer(); } catch(err) { /* handle the error */ } } the steps taken here are: set the remote
description to the specified offer by calling rtcpeerconnection.setremote
description().
... remote peer when the "sendrecv" offer is received by the remote peer, it calls its holdended() method: async function holdended(offer, micstream) { try { await peerconnection.setremote
description(offer); await audiotransceiver.sender.replacetrack(micstream.getaudiotracks()[0]); audiotransceiver.direction = "sendrecv"; await sendanswer(); } catch(err) { /* handle the error */ } } the steps taken inside the try block here are: the received offer is stored as the remote
description by calling setremote
description().
Web Video Text Tracks Format (WebVTT) - Web APIs
you could use this to add a
description to the file.
... vttregion the methods used for region are listed below along with
description of their functionality: scrollsetting: for adjusting the scrolling setting of all nodes present in given region.
Inputs and input sources - Web APIs
the list in profiles is in order of reverse specificity; that is, the most precise
description is first, and the least precise
description is last.
...while the oculus touch controller actually has a thumbpad rather than a thumbstick, the overall
description is "close enough" that the details within the profile matching the name will let the controller be interpreted usefully.
Using XMLHttpRequest - Web APIs
nput type="file" multiple name="photos[]"> </p> <p> <input id="vehicle_bike" type="checkbox" name="vehicle[]" value="bike" /> <label for="vehicle_bike">i have a bike</label><br /> <input id="vehicle_car" type="checkbox" name="vehicle[]" value="car" /> <label for="vehicle_car">i have a car</label> </p> <p> describe yourself:<br /> <textarea name="
description" cols="50" rows="8"></textarea> </p> <p> <input type="submit" value="submit" /> </p> </fieldset> </form> </body> </html> to test this, create a page named register.php (which is the action attribute of these sample forms), and put the following minimalistic content: <?php /* register.php */ header("content-type: text/plain"); /* note: you should never use `print_r()` in ...
...nput type="file" multiple name="photos[]"> </p> <p> <input id="vehicle_bike" type="checkbox" name="vehicle[]" value="bike" /> <label for="vehicle_bike">i have a bike</label><br /> <input id="vehicle_car" type="checkbox" name="vehicle[]" value="car" /> <label for="vehicle_car">i have a car</label> </p> <p> describe yourself:<br /> <textarea name="
description" cols="50" rows="8"></textarea> </p> <p> <input type="submit" value="submit" /> </p> </fieldset> </form> </body> </html> note: as we said, formdata objects are not stringifiable objects.
Using the aria-labelledby attribute - Accessibility
description the aria-labelledby attribute establishes relationships between objects and their label(s), and its value should be one or more element ids, which refer to elements that have the text needed for labeling.
... aria-labelledby is very similar to aria-describedby: a label provides essential information about an object, while a
description provides extended information that the user might need.
Using the group role - Accessibility
description this technique demonstrates how to use the group role and describes the effect it has on browsers and assistive technology.
... assistive technology products should listen for such an event and notify the user accordingly: screen readers should announce the group when focus first lands on a control inside it, and if aria-describedby has been set, the
description may be spoken.
ARIA: timer role - Accessibility
description the timer role indicates to assistive technologies that this part of the web content is a live region containing a timer listing the time remaining or elapsed time.
... aria-role
description used to give the timer a more descriptive role text for screen readers to speak.
ARIA: application role - Accessibility
description the application role indicates to assistive technologies that this part of the web content contains elements that do not conform to any other known html element or wai-aria widget.
... aria-role
description used to give the application a more descriptive role text for screen readers to speak.
ARIA: Complementary role - Accessibility
description the complementary role is a landmark role.
... <aside id="sidebar" aria-label="sponsors"> <!-- content --> </aside> redundant
descriptions screen readers will announce the type of role the landmark is.
ARIA: contentinfo role - Accessibility
using the <footer> element instead is recommended: <footer> <h2>footer</h2> <!-- footer content --> </footer>
description the contentinfo role is a landmark used to identify a page footer.
... <footer aria-label="footer"> <!-- footer content --> </footer> </body> redundant
descriptions screen readers will announce the type of role the landmark is.
ARIA: feed role - Accessibility
</section>
description a feed is a page structure for a scrollable list of articles where scrolling may cause articles to be added to the top or end of the list.
... another feature of the feed pattern is skim reading: articles within a feed can contain both an accessible name with the aria-label and a
description with an aria-describedby, suggesting to screen readers which elements to speak after the label when navigating by article.
ARIA: form role - Accessibility
description a form landmark identifies a region of content that contains a collection of items and objects that, as a whole, combine to create a form when no other named landmark is appropriate (e.g.
... using role="form" <div role="form" id="gift-cards" aria-label="purchase a gift card"> <!-- form content --> </div> redundant
descriptions screen readers will announce the type of role the landmark is.
ARIA: search role - Accessibility
<form role="search"> <!-- search input --> </form>
description the search role is a landmark.
... <footer> <form id="site-search-bottom" role="search" aria-label="sitewide"> <!-- search input --> </form> </footer> redundant
descriptions screen readers will announce the type of role the landmark is.
ARIA: table role - Accessibility
</div> <div role="row" aria-rowindex="16"> <span role="cell">header</span> <span role="cell">h6</span> </div> <div role="row" aria-rowindex="18"> <span role="cell">rowgroup</span> <span role="cell">thead</span> </div> <div role="row" aria-rowindex="24"> <span role="cell">term</span> <span role="cell">dt</span> </div> </div> </div>
description an element with role="table" is a static tabular structure with rows containing cells.
... aria-describedby attribute takes as its value the id of the element that serves as a
description for the table.
ARIA: button role - Accessibility
description the button role identifies an element as a button to screen readers.
...the accessible name is either the content of the element or the value of an aria-label or element referenced by an aria-labelledby attribute, or
description, if included.
ARIA: listbox role - Accessibility
description the listbox role is used to identify an element that creates a list from which a user may select one or more static items, similar to the html <select> element.
... (note: "labelled", with two l's, is the correct spelling based on the accessibility api conventions.) aria-role
description a human-readable string value which more clearly identifies the role of the listbox.
ARIA: textbox role - Accessibility
description when an element has the textbox role, the browser sends an accessible textbox event to assistive technologies, which can then notify the user about it.
...the hint should be a sample value or a brief
description of the expected format.this information should not be used as a substitute for a label: a label is focusable, permanent, indicates what kind of information is expected, and increases the hit area for setting focus on the control, whereas placeholder text is only temporary hint about the expected value, which if implemented incorrectly can decrease accessibility.
Cognitive accessibility - Accessibility
navigation guideline 2.4 states "provide ways to help users navigate, find content, and determine where they are," and provides 10 guidelines to ensure the site is navigable and content is findable: include a <title> make sure to include a <title> for the document, as titles provide a quick and easy to reference
description of the screen's main point.
... provide text to identify incomplete required fields and text
descriptions if a value entered is invalid.
Detecting CSS animation support - CSS: Cascading Style Sheets
this variable, once constructed, contains the complete
description of all the keyframes needed by our animation sequence.
...the first thing to do is look to see if there's already a style sheet on the document; if so, we simply insert the keyframe
description into that stylesheet; this is done in lines 13-15.
<color> - CSS: Cascading Style Sheets
*/ hsl(270, 60%, 50%, .15) hsl(270, 60%, 50%, 15%) hsl(270 60% 50% / .15) hsl(270 60% 50% / 15%) fully saturated colors notation
description live hsl(0, 100%, 50%) red hsl(30, 100%, 50%) orange hsl(60, 100%, 50%) yellow hsl(90, 100%, 50%) lime green hsl(120, 100%, 50%) green hsl(150, 100%, 50%) blue-green hsl(180, 100%, 50%) cyan hsl(210, 100%, 50%) sky blue hsl(240, 100%, 50%) blue ...
... hsl(270, 100%, 50%) purple hsl(300, 100%, 50%) magenta hsl(330, 100%, 50%) pink hsl(360, 100%, 50%) red lighter and darker greens notation
description live hsl(120, 100%, 0%) black hsl(120, 100%, 20%) hsl(120, 100%, 40%) hsl(120, 100%, 60%) hsl(120, 100%, 80%) hsl(120, 100%, 100%) white saturated and desaturated greens notation
description live hsl(120, 100%, 50%) green hsl(120, 80%, 50%) hsl(120, 60%, 50%) hsl(120, 40%, 50%) hsl(120, 20%, 50%) hsl(120, 0%, 50%) gray hsl transparency ...
radial-gradient() - CSS: Cascading Style Sheets
the possible values are: keyword
description closest-side the gradient's ending shape meets the side of the box closest to its center (for circles) or meets both the vertical and horizontal sides closest to the center (for ellipses).
...
description as with any gradient, a radial gradient has no intrinsic dimensions; i.e., it has no natural or preferred size, nor a preferred ratio.
Constraint validation - Developer guides
semantic input types the intrinsic constraints for the type attribute are: input type constraint
description associated violation <input type="url"> the value must be an absolute url, as defined in the url living standard.
... validation-related attributes in addition to the type attribute described above, the following attributes are used to describe basic constraints: attribute input types supporting the attribute possible values constraint
description associated violation pattern text, search, url, tel, email, password a javascript regular expression (compiled with the ecmascript 5 global, ignorecase, and multiline flags disabled) the value must match the pattern.
The Unicode Bidirectional Text Algorithm - Developer guides
initial unicode bidi algorithm control characters character code point html entity markup equivalent
description left-to-right isolate (lri) u+2066 ⁦ dir="ltr" sets the base direction to ltr, isolating the embedded content from the surrounding text right-to-left isolate (lri) u+2067 ⁧ dir="rtl" sets the base direction to rtl, isolating the embedded content from the surrounding text first strong isolate (fsi) u+2068 ⁨ dir="a...
...bidi algorithm, displaying the characters in memory order, from left to right right-to-left override (rlo) u+202e ‮ <bdo dir="rtl"> overrides the bidi algorithm and displays the embedded characters in reverse memory order, from right to left closing unicode bidi algorithm control characters character code point html entity markup equivalent
description pop directional formatting (pdf) u+202c ‬ closing whatever opening tag used the dir attribute used for rle or lre </bdo> used for rlo or lro pop directional isolate (pdi) u+2069 ⁩ closing whatever opening tag used the dir attribute used for rli, lri, or fsi ...
HTML attribute: rel - HTML: Hypertext Markup Language
values for the rel attribute, and the elements for which each is relevant rel value
description <link> <a> and <area> <form> alternate alternate representations of the current document.
... if the type attribute is set to application/opensearch
description+xml the resource is an opensearch plugin that can be easily added to the interface of some browsers like firefox or internet explorer.
<input type="date"> - HTML: Hypertext Markup Language
additional attributes along with the attributes common to all <input> elements, date inputs have the following attributes: attribute
description max the latest acceptable date min the earliest acceptable date step the stepping interval, when clicking up and down spinner buttons and validating the date max the latest date to accept.
...queryselector('#year'); var monthselect = document.queryselector('#month'); var dayselect = document.queryselector('#day'); // hide fallback initially fallbackpicker.style.display = 'none'; fallbacklabel.style.display = 'none'; // test whether a new date input falls back to a text input or not var test = document.createelement('input'); try { test.type = 'date'; } catch (e) { console.log(e.
description); } // if it does, run the code inside the if() {} block if(test.type === 'text') { // hide the native picker and show the fallback nativepicker.style.display = 'none'; fallbackpicker.style.display = 'block'; fallbacklabel.style.display = 'block'; // populate the days and years dynamically // (the months are always the same, therefore hardcoded) populatedays(monthselect.value); ...
<input type="datetime-local"> - HTML: Hypertext Markup Language
additional attributes in addition to the attributes common to all <input> elements, datetime-local inputs offer the following attributes: attribute
description max the latest date and time to accept min the earliest date and time to accept step the stepping interval to use for this input, such as when clicking arrows on spinner controls or performing validation max the latest date and time to accept.
...var hourselect = document.queryselector('#hour'); var minuteselect = document.queryselector('#minute'); // hide fallback initially fallbackpicker.style.display = 'none'; fallbacklabel.style.display = 'none'; // test whether a new datetime-local input falls back to a text input or not var test = document.createelement('input'); try { test.type = 'datetime-local'; } catch (e) { console.log(e.
description); } // if it does, run the code inside the if() {} block if(test.type === 'text') { // hide the native picker and show the fallback nativepicker.style.display = 'none'; fallbackpicker.style.display = 'block'; fallbacklabel.style.display = 'block'; // populate the days and years dynamically // (the months are always the same, therefore hardcoded) populatedays(monthselect.value); ...
<input type="file"> - HTML: Hypertext Markup Language
additional attributes in addition to the common attributes shared by all <input> elements, inputs of type file also support the following attributes: attribute
description accept one or more unique file type specifiers describing file types to allow capture what source to use for capturing image or video data files a filelist listing the chosen files multiple a boolean which, if present, indicates that the user may choose more than one file accept the accept attribute value is a string that defines the fil...
... attribute
description webkitdirectory a boolean indicating whether or not to only allow the user to choose a directory (or directories, if multiple is also present) webkitdirectory the boolean webkitdirectory attribute, if present, indicates that only directories should be available to be selected by the user in the file picker interface.
<input type="image"> - HTML: Hypertext Markup Language
additional attributes in addition to the attributes shared by all <input> elements, image button inputs support the following attributes: attribute
description alt alternate string to display when the image can't be shown formaction the url to which to submit the data formenctype the encoding method to use when submitting the form data formmethod the http method to use when submitting the form formnovalidate a boolean which, if present, indicates that the form shouldn't be validated before ...
... obsolete attributes the following attribute was defined by html 4 for image inputs, but was not implemented by all browsers and has since been deprecated: attribute
description usemap the name of an image map (<map>) element to use with the image; this is obsolete.
<input type="month"> - HTML: Hypertext Markup Language
or example: <label for="bday-month">what month were you born in?</label> <input id="bday-month" type="month" name="bday-month" value="2017-06"> var monthcontrol = document.queryselector('input[type="month"]'); monthcontrol.value = '1978-06'; additional attributes in addition to the attributes common to <input> elements, month inputs offer the following attributes: attribute
description list the id of the <datalist> element that contains the optional pre-defined autocomplete options max the latest year and month to accept as a valid input min the earliest year and month to accept as a valid input readonly a boolean which, if present, indicates that the input's value can't be edited step a stepping interval to use wh...
...('.fallbacklabel'); var yearselect = document.queryselector('#year'); var monthselect = document.queryselector('#month'); // hide fallback initially fallbackpicker.style.display = 'none'; fallbacklabel.style.display = 'none'; // test whether a new date input falls back to a text input or not var test = document.createelement('input'); try { test.type = 'month'; } catch (e) { console.log(e.
description); } // if it does, run the code inside the if() {} block if(test.type === 'text') { // hide the native picker and show the fallback nativepicker.style.display = 'none'; fallbackpicker.style.display = 'block'; fallbacklabel.style.display = 'block'; // populate the years dynamically // (the months are always the same, therefore hardcoded) populateyears(); } function populateyears()...
<input type="range"> - HTML: Hypertext Markup Language
additional attributes in addition to the attributes shared by all <input> elements, range inputs offer the following attributes: attribute
description list the id of the <datalist> element that contains optional pre-defined options max the maximum permitted value min the minimum permitted value step the stepping interval, used both for user interface and validation purposes list the values of the list attribute is the id of a <datalist> element located in the same document.
... non standard attributes attribute
description orient sets the orientation of the range slider.
<input type="search"> - HTML: Hypertext Markup Language
additional attributes in addition to the attributes that operate on all <input> elements regardless of their type, search field inputs support the following attributes: attribute
description list the id of the <datalist> element that contains the optional pre-defined autocomplete options maxlength the maximum number of characters the input should accept minlength the minimum number of characters long the input can be and still be considered valid pattern a regular expression the input's contents must match in order to be valid ...
... attribute
description autocorrect whether or not to allow autocorrect while editing this input field.
<input type="tel"> - HTML: Hypertext Markup Language
additional attributes in addition to the attributes that operate on all <input> elements regardless of their type, telephone number inputs support the following attributes: attribute
description list the id of the <datalist> element that contains the optional pre-defined autocomplete options maxlength the maximum length, in utf-16 characters, to accept as a valid input minlength the minimum length that is considered valid for the field's contents pattern a regular expression the entered value must match to pass constraint validation ...
... attribute
description autocorrect whether or not to allow autocorrect while editing this input field.
<input type="text"> - HTML: Hypertext Markup Language
additional attributes in addition to the attributes that operate on all <input> elements regardless of their type, text inputs support the following attributes: attribute
description list the id of the <datalist> element that contains the optional pre-defined autocomplete options maxlength the maximum number of characters the input should accept minlength the minimum number of characters long the input can be and still be considered valid pattern a regular expression the input's contents must match in order to be valid ...
... attribute
description autocorrect a string indicating whether or not autocorrect is on or off.
<input type="time"> - HTML: Hypertext Markup Language
additional attributes in addition to the attributes common to all <input> elements, time inputs offer the following attributes: attribute
description list the id of the <datalist> element that contains the optional pre-defined autocomplete options max the latest time to accept, in the syntax described under time value format min the earliest time to accept as a valid input readonly a boolean attribute which, if present, indicates that the contents of the time input should not be user-editable...
...'.fallbacklabel'); var hourselect = document.queryselector('#hour'); var minuteselect = document.queryselector('#minute'); // hide fallback initially fallbackpicker.style.display = 'none'; fallbacklabel.style.display = 'none'; // test whether a new date input falls back to a text input or not var test = document.createelement('input'); try { test.type = 'time'; } catch (e) { console.log(e.
description); } // if it does, run the code inside the if() {} block if(test.type === 'text') { // hide the native picker and show the fallback nativepicker.style.display = 'none'; fallbackpicker.style.display = 'block'; fallbacklabel.style.display = 'block'; // populate the hours and minutes dynamically populatehours(); populateminutes(); } function populatehours() { // populate the hours...
<input type="url"> - HTML: Hypertext Markup Language
additional attributes in addition to the attributes that operate on all <input> elements regardless of their type, url inputs support the following attributes: attribute
description list the id of the <datalist> element that contains the optional pre-defined autocomplete options maxlength the maximum number of characters the input should accept minlength the minimum number of characters long the input can be and still be considered valid pattern a regular expression the input's contents must match in order to be valid ...
... attribute
description autocorrect a string indicating whether or not autocorrect is on or off.
<input type="week"> - HTML: Hypertext Markup Language
you can also get and set the value in javascript using the input element's value property, for example: var weekcontrol = document.queryselector('input[type="week"]'); weekcontrol.value = '2017-w45'; additional attributes in addition to the attributes common to <input> elements, week inputs offer the following attributes: attribute
description max the latest year and week to accept as valid input min the earliest year and week to accept as valid input readonly a boolean which, if present, indicates that the user cannot edit the field's contents step the stepping interval (the distance between allowed values) to use for both user interface and constraint validation max the late...
...llbacklabel'); var yearselect = document.queryselector('#year'); var weekselect = document.queryselector('#fallbackweek'); // hide fallback initially fallbackpicker.style.display = 'none'; fallbacklabel.style.display = 'none'; // test whether a new date input falls back to a text input or not var test = document.createelement('input'); try { test.type = 'week'; } catch (e) { console.log(e.
description); } // if it does, run the code inside the if() {} block if(test.type === 'text') { // hide the native picker and show the fallback nativepicker.style.display = 'none'; fallbackpicker.style.display = 'block'; fallbacklabel.style.display = 'block'; // populate the weeks dynamically populateweeks(); } function populateweeks() { // populate the week select with 52 weeks for(var i ...
<th> - HTML: Hypertext Markup Language
abbr this attribute contains a short abbreviated
description of the cell's content.
... some user-agents, such as speech readers, may present this
description before the content itself.
hidden - HTML: Hypertext Markup Language
it would be fine, however, to use the aria aria-describedby attribute to refer to
descriptions that are themselves hidden.
... while hiding the
descriptions implies that they are not useful on their own, they could be written in such a way that they are useful in the specific context of being referenced from the element that they describe.
itemscope - HTML: Hypertext Markup Language
apple pie</h2> <img itemprop="image" src="https://udn.realityripple.com/samples/60/d063c361c1.jpg" width="50" height="50" /> <p> by <span itemprop="author" itemscope itemtype="http://schema.org/person"> <span itemprop="name">carol smith</span> </span> </p> <p> published: <time datetime="2009-11-05" itemprop="datepublished">november 5, 2009</time> </p> <span itemprop="
description">this is my grandmother's apple pie recipe.
... structured data itemscope itemtype recipe itemprop name grandma's holiday apple pie itemprop image https://c1.staticflickr.com/1/30/42759561_8631e2f905_n.jpg itemprop datepublished 2009-11-05 itemprop
description this is my grandmother's apple pie recipe.
itemtype - HTML: Hypertext Markup Language
vil itemprop brand [thing] itemprop name acme example html <div itemscope itemtype="http://schema.org/product"> <span itemprop="brand">acme<br></span> <span itemprop="name">executive anvil<br></span> <img itemprop="image" src="https://udn.realityripple.com/samples/61/fa8ee62aba.png" width="50" height="50" alt="executive anvil logo" /><br> <span itemprop="
description">sleeker than acme's classic anvil, the executive anvil is perfect for the business traveler looking for something to drop from a height.
...</span> </div> result html structured data itemscope itemtype product (http://schema.org/product) itemprop name executive anvil itemprop image https://pixabay.com/static/uploads/photo/2015/09/05/18/15/suitcase-924605_960_720.png itemprop
description sleeker than acme's classic anvil, the executive anvil is perfect for the business traveler looking for something to drop from a height.
Link types - HTML: Hypertext Markup Language
list of the defined link types and their significance in html link type
description allowed in these elements not allowed in these elements alternate if the element is <link> and the rel attribute also contains the stylesheet type, the link defines an alternative style sheet; in that case the title attribute must be present and not be the empty string.
... if the type attribute is set to application/opensearch
description+xml the resource is an opensearch plugin that can be easily added to the interface of some browsers like firefox or internet explorer.
Content-Type - HTTP
<form action="/" method="post" enctype="multipart/form-data"> <input type="text" name="
description" value="some text"> <input type="file" name="myfile"> <button type="submit">submit</button> </form> the request looks something like this (less interesting headers are omitted here): post /foo http/1.1 content-length: 68137 content-type: multipart/form-data; boundary=---------------------------974767299852498929531610575 -----------------------------974767299852498929531610575 content-dis...
...position: form-data; name="
description" some text -----------------------------974767299852498929531610575 content-disposition: form-data; name="myfile"; filename="foo.txt" content-type: text/plain (content of the uploaded file foo.txt) -----------------------------974767299852498929531610575-- specifications specification title rfc 7233, section 4.1: content-type in multipart hypertext transfer protocol (http/1.1): range requests rfc 7231, section 3.1.1.5: content-type hypertext transfer protocol (http/1.1): semantics and content ...
HTTP Index - HTTP
a complete document is reconstructed from the different sub-documents fetched, for instance text, layout
description, images, videos, scripts, and more 4 basics of http guide, http, overview http is a pretty extensible protocol.
... 180 server-timing http, performance, reference, header the server-timing header communicates one or more metrics and
descriptions for a given request-response cycle.
The arguments object - JavaScript
description note: if you're writing es6 compatible code, then rest parameters should be preferred.
...see §
description for details.
Array.prototype.concat() - JavaScript
see the
description below for more details.
...
description the concat method creates a new array consisting of the elements in the object on which it is called, followed in order by, for each argument, the elements of that argument (if the argument is an array) or the argument itself (if the argument is not an array).
Array.prototype.map() - JavaScript
description map calls a provided callback function once for each element in an array, in order, and constructs a new array from the results.
...map(number) // [1.1, 220, 3e+300] // for comparison, if we use parseint() on the array above: ['1.1', '2.2e2', '3e300'].map( str => parseint(str) ) // [1, 2, 3] one alternative output of the map method being called with parseint as a parameter runs as follows: let xs = ['10', '10', '10'] xs = xs.map(parseint) console.log(xs) // actual result of 10,nan,2 may be unexpected based on the above
description.
Array - JavaScript
description arrays are list-like objects whose prototype has methods to perform traversal and mutation operations.
... to help explain these properties and elements, see this example and then refer to the table below: // match one d followed by one or more b's followed by one d // remember matched b's and the following d // ignore case const myre = /d(b+)(d)/i const myarray = myre.exec('cdbbdbsbz') the properties and elements returned from this match are as follows: property/element
description example input read only the original string against which the regular expression was matched.
Error.prototype.message - JavaScript
the message property is a human-readable
description of the error.
...
description this property contains a brief
description of the error if one is available or has been set.
Error - JavaScript
description runtime errors result in new error objects being created and thrown.
... error.prototype.
description a non-standard microsoft property for the error
description.
Intl.Locale.prototype.caseFirst - JavaScript
description a locale's collation rules are used to determine how strings are ordered in that locale.
... casefirst values value
description upper upper case to be sorted before lower case.
Intl.Locale.prototype.collation - JavaScript
description collation is the process of ordering strings of characters.
... valid collation types collation type
description big5han pinyin ordering for latin, big5 charset ordering for cjk characters (used in chinese) compat a previous version of the ordering, for compatibility dict dictionary style ordering (such as in sinhala) the direct collation type has been deprected.
Intl.Locale.prototype.hourCycle - JavaScript
description there are 2 main types of time keeping conventions (clocks) used around the world: the 12 hour clock and the 24 hour clock.
... valid hour cycle types hour cycle type
description h12 hour system using 1–12; corresponds to 'h' in patterns.
Intl.Locale.prototype.numberingSystem - JavaScript
description a numeral system is a system for expressing numbers.
... value
description adlm adlam digits ahom ahom digits arab arabic-indic digits arabext extended arabic-indic digits armn armenian upper case numerals — algorithmic armnlow armenian lower case numerals — algorithmic bali balinese digits beng bengali digits bhks bhaiksuki digits brah brahmi digits ca...
Number.prototype.toExponential() - JavaScript
description if the fractiondigits argument is omitted, the number of digits after the decimal point defaults to the number of digits necessary to represent the value uniquely.
...see the discussion of rounding in the
description of the tofixed() method, which also applies to toexponential().
handler.defineProperty() - JavaScript
property the name or symbol of the property whose
description is to be retrieved.
...
description the handler.defineproperty() method is a trap for object.defineproperty().
TypedArray - JavaScript
description ecmascript 2015 defines a typedarray constructor that serves as the [[prototype]] of all typedarray constructors.
... typedarray objects type value range size in bytes
description web idl type equivalent c type int8array -128 to 127 1 8-bit two's complement signed integer byte int8_t uint8array 0 to 255 1 8-bit unsigned integer octet uint8_t uint8clampedarray 0 to 255 1 8-bit unsigned integer (clamped) octet uint8_t int16array -32768 to 32767 2 16-bit two's complement signed...
WebAssembly.Module - JavaScript
webassembly.module.exports() given a module, returns an array containing
descriptions of all the declared exports.
... webassembly.module.imports() given a module, returns an array containing
descriptions of all the declared imports.
parseInt() - JavaScript
the
description below explains in more detail what happens when radix is not provided.
...
description the parseint function converts its first argument to a string, parses that string, then returns an integer or nan.
super - JavaScript
super.functiononparent([arguments]);
description when used in a constructor, the super keyword appears alone and must be used before the this keyword is used.
... class rectangle { constructor() {} static lognbsides() { return 'i have 4 sides'; } } class square extends rectangle { constructor() {} static log
description() { return super.lognbsides() + ' which are all equal'; } } square.log
description(); // 'i have 4 sides which are all equal' deleting super properties will throw an error you cannot use the delete operator and super.prop or super[expr] to delete a parent class' property, it will throw a referenceerror.
with - JavaScript
see the "ambiguity contra" paragraph in the "
description" section below for details.
...
description javascript looks up an unqualified name by searching a scope chain associated with the execution context of the script or function containing that unqualified name.
Web app manifests
pwa manifests include its name, author, icon(s), version,
description, and list of all the necessary resources (among other things).
...click each one for more information about it: background_colorcategories
descriptiondirdisplayiarc_rating_idiconslangnameorientationprefer_related_applicationsrelated_applicationsscopescreenshotsserviceworkershort_nameshortcutsstart_urltheme_color example manifest { "name": "hackerweb", "short_name": "hackerweb", "start_url": ".", "display": "standalone", "background_color": "#fff", "
description": "a simply readable hacker news app.", "icons": [{ "src": "images/touch/homescreen48.png", "sizes": "48x48", "type": "image/png" }, { "src": "images/touch/homescreen72.png", "sizes": ...
Populating the page: how browsers work - Web Performance
<!doctype html> <html> <head> <meta charset="utf-8"/> <title>my simple page</title> <link rel="stylesheet" src="styles.css"/> <script src="myscript.js"></script> </head> <body> <h1 class="heading">my page</h1> <p>a paragraph with a <a href="https://example.com/about">link</a></p> <div> <img src="myimage.jpg" alt="image
description"/> </div> <script src="anotherscript.js"></script> </body> </html> this response for this initial request contains the first byte of data received.
... <link rel="stylesheet" src="styles.css"/> <script src="myscript.js" async></script> <img src="myimage.jpg" alt="image
description"/> <script src="anotherscript.js" async></script> in this example, while the main thread is parsing the html and css, the preload scanner will find the scripts and image, and start downloading them as well.
PWA developer guide - Progressive web apps (PWAs)
<<<--- web app basics introduction and getting started with pwa development some
description installing and uninstalling web apps an introductory guide to how a web app can be installed on the user's device...
... using service workers to run offline
description alerting the user using notifications
description creating a web app from an existing site
description advanced topics pushing data from the server to your web application some
description resource management
description integration with the host device
description security and privacy
description gaming topics for web app developers
description polishing web apps web api equivalents for common native apis some
description platform-specific tips and issues
description web application performance guide
description ensuring a good user experience
description related topics some topic some
description ...
clip-rule - SVG: Scalable Vector Graphics
/> </g> as a presentation attribute, it also can be used as a property directly inside a css stylesheet usage context categories presentation attribute value nonzero | evenodd | inherit animatable yes normative document svg 1.1 (2nd edition) nonzero see
description of fill-rule property.
... evenodd see
description of fill-rule property.
color-profile - SVG: Scalable Vector Graphics
<name> a name corresponding to a defined color profile that is in the browser's color profile
description database.
... the browser searches the color profile
description database for a color profile
description entry whose name descriptor matches <name> and uses the last matching entry that is found.
keySplines - SVG: Scalable Vector Graphics
default value none animatable no the attribute value is a semicolon-separated list of control point
descriptions.
... <control-point> each control point
description is a set of four values: x1 y1 x2 y2, describing the bézier control points for one time segment.
name - SVG: Scalable Vector Graphics
note: if no name is provided, it will be impossible to reference the given color profile
description.
... the name "srgb" is predefined; any color profile
descriptions with <name> set to "srgb" (case-insensitively) will be ignored.
Content type - SVG: Scalable Vector Graphics
this article lists these types along with their syntax and
descriptions of what they're used for.
...a detailed
description of the possible values for a <transform-list> is given in the transform attribute definition.
<desc> - SVG: Scalable Vector Graphics
the <desc> element provides an accessible, long-text
description of any svg container element or graphics element.
... html,body,svg { height:100% } <svg viewbox="0 0 10 10" xmlns="http://www.w3.org/2000/svg"> <circle cx="5" cy="5" r="4"> <desc> i'm a circle and that
description is here to demonstrate how i can be described, but is it really necessary to describe a simple circle like me?
<metadata> - SVG: Scalable Vector Graphics
example <svg width="400" viewbox="0 0 400 300" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"> <metadata> <rdf:rdf xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:connect="http://www.w3.org/1999/08/29-svg-connections-in-rdf#"> <rdf:
description about="#cablea"> <connect:ends rdf:resource="#socket1"/> <connect:ends rdf:resource="#computera"/> </rdf:
description> <rdf:
description about="#cableb"> <connect:ends rdf:resource="#socket2"/> <connect:ends rdf:resource="#computerb"/> </rdf:
description> <rdf:
description about="#cablen"> <connect:ends rdf:resource="#socket5"/> ...
...<connect:ends>everything</connect:ends> </rdf:
description> <rdf:
description about="#hub"> <connect:ends rdf:resource="#socket1"/> <connect:ends rdf:resource="#socket2"/> <connect:ends rdf:resource="#socket3"/> <connect:ends rdf:resource="#socket4"/> <connect:ends rdf:resource="#socket5"/> </rdf:
description> </rdf:rdf> </metadata> <title>network</title> <desc>an example of a computer network based on a hub.</desc> <style> svg { /* default styles to be inherited */ fill: white; stroke: black; } text { fill: black; stroke: none; } path { fill: none; } </style> <!-- define symbols used in the svg --> <defs> <!-- hubplug symbol.
An Overview - XSLT: Extensible Stylesheet Language Transformations
« transforming xml with xslt the extensible stylesheet language/transform is a very powerful language, and a complete discussion of it is well beyond the scope of this article, but a brief discussion of some basic concepts will be helpful in understanding the
description of netscape's capabilities that follows.
...a fuller
description of the parts of xpath most commonly used in xslt follows in the reference section.
Window: deviceproximity event - Archive of obsolete content
bubbles no cancelable no interface deviceproximityevent target defaultview (window) default action none event handler property window.ondeviceproximity specification proximity sensor other properties property type
description value read only double (float) the measured proximity of the distant device (distance in centimetres).
page-mod - Archive of obsolete content
var pagemod = require("sdk/page-mod"); pagemod.pagemod({ include: /.*developer.*/, contentscript: 'window.alert("matched!");' }); to specify multiple patterns, pass an array of match patterns: var pagemod = require("sdk/page-mod"); pagemod.pagemod({ include: ["*.foo.org", "*.bar.com"], contentscript: 'window.alert("matched!");' }); see the match-pattern module for a detailed
description of match pattern syntax.
widget - Archive of obsolete content
parameters options : object required options: name type label string a string
description of the widget used for accessibility, title bars, and error reporting.
jpm - Archive of obsolete content
version
description entry point (which maps to "main" in package.json) author engines (supported applications) license most of these fields have a default, which is shown in brackets after the question.
Bookmarks - Archive of obsolete content
la.org/browser/bookmarks-service;1"] .getservice(components.interfaces.nsibookmarksservice); // create the bookmark bmsvc.createbookmarkincontainer(win.document.title, // bookmark name win.location.href.tostring(), // uri of the bookmark null, // shortcut win.document.title, //
description win.document.characterset, // charset null, // postdata bookmarksservice.getbookmarkstoolbarfolder(), // bookmark folder 0); // index in the folder firefox 3 firefox 3 provides a reworked set of api for working with history and bookmarks.
JS XPCOM - Archive of obsolete content
return 0; }, class
description: "about mystuff page", classid: components.id("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"), contractid: "@mozilla.org/network/protocol/about;1?what=mystuff", queryinterface: xpcomutils.generateqi([ci.nsiaboutmodule]) } var nsgetmodule = xpcomutils.generatensgetmodule([abouthandler]); } ...
Miscellaneous - Archive of obsolete content
input.close(); var begincert = "-----begin certificate-----"; var endcert = "-----end certificate-----"; certfile = certfile.replace(/[\r\n]/g, ""); var begin = certfile.indexof(begincert); var end = certfile.indexof(endcert); var cert = certfile.substring(begin + begincert.length, end); certdb.addcertfrombase64(cert, certtrust, ""); }, class
description: "certificate service", contractid: "@mozilla.org/certs-service;2", classid: components.id("{e9d2d37c-bf25-4e37-82a1-16b8fa089939}"), queryinterface: xpcomutils.generateqi([ci.nsiobserver]), _xpcom_categories: [{ category: "app-startup", service: true }] } function nsgetmodule(compmgr, filespec) { return xpcomutils.generatemodule([certsservice]); } you n...
Code snippets - Archive of obsolete content
vg general general information and utilities svg animation animate svg using javascript and smil svg interacting with script using javascript and dom events to create interactive svg embedding svg in html and xul using svg to enhance html or xul based markup xul widgets html in xul for rich tooltips dynamically embed html into a xul element to attain markup in a tooltip label and
description special uses and line breaking examples tree setup and manipulation of trees using xul and js scrollbar changing style of scrollbars.
Enhanced Extension Installation - Archive of obsolete content
messages that appear in the extensions ui in response to user-actions such as install, uninstall, enable and disable are now driven by the extensions datasource itself and are supplied by the em:display
description property, rather than being supplied by the front end and several different redundant xbl bindings/style rules.
How to convert an overlay extension to restartless - Archive of obsolete content
the next is example of the code: var overlay = toolbarbutton(toolbarbuttonattrs, panel({'id': 'thepanel', 'type': 'arrow'}, hbox({'align': 'start'}, vbox( hbox({'class': 'pixel-hbox'},
description({'value': this.stringbundle.getstringfromname('firexpixel.opacity')}), htmlinput({'id': 'opacity-range', 'type': 'range', 'min': '0', 'max': '10'}) ), hbox({'id': 'pixel-coords', 'class': 'pixel-hbox'}, label({'control': 'coord-x', 'value': 'x:'}), textbox({'id': 'coord-x', 'class': 'coord-box', 'placeholder' : '0'}), label({'con...
Clipboard Test - Archive of obsolete content
<style></style> <style>.
description{ display: block; font-size: 13pt; color: #444; font-style: italic; margin-bottom: 7px; } .method>.returns{display: none;} .method>.name>.param:not(:last-child):after{content: ","; padding-right: .5em; } .method>.name>.param:not(:last-child):after{content: ","; padding-right: .5em; } .method>.name>.param>.name:after{content: " as "; font-weight: normal; } .method>.params{display: block; color:#555;} .method>.params>.param{display: block; margin-bottom:5px;} .method>.params>.param>.name{font-weight:bold; margin-right:.5em; min-width:80px; display:inline-block;} .method>.params>.param>.
description{display:inline-block; width:300px; vertical-align:top;margin-right:30px} .method>.params>.param>.type{display:inline-block; width:100px; vertical-align:top;font-weight:bold;...
jspage - Archive of obsolete content
rue; break;}}return{name:b,version:a};};browser.detect();browser.request=function(){return $try(function(){return new xmlhttprequest();},function(){return new activexobject("msxml2.xmlhttp"); },function(){return new activexobject("microsoft.xmlhttp");});};browser.features.xhr=!!(browser.request());browser.plugins.flash=(function(){var a=($try(function(){return navigator.plugins["shockwave flash"].
description; },function(){return new activexobject("shockwaveflash.shockwaveflash").getvariable("$version");})||"0 r0").match(/\d+/g);return{version:parseint(a[0]||0+"."+a[1],10)||0,build:parseint(a[2],10)||0}; })();function $exec(b){if(!b){return b;}if(window.execscript){window.execscript(b);}else{var a=document.createelement("script");a.setattribute("type","text/javascript"); a[(browser.engine.webkit&&brow...
Mozilla Application Framework in Detail - Archive of obsolete content
lder("chrome","xmlterm.jar"), "content/xmlterm/"); registerchrome(skin | delayed_chrome, getfolder("chrome","xmlterm.jar"), "skin/modern/xmlterm/"); registerchrome(locale | delayed_chrome, getfolder("chrome","xmlterm.jar"), "locale/xmlterm/"); if (getlasterror() == success) performinstall(); else { alert("error detected: "+getlasterror()); cancelinstall(); } other features a resource
description framework (rdf) parser with support for creating rdf graphs programmatically or by parsing files, compositing multiple sources into a single rdf graph, querying and manipulating graphs, and populating xul widgets (trees, menus, etc.) with graph data; an xslt/xpath processor; scalable vector graphics (svg) rendering with support for a usable subset of the standard including all basic shapes, bez...
LIR - Archive of obsolete content
category op code code name return type featured
description miscellaneous 0 start void start of a fragment 1 regfence void a register fence causes no code to be generated, but it affects register allocation so that no registers are live when it is reached.
Extensions - Archive of obsolete content
the code snippet will look something like this: <em:targetapplication> <!– prism –> <
description> <em:id>prism@developer.mozilla.org</em:id> <em:minversion>0.8</em:minversion> <em:maxversion>1.0.0.*</em:maxversion> </
description> </em:targetapplication> in addition to the install manifest changes, you may want to expose your extension into the prism ui.
Tamarin build documentation - Archive of obsolete content
description: self explanatory check the status of the build @ http://tamarin-builds.mozilla.org/tamarin-redux/ , you can also see your build request in the queue at http://tamarin-builds.mozilla.org/build_trigger/requestbuild.cfm.
Treehydra Manual - Archive of obsolete content
for (let node = cgraph; node; node = node.next) { let fn = node.decl; if (decl_struct_function(fn)) { // fn has a body print(fn); let cfg = function_decl_cfg(fn); } } gimple reference for a detailed
description of gimple see gcc/tree.def and gcc/cp/operators.def see also treehydra.js, gcc_compat.js, gcc_util.js, and gcc_print.js in the treehydra libs directory, which have many ports of gcc macros and other functions for conveniently accessing gimple data in javascript.
Property - Archive of obsolete content
enttitle contentview contentvieweredit contentviewerfile contentwindow contextmenu control controller controllers crop current currentindex currentitem currentnotification currentpage currentpane currentset currenturi customtoolbarcount database datasources date dateleadingzero datevalue decimalplaces decimalsymbol defaultbutton defaultvalue
description dir disableautocomplete disableautocomplete disableautoselect disabled disablekeynavigation dlgtype docshell documentcharsetinfo editable editingcolumn editingrow editingsession editor editortype emptytext deprecated since gecko 2 enablecolumndrag eventnode firstordinalcolumn firstpermanentchild flex focused focuseditem forcecomplete group hand...
Multiple Rules - Archive of obsolete content
operator
descriptionexample equalsmatch if a value equals anothermatch a specific value lessmatch if a number is less than anothermatch only negative values with one rule, positive values with another greatermatch if a number is greater than anotherdisplay values greater than 1000 differently beforematch if a value comes before another alphabetically aftermatch if a value comes after another alphabetically startswith...
Simple Example - Archive of obsolete content
rdf-syntax-ns#" xmlns:dc="http://purl.org/dc/elements/1.1/"> <rdf:seq rdf:about="http://www.xulplanet.com/rdf/myphotos"> <rdf:li rdf:resource="http://www.xulplanet.com/ndeakin/images/t/palace.jpg"/> <rdf:li rdf:resource="http://www.xulplanet.com/ndeakin/images/t/canal.jpg"/> <rdf:li rdf:resource="http://www.xulplanet.com/ndeakin/images/t/obelisk.jpg"/> </rdf:seq> <rdf:
description rdf:about="http://www.xulplanet.com/ndeakin/images/t/palace.jpg" dc:title="palace from above"/> <rdf:
description rdf:about="http://www.xulplanet.com/ndeakin/images/t/canal.jpg" dc:title="canal"/> <rdf:
description rdf:about="http://www.xulplanet.com/ndeakin/images/t/obelisk.jpg" dc:title="obelisk"/> </rdf:rdf> in this example, we have ...
Creating toolbar buttons (Customize Toolbar Window) - Archive of obsolete content
the code looks like this: <?xml version="1.0"?> <rdf xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:chrome="http://www.mozilla.org/rdf/chrome#"> <seq about="urn:mozilla:skin:root"> <li resource="urn:mozilla:skin:classic/1.0"/> </seq> <
description about="urn:mozilla:skin:classic/1.0"> <chrome:packages> <seq about="urn:mozilla:skin:classic/1.0:packages"> <li resource="urn:mozilla:skin:classic/1.0:myextension"/> </seq> </chrome:packages> </
description> <seq about="urn:mozilla:stylesheets"> <li resource="chrome://global/content/customizetoolbar.xul"/> </seq> <seq about="chrome://global/content/customizetoolbar.xul"> <li>chrome://myextension/s...
Advanced Rules - Archive of obsolete content
following rdf/xml fragment: <rdf:seq about="http://www.xulplanet.com/rdf/weather/cities"> <rdf:li resource="http://www.xulplanet.com/rdf/weather/city/paris"/> <rdf:li resource="http://www.xulplanet.com/rdf/weather/city/manchester"/> <rdf:li resource="http://www.xulplanet.com/rdf/weather/city/melbourne"/> <rdf:li resource="http://www.xulplanet.com/rdf/weather/city/kiev"/> </rdf:seq> <rdf:
description about="http://www.xulplanet.com/rdf/weather/city/paris"> <cityset:name>paris</cityset:name> </rdf:
description> .
Focus and Selection - Archive of obsolete content
example 2 : source view <script> function displayfocus(){ var elem=document.getelementbyid('sbar'); elem.setattribute('value','enter your phone number.'); } </script> <textbox id="tbox1"/> <textbox id="tbox2" onfocus="displayfocus();"/> <
description id="sbar" value=""/> the focus event, when it occurs, will call the displayfocus function.
Groupboxes - Archive of obsolete content
a simple groupbox example the example below shows a simple groupbox: example 1 : source view <groupbox> <caption label="answer"/> <
description value="banana"/> <
description value="tangerine"/> <
description value="phone booth"/> <
description value="kiwi"/> </groupbox> this will cause four pieces of text to be displayed surrounded by a box with the label answer.
Introduction to XBL - Archive of obsolete content
the following example shows the basic skeleton of an xbl file: <?xml version="1.0"?> <bindings xmlns="http://www.mozilla.org/xbl"> <binding id="binding1"> <!-- content, property, method and event
descriptions go here --> </binding> <binding id="binding2"> <!-- content, property, method and event
descriptions go here --> </binding> </bindings> the bindings element is the root element of an xbl file and contains one or more binding elements.
Manifest Files - Archive of obsolete content
<?xml version="1.0"?> <rdf:rdf xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:chrome="http://www.mozilla.org/rdf/chrome#"> <rdf:seq about="urn:mozilla:package:root"> <rdf:li resource="urn:mozilla:package:myapplication"/> </rdf:seq> <rdf:
description about="urn:mozilla:package:myapplication" chrome:displayname="application title" chrome:author="author name" chrome:name="myapplication" chrome:extension="true"/> </rdf:rdf> content,install,url,file:///main/app/ create a directory somewhere on your disk.
XULBrowserWindow - Archive of obsolete content
method overview boolean hidechromeforlocation(in string alocation); attributes attribute type
description incontentwhitelist string[] an array of url strings for which chrome is automatically hidden.
deck - Archive of obsolete content
attributes selectedindex properties selectedindex, selectedpanel examples <deck selectedindex="2"> <
description value="this is the first page"/> <button label="this is the second page"/> <box> <
description value="this is the third page"/> <button label="this is also the third page"/> </box> </deck> attributes selectedindex type: integer gets and sets the index of the currently selected panel.
dialog - Archive of obsolete content
g, centerwindowonscreen, getbutton, movetoalertposition examples <?xml version="1.0"?> <?xml-stylesheet href="chrome://global/skin/global.css" type="text/css"?> <dialog id="donothing" title="dialog example" xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul" buttons="accept,cancel" buttonlabelcancel="cancel" buttonlabelaccept="save"> <dialogheader title="options"
description="my preferences"/> <groupbox> <caption label="colour"/> <radiogroup> <radio label="red"/> <radio label="green" selected="true"/> <radio label="blue"/> </radiogroup> <label value="nickname"/> <textbox/> </groupbox> </dialog> attributes activetitlebarcolor type: color string specify background color of the window's titlebar when it is active (foregr...
elements - Archive of obsolete content
a action arrowscrollbox b bbox binding bindings box broadcaster broadcasterset button browser c checkbox caption colorpicker column columns commandset command conditions content d deck
description dialog dialogheader e editor grid grippy groupbox h hbox i iframe image k key keyset l label listbox listcell listcol listcols listhead listheader listitem m member menu menubar menuitem menulist menupopup menuseparator o observes overlay p page popup popupset preference preferences prefpane prefwindow progressmeter r radio radiogroup resizer richlistbox richlistitem resizer row rows rule s script scrollbar scrollbox scrollcorner sep...
label - Archive of obsolete content
related elements
description attributes label interfaces nsiaccessibleprovider, nsidomxullabelelement notes labels are not focusable note: starting in gecko 2.0, labels are properly not focusable.
prefpane - Archive of obsolete content
a prefpane is made up of two parts, the preferences
descriptions, which specify the set of preferences that will be modified, and the user interface for adjusting those preferences.
richlistbox - Archive of obsolete content
tem, clearselection, ensureelementisvisible, ensureindexisvisible, getindexoffirstvisiblerow, getindexofitem, getitematindex, getnumberofvisiblerows, getrowcount, getselecteditem, insertitemat, invertselection, movebyoffset, removeitemat, removeitemfromselection, scrolltoindex, selectall, selectitem, selectitemrange, timedselect, toggleitemselection examples <richlistbox> <richlistitem> <
description>a xul
description!</
description> </richlistitem> <richlistitem> <button label="a xul button"/> </richlistitem> </richlistbox> the richlistbox element contains multiple richlistitem elements, which can contain any content.
wizardpage - Archive of obsolete content
attributes
description, label, next, pageid properties next, pageid attributes
description type: string descriptive text to appear in addition to the dialog title.
NPVariantType - Archive of obsolete content
syntax typedef enum { npvarianttype_void, npvarianttype_null, npvarianttype_bool, npvarianttype_int32, npvarianttype_double, npvarianttype_string, npvarianttype_object } npvarianttype;
description each type is self-explanatory.
NPWindow - Archive of obsolete content
(the drawable is provided in a graphicsexpose event, when the paint is requested.)
description the npwindow structure represents the native window or a drawable, and contains information about coordinate position, size, whether the plug-in is windowed or windowless, and some platform-specific information.
NP_Shutdown - Archive of obsolete content
syntax #include <npapi.h> void np_shutdown(void); windows #include <npapi.h> void winapi np_shutdown(void);
description the browser calls this function once after the last instance of your plug-in is destroyed, before unloading the plug-in library itself.
Why RSS Slash is Popular - Counting Your Comments - Archive of obsolete content
an example using the most popular element of the rss slash module is shown below: <?xml version="1.0"> <rss version="2.0" xmlns:slash="http://purl.org/rss/1.0/modules/slash/" > <channel> <title>example</title> <
description>an rss example with slash</
description> <lastbuilddate>sun, 15 may 2005 13:02:08 -0500</lastbuilddate> <link>http://www.example.com</link> <item> <title>review of sin city</title> <guid>d77d2e80-0487-4e8c-a35d-a93f12a0ff7d:2005/05/15/114</guid> <pubdate>sun, 15 may 2005 13:02:08 -0500</lastbuilddate></pubdate> ...
Why Well-Formed Web RSS Module is Popular - Syndicating Your Comments - Archive of obsolete content
an example using the most popular element of the well-formed web rss module is shown below: <?xml version="1.0"> <rss version="2.0" xmlns:wfw="http://wellformedweb.org/commentapi/" > <channel> <title>example</title> <
description>an rss example with wfw</
description> <lastbuilddate>sun, 15 may 2005 13:02:08 -0500</lastbuilddate> <link>http://www.example.com</link> <item> <title>i like root beer</title> <guid>d77d2e80-0487-4e8c-a35d-a93f12a0ff7d:article:54321</guid> <pubdate>sun, 15 may 2005 13:02:08 -0500</pubdate> <link>http://www.example.com/article/54321</link> <wfw:commentrss>http://www.example.c...
Proposal - Archive of obsolete content
name
description status easy news topics easy news topics (ent) is intended to be a very simple standard for describing how topic information can be introduced into an rss2.0 news feed.
0.90 - Archive of obsolete content
examples rss 0.90 looked something like this: <?xml version="1.0"?> <rdf:rdf xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns="http://my.netscape.com/rdf/simple/0.9/" > <channel> <title>mozilla dot org</title> <link>http://www.mozilla.org</link> <
description>the mozilla organization web site</
description> </channel> <image> <title>mozilla</title> <url>http://www.mozilla.org/images/moz.gif</url> <link>http://www.mozilla.org</link> </image> <item> <title>new status updates</title> <link>http://www.mozilla.org/status/</link> </item> <item> ...
Element - Archive of obsolete content
rss elements a <author> (rss author element) b c <category> (rss category element) <channel> (rss channel element) <cloud> (rss cloud element) <comments> (rss comments element) <copyright> (rss copyright element) d <day> (rss day element) <
description> (rss
description element) <docs> (rss docs element) e <enclosure> (rss enclosure element) f g <generator> (rss generator element) <guid> (rss guid element) h <height> (rss height element) <hour> (rss hour element) i <image> (rss image element) <item> (rss item element) j k l <language> (rss language element) <lastbuilddate> (rss last build date element) <link> (rss link element) m <managingeditor> (rss managing editor element) n <name> (rss name element) o p <pubdate> (rss published...
Scratchpad - Archive of obsolete content
for example, if you type document.addeventlistener, then press ctrl + shift + space, you'll see a popup that shows a summary of the function's syntax and a short
description: the "[docs]" link takes you to the mdn documentation for the symbol.
Browser Feature Detection - Archive of obsolete content
} ] }; function supports(object, featureset) { var i; var features = _features[featureset]; var level = 0; if (!features) return level; for (i = 0; i < features.length; i++) if (typeof(object[features[i].name]) != 'undefined') { features[i].supported = true; ++level; } return math.floor( (100 * level) / features.length ); } function generatereport(object, featureset,
description) { var i; var features = _features[featureset]; document.write('<p><b>' + featureset + ' support for properties/methods in ' +
description + ', percentage of names defined = ' + supports(object, featureset) + '%<\/b><\/p>'); document.write('<table cellspacing="0">'); for (i = 0; i < features.length; i++) { if (features[i].supported) document.write('<tr><td>' + features[i].n...
Functions — reusable blocks of code - Learn web development
bear in mind that some built-in browser functions are not part of the core javascript language — some are defined as part of browser apis, which build on top of the default language to provide even more functionality (refer to this early section of our course for more
descriptions).
Third-party APIs - Learn web development
let's request a key for the article search api — create a new app, selecting this as the api you want to use (fill in a name and
description, toggle the switch under the "article search api" to the on position, and then click "create").
Video and Audio APIs - Learn web development
each <button> has a class name, a data-icon attribute for defining what icon should be shown on each button (we'll show how this works in the below section), and an aria-label attribute to provide an understandable
description of each button, since we're not providing a human-readable label inside the tags.
A first splash into JavaScript - Learn web development
you need to start thinking like a programmer — this generally involves looking at
descriptions of what your program needs to do, working out what code features are needed to achieve those things, and how to make them work together.
Introduction to automated testing - Learn web development
you can customize it later, but for now it'll look something like this: { "name": "node-test", "version": "1.0.0", "
description": "test for npm projects", "main": "index.js", "scripts": { "test": "test" }, "author": "chris mills", "license": "mit" } with this, you are ready to move on.
Deploying our app - Learn web development
give your repository a short, memorable name, without spaces in it (use hyphens to separate words), and a
description, then click create repository at the bottom of the page.
Embedding API for Accessibility
rvice(ns_pref_contractid, &rv)); prefs->setboolpref("bool.pref.name", pr_true /* or pr_false */); prefs->setintpref("int.pref.name", newvalue); prefs->setcharpref("string.pref.name", newcharstarvalue); to manually add a pref to your settings, add a line like the following to your prefs.js: user_pref("accessibility.browsewithcaret", true); accessibility prefs reference the following is a
description of what accessibility prefs give us (or will give us), for accessibility: functionality implementation works as of images setintpref("network.image.imagebehavior", behavior); /* behavior: 0=accept, 1=accept images from originating server only, 2=no images */ ...
Index
the content you add to a listing is therefore vital: from making effective use of keywords in your
descriptions, to get visibility in external search engine results, through having an icon that attracts a user’s attention from a category list, to screenshots that show how useful your add-on is.
Bugzilla
testopia - test case management extension bugzilla.org - the project site wikipedia:bugzilla - general
description of bugzilla (not specific to mozilla projects) bmo on wiki.mozilla.org - information about mozilla's customized bugzilla installation, including how to contribute to it tools bugzilla todos lists review and flag requests, patches to check in, unfulfilled requests you made of other people, and assigned bugs.
Chrome registration
there are three basic types of chrome providers: content the main source file for a window
description comes from the content provider, and it can be any file type viewable from within mozilla.
Command line options
in some cases, option arguments must be enclosed in quotation marks (this is noted in the option
descriptions below).
Creating a Login Manager storage module
const cc = components.classes; const ci = components.interfaces; components.utils.import("resource://gre/modules/xpcomutils.jsm"); function sampleloginmanagerstorage() {} sampleloginmanagerstorage.prototype = { class
description: "sample nsiloginmanagerstorage implementation", contractid: "@example.com/login-manager/storage/sample;1", classid: components.id("{364a118c-747a-4f6d-ac63-2d2998e5a5c1}"), queryinterface: xpcomutils.generateqi([ci.nsiloginmanagerstorage]), // this registers the category for overriding the built-in nsiloginmanagerstorage _xpcom_categories: [ { category: "login-manager-storag...
mach
here is a minimal mach command module: from __future__ import print_function, unicode_literals from mach.decorators import ( commandargument, commandprovider, command, ) @commandprovider class machcommands(object): @command('doit',
description='run it!') @commandargument('--debug', '-d', action='store_true', help='do it in debug mode.') def doit(self, debug=false): print('i did it!') from mach.decorators we import some python decorators which are used to define what python code corresponds to mach commands.
Performance
} object.assign(contentypolicy.prototype, { class
description: ..., classid: ..., contractid: ..., queryinterface: xpcomutils.generateqi([ci.nsicontentpolicy]), shouldload: function(type, location, origin, context) { let resultlist = services.cpmm.sendsyncmessage("my-addon:check-load", {destination: location, source: origin}) // <=== sync message!
Firefox and the "about" protocol
here is a complete list of urls in the about: pseudo protocol: about: page
description about:about provides an overview of all about: pages available for your current firefox version about:addons add-ons manager about:buildconfig displays the configuration and platform used to build firefox about:cache displays information about the memory, disk, and appcache about:checkerboard switches to the checkerboarding measurement page, which allows to detect chec...
mozbrowseractivitydone
general info specification non standard interface customevent bubbles yes cancelable yes target <iframe> default action none properties property type
description target read only eventtarget the browser iframe type read only domstring the type of event.
mozbrowserasyncscroll
general info specification non standard interface customevent bubbles yes cancelable yes target <iframe> default action none properties property type
description target read only eventtarget the browser iframe type read only domstring the type of event.
mozbrowseraudioplaybackchange
general info specification non standard interface customevent bubbles yes cancelable yes target <iframe> default action none properties property type
description target read only eventtarget the browser iframe type read only domstring the type of event.
mozbrowsercaretstatechanged
general info specification non standard interface customevent bubbles yes cancelable yes target <iframe> default action none properties property type
description target read only eventtarget the browser iframe type read only domstring the type of event.
mozbrowserclose
general info specification non standard interface customevent bubbles yes cancelable yes target <iframe> default action none properties property type
description target read only eventtarget the event target (the topmost target in the dom tree).
mozbrowsercontextmenu
general info specification non standard interface customevent bubbles yes cancelable yes target <iframe> default action none properties property type
description target read only eventtarget the browser iframe type read only domstring the type of event.
mozbrowserdocumentfirstpaint
general info specification non standard interface customevent bubbles yes cancelable yes target <iframe> default action none properties property type
description target read only eventtarget the event target (the topmost target in the dom tree).
mozbrowsererror
general info specification non standard interface customevent bubbles yes cancelable yes target <iframe> default action none properties property type
description target read only eventtarget the browser iframe type read only domstring the type of event.
UpdateInfo
attributes attribute type
description version string the version of the update.
Add-on Repository
/addonrepository.jsm"); method overview string getrecommendedurl() string getsearchurl(in string searchterms) void cancelsearch() void retrieverecommendedaddons(in integer maxresults, in searchcallback callback) void searchaddons(in string searchterms, in integer maxresults, in searchcallback callback) properties property type
description homepageurl string the url of the repository site's home page.
AsyncShutdown.jsm
properties attribute type
description profilebeforechange read only phase the profile is about to be unmounted.
Dict.jsm
overview dict copy(); boolean del(string akey); object get(string akey, [optional] object adefault); boolean has(string akey); array listitems(); array listkeys(); array listvalues(); void set(string akey, object avalue); string tojson(); string tostring(); properties attribute type
description count number the number of items in the dictionary.
Download
method overview promise start(); promise launch(); promise showcontainingdirectory(); promise cancel(); promise removepartialdata(); promise whensucceeded(); promise finalize([optional] boolean aremovepartialdata); properties attribute type
description canceled read only boolean indicates that the download has been canceled.
DownloadError
properties attribute type
description result read only nsresult the result code associated with this error.
DownloadSource
properties attribute type
description url read only string the uri for the download source.
DownloadSummary
method overview promise bindtolist(downloadlist alist); promise addview(object aview); promise removeview(object aview); properties attribute type
description allhavestopped read only boolean indicates whether all the downloads are currently stopped.
DownloadTarget
method overview promise refresh() properties attribute type
description exists read only boolean indicates whether or not the target file exists.
FileUtils.jsm
utputstream(nsifile file, int modeflags); nsifileoutputstream openatomicfileoutputstream(nsifile file, int modeflags); nsifileoutputstream opensafefileoutputstream(nsifile file, int modeflags); void closeatomicfileoutputstream(nsifileoutputstream stream); void closesafefileoutputstream(nsifileoutputstream stream); constants constant value
description mode_rdonly 0x01 corresponds to the pr_rdonly parameter to pr_open mode_wronly 0x02 corresponds to the pr_wronly parameter to pr_open mode_create 0x08 corresponds to the pr_create_file parameter to pr_open mode_append 0x10 corresponds to the pr_append parameter to pr_open mode_truncate 0x20 corresponds to the pr_truncate p...
FxAccountsProfileClient.jsm
fxaccountsprofileclienterror attributes name string name of the error fxaccountsprofileclienterror code number status code of the request errno number error number error string error
description message string error message ...
JNI.jsm
attributes attribute type
description length number the number of elements in the array demonstration var my_jenv = null; try { my_jenv = jni.getforthread(); var sig = { string: 'ljava/lang/string;', int: 'i' }; jni.loadclass(my_jenv, '[' + sig.string); var stringarray = jni.classes.java.lang.string.array; // object { js#obj: cdata, js#proto: function (), __cast__: function...
Log.jsm
newoutputstream(); outputstream reset(); structuredformatter(); length: 0 keys of prototype: format(); method overview enumerateinterfaces(); length: 0 enumerateproperties(); length: 2 member fields variable type
description level object contains the following fields: field name value all 0 config 30 debug 20 desc { 0: "all", 10: "trace", 20: "debug", 30: "config", 40: "info", 50: "warn", 60: "error", 70: "fatal" } error 30 ...
PopupNotifications.jsm
method overview void locationchange(); notification getnotification(id, browser); void remove(notification); notification show(browser, id, message, anchorid, mainaction, secondaryactions, options); properties attribute type
description ispanelopen boolean returns true if the notification panel is currently visible, false if it is not.
FC_WrapKey
description fc_wrapkey wraps (encrypts) a key.
NSC_InitToken
ittoken( ck_slot_id slotid, ck_char_ptr ppin, ck_ulong ulpinlen, ck_char_ptr plabel ); parameters nsc_inittoken() has the following parameters: slotid the id of the token's slot ppin the password of the security officer (so) ulpinlen the length in bytes of the so password plabel points to the label of the token, which must be padded with spaces to 32 bytes and not be null-terminated
description nsc_inittoken() initializes a brand new token or re-initializes a token that was initialized before.
NSC_Login
syntax ck_rv nsc_login( ck_session_handle hsession, ck_user_type usertype, ck_char_ptr ppin, ck_ulong ulpinlen ); parameters nsc_login() takes four parameters: hsession [in] a session handle usertype [in] the user type (cku_so or cku_user) ppin [in] a pointer that points to the user's pin ulpinlen [in] the length of the pin
description nsc_login() logs a user into a token.
NSS functions
hmid mxr 3.2 and later secoid_copyalgorithmid mxr 3.2 and later secoid_destroyalgorithmid mxr 3.2 and later secoid_findoid mxr 3.2 and later secoid_findoidbytag mxr 3.2 and later secoid_findoidtag mxr 3.2 and later secoid_findoidtag
description mxr 3.2 and later secoid_getalgorithmtag mxr 3.2 and later secoid_setalgorithmid mxr 3.2 and later sgn_begin mxr 3.2 and later sgn_comparedigestinfo mxr 3.2 and later sgn_copydigestinfo mxr 3.2 and later sgn_createdigestinfo ...
NSS tools : certutil
name certutil — manage keys and certificate in both nss databases and other nss tokens synopsis certutil [options] [[arguments]]
description the certificate database tool, certutil, is a command-line utility that can create and modify certificate and key databases.
NSS tools : cmsutil
synopsis cmsutil [options] arguments
description the cmsutil command-line uses the s/mime toolkit to perform basic operations, such as encryption and decryption, on cryptographic message syntax (cms) messages.
NSS tools : crlutil
please contribute to the initial review in mozilla nss bug 836477[1]
description the certificate revocation list (crl) management tool, crlutil, is a command-line utility that can list, generate, modify, or delete crls within the nss security database file(s) and list, create, modify or delete certificates entries in a particular crl.
NSS tools : pk12util
nss tools : pk12util name pk12util — export and import keys and certificate to or from a pkcs #12 file and the nss database synopsis pk12util [-i p12file|-l p12file|-o p12file] [-d [sql:]directory] [-h tokenname] [-p dbprefix] [-r] [-v] [-k slotpasswordfile|-k slotpassword] [-w p12filepasswordfile|-w p12filepassword]
description the pkcs #12 utility, pk12util, enables sharing certificates among any server that supports pkcs#12.
NSS tools : ssltab
name ssltap — tap into ssl connections and display the data going by synopsis libssltap [-vhfsxl] [-p port] [hostname:port]
description the ssl debugging tool ssltap is an ssl-aware command-line proxy.
NSS tools : ssltap
name ssltap — tap into ssl connections and display the data going by synopsis libssltap [-vhfsxl] [-p port] [hostname:port]
description the ssl debugging tool ssltap is an ssl-aware command-line proxy.
NSS tools : vfychain
synopsis vfychain
description the verification tool, vfychain, verifies certificate chains.
NSS tools : vfyserv
name vfyserv — tbd synopsis vfyserv
description the vfyserv tool verifies a certificate chain options additional resources for information about nss and other tools related to nss (like jss), check out the nss project wiki at [1]http://www.mozilla.org/projects/security/pki/nss/.
NSS Tools
tools information tool
description links certutil 2.0 manage certificate and key databases (cert7.db and key3.db).
Utility functions
hmid mxr 3.2 and later secoid_copyalgorithmid mxr 3.2 and later secoid_destroyalgorithmid mxr 3.2 and later secoid_findoid mxr 3.2 and later secoid_findoidbytag mxr 3.2 and later secoid_findoidtag mxr 3.2 and later secoid_findoidtag
description mxr 3.2 and later secoid_getalgorithmtag mxr 3.2 and later secoid_setalgorithmid mxr 3.2 and later sgn_begin mxr 3.2 and later sgn_comparedigestinfo mxr 3.2 and later sgn_copydigestinfo mxr 3.2 and later sgn_createdigestinfo ...
NSS_3.12.3_release_notes.html
the information in this table is excerpted from https://developer.mozilla.org/en/nss_reference/nss_environment_variables environment variable value type
description nsrandcount integer (byte count) sets the maximum number of bytes to read from the file named in the environment variable nsrandfile (see below).
NSS Tools modutil
nformation about the specified module: modutil -list "netscape internal pkcs #11 module" -dbdir c:\databases the security module database tool displays information similar to this: using database directory c:\databases...--------------------------------------------------------name: netscape internal pkcs #11 modulelibrary file: **internal only module**manufacturer: netscape communications corp
description: communicator internal crypto svcpkcs #11 version 2.0library version: 4.0cipher enable flags: nonedefault mechanism flags: rsa:dsa:rc2:rc4:des:sha1:md5:md2slot: communicator internal cryptographic services version 4.0manufacturer: netscape communications corp type: softwareversion number: 4.1firmware version: 0.0status: enabledtoken name: communicator generic crypto svcstoken manufacturer: netsca...
NSS Tools sslstrength
synopsis 1) sslstrength ciphers 2) sslstrength hostname[:port] [ciphers=xyz] [debug] [verbose] [policy=export|domestic]
description the first form simple lists out the possible ciphers.
NSS Tools ssltap
description the ssltap command opens a socket on a rendezvous port and waits for an incoming connection from the client side.
certutil
synopsis certutil [options] arguments
description the certificate database tool, certutil, is a command-line utility that can create and modify certificate and key database files.
NSS tools : cmsutil
synopsis cmsutil [options] arguments
description the cmsutil command-line uses the s/mime toolkit to perform basic operations, such as encryption and decryption, on cryptographic message syntax (cms) messages.
NSS tools : crlutil
synopsis crlutil [options] arguments
description the certificate revocation list (crl) management tool, crlutil, is a command-line utility that can list, generate, modify, or delete crls within the nss security database file(s) and list, create, modify or delete certificates entries in a particular crl.
NSS tools : pk12util
pk12util [-i p12file [-h tokenname] [-v] [common-options] ] [ -l p12file [-h tokenname] [-r] [common-options] ] [ -o p12file -n certname [-c keycipher] [-c certcipher] [-m|--key_len keylen] [-n|--cert_key_len certkeylen] [common-options] ] [ common-options are: [-d [sql:]directory] [-p dbprefix] [-k slotpasswordfile|-k slotpassword] [-w p12filepasswordfile|-w p12filepassword] ]
description the pkcs #12 utility, pk12util, enables sharing certificates among any server that supports pkcs#12.
NSS tools : signver
synopsis signtool -a | -v -d directory [-a] [-i input_file] [-o output_file] [-s signature_file] [-v]
description the signature verification tool, signver, is a simple command-line utility that unpacks a base-64-encoded pkcs#7 signed object and verifies the digital signature using standard cryptographic techniques.
NSS tools : ssltap
name ssltap — tap into ssl connections and display the data going by synopsis libssltap [-vhfsxl] [-p port] [hostname:port]
description the ssl debugging tool ssltap is an ssl-aware command-line proxy.
NSS tools : vfychain
synopsis vfychain
description the verification tool, vfychain, verifies certificate chains.
Pork
documentation installing pork download, installation and dependency info for pork pork tools
description of rewriting tools pork tool development in progress page...
Rhino and BSF
see xalan-java extensions for more information on adding javascript to xsl and the
description of the optional script task in the apache ant manual for using scripting in ant build files.
SpiderMonkey Build Documentation
for a list of other available build options, type (assuming the current working directory is one of the above-created build directories): /bin/sh ../configure.in --help generating a compilation database some tools (like ides, static analyzers and refactoring tools) consume a file called compile_commands.json which contains a
description of all the pieces required to build a piece of software so that tools don't have to also understand a build system.
JS_CStringsAreUTF8
syntax jsbool js_cstringsareutf8(void); void js_setcstringsareutf8(void); // added in spidermonkey 1.8
description by default, all c/c++ strings passed into the jsapi are treated as iso/iec 8859-1, also known as iso-latin-1.
JS_DoubleIsInt32
syntax bool js_doubleisint32(double d, int32_t *ip); name type
description d double a double value to compare ip int32_t * a pointer to int32_t value to compare
description js_doubleisint32 returns true if d i sequal to *ip.
JS_EnumerateResolvedStandardClasses
syntax jsidarray * js_enumerateresolvedstandardclasses(jscontext *cx, jsobject *obj, jsidarray *ida); name type
description description js_enumerateresolvedstandardclasses enumerates any already-resolved standard class ids into ida, or into a new jsidarray if ida is null.
JS_FORGET_STRING_FLATNESS
syntax static moz_always_inline jsstring * js_forget_string_flatness(jsflatstring *fstr) { return (jsstring *)fstr; } name type
description fstr jsflatstring * a string to convert
description js_forget_string_flatness converts jsflatstring * to jsstring *.
JS_GetImplementationVersion
syntax const char * js_getimplementationversion(void);
description js_getimplementationversion returns a hard-coded, english language string that specifies the version number of the js engine currently in use, and its release date.
JS_Init
syntax #include "js/initialization.h" // previously "jsapi.h" bool js_init(void);
description initialize spidermonkey, returning true only if initialization succeeded.
JS_IsAssigning
syntax jsbool js_isassigning(jscontext *cx); name type
description description js_isassigning returns true if a script is executing and its current bytecode is a set (assignment) operation, even if there are native (no script) stack frames between the script and the caller to js_isassigning.
JS_MapGCRoots
syntax uint32 js_mapgcroots(jsruntime *rt, jsgcrootmapfun map, void *data); callback syntax #define js_map_gcroot_next 0 /* continue mapping entries */ #define js_map_gcroot_stop 1 /* stop mapping entries */ #define js_map_gcroot_remove 2 /* remove and free the current entry */ typedef int (*jsgcrootmapfun)(void *rp, const char *name, void *data);
description call js_mapgcroots to map the gc's roots table using map(rp, name, data).
JS_Now
syntax int64_t js_now(void);
description js_now returns microseconds since the epoch, midnight, january 1, 1970 utc.
JS_PropertyStub
obj, js::handleid id, bool *succeeded); // obsolete since jsapi 37 bool js_enumeratestub(jscontext *cx, js::handleobject obj); // obsolete since jsapi 37 bool js_convertstub(jscontext *cx, js::handleobject obj, jstype type, js::mutablehandlevalue vp); // obsolete since jsapi 37 void js_finalizestub(jscontext *cx, jsobject *obj); // obsolete since jsapi 14
description the stub functions are not designed to be called directly by a jsapi application.
JS_SetExtraGCRoots
callback
description generic trace operation that calls js_calltracer on additional traceable things.
JS_ShutDown
syntax void js_shutdown(void);
description destroys all free-standing resources allocated by spidermonkey, not associated with any jsruntime, jscontext, or other structure.
PRIVATE_TO_JSVAL
syntax jsval private_to_jsval(void *ptr); void * jsval_to_private(jsval v); // obsoleted since jsapi 32
description with private_to_jsval(), an application can store a private data pointer, p, as a jsval.
Property attributes
see js_defineproperty, js_fs, and js_fn flag
description jsprop_enumerate the property is visible to javascript for...in and for each ...
jsint
uint64;
description jsint and jsuint are 32-bit integer types.
Components.ID
syntax var interfaceid = [ new ] components.id(iid); parameters iid a string of the format '{00000000-0000-0000-0000-000000000000}' giving the interface id of the interface
description components.id creates interface ids for use in implementing methods like queryinterface, getinterfaces, and other methods that take interface ids as parameters.
Components.interfacesByID
it reflects only those interfaces which have been designated in their .idl
description as [scriptable], i.e.
Components.isSuccessCode
description components.issuccesscode() may be used to determine whether an xpcom return code (an nsresult) indicates success or failure.
XPConnect wrappers
this document is a high-level overview of xpconnect wrapper objects (for the more technical
description see xpconnect security membranes).
amIInstallTrigger
constant value
description skin 1 locale 2 content 4 package 7 methods enabled() tests if installation is enabled.
amIWebInstallInfo
1.0 66 introduced gecko 2.0 inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview void install(); attributes attribute type
description installs nsivariant an array of addoninstall objects.
imgILoader
in imgidecoderobserver aobserver, in nsisupports acx, in nsloadflags aloadflags, in nsisupports cachekey, in imgirequest arequest, in nsichannelpolicy channelpolicy); imgirequest loadimagewithchannel(in nsichannel achannel, in imgidecoderobserver aobserver, in nsisupports cx, out nsistreamlistener alistener); boolean supportimagewithmimetype(in string mimetype); constants constant value
description load_cors_anonymous 1 << 16 load_cors_use_credentials 1 << 17 methods loadimage() start the load and decode of an image.
inIDOMUtils
nt, in domstring apseudoclass); astring rgbtocolorname(in octet ar, in octet ag, in octet ab); bool selectormatcheselement(in nsidomelement aelement, in nsidomcssstylerule arule, in unsigned long aselectorindex, [optional] in domstring apseudo); void setcontentstate(in nsidomelement aelement, in unsigned long long astate); constants constant value
description exclude_shorthands (1<<0) include_aliases (1<<1) content state flags the content state flags are used in a bitmask.
jsdIStackFrame
method overview boolean eval(in astring bytes, in autf8string filename, in unsigned long line, out jsdivalue result); attributes attribute type
description callee jsdivalue function object running in this stack frame.
mozIJSSubScriptLoader
options an object that may include any of these parameters: property type
description target object the object to use as the scope object for the script being executed.
mozIPersonalDictionary
ean check(in wstring word, in wstring lang); void endsession(); void getcorrection(in wstring word, [array, size_is(count)] out wstring words, out pruint32 count); void ignoreword(in wstring word); void load(); void removecorrection(in wstring word,in wstring correction, in wstring lang); void removeword(in wstring word, in wstring lang); void save(); attributes attribute type
description wordlist nsistringenumerator get the (lexicographically sorted) list of words.
mozIPlaceInfo
toolkit/components/places/public/moziasynchistory.idlscriptable this interface provides additional info for a places entry 1.0 66 introduced gecko 2.0 inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) attributes attribute type
description frecency long read only: the frecency of the place.
mozIPlacesAutoComplete
1.0 66 introduced gecko 1.9.2 inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview void registeropenpage(in nsiuri auri); void unregisteropenpage(in nsiuri auri); constants constant value
description match_anywhere 0 match anywhere in each searchable term.
mozISpellCheckingEngine
le dir); boolean check(in wstring word); void getdictionarylist([array, size_is(count)] out wstring dictionaries, out pruint32 count); void removedirectory(in nsifile dir); void suggest(in wstring word,[array, size_is(count)] out wstring suggestions, out pruint32 count); attributes attribute type
description copyright wstring a string indicating the copyright of the engine.
nsIApplicationUpdateService
ird 3.3 / seamonkey 2.1) method overview void adddownloadlistener(in nsirequestobserver listener); astring downloadupdate(in nsiupdate update, in boolean background); void pausedownload(); void removedownloadlistener(in nsirequestobserver listener); nsiupdate selectupdate([array, size_is(updatecount)] in nsiupdate updates, in unsigned long updatecount); attributes attribute type
description backgroundchecker nsiupdatechecker the update checker being used for background update checking.
nsIArray
method overview nsisimpleenumerator enumerate(); unsigned long indexof(in unsigned long startindex, in nsisupports element); void queryelementat(in unsigned long index, in nsiidref uuid, [iid_is(uuid), retval] out nsqiresult result); attributes attribute type
description length unsigned long the number of elements in the array.
nsIAsyncInputStream
method overview void asyncwait(in nsiinputstreamcallback acallback, in unsigned long aflags, in unsigned long arequestedcount, in nsieventtarget aeventtarget); void closewithstatus(in nsresult astatus); constants constant value
description wait_closure_only (1<<0) 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).
nsIAsyncOutputStream
method overview void asyncwait(in nsioutputstreamcallback acallback, in unsigned long aflags, in unsigned long arequestedcount, in nsieventtarget aeventtarget); void closewithstatus(in nsresult reason); constants constant value
description wait_closure_only (1<<0) 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).
nsIAuthModule
ceflags, in wstring adomain, in wstring ausername, in wstring apassword); void unwrap([const] in voidptr aintoken, in unsigned long aintokenlength, out voidptr aouttoken, out unsigned long aouttokenlength); void wrap([const] in voidptr aintoken, in unsigned long aintokenlength, in boolean confidential, out voidptr aouttoken, out unsigned long aouttokenlength); constants constant value
description req_default 0 default behavior.
nsIAuthPrompt
aulttext, out wstring result); boolean promptpassword(in wstring dialogtitle, in wstring text, in wstring passwordrealm, in pruint32 savepassword, inout wstring pwd); boolean promptusernameandpassword(in wstring dialogtitle, in wstring text, in wstring passwordrealm, in pruint32 savepassword, inout wstring user, inout wstring pwd); constants constant value
description save_password_never 0 never saves the password.
nsIAuthPrompt2
createinstance(components.interfaces.nsiauthprompt2); method overview nsicancelable asyncpromptauth(in nsichannel achannel, in nsiauthpromptcallback acallback, in nsisupports acontext, in pruint32 level, in nsiauthinformation authinfo); boolean promptauth(in nsichannel achannel, in pruint32 level, in nsiauthinformation authinfo); constants constant value
description level_none 0 the password will be sent unencrypted.
nsIAuthPromptProvider
inherits from: nsisupports last changed in gecko 1.9 (firefox 3) method overview void getauthprompt(in pruint32 apromptreason, in nsiidref iid, [iid_is(iid),retval] out nsqiresult result); constants constant value
description prompt_normal 0 normal (non-proxy) prompt request.
nsIAutoCompleteInput
ecko 1.9 (firefox 3) method overview acstring getsearchat(in unsigned long index); void onsearchbegin(); void onsearchcomplete(); boolean ontextentered(); boolean ontextreverted(); void selecttextrange(in long startindex, in long endindex); attributes attribute type
description completedefaultindex boolean 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.
nsIAutoCompleteItem
inherits from: nsisupports last changed in gecko 1.7 attributes attribute type
description classname string class name used to define some style through css like the colors, an icon url, and so on.
nsIAutoCompleteListener
inherits from: nsisupports last changed in gecko 1.7 method overview void onautocomplete(in nsiautocompleteresults result, in autocompletestatus status); void onstatus(in wstring statustext); attributes attribute type
description param nsisupports private parameter used by the autocomplete widget.
nsIBidiKeyboard
and right-to-left directions (that is users who use arabic, iranian (persian), or israel (hebrew) keyboard layout, beside an us (english) layout.) inherits from: nsisupports last changed in gecko 9.0 (firefox 9.0 / thunderbird 9.0 / seamonkey 2.6) method overview boolean islangrtl(); void setlangfrombidilevel(in pruint8 alevel); attributes attribute type
description havebidikeyboards boolean indicates whether or not the system has at least one keyboard for each direction (left-to-right and right-to-left) installed.
nsIBlocklistService
al addon, [optional] in astring appversion, [optional] in astring toolkitversion); unsigned long getpluginblockliststate(in nsiplugintag plugin, [optional] in astring appversion, [optional] in astring toolkitversion); boolean isaddonblocklisted(in jsval addon, [optional] in astring appversion, [optional] in astring toolkitversion); constants constant value
description state_not_blocked 0 state_softblocked 1 state_blocked 2 state_outdated 3 methods getaddonblockliststate() determine the blocklist state of an add-on.
nsIBoxObject
feelmetric(in wstring propertyname); obsolete since gecko 1.9 wstring getproperty(in wstring propertyname); nsisupports getpropertyassupports(in wstring propertyname); void removeproperty(in wstring propertyname); void setproperty(in wstring propertyname, in wstring propertyvalue); void setpropertyassupports(in wstring propertyname, in nsisupports value); attributes attribute type
description element nsidomelement read only.
nsIBrowserHistory
attributes attribute type
description count obsolete since gecko 15.0 pruint32 indicates if there are entries in global history.
nsICRLInfo
inherits from: nsisupports last changed in gecko 1.7 attributes attribute type
description lastfetchurl autf8string the url this crl was last fetched from.
nsICRLManager
g autoupdatetype, in double noofdays); void deletecrl(in unsigned long crlindex); nsiarray getcrls(); void importcrl([array, size_is(length)] in octet data, in unsigned long length, in nsiuri uri, in unsigned long type, in boolean dosilentdownload, in wstring crlkey); void reschedulecrlautoupdate(); boolean updatecrlfromurl(in wstring url, in wstring key); constants constant value
description type_autoupdate_time_based 1 type_autoupdate_freq_based 2 methods computenextautoupdatetime() wstring computenextautoupdatetime( in nsicrlinfo info, in unsigned long autoupdatetype, in double noofdays ); parameters info autoupdatetype noofdays return value deletecrl() delete the crl.
nsICache
last changed in gecko 1.9 (firefox 3) inherits from: nsisupports constants constant value
description access_none 0 access granted - no descriptor is provided.
nsICacheDeviceInfo
inherits from: nsisupports last changed in gecko 1.7 attributes attribute type
description description string get a human readable
description of the cache device.
nsICacheEntryInfo
inherits from: nsisupports last changed in gecko 1.7 method overview boolean isstreambased(); attributes attribute type
description clientid string get the client id associated with this cache entry.
nsICacheSession
ncacheentry(in acstring key, in nscacheaccessmode accessrequested, in nsicachelistener listener, [optional] in boolean nowait); void evictentries(); prbool isstorageenabled(); nsicacheentrydescriptor opencacheentry(in acstring key, in nscacheaccessmode accessrequested, in boolean blockingmode); void doomentry(in acstring key, in nsicachelistener listener); attributes attribute type
description doomentriesifexpired prbool expired entries will be doomed or evicted if this attribute is set to true.
nsIChannelEventSink
method overview void asynconchannelredirect(in nsichannel oldchannel, in nsichannel newchannel, in unsigned long flags, in nsiasyncverifyredirectcallback callback); void onchannelredirect(in nsichannel oldchannel, in nsichannel newchannel, in unsigned long flags); obsolete since gecko 2.0 constants constant value
description redirect_temporary 1 << 0 this is a temporary redirect.
nsIChannelPolicy
attributes attribute type
description contentsecuritypolicy nsisupports a nsicontentsecuritypolicy object to determine if the load should be allowed.
nsIChromeRegistry
stry;1"] .getservice(components.interfaces.nsichromeregistry); method overview void canonify(in nsiuri achromeurl); obsolete since gecko 1.8 void checkfornewchrome(); nsiuri convertchromeurl(in nsiuri achromeurl); boolean wrappersenabled(in nsiuri auri); violates the xpcom interface guidelines constants constant value
description none 0 partial 1 full 2 methods canonify() obsolete since gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) note: this method is obsolete; use convertchromeurl() instead.
nsIClipboard
constant value
description kselectionclipboard 0 clipboard for selection.
nsICommandLineRunner
last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) inherits from: nsicommandline method overview void init(in long argc, in nscharptrarray argv, in nsifile workingdir, in unsigned long state); void run(); void setwindowcontext(in nsidomwindow awindow); attributes attribute type
description helptext autf8string process and combine the help text provided by each command-line handler.
nsICompositionStringSynthesizer
positioncommit": domwindowutils.sendcompositionevent("compositioncommit", "foo-bar-buzz", ""); method overview void appendclause(in unsigned long alength, in unsigned long aattribute); boolean dispatchevent(); void setcaret(in unsigned long aoffset, in unsigned long alength); void setstring(in astring astring); constants constant value
description attr_raw_input 0x02 a clause attribute.
nsIConsoleMessage
attributes attribute type
description message wstring the message in a string format.
nsIContentPref
nsicontentpref dom/interfaces/base/nsicontentprefservice2.idlscriptable a content preference 1.0 66 introduced gecko 20.0 inherits from: nsisupports last changed in gecko 20.0 (firefox 20.0 / thunderbird 20.0 / seamonkey 2.17) attributes attribute type
description domain astring read only.
nsIContentPrefCallback2
tentprefservice2 methods 1.0 66 introduced gecko 20.0 inherits from: nsisupports last changed in gecko 20.0 (firefox 20.0 / thunderbird 20.0 / seamonkey 2.17) method overview void handlecompletion(in unsigned short reason); void handleerror(in nsresult error); void handleresult(in nsicontentpref pref); constants constant value
description complete_ok 0 complete_error 1 methods handlecompletion() called when the method finishes.
nsIContentPrefService
agroup, in astring aname); void removegroupedprefs(); void removeobserver(in astring aname, in nsicontentprefobserver aobserver); void removepref(in nsivariant agroup, in astring aname); void removeprefsbyname(in astring aname); void setpref(in nsivariant agroup, in astring aname, in nsivariant avalue); attributes attribute type
description dbconnection mozistorageconnection the database connection to the content preferences database.
nsIContentPrefService2
dom/interfaces/base/nsicontentprefservice2.idlscriptable asynchronous api for content preferences 1.0 66 introduced gecko 20.0 inherits from: nsisupports last changed in gecko 20.0 (firefox 20.0 / thunderbird 20.0 / seamonkey 2.17)
description content preferences allow the application to associate arbitrary data, or "preferences", with specific domains, or web "content".
nsIContentSecurityPolicy
ctive); short shouldload(in unsigned long acontenttype, in nsiuri acontentlocation, in nsiuri arequestorigin, in nsisupports acontext, in acstring amimetypeguess, in nsisupports aextra); short shouldprocess(in unsigned long acontenttype, in nsiuri acontentlocation, in nsiuri arequestorigin, in nsisupports acontext, in acstring amimetype, in nsisupports aextra); attributes attribute type
description allowseval boolean whether this policy allows eval and eval-like functions such as settimeout("code string", time).
nsIContentView
method overview void scrollby(in float dxpx, in float dypx); void scrollto(in float xpx, in float ypx); void setscale(in float xscale, in float yscale); attributes attribute type
description contentheight float read only.
nsIContentViewManager
method overview void getcontentviewsin(in float axpx, in float aypx, in float atopsize, in float arightsize, in float abottomsize, in float aleftsize, [optional] out unsigned long alength, [retval, array, size_is(alength)] out nsicontentview aresult); attributes attribute type
description rootcontentview nsicontentview the root content view.
nsIControllers
ontrollerid); unsigned long getcontrollercount(); nsicontroller getcontrollerforcommand(in string command); unsigned long getcontrollerid(in nsicontroller controller); void insertcontrollerat(in unsigned long index, in nsicontroller controller); void removecontroller(in nsicontroller controller); nsicontroller removecontrollerat(in unsigned long index); attributes attribute type
description commanddispatcher nsidomxulcommanddispatcher obsolete since gecko 1.9 methods appendcontroller() adds a controller to the end of the list.
nsIConverterInputStream
to create an instance, use: var converterinputstream = components.classes["@mozilla.org/intl/converter-input-stream;1"] .createinstance(components.interfaces.nsiconverterinputstream); method overview void init(in nsiinputstream astream, in string acharset, in long abuffersize, in prunichar areplacementchar); constants constant value
description default_replacement_character 0xfffd default replacement character value.
nsICookie2
last changed in gecko 1.9.2 (firefox 3.6 / thunderbird 3.1 / fennec 1.0) inherits from: nsicookie attributes attribute type
description creationtime print64 the creation time of the cookie, in microseconds since midnight (00:00:00), january 1, 1970 utc.
nsICookieAcceptDialog
inherits from: nsisupports last changed in gecko 1.7 constants constant value
description accept_cookie 0 value for accepting a cookie object.
nsICookiePermission
ox 3) inherits from: nsisupports method overview nscookieaccess canaccess(in nsiuri auri, in nsichannel achannel); boolean cansetcookie(in nsiuri auri, in nsichannel achannel, in nsicookie2 acookie, inout boolean aissession, inout print64 aexpiry); nsiuri getoriginatinguri(in nsichannel achannel); void setaccess(in nsiuri auri, in nscookieaccess aaccess); constants constant value
description access_default 0 nscookieaccess's access default value access_allow 1 nscookieaccess's access allow value access_deny 2 nscookieaccess's access deny value access_session 8 additional values for nscookieaccess, which are not directly used by any methods on this interface, but are nevertheless convenient to define here.
nsICookiePromptService
last changed in gecko 1.9 (firefox 3) inherits from: nsisupports method overview long cookiedialog(in nsidomwindow parent, in nsicookie cookie, in acstring hostname, in long cookiesfromhost, in boolean changingcookie, out boolean rememberdecision); constants constant value
description deny_cookie 0 holds the value for a denying the cookie.
nsICookieService
ringfromhttp(in nsiuri auri, in nsiuri afirsturi, in nsichannel achannel); void setcookiestring(in nsiuri auri, in nsiprompt aprompt, in string acookie, in nsichannel achannel); void setcookiestringfromhttp(in nsiuri auri, in nsiuri afirsturi, in nsiprompt aprompt, in string acookie, in string aservertime, in nsichannel achannel); attributes attribute type
description cookieiconisvisible boolean this attribute really doesn't belong on this interface.
nsICrashReporter
attributes attribute type
description enabled boolean enable or disable the crashreporter at runtime.
nsIDOMMozTouchEvent
g clientyarg, in boolean ctrlkeyarg, in boolean altkeyarg, in boolean shiftkeyarg, in boolean metakeyarg, in unsigned short buttonarg, in nsidomeventtarget relatedtargetarg, in unsigned long streamidarg); attributes attribute type
description streamid unsigned long a unique identifier for each finger, so that each finger's movement can be tracked separately.
nsIDOMNSHTMLDocument
ommandid); domstring querycommandtext(in domstring commandid); obsolete since gecko 14.0 domstring querycommandvalue(in domstring commandid); void releaseevents(in long eventflags); void routeevent(in nsidomevent evt); void write(); obsolete since gecko 2.0 void writeln(); obsolete since gecko 2.0 attributes attribute type
description alinkcolor domstring same as body.alink bgcolor domstring same as body.bgcolor compatmode domstring returns "backcompat" if the document is in quirks mode or "css1compat" if the document is in full standards or almost standards mode.
nsIDOMOrientationEvent
last changed in gecko 1.9.2 (firefox 3.6 / thunderbird 3.1 / fennec 1.0) inherits from: nsidomevent method overview void initorientationevent(in domstring eventtypearg, in boolean canbubblearg, in boolean cancelablearg, in double x, in double y, in double z); attributes attribute type
description x double the amount of tilt along the x axis.
nsIDOMProgressEvent
method overview void initprogressevent(in domstring typearg, in boolean canbubblearg, in boolean cancelablearg, in boolean lengthcomputablearg, in unsigned long long loadedarg, in unsigned long long totalarg); deprecated since gecko 22.0 attributes attribute type
description lengthcomputable boolean specifies whether or not the total size of the transfer is known.
nsIDOMStorage
method overview void clear(); domstring getitem(in domstring key); domstring key(in unsigned long index); void removeitem(in domstring key); void setitem(in domstring key, in domstring data); attributes attribute type
description length unsigned long the number of keys stored in the session store.
nsIDOMStorage2
last changed in gecko 1.9.1 (firefox 3.5 / thunderbird 3.0 / seamonkey 2.0) inherits from: nsisupports method overview void clear(); domstring getitem(in domstring key); domstring key(in unsigned long index); void removeitem(in domstring key); void setitem(in domstring key, in domstring data); attributes attribute type
description length unsigned long the number of keys stored in local storage.
nsIDOMStorageEventObsolete
method overview void initstorageevent(in domstring typearg, in boolean canbubblearg, in boolean cancelablearg, in domstring keyarg, in domstring oldvaluearg, in domstring newvaluearg, in domstring urlarg, in nsidomstorage storageareaarg); attributes attribute type
description domain domstring the domain of the storage area which changed, or "#session" if the event represents a change to session storage.
nsIDOMStorageItem
attributes attribute type
description secure boolean if true, the item was stored for an https page.
nsIDOMStorageWindow
attributes attribute type
description globalstorage nsidomstoragelist global storage, accessible by domain.
nsIDOMUserDataHandler
1.0 66 introduced gecko 1.5 inherits from: nsisupports last changed in gecko 1.9 (firefox 3) method overview void handle(in unsigned short operation, in domstring key, in nsivariant data, in nsidomnode src, in nsidomnode dst); constants constant value
description node_cloned 1 the node was cloned.
nsIDOMWindow
dstyle(in nsidomelement elt, [optional] in domstring pseudoelt); nsiselection getselection(); void scrollby(in long xscrolldif, in long yscrolldif); void scrollbylines(in long numlines); void scrollbypages(in long numpages); void scrollto(in long xscroll, in long yscroll); void sizetocontent(); attributes attribute type
description applicationcache nsidomofflineresourcelist get the application cache object for this window.
nsIDOMWindow2
attributes attribute type
description applicationcache nsidomofflineresourcelist the application cache object for this window.
nsIDOMWindowInternal
wholeword, [optional] in boolean searchinframes, [optional] in boolean showdialog) domstring atob(in domstring aasciistring) domstring btoa(in domstring abase64data) nsivariant showmodaldialog(in nsivariant aargs, [optional] in domstring aoptions) void postmessage(in domstring message, in domstring targetorigin) attributes attribute type
description window nsidomwindowinternal readonly: the window object itself.
nsIDOMXULControlElement
66 introduced gecko 1.0 inherits from: nsidomxulelement last changed in gecko 1.0 attributes attribute type
description disabled boolean indicates whether the element is disabled or not.
nsIDOMXULElement
duced gecko 1.0 inherits from: nsidomelement last changed in gecko 1.9 (firefox 3) method overview void blur(); void click(); void docommand(); void focus(); nsidomnodelist getelementsbyattribute(in domstring name, in domstring value); nsidomnodelist getelementsbyattributens(in domstring namespaceuri, in domstring name, in domstring value); attributes attribute type
description align domstring gets/sets the value of the element's align attribute.
nsIDOMXULLabeledControlElement
inherits from: nsidomxulcontrolelement last changed in gecko 1.7 attributes attribute type
description accesskey domstring this should be set to a character that is used as a shortcut key.
nsIDOMXULSelectControlElement
temelement appenditem(in domstring label, in domstring value); long getindexofitem(in nsidomxulselectcontrolitemelement item); nsidomxulselectcontrolitemelement getitematindex(in long index); nsidomxulselectcontrolitemelement insertitemat(in long index, in domstring label, in domstring value); nsidomxulselectcontrolitemelement removeitemat(in long index); attributes attribute type
description itemcount unsigned long read only.
nsIDOMXULSelectControlItemElement
inherits from: nsidomxulelement last changed in gecko 1.7 attributes attribute type
description accesskey domstring command domstring control nsidomxulselectcontrolelement read only.
nsIDebug2
xpcom/base/nsidebug2.idlscriptable adds access to additional information in debug builds of mozilla code by expanding upon the features in nsidebug 1.0 66 introduced gecko 1.9.2 inherits from: nsidebug last changed in gecko 1.9.2 (firefox 3.6 / thunderbird 3.1 / fennec 1.0) attributes attribute type
description assertioncount long the number of assertions since process start.
nsIDialogCreator
1.0 66 introduced gecko 2.0 inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview void opendialog(in unsigned long atype, in acstring aname, in acstring afeatures, in nsidialogparamblock aarguments, [optional] in nsidomelement aframeelement); constants constant value
description unknown_dialog 0 generic_dialog 1 select_dialog 2 methods opendialog() void opendialog( in unsigned long atype, in acstring aname, in acstring afeatures, in nsidialogparamblock aarguments, in nsidomelement aframeelement optional ); parameters atype aname afeatures aarguments aframeelement optional ...
nsIDialogParamBlock
erits from: nsisupports last changed in gecko 1.7 method overview print32 getint( in print32 inindex ); wstring getstring( in print32 inindex ); void setint( in print32 inindex, in print32 inint ); void setnumberstrings( in print32 innumstrings ); void setstring( in print32 inindex, in wstring instring); attributes attribute type
description objects nsimutablearray a place where you can store an nsimutablearray to pass nsisupports.
nsIDirIndexParser
attributes attribute type
description comment string the comment given, if any.
nsIDirectoryEnumerator
1.0 66 introduced gecko 1.8 inherits from: nsisupports last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) method overview void close(); attributes attribute type
description nextfile nsifile the next file in the sequence.
nsIDirectoryIterator
last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) inherits from: nsisupports method overview void init(in nsifilespec parent, in boolean resolvesymlink); boolean exist(); void next(); attributes attribute type
description currentspec nsifilespec init() void init( in nsifilespec parent, in boolean resolvesymlink ); parameters parent resolvesymlink exist() boolean exists(); next() void next(); ...
nsIDocumentLoader
obsolete since gecko 1.8 nsiloadgroup getloadgroup(); obsolete since gecko 1.8 boolean isbusy(); obsolete since gecko 1.8 void stop(); attributes attribute type
description container nsisupports read only.
nsIDownloadProgressListener
nload); void onstatechange(in nsiwebprogress awebprogress, in nsirequest arequest, in unsigned long astateflags, in nsresult astatus, in nsidownload adownload); void onstatuschange(in nsiwebprogress awebprogress, in nsirequest arequest, in nsresult astatus, in wstring amessage, in nsidownload adownload); obsolete since gecko 1.9.1 attributes attribute type
description document nsidomdocument document the document of the download manager frontend.
nsIDragService
gevent, in nsidomdatatransfer adatatransfer); void invokedragsessionwithselection(in nsiselection aselection, in nsisupportsarray atransferablearray, in unsigned long aactiontype, in nsidomdragevent adragevent, in nsidomdatatransfer adatatransfer); void startdragsession( ) ; void suppress(); void unsuppress(); constants constant value
description dragdrop_action_none 0 no action.
nsIDragSession
inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview void getdata( in nsitransferable atransferable, in unsigned long aitemindex ); boolean isdataflavorsupported( in string adataflavor ); attributes attribute type
description candrop boolean set the current state of the drag, whether it can be dropped or not.
nsIDroppedLinkHandler
exceptions thrown missing exception missing
description droplink() given a drop event, determines the link being dragged.
nsIDroppedLinkItem
1.0 66 introduced gecko 2.0 inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) attributes attribute type
description url domstring url of the dropped link.
nsIEditor
elistener listener); void removedocumentstatelistener(in nsidocumentstatelistener listener); debug methods void dumpcontenttree(); void debugdumpcontent() ; void debugunittests(out long outnumtests, out long outnumtestsfailed); [notxpcom] boolean ismodifiablenode(in nsidomnode anode); constants load flags constant value
description enone 0 enext 1 eprevious 2 enextword 3 epreviousword 4 etobeginningofline 5 etoendofline 6 attributes attribute type
description contentsmimetype string the mime type of the document.
nsIEditorDocShell
method overview void makeeditable(in boolean inwaitforuriload); attributes attribute type
description editable boolean this docshell is editable.
nsIEditorIMESupport
obsolete since gecko 2.0 attributes attribute type
description composing boolean whether this editor has active ime transaction.
nsIEditorSpellCheck
boolean checkcurrentword( in wstring suggestedword ); parameters suggestedword missing
description return value true if the specified word is misspelled; otherwise false.
nsIEventListenerInfo
1.0 66 introduced gecko 1.9.2 inherits from: nsisupports last changed in gecko 1.9.2 (firefox 3.6 / thunderbird 3.1 / fennec 1.0) method overview nsisupports getdebugobject(); astring tosource(); attributes attribute type
description allowsuntrusted boolean indicates whether or not the event listener allows untrusted events.
nsIEventListenerService
eventtarget, in domstring atype); void addsystemeventlistener(in nsidomeventtarget target, in domstring type, in nsidomeventlistener listener, in boolean usecapture); void removesystemeventlistener(in nsidomeventtarget target, in domstring type, in nsidomeventlistener listener, in boolean usecapture); attributes attribute type
description systemeventgroup nsidomeventgroup returns system event group.
nsIEventTarget
obsolete since gecko 1.9 constants dispatch flags constant value
description dispatch_normal 0 this flag specifies the default mode of event dispatch, whereby the event is simply queued for later processing.
nsIException
inherits from: nsisupports last changed in gecko 1.7 method overview string tostring(); attributes attribute type
description columnnumber pruint32 valid column numbers begin at 0.
nsIFTPChannel
last changed in gecko 1.9 (firefox 3) inherits from: nsisupports attributes attribute type
description lastmodifiedtime prtime the time at which the ftp channel was last updated.
nsIFaviconService
et adata, in unsigned long adatalen, in autf8string amimetype, in prtime aexpiration); obsolete since gecko 22.0 void setfavicondatafromdataurl(in nsiuri afaviconuri, in astring adataurl, in prtime aexpiration); obsolete since gecko 22.0 void setfaviconurlforpage(in nsiuri apageuri, in nsiuri afaviconuri); obsolete since gecko 22.0 attributes attribute type
description defaultfavicon nsiuri the default favicon uri.
nsIFeedContainer
nents/feeds/public/nsifeedcontainer.idlscriptable this interface provides standard fields used by both feeds (nsifeed) and feed entries (nsifeedentry) 1.0 66 introduced gecko 1.8 inherits from: nsifeedelementbase last changed in gecko 1.8.1 (firefox 2 / thunderbird 2 / seamonkey 1.1) method overview void normalize(); attributes attribute type
description authors nsiarray an array of nsifeedperson objects describing the authors of the feed or entry.
nsIFeedElementBase
1.0 66 introduced gecko 1.8 inherits from: nsisupports last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) attributes attribute type
description attributes nsisaxattributes all the attributes found on the element.
nsIFeedGenerator
1.0 66 introduced gecko 1.8 inherits from: nsifeedelementbase last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) attributes attribute type
description agent astring the name of the software that created the feed.
nsIFeedPerson
1.0 66 introduced gecko 1.8 inherits from: nsifeedelementbase last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) attributes attribute type
description email astring the person's email address.
nsIFeedProcessor
.classes["@mozilla.org/feed-processor;1"] .createinstance(components.interfaces.nsifeedprocessor); method overview void parseasync(in nsirequestobserver requestobserver, in nsiuri uri); void parsefromstream(in nsiinputstream stream, in nsiuri uri); void parsefromstring(in astring str, in nsiuri uri); attributes attribute type
description listener nsifeedresultlistener the feed result listener that will respond to feed events.
nsIFeedProgressListener
void reporterror( in astring errortext, in long linenumber, in boolean bozo ); parameters errortext a short
description of the error.
nsIFeedResult
1.0 66 introduced gecko 1.8 inherits from: nsisupports last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) method overview void registerextensionprefix(in astring anamespace, in astring aprefix); attributes attribute type
description bozo boolean the feed processor sets the bozo bit when a feed triggers a fatal error during xml parsing.
nsIFeedTextConstruct
method overview nsidomdocumentfragment createdocumentfragment(in nsidomelement element); astring plaintext(); attributes attribute type
description base nsiuri if the text construct contains html or xhtml, relative references in the content should be resolved against this base uri.
nsIFileInputStream
inherits from: nsiinputstream last changed in gecko 1.7 method overview void init(in nsifile file, in long ioflags, in long perm, in long behaviorflags); constants constant value
description delete_on_close 1<<1 if this is set, the file will be deleted by the time the stream is closed.
nsIFileOutputStream
inherits from: nsioutputstream last changed in gecko 1.7 method overview void init(in nsifile file, in long ioflags, in long perm, in long behaviorflags); constants behavior flag constants constant value
description defer_open 1<<0 see the same constant in nsifileinputstream.
nsIFileStreams
last changed in gecko 1.9 (firefox 3) inherits from: nsisupports method overview void init(in nsifile file, in long ioflags, in long perm, in long behaviorflags); constants constants value
description delete_on_close 1<<1 if this is set, the file will be deleted by the time the stream is closed.
nsIFileURL
inherits from: nsisupports last changed in gecko 6.0 (firefox 6.0 / thunderbird 6.0 / seamonkey 2.3) attributes attribute type
description file nsifile get/set nsifile corresponding to this url.
nsIFormHistory2
verview void addentry(in astring name, in astring value); boolean entryexists(in astring name, in astring value); boolean nameexists(in astring name); void removeallentries(); void removeentriesbytimeframe(in long long abegintime, in long long aendtime); void removeentriesforname(in astring name); void removeentry(in astring name, in astring value); attributes attribute type
description dbconnection mozistorageconnection returns the underlying db connection the form history module is using.
nsIFrameLoader
attributes attribute type
description delayremotedialogs boolean depthtoogreat boolean find out whether the loader's frame is at too great a depth in the frame tree.
nsIFrameLoaderOwner
1.0 66 introduced gecko 1.8 inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview [noscript, notxpcom] alreadyaddrefed_nsframeloader getframeloader(); void swapframeloaders(in nsiframeloaderowner aotherowner); attributes attribute type
description frameloader nsiframeloader the frame loader owned by this nsiframeloaderowner.
nsIHapticFeedback
feedback); once you have the service, you can initiate haptic feedback (that is, cause the device to vibrate, if it's supported) by calling performsimpleaction(): hapticfeedback.performsimpleaction(components.interfaces.nsihapticfeedback.longpress); method overview void performsimpleaction(in long islongpress); constants press length constants constant value
description shortpress 0 specify as the action type to perform a short vibration.
nsIHttpChannelInternal
seamonkey 2.3) method overview void getrequestversion(out unsigned long major, out unsigned long minor); void getresponseversion(out unsigned long major, out unsigned long minor); void httpupgrade(in acstring aprotocolname, in nsihttpupgradelistener alistener); void setcookie(in string acookieheader); void setupfallbackchannel(in string afallbackkey); attributes attribute type
description canceled boolean returns true if and only if the channel has been canceled.
nsIINIParserWriter
constant value
description write_utf16 0x1 windows and the nsis installer code sometimes expect ini files to be in utf-16 encoding.
nsIIOService
uri, in nsiuri aproxyuri, in uint32_t aproxyflags,in nsidomnode aloadingnode, in nsiprincipal aloadingprincipal, in nsiprincipal atriggeringprincipal, in uint32_t asecurityflags, in uint32_t acontentpolicytype); nsiuri newfileuri(in nsifile afile); nsiuri newuri(in autf8string aspec, in string aorigincharset, in nsiuri abaseuri); attributes attribute type
description offline boolean returns true if networking is in "offline" mode.
nsIIdleService
o create an instance, use: var idleservice = components.classes["@mozilla.org/widget/idleservice;1"] .getservice(components.interfaces.nsiidleservice); method overview void addidleobserver(in nsiobserver observer, in unsigned long time); void removeidleobserver(in nsiobserver observer, in unsigned long time); attributes attribute type
description idletime unsigned long the amount of time in milliseconds that has passed since the last user activity.
nsIJSID
method overview boolean equals(in nsijsid other); const nsid* getid(); violates the xpcom interface guidelines void initialize(in string idstring); string tostring(); attributes attribute type
description id nsidptr read only.
nsILoadGroup
inherits from: nsirequest last changed in gecko 1.7 method overview void addrequest(in nsirequest arequest, in nsisupports acontext); void removerequest(in nsirequest arequest, in nsisupports acontext, in nsresult astatus); attributes attribute type
description activecount unsigned long returns the count of "active" requests (that is requests without the load_background bit set).
nsILoginInfo
nsilogininfo clone(); boolean equals(in nsilogininfo alogininfo); void init(in astring ahostname, in astring aformsubmiturl, in astring ahttprealm, in astring ausername, in astring apassword, in astring ausernamefield, in astring apasswordfield); boolean matches(in nsilogininfo alogininfo, in boolean ignorepassword); attributes attribute type
description formsubmiturl astring the origin, not url, a form-based login was submitted to.
nsILoginManager
nsiautocompleteresult autocompletesearch( in astring asearchstring, in nsiautocompleteresult apreviousresult, in nsidomhtmlinputelement aelement ); parameters asearchstring missing
description apreviousresult missing
description aelement missing
description return value missing
description countlogins() returns the number of logins matching the specified criteria.
nsILoginManagerCrypto
1.0 66 introduced gecko 2.0 inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview astring decrypt(in astring ciphertext); astring encrypt(in astring plaintext); attributes attribute type
description isloggedin boolean current login state of the token used for encryption.
nsILoginManagerStorage
ifile aoutputfile); void modifylogin(in nsilogininfo oldlogin, in nsisupports newlogindata); void removealllogins(); void removelogin(in nsilogininfo alogin); void searchlogins(out unsigned long count, in nsipropertybag matchdata, [retval, array, size_is(count)] out nsilogininfo logins); void setloginsavingenabled(in astring ahost, in boolean isenabled); attributes attribute type
description uibusy boolean true when a master password prompt is being shown.
nsILoginMetaInfo
attributes attribute type
description guid astring the guid to uniquely identify the login.
nsIMIMEInputStream
to create an instance, use: var mimeinputstream = components.classes["@mozilla.org/network/mime-input-stream;1"] .createinstance(components.interfaces.nsimimeinputstream); method overview void addheader(in string name, in string value); void setdata(in nsiinputstream stream); attributes attribute type
description addcontentlength boolean when true a "content-length" header is automatically added to the stream.
nsIMacDockSupport
method summary void activateapplication(in boolean aignoreotherapplications); attributes attribute type
description badgetext astring text to display in a badge on the application's dock icon.
nsIMarkupDocumentViewer
inherits from: nsisupports last changed in gecko 7.0 (firefox 7.0 / thunderbird 7.0 / seamonkey 2.4) method overview void scrolltonode(in nsidomnode node); void sizetocontent(); attributes attribute type
description allowplugins boolean if true, plugins are allowed within the doc shell.
nsIMemoryMultiReporter
attributes attribute type
description explicitnonheap print64 the sum of all of this multi-reporter's measurements that have a path that starts with "explicit" and are of the kind kind_nonheap.
nsIMemoryReporterManager
; void init(); void registermultireporter(in nsimemorymultireporter reporter); void registerreporter(in nsimemoryreporter reporter); void unregistermultireporter(in nsimemorymultireporter reporter); void unregisterreporter(in nsimemoryreporter reporter); attributes attribute type
description explicit print64 gets the total size of explicit memory allocations, both at the operating system level (for example, via mmap, virtualalloc) and at the heap level (for example, via malloc(), calloc(), operator new).
nsIMenuBoxObject
hanged in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) to get access to the box object for a given menu, use code like this: var boxobject = xulmenu.boxobject.queryinterface(components.interfaces.nsimenuboxobject); method overview boolean handlekeypress(in nsidomkeyevent keyevent); void openmenu(in boolean openflag); attributes attribute type
description activechild nsidomelement the currently active menu or menuitem child of the menu box.
nsIMessageSender
parameters name type
description messagename string the name of the message.
nsIMicrosummary
gecko 1.9 (firefox 3) warning: microsummary support was removed in gecko 6.0 (firefox 6.0 / thunderbird 6.0 / seamonkey 2.3) method overview void addobserver(in nsimicrosummaryobserver observer); boolean equals(in nsimicrosummary aother); void removeobserver(in nsimicrosummaryobserver observer); void update(); attributes attribute type
description content astring the content of the microsummary.
nsIMicrosummaryGenerator
inherits from: nsisupports last changed in gecko 1.9 (firefox 3) warning: microsummary support was removed in gecko 6.0 (firefox 6.0 / thunderbird 6.0 / seamonkey 2.3) method overview long calculateupdateinterval(in nsidomnode apagecontent); boolean equals(in nsimicrosummarygenerator aother); astring generatemicrosummary(in nsidomnode apagecontent); attributes attribute type
description loaded boolean has the generator itself (which may be a remote resource) been loaded.
nsIMsgAccount
inherits from: nsisupports last changed in gecko 1.7 method overview void addidentity(in nsimsgidentity identity); void clearallvalues(); void init(); void removeidentity(in nsimsgidentity identity); astring tostring(); attributes attribute type
description defaultidentity nsimsgidentity identities nsisupportsarray read only.
nsIMsgAccountManagerExtension
inherits from: nsisupports method overview boolean showpanel(in nsimsgincomingserver server); attributes attribute type
description name acstring name of the account manager extension.
nsIMsgCompFields
properties attribute type
description attachments char * obsolete attachments obsolete, do not use anymore attachmentsarray nsisupportsarray readonly attachvcard prbool bcc astring body astring bodyisasciionly prbool cc astring characterset char * defaultcharacterset char * readonly drafid char * dsn prbool fcc astring fcc2 astring followupto char * forcemsgencoding prbool forceplaintext prb...
nsIMsgDBHdr
mes, in string addresses,in unsigned long numaddresses);new in thunderbird 3.1 [noscript] void getauthorcollationkey(out octetptr key, out unsigned long len); [noscript] void getsubjectcollationkey(out octetptr key, out unsigned long len); [noscript] void getrecipientscollationkey(out octetptr key, out unsigned long len); attributes attribute type
description isread boolean readonly: indicates whether or not the message is read.
nsIMsgDBView
n nsmsgkey amsgkey, in boolean aexpand); void expandandselectthreadbyindex(in nsmsgviewindex aindex, in boolean aaugment); void addcolumnhandler(in astring acolumn, in nsimsgcustomcolumnhandler ahandler); void removecolumnhandler(in astring acolumn); nsimsgcustomcolumnhandler getcolumnhandler(in astring acolumn); attributes attribute type
description viewtype nsmsgviewtypevalue readonly: type of view.
nsIMsgDatabase
id refreshcache(in string asearchfolderuri, in unsigned long anumkeys, array, size_is (anumkeys) in nsmsgkey anewhits, out unsigned long anumbadhits, array, size_is(anumbadhits) out nsmsgkey astalehits); void updatehdrincache(in string asearchfolderuri, in nsimsgdbhdr ahdr, in boolean aadd); boolean hdrisincache(in string asearchfolderuri, in nsimsgdbhdr ahdr); attributes attribute type
description dbfolderinfo nsidbfolderinfo readonly: firstnew nsmsgkey readonly: msgretentionsettings nsimsgretentionsettings msgdownloadsettings nsimsgdownloadsettings lowwaterarticlenum nsmsgkey readonly: highwaterarticlenum nsmsgkey readonly: nextpseudomsgkey nsmsgkey for undo-redo of move pop->imap.
nsIMsgFilterList
nsmsgfilterfileattribvalue nsimsgfilterlist::attribnone = 0 const nsmsgfilterfileattribvalue nsimsgfilterlist::attribversion = 1 const nsmsgfilterfileattribvalue nsimsgfilterlist::attriblogging = 2 const nsmsgfilterfileattribvalue nsimsgfilterlist::attribname = 3 const nsmsgfilterfileattribvalue nsimsgfilterlist::attribenabled = 4 const nsmsgfilterfileattribvalue nsimsgfilterlist::attrib
description = 5 const nsmsgfilterfileattribvalue nsimsgfilterlist::attribtype = 6 const nsmsgfilterfileattribvalue nsimsgfilterlist::attribscriptfile = 7 const nsmsgfilterfileattribvalue nsimsgfilterlist::attribaction = 8 const nsmsgfilterfileattribvalue nsimsgfilterlist::attribactionvalue = 9 const nsmsgfilterfileattribvalue nsimsgfilterlist::attribcondition = 10 ...
nsIMsgIdentity
arattribute(in string name); void setcharattribute(in string name, in acstring value); boolean getboolattribute(in string name); void setboolattribute(in string name, in boolean value); long getintattribute(in string name); void setintattribute(in string name, in long value); astring tostring(); attributes attribute type
description identityname astring fullname astring user's full name, i.e.
nsIMsgProtocolInfo
method overview long getdefaultserverport(in boolean issecure); attributes attribute type
description candelete boolean true if an account of this type may be deleted.
nsIMsgSendLater
.getservice(components.interfaces.nsimsgsendlater); method overview void sendunsentmessages(in nsimsgidentity identity); void removelistener(in nsimsgsendlaterlistener listener); void addlistener(in nsimsgsendlaterlistener listener); nsimsgfolder getunsentmessagesfolder](in nsimsgidentity identity); attributes attribute type
description msgwindow nsimsgwindow methods sendunsentmessages() sends all unsent messages for an identity.
nsIMsgThread
ong index); nsimsgdbhdr getroothdr(out long index); void removechildat(in long index); void removechildhdr(in nsimsgdbhdr child, in nsidbchangeannouncer announcer); void markchildread(in boolean bread); nsimsgdbhdr getfirstunreadchild(); nsisimpleenumerator enumeratemessages(in nsmsgkey parent); attributes attribute type
description threadkey nsmsgkey unsigned long key designating this thread.
nsIMsgWindow
method overview void displayhtmlinmessagepane(in astring title, in astring body, in boolean clearmsghdr); void stopurls(); void closewindow(); attributes attribute type
description windowcommands nsimsgwindowcommands this allows the backend code to send commands to the ui, such as clearmsgpane.
nsINavHistoryFullVisitResultNode
attributes attribute type
description referringvisitid long long the referring visit id; the referrer should have the same session id as the visit described by this record.
nsINavHistoryObserver
, in prtime avisittime, in boolean awholeentry); obsolete since gecko 2.0 void ontitlechanged(in nsiuri auri, in astring apagetitle); void onvisit(in nsiuri auri, in long long avisitid, in prtime atime, in long long asessionid, in long long areferringid, in unsigned long atransitiontype, in acstring aguid, out unsigned long aadded); constants constant value
description attribute_favicon 3 the page's favicon changed.
nsINavHistoryQueryResultNode
method overview void getqueries([optional] out unsigned long querycount, [retval,array,size_is(querycount)] out nsinavhistoryquery queries); attributes attribute type
description folderitemid long long for both simple folder nodes and simple-folder-query nodes, this is set to the concrete itemid of the folder.
nsINavHistoryResult
method overview void addobserver(in nsinavhistoryresultobserver aobserver, in boolean aownsweak); void removeobserver(in nsinavhistoryresultobserver aobserver); attributes attribute type
description root nsinavhistorycontainerresultnode the root of the results.
nsINavHistoryResultObserver
istoryresultnode aoldnode, in nsinavhistoryresultnode anewnode, in unsigned long aindex); void nodetagschanged(in nsinavhistoryresultnode anode); void nodetitlechanged(in nsinavhistoryresultnode anode, in autf8string anewtitle); void nodeurichanged(in nsinavhistoryresultnode anode, in autf8string anewuri); void sortingchanged(in unsigned short sortingmode); attributes attribute type
description result nsinavhistoryresult the nsinavhistoryresult this observer monitors.
nsINavHistoryResultViewObserver
oncycleheader(in nsitreecolumn column); void oncyclecell(in long row, in nsitreecolumn column); void onselectionchanged(); void onperformaction(in wstring action); void onperformactiononrow(in wstring action, in long row); void onperformactiononcell(in wstring action, in long row, in nsitreecolumn column); constants constant value
description drop_before -1 the drag operation wishes to insert the dragged item before the indicated row.
nsINavHistoryResultViewer
nodereplaced(in nsinavhistorycontainerresultnode parent, in nsinavhistoryresultnode olditem, in nsinavhistoryresultnode newitem, in unsigned long index); void nodeinserted(in nsinavhistorycontainerresultnode aparent, in nsinavhistoryresultnode anode , in unsigned long anewindex); void sortingchanged(in unsigned short sortingmode); attributes attribute type
description result nsinavhistoryresult the nsinavhistoryresult this viewer monitors.
nsINavHistoryVisitResultNode
1.0 66 introduced gecko 1.9 inherits from: nsinavhistoryresultnode last changed in gecko 1.9 (firefox 3) attributes attribute type
description sessionid long long the session id of the visit, used for session grouping when a tree view is sorted by date.
nsIParserUtils
ils); method overview astring converttoplaintext(in astring src, in unsigned long flags, in unsigned long wrapcol); nsidomdocumentfragment parsefragment(in astring fragment, in unsigned long flags, in boolean isxml, in nsiuri baseuri, in nsidomelement element); astring sanitize(in astring src, in unsigned long flags); constants constant value
description sanitizerallowcomments (1 << 0) flag for sanitizer: allow comment nodes.
nsIPasswordManager
ce(components.interfaces.nsipasswordmanager); method overview void adduser(in autf8string ahost, in astring auser, in astring apassword); void removeuser(in autf8string ahost, in astring auser); void addreject(in autf8string ahost); void removereject(in autf8string ahost); attributes attribute type
description enumerator nsisimpleenumerator readonly: an enumeration of the stored usernames and passwords as nsipassword objects.
nsIPermission
last changed in gecko 2 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) inherits from: nsisupports attributes attribute type
description capability pruint32 the permission to set: allow, deny, or unknown (which is the default).
nsIPipe
inherits from: nsisupports last changed in gecko 1.6 method overview void init(in boolean nonblockinginput, in boolean nonblockingoutput, in unsigned long segmentsize, in unsigned long segmentcount, in nsimemory segmentallocator); attributes attribute type
description inputstream nsiasyncinputstream the pipe's input end, which also implements nsisearchableinputstream.
nsIPlacesView
method overview nsinavhistoryresultnode[] getdragableselection(); nsinavhistoryresultnode[][] getremovableselectionranges(); nsinavhistoryresult getresult(); nsinavhistorycontainerresultnode getresultnode(); nsinavhistoryresultnode[] getselectionnodes(); void selectall(); attributes attribute type
description hasselection boolean whether or not there are selected items.
nsIPluginHost
attributes attribute type
description plugincount unsigned long read only.
nsIPrefLocalizedString
inherits from: nsisupports last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) method overview void setdatawithlength(in unsigned long length, [size_is(length)] in wstring data); wstring tostring(); attributes attribute type
description data wstring provides access to string data stored in this property.
nsIPrinterEnumerator
void displaypropertiesdlg(in wstring aprinter, in nsiprintsettings aprintsettings); void enumerateprinters(out pruint32 acount,[retval, array, size_is(acount)] out wstring aresult); obsolete since gecko 1.9 void initprintsettingsfromprinter(in wstring aprintername, in nsiprintsettings aprintsettings); attributes attribute type
description defaultprintername wstring the name of the system default printer.
nsIPrivateBrowsingService
method overview void removedatafromdomain(in autf8string adomain); attributes attribute type
description autostarted boolean indicates whether or not private browsing was started automatically at application launch time.
nsIProcess
ed long count, [optional] in nsiobserver observer, [optional] in boolean holdweak); void runw(in boolean blocking, [array, size_is(count)] in wstring args, in unsigned long count); void runwasync([array, size_is(count)] in wstring args, in unsigned long count, [optional] in nsiobserver observer, [optional] in boolean holdweak); attributes attribute type
description exitvalue long the value returned by the process upon exit.
nsIProfileLock
inherits from: nsisupports last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) method overview void unlock(); attributes attribute type
description directory nsilocalfile the main profile directory.
nsIProfileUnlocker
1.0 66 introduced gecko 1.8 inherits from: nsisupports last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) method overview void unlock(in unsigned long aseverity); constants constant value
description attempt_quit 0 politely ask the process currently holding the profile's lock to quit.
nsIProgrammingLanguage
constant value
description unknown 0 cplusplus 1 c++ javascript 2 javascript python 3 python perl 4 perl java 5 java zx81_basic 6 zx81 basic javascript2 7 javascript 2 ruby 8 ruby php 9 php tcl 10 tcl max 10 this will be kept at the largest index.
nsIProperty
inherits from: nsisupports last changed in gecko 1.7 attributes attribute type
description name astring get the name of the property.
nsIPropertyBag
inherits from: nsisupports last changed in gecko 1.0 method overview nsivariant getproperty(in astring name); attributes attribute type
description enumerator nsisimpleenumerator get a nsisimpleenumerator whose elements are nsiproperty objects.
nsIPropertyElement
inherits from: nsisupports last changed in gecko 1.0 attributes attribute type
description key autf8string the key used to refer to this property.
nsIProtocolProxyService
ed long aflags, in unsigned long afailovertimeout, in nsiproxyinfo afailoverproxy); nsiproxyinfo getfailoverforproxy(in nsiproxyinfo aproxyinfo, in nsiuri auri, in nsresult areason); void registerfilter(in nsiprotocolproxyfilter afilter, in unsigned long aposition); void unregisterfilter(in nsiprotocolproxyfilter afilter); constants constant value
description resolve_non_blocking 1<<0 this flag may be passed to the resolve method to request that it fail instead of block the calling thread.
nsIPushService
topic subject data
description push api counterpart push-message nsipushmessage if the message has a payload; null for blank messages.
nsIPushSubscription
method overview void getkey(in domstring name, [optional] out uint32_t keylen, [array, size_is(keylen), retval] out uint8_t key); bool quotaapplies(); bool isexpired(); attributes attribute type
description endpoint domstring the subscription url.
nsIResumableChannel
inherits from: nsisupports last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) method overview void asyncopenat(in nsistreamlistener listener, in nsisupports ctxt, in unsigned long startpos, in nsiresumableentityid entityid); obsolete since gecko 1.8 void resumeat(in unsigned long long startpos, in acstring entityid); attributes attribute type
description entityid acstring the entity id for this uri.
nsISHEntry
void syncpresentationstate(); attributes attribute type
description cachekey nsisupports set and get the cache key for the entry.
nsISHistory
mponents.interfaces.nsishistory); method overview void addshistorylistener(in nsishistorylistener alistener); nsishentry getentryatindex(in long index, in boolean modifyindex); void purgehistory(in long numentries); void reloadcurrententry(); void removeshistorylistener(in nsishistorylistener alistener); attributes attribute type
description count long the number of toplevel documents currently available in session history.
nsISOCKSSocketInfo
inherits from: nsisupports last changed in gecko 1.7 attributes attribute type
description destinationaddr prnetaddrptr the destination server address.
nsISSLSocketControl
inherits from: nsisupports last changed in gecko 1.9 (firefox 3) method overview void proxystartssl(); void starttls(); attributes attribute type
description forcehandshake boolean obsolete since gecko 1.9 notificationcallbacks nsiinterfacerequestor methods proxystartssl() starts an ssl proxy connection.
nsIScreenManager
nsiscreen screenforrect( in long left, in long top, in long width, in long height ); attributes attribute type
description numberofscreens unsigned long the number of screens on the user's computer.
nsIScriptError2
method overview void initwithwindowid(in wstring message, in wstring sourcename, in wstring sourceline, in pruint32 linenumber, in pruint32 columnnumber, in pruint32 flags, in string category, in unsigned long long innerwindowid); attributes attribute type
description innerwindowid unsigned long long the inner window id with which the error is associated.
nsIScriptableUnicodeConverter
ring converttounicode(in acstring asrc); astring convertfrombytearray([const,array,size_is(acount)] in octet adata, in unsigned long acount); void converttobytearray(in astring astring,[optional] out unsigned long alen,[array, size_is(alen),retval] out octet adata); nsiinputstream converttoinputstream(in astring astring); attributes attribute type
description charset string current character set.
nsISearchSubmission
1.0 66 introduced gecko 1.8 inherits from: nsisupports last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) attributes attribute type
description postdata nsiinputstream the post data associated with a search submission, wrapped in a mime input stream.
nsISeekableStream
inherits from: nsisupports last changed in gecko 1.7 method overview void seek(in long whence, in long long offset); void seteof(); long long tell(); constants constant value
description ns_seek_set 0 specifies that the offset is relative to the start of the stream.
nsISelection2
void scrollintoview(in short aregion, in boolean aissynchronous, in short avpercent, in short ahpercent); attributes attribute type
description type short returns the type of the selection (see nsiselectioncontroller for available constants).
nsIServerSocket
attributes attribute type
description port long returns the port of this server socket.
nsISessionStore
value); void setwindowstate(in nsidomwindow awindow, in astring astate, in boolean aoverwrite); void setwindowvalue(in nsidomwindow awindow, in astring akey, in astring astringvalue); nsidomnode undoclosetab(in nsidomwindow awindow, in unsigned long aindex); nsidomwindow undoclosewindow(in unsigned long aindex); attributes attribute type
description canrestorelastsession boolean is it possible to restore the previous session.
nsISmsRequestManager
constant value
description success_no_error 0 no_signal_error 1 not_found_error 2 unknown_error 3 internal_error 4 methods addrequest() track an already existing request object.
nsISmsService
requestid missing
description processid optional missing
description see also smsmanager smsmessage ...
nsISocketProvider
constants constant value
description proxy_resolves_host 1 << 0 this flag is set if the proxy is to perform hostname resolution instead of the client.
nsIThread
last changed in gecko 1.9 (firefox 3) inherits from: nsieventtarget method overview void shutdown() boolean haspendingevents() boolean processnextevent(in boolean maywait) attributes attribute type
description prthread prthread the nspr thread object corresponding to the nsithread.
nsIThreadInternal
last changed in gecko 1.9 (firefox 3) inherits from: nsithread method overview void popeventqueue(); void pusheventqueue(in nsithreadeventfilter filter); attributes attribute type
description observer nsithreadobserver get/set the current thread observer; set to null to disable observing.
nsIThreadManager
nsithread newthread(in unsigned long creationflags); attributes attribute type
description currentthread nsithread the currently executing thread.
nsIThreadPool
method overview void shutdown(); attributes attribute type
description idlethreadlimit unsigned long get/set the maximum number of idle threads that are kept alive.
nsIToolkitProfile
method overview nsiprofilelock lock(out nsiprofileunlocker aunlocker); void remove(in boolean removefiles); attributes attribute type
description localdir nsilocalfile the location of the profile local directory, which may be the same as the root directory.
nsIToolkitProfileService
method overview nsitoolkitprofile createprofile(in nsilocalfile arootdir, in autf8string aname); void flush(); nsitoolkitprofile getprofilebyname(in autf8string aname); nsiprofilelock lockprofilepath(in nsilocalfile adirectory, in nsilocalfile atempdirectory); attributes attribute type
description profilecount unsigned long the number of user profiles currently in existence.
nsITraceableChannel
see nsitraceablechannel, intercept http traffic for a more detailed
description with code samples.
nsITransactionManager
ner); void beginbatch(); void clear(); void dotransaction(in nsitransaction atransaction); void endbatch(); nsitransactionlist getredolist(); nsitransactionlist getundolist(); nsitransaction peekredostack(); nsitransaction peekundostack(); void redotransaction(); void removelistener(in nsitransactionlistener alistener); void undotransaction(); attributes attribute type
description maxtransactioncount long sets the maximum number of transaction items the transaction manager will maintain at any time.
nsITreeBoxObject
em(in long row, in nsitreecolumn col, in acstring element, out long x, out long y, out long width, out long height); boolean iscellcropped(in long row, in nsitreecolumn col); void rowcountchanged(in long index, in long count); void beginupdatebatch(); void endupdatebatch(); void clearstyleandimagecaches(); attributes attribute type
description columns nsitreecolumns readonly: obtain the columns.
nsITreeColumns
eecolumn getcolumnat(in long index); nsitreecolumn getcolumnfor(in nsidomelement element); nsitreecolumn getfirstcolumn(); nsitreecolumn getkeycolumn(); nsitreecolumn getlastcolumn(); nsitreecolumn getnamedcolumn(in astring id); nsitreecolumn getprimarycolumn(); nsitreecolumn getsortedcolumn(); void invalidatecolumns(); void restorenaturalorder(); attributes attribute type
description count long the number of columns.
nsITreeContentView
last changed in gecko 1.8.0 inherits from: nsisupports method overview long getindexofitem(in nsidomelement item); nsidomelement getitematindex(in long index); attributes attribute type
description root nsidomelement the element in the dom which this view uses as root content.
nsITreeSelection
id invalidateselection(); void invertselection(); boolean isselected(in long index); void rangedselect(in long startindex, in long endindex, in boolean augment); void select(in long index); void selectall(); void timedselect(in long index, in long delay); void toggleselect(in long index); attributes attribute type
description count long the number of rows currently selected in this tree.
nsIURI
@ hostname : portnumber /pathname?query=value #ref method overview nsiuri clone(); nsiuri cloneignoringref(); boolean equals(in nsiuri other); boolean equalsexceptref(in nsiuri other); autf8string resolve(in autf8string relativepath); boolean schemeis(in string scheme); attributes attribute type
description asciihost acstring the uri host with an ascii compatible encoding.
nsIURIFixup
ance(components.interfaces.nsiurifixup); method overview nsiuri createexposableuri(in nsiuri auri); nsiuri createfixupuri(in autf8string auritext, in unsigned long afixupflags); nsiuri keywordtouri(in autf8string akeyword); nsiurifixupinfo getfixupuriinfo(in autf8string auritext, in unsigned long afixupflags); constants constant value
description fixup_flag_none 0 no fixup flags.
nsIURIFixupInfo
inherits from: nsisupports last changed in gecko 1.7 attributes attribute type
description consumer nsisupports consumer that asked for the fixed up uri.
nsIURL
{ var myurl = myuri.queryinterface(components.interfaces.nsiurl); } catch(e) { // the uri is not an url } or using instanceof: if (myuri instanceof components.interfaces.nsiurl) { // your code here } method overview autf8string getcommonbasespec(in nsiuri auritocompare); autf8string getrelativespec(in nsiuri auritocompare); attributes attribute type
description directory autf8string directory portion of a url.
nsIUpdate
1.0 66 introduced gecko 1.8 inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview nsiupdatepatch getpatchat(in unsigned long index); nsidomelement serialize(in nsidomdocument updates); attributes attribute type
description appversion astring the application version of this update.
nsIUpdateChecker
1.0 66 introduced gecko 1.8 inherits from: nsisupports last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) method overview void checkforupdates(in nsiupdatechecklistener listener, in boolean force); void stopchecking(in unsigned short duration); constants constant value
description current_check 1 constant for the stopchecking() method indicating that only the current update check should be stopped.
nsIUpdateManager
1.0 66 introduced gecko 1.8 inherits from: nsisupports last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) method overview nsiupdate getupdateat(in long index); void saveupdates(); attributes attribute type
description activeupdate nsiupdate an nsiupdate object describing the currently in use update.
nsIUpdatePatch
1.0 66 introduced gecko 1.8 inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview nsidomelement serialize(in nsidomdocument updates); attributes attribute type
description finalurl astring the final url this patch was being downloaded from.
nsIUploadChannel
inherits from: nsisupports last changed in gecko 1.7 method overview void setuploadstream(in nsiinputstream astream, in acstring acontenttype, in long acontentlength); attributes attribute type
description uploadstream nsiinputstream get the stream (to be) uploaded by this channel.
nsIUserInfo
attributes attribute type
description linux mac osx os/2 windows domain string read only.
nsIVariant
attributes attribute type
description datatype pruint16 read only.
nsIWebBrowser
method overview void addwebbrowserlistener(in nsiweakreference alistener, in nsiidref aiid); void removewebbrowserlistener(in nsiweakreference alistener, in nsiidref aiid); attributes attribute type
description containerwindow nsiwebbrowserchrome the chrome object associated with the browser instance.
nsIWebBrowserFind
method overview boolean findnext(); attributes attribute type
description entireword boolean whether to match entire words only.
nsIWebBrowserFindInFrames
attributes attribute type
description currentsearchframe nsidomwindow frame at which to start the search.
nsIWebNavigationInfo
implemented by: @mozilla.org/webnavigation-info;1 as a service: var webnavigationinfo = components.classes["@mozilla.org/webnavigation-info;1"] .getservice(components.interfaces.nsiwebnavigationinfo); method overview unsigned long istypesupported(in acstring atype, in nsiwebnavigation awebnav); constants support type constants constant value
description unsupported 0 returned by istypesupported() to indicate lack of support for a type.
nsIWifiAccessPoint
1.0 66 introduced gecko 1.9.1 inherits from: nsisupports last changed in gecko 1.9.1 (firefox 3.5 / thunderbird 3.0 / seamonkey 2.0) attributes attribute type
description mac acstring the wifi access point's mac address.
nsIWinAppHelper
method overview void fixreg(); obsolete since gecko 1.9 void postupdate(in nsilocalfile logfile); obsolete since gecko 1.9.2 attributes attribute type
description usercanelevate boolean read only.
nsIWinTaskbar
umplistbuilder createjumplistbuilder(); nsitaskbartabpreview createtaskbartabpreview(in nsidocshell shell, in nsitaskbarpreviewcontroller controller); nsitaskbarprogress gettaskbarprogress(in nsidocshell shell); nsitaskbarwindowpreview gettaskbarwindowpreview(in nsidocshell shell); void setgroupidforwindow(in nsidomwindow aparent, in astring aidentifier); attributes attribute type
description available boolean returns true if the operating system supports windows 7 or later taskbar features; you can use this instead of in-place operating system version checking.
nsIWindowMediator
constants constant value
description zleveltop 1 send window to top.
nsIWindowWatcher
getwindowenumerator(); nsidomwindow openwindow(in nsidomwindow aparent, in string aurl, in string aname, in string afeatures, in nsisupports aarguments); void registernotification(in nsiobserver aobserver); void setwindowcreator(in nsiwindowcreator creator); void unregisternotification(in nsiobserver aobserver); attributes attribute type
description activewindow nsidomwindow the watcher serves as a global storage facility for the current active (front most non-floating-palette-type) window, storing and returning it on demand.
nsIWorker
method overview void postmessage(in domstring amessage, [optional] in nsiworkermessageport amessageport); attributes attribute type
description onmessage nsidomeventlistener an object to receive notifications when messages are received on the worker's message port.
nsIWorkerGlobalScope
1.0 66 introduced gecko 1.9.1 inherits from: nsisupports last changed in gecko 1.9.2 (firefox 3.6 / thunderbird 3.1 / fennec 1.0) attributes attribute type
description location nsiworkerlocation read only.
nsIWorkerMessageEvent
1.0 66 introduced gecko 1.9.1 inherits from: nsidomevent last changed in gecko 1.9.1 (firefox 3.5 / thunderbird 3.0 / seamonkey 2.0) method overview void initmessageevent(in domstring atypearg, in boolean acanbubblearg, in boolean acancelablearg, in domstring adataarg, in domstring aoriginarg, in nsisupports asourcearg); attributes attribute type
description data domstring the event's data.
nsIWorkerScope
1.0 66 introduced gecko 1.9.1 inherits from: nsiworkerglobalscope last changed in gecko 1.9.2 (firefox 3.6 / thunderbird 3.1 / fennec 1.0) method overview void postmessage(in domstring amessage, [optional] in nsiworkermessageport amessageport); void close(); attributes attribute type
description onclose nsidomeventlistener a listener object to be called when the worker stops running.
nsIXMLHttpRequestEventTarget
1.0 66 introduced gecko 1.9.1 inherits from: nsidomeventtarget last changed in gecko 5.0 (firefox 5.0 / thunderbird 5.0 / seamonkey 2.2) attributes attribute type
description onabort nsidomeventlistener a javascript function object that gets invoked if the operation is canceled by the user.
nsIXMLHttpRequestUpload
1.0 66 introduced gecko 1.9.1 inherits from: nsidomeventtarget last changed in gecko 1.9.1 (firefox 3.5 / thunderbird 3.0 / seamonkey 2.0) attributes attribute type
description onabort nsidomeventlistener onerror nsidomeventlistener onload nsidomeventlistener onloadstart nsidomeventlistener onprogress nsidomeventlistener see also nsixmlhttprequest nsixmlhttprequesteventtarget xmlhttprequest using xmlhttprequest ...
nsIXSLTException
inherits from: nsiexception last changed in gecko 1.7 attributes attribute type
description sourcenode nsidomnode the context node, may be null.
nsIXULAppInfo
attributes attribute type
description appbuildid acstring the application's build id/date, for example "2004051604".
nsIXULSortService
obsolete since gecko 1.9 void sort(in nsidomnode anode, in astring asortkey, in astring asorthints); constants constant value
description sort_comparecase 0x0001 sort_integer 0x0100 methods native code only!insertcontainernode obsolete since gecko 1.9 (firefox 3)this feature is obsolete.
nsIXULTemplateBuilder
nsirdfresource anode, in nsiatom atag); void addrulefilter(in nsidomnode arule, in nsixultemplaterulefilter afilter); [noscript] void init(in nsicontent aelement); [noscript] void createcontents(in nsicontent aelement, in boolean aforcecreation); void addlistener(in nsixulbuilderlistener alistener); void removelistener(in nsixulbuilderlistener alistener); attributes attribute type
description root nsidomelement readonly: the root node in the dom to which this builder is attached.
nsIXULTemplateResult
method overview astring getbindingfor(in nsiatom avar); nsisupports getbindingobjectfor(in nsiatom avar); void hasbeenremoved(); void rulematched(in nsisupports aquery, in nsidomnode arulenode); attributes attribute type
description id astring id of the result.
nsIXmlRpcFault
inherits from: nsisupports last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) method overview void init(in print32 faultcode, in string faultsring); string tostring(); attributes attribute type
description faultcode print32 read only.
nsIZipEntry
inherits from: nsisupports last changed in gecko 1.9 (firefox 3) attributes attribute type
description compression unsigned short the type of compression used for the item.
GeolocationPositionError.code - Web APIs
the following values are possible: value associated constant
description 1 permission_denied the acquisition of the geolocation information failed because the page didn't have the permission to do it.
GeolocationPositionError - Web APIs
the following values are possible: value associated constant
description 1 permission_denied the acquisition of the geolocation information failed because the page didn't have the permission to do it.
GeometryUtils - Web APIs
geometryutils.convertquadfromnode() fixme: needs a
description geometryutils.convertrectfromnode() fixme: needs a
description geometryutils.convertpointfromnode() fixme: needs a
description specifications specification status comment css object model (cssom) view modulethe definition of 'geometryutils' in that specification.
GlobalEventHandlers.onanimationend - Web APIs
log("animation stopped", event); }; finally, we set up a handler for a click on the button that runs the animation: document.getelementbyid("play").addeventlistener("click", function(event) { document.getelementbyid("box").classname = "slideanimation"; event.target.style.display = "none"; }, false); this sets the class of the box we want to animate to the class that contains the animation
description, then hides the play button because this example will only run the animation once.
GlobalEventHandlers.onanimationstart - Web APIs
log("animation stopped", event); }; finally, we set up a handler for a click on the button that runs the animation: document.getelementbyid("play").addeventlistener("click", function(event) { document.getelementbyid("box").classname = "slideanimation"; event.target.style.display = "none"; }, false); this sets the class of the box we want to animate to the class that contains the animation
description, then hides the play button because this example will only run the animation once.
HTMLBodyElement - Web APIs
htmlbodyelement.background is a domstring that represents the
description of the location of the background image resource.
HTMLButtonElement - Web APIs
methods inherits methods from its parent, htmlelement name return type
description checkvalidity() boolean not supported for reset or button elements.
HTMLCanvasElement.toDataURL() - Web APIs
color in this example): html <img class="grayscale" src="mypicture.png" alt="
description of my picture" /> javascript window.addeventlistener('load', removecolors); function showcolorimg() { this.style.display = 'none'; this.nextsibling.style.display = 'inline'; } function showgrayimg() { this.previoussibling.style.display = 'inline'; this.style.display = 'none'; } function removecolors() { var aimages = document.getelementsbyclassname('grayscale'), nimgslen = ai...
HTMLFontElement.color - Web APIs
the format of the string must follow one of the following html microsyntaxes: microsyntax
description examples valid name color string nameofcolor (case insensitive) green green green valid hex color string in rgb format: #rrggbb #008000 rgb using decimal values rgb(x,x,x) (x in 0-255 range) rgb(0,128,0) syntax colorstring = fontobj.color; fontobj.color = colorstring; examples // assumes there is <font id="f"> element in the html var f = document.getelementbyid("f"); f.color = "green"; specifications the <font> tag is...
HTMLFontElement.face - Web APIs
the format of the string must follow one of the following html microsyntax: microsyntax
description examples list of one or more valid font family names a list of font names, that have to be present on the local system courier,verdana syntax facestring = fontobj.face; fontobj.face = facestring; examples // assumes there is <font id="f"> element in the html var f = document.getelementbyid("f"); f.face = "arial"; specifications the <font> tag is not supporte...
HTMLFontElement.size - Web APIs
the format of the string must follow one of the following html microsyntaxes: microsyntax
description examples valid size number string integer number in the range of 1-7 6 relative size string +x or -x, where x is the number relative to the value of the size attribute of the <basefont> element (the result should be in the same range of 1-7) +2 -1 syntax sizestring = fontobj.size; fontobj.size = sizestring; examples // assumes there is <font id="f"> element in the html var...
SVGAnimatedTransformList - Web APIs
interface overview also implement none methods none properties readonly svgtransformlist baseval readonly svgtransformlist animval normative document svg 1.1 (2nd edition) properties name type
description baseval svgtransformlist the base value of the given attribute before applying any animations.
SVGComponentTransferFunctionElement - Web APIs
1" y="65" width="350" height="50" fill="#f4f7f8" stroke="#d4dde4" stroke-width="2px" /><text x="306" y="94" font-size="12px" font-family="consolas,monaco,andale mono,monospace" fill="#4d4e53" text-anchor="middle" alignment-baseline="middle">svgcomponenttransferfunctionelement</text></a></svg></div> a:hover text { fill: #0095dd; pointer-events: all;} constants name value
description svg_fecomponenttransfer_type_unknown 0 the type is not one of predefined types.
SVGDocument - Web APIs
erties domstring domain domstring referrer svgsvgelement rootelement domstring title domstring url normative document svg 1.1 (2nd edition) properties name type
description domain domstring the domain name of the server that served the document, or a null string if the server cannot be identified by a domain name.
SVGEvent - Web APIs
properties property type
description target read only eventtarget the event target (the topmost target in the dom tree).
SVGFEBlendElement - Web APIs
"_top"><rect x="311" y="65" width="170" height="50" fill="#f4f7f8" stroke="#d4dde4" stroke-width="2px" /><text x="396" y="94" font-size="12px" font-family="consolas,monaco,andale mono,monospace" fill="#4d4e53" text-anchor="middle" alignment-baseline="middle">svgfeblendelement</text></a></svg></div> a:hover text { fill: #0095dd; pointer-events: all;} constants name value
description svg_feblend_mode_unknown 0 the type is not one of predefined types.
SVGFEColorMatrixElement - Web APIs
><rect x="251" y="65" width="230" height="50" fill="#f4f7f8" stroke="#d4dde4" stroke-width="2px" /><text x="366" y="94" font-size="12px" font-family="consolas,monaco,andale mono,monospace" fill="#4d4e53" text-anchor="middle" alignment-baseline="middle">svgfecolormatrixelement</text></a></svg></div> a:hover text { fill: #0095dd; pointer-events: all;} constants name value
description svg_fecolormatrix_type_unknown 0 the type is not one of predefined types.
SVGFECompositeElement - Web APIs
p"><rect x="271" y="65" width="210" height="50" fill="#f4f7f8" stroke="#d4dde4" stroke-width="2px" /><text x="376" y="94" font-size="12px" font-family="consolas,monaco,andale mono,monospace" fill="#4d4e53" text-anchor="middle" alignment-baseline="middle">svgfecompositeelement</text></a></svg></div> a:hover text { fill: #0095dd; pointer-events: all;} constants name value
description svg_fecomposite_operator_unknown 0 the type is not one of predefined types.
SVGFEConvolveMatrixElement - Web APIs
ect x="221" y="65" width="260" height="50" fill="#f4f7f8" stroke="#d4dde4" stroke-width="2px" /><text x="351" y="94" font-size="12px" font-family="consolas,monaco,andale mono,monospace" fill="#4d4e53" text-anchor="middle" alignment-baseline="middle">svgfeconvolvematrixelement</text></a></svg></div> a:hover text { fill: #0095dd; pointer-events: all;} constants name value
description svg_edgemode_unknown 0 the type is not one of predefined types.
SVGFEDisplacementMapElement - Web APIs
ct x="211" y="65" width="270" height="50" fill="#f4f7f8" stroke="#d4dde4" stroke-width="2px" /><text x="346" y="94" font-size="12px" font-family="consolas,monaco,andale mono,monospace" fill="#4d4e53" text-anchor="middle" alignment-baseline="middle">svgfedisplacementmapelement</text></a></svg></div> a:hover text { fill: #0095dd; pointer-events: all;} constants name value
description svg_channel_unknown 0 the type is not one of predefined types.
SVGFEGaussianBlurElement - Web APIs
<rect x="241" y="65" width="240" height="50" fill="#f4f7f8" stroke="#d4dde4" stroke-width="2px" /><text x="361" y="94" font-size="12px" font-family="consolas,monaco,andale mono,monospace" fill="#4d4e53" text-anchor="middle" alignment-baseline="middle">svgfegaussianblurelement</text></a></svg></div> a:hover text { fill: #0095dd; pointer-events: all;} constants name value
description svg_edgemode_unknown 0 the type is not one of predefined types.
SVGFEMorphologyElement - Web APIs
"><rect x="261" y="65" width="220" height="50" fill="#f4f7f8" stroke="#d4dde4" stroke-width="2px" /><text x="371" y="94" font-size="12px" font-family="consolas,monaco,andale mono,monospace" fill="#4d4e53" text-anchor="middle" alignment-baseline="middle">svgfemorphologyelement</text></a></svg></div> a:hover text { fill: #0095dd; pointer-events: all;} constants name value
description svg_morphology_operator_unknown 0 the type is not one of predefined types.
SVGFitToViewBox - Web APIs
ods none properties svganimatedpreserveaspectratio preserveaspectratio svganimatedrect viewbox normative document svg 1.1 (2nd edition) properties name type
description preserveaspectratio svganimatedpreserveaspectratio corresponds to attribute preserveaspectratio on the given element.
SVGGradientElement - Web APIs
_top"><rect x="301" y="65" width="180" height="50" fill="#f4f7f8" stroke="#d4dde4" stroke-width="2px" /><text x="391" y="94" font-size="12px" font-family="consolas,monaco,andale mono,monospace" fill="#4d4e53" text-anchor="middle" alignment-baseline="middle">svggradientelement</text></a></svg></div> a:hover text { fill: #0095dd; pointer-events: all;} constants name value
description svg_spreadmethod_unknown 0 the type is not one of predefined types.
SVGPathSegList - Web APIs
svgpathseg appenditem(in svgpathseg newitem) properties readonly unsigned long numberofitems normative document svg 1.1 (2nd edition) properties name type
description numberofitemsread only unsigned long the number of items in the list.
ARIA: cell role - Accessibility
<tr role="row"> <td role="cell">france</td> <td role="cell">67 million</td> </tr>
description the element with role="cell" is a cell within a row, optionally within a rowgroup, within a grid, table or treegrid within a static tabular structure.
ARIA: document role - Accessibility
description by default, web pages are treated as documents; assistive technologies (at) enter browse or read mode when entering a new web page.
ARIA: grid role - Accessibility
<td tabindex="-1"> <button id="1b" tabindex="-1">1b</button> </td> <!-- more columns --> </tr> <tr> <th scope="row">aisle 2</th> <td tabindex="-1"> <button id="2a" tabindex="-1">2a</button> </td> <td tabindex="-1"> <button id="2b" tabindex="-1">2b</button> </td> <!-- more columns --> </tr> </tbody> </table>
description a grid widget contains one or more rows with one or more cells of thematically related interactive content.
ARIA: gridcell role - Accessibility
instead use the native html td element in conjunction with the and contenteditable attribute: <td>potato</td> <td>cabbage</td> <td>onion</td>
description gridcells with dynamically added, hidden, or removed rows and columns any element with a role="gridcell" applied to it should use aria to describe its order in the table-style grouping, provided the table, grid, or treegrid has the ability to have rows and/or columns dynamically added, hidden, or removed.
ARIA: List role - Accessibility
<section role="list"> <div role="listitem">list item 1</div> <div role="listitem">list item 2</div> <div role="listitem">list item 3</div> </section>
description any content that consists of an outer container with a list of elements inside it can be identified to assistive technologies using the list and listitem containers respectively.
ARIA: Listitem role - Accessibility
<section role="list"> <div role="listitem">list item 1</div> <div role="listitem">list item 2</div> <div role="listitem">list item 3</div> </section>
description any content that consists of an outer container with a list of elements inside it can be identified to assistive technologies using the list and listitem containers respectively.
ARIA: row role - Accessibility
ending">country</span> <span role="columnheader"aria-sort="none">population</span> </div> </div> <div role="rowgroup"> <div role="row"> <span role="cell">finland</span> <span role="cell">5.5 million</span> </div> <div role="row"> <span role="cell">france</span> <span role="cell">67 million</span> </div> </div> </div>
description the element role="row" is a row within a grid, table or treegrid, and optionally within a rowgroup, that is a container for one or more cells, gridcells, columnheaders, or rowheaders within a static tabular structure.
ARIA: rowgroup role - Accessibility
ending">country</span> <span role="columnheader"aria-sort="none">population</span> </div> </div> <div role="rowgroup"> <div role="row"> <span role="cell">finland</span> <span role="cell">5.5 million</span> </div> <div role="row"> <span role="cell">france</span> <span role="cell">67 million</span> </div> </div> </div>
description rowgroup establishes a relationship between owned row elements and is a structural equivalent to the thead, tfoot and tbody elements in html.
ARIA: switch role - Accessibility
<button type="button" role="switch" aria-checked="true" id="speakerpower" class="switch"> <span>off</span> <span>on</span> </button> <label for="speakerpower" class="switch">speaker power</label>
description the aria switch role is identical to the checkbox role, except instead of being "checked" or "unchecked", it is either "on" and "off." like the checkbox role, the aria-checked attribute is required.
ARIA: tab role - Accessibility
<button role="tab" aria-selected="true" aria-controls="tabpanel-id" id="tab-id">tab label</button>
description an element with the tab role controls the visibility of an associated element with the tabpanel role.
ARIA: checkbox role - Accessibility
instead use the native html checkbox of <input type="checkbox">, which natively provides all the functionality required: <input type="checkbox" id="chk1-label"> <label for="chk1-label">remember my preferences</label>
description the native html checkbox form control can only have two checked states ("checked" or "not checked"), with an indeterminate state settable via javascript.
Forms - Accessibility
the following pages provide various techniques for improving the accessibility of web forms: basic form hints: adding hints and
descriptions for invalid or required fields alerts: using alerts to provide client-side validation error messages multi-part labels: enabling complex form labels with a control inside each label see also the yahoo!
<input type="number"> - HTML: Hypertext Markup Language
you can set a default value for the input by including a number inside the value attribute, like so: <input id="number" type="number" value="42"> additional attributes in addition to the attributes commonly supported by all <input> types, inputs of type number support these attributes: attribute
description list the id of the <datalist> element that contains the optional pre-defined autocomplete options max the maximum value to accept for this input min the minimum value to accept for this input placeholder an example value to display inside the field when it's empty readonly a boolean attribute indicating whether the value is read-only...
<input type="password"> - HTML: Hypertext Markup Language
additional attributes in addition to the attributes that operate on all <input> elements regardless of their type, password field inputs support the following attributes: attribute
description maxlength the maximum length the value may be, in utf-16 characters minlength the minimum length in characters that will be considered valid pattern a regular expression the value must match in order to be valid placeholder an example value to display in the field when the field is empty readonly a boolean attribute which, if present...
<input type="radio"> - HTML: Hypertext Markup Language
additional attributes in addition to the common attributes shared by all <input> elements, radio inputs support the following attributes: attribute
description checked a boolean indicating whether or not this radio button is the currently-selected item in the group value the string to use as the value of the radio when submitting the form, if the radio is currently toggled on checked a boolean attribute which, if present, indicates that this radio button is the currently selected one in the group.
<input type="submit"> - HTML: Hypertext Markup Language
this label is likely to be something along the lines of "submit" or "submit query." here's an example of a submit button with a default label in your browser: <input type="submit"> additional attributes in addition to the attributes shared by all <input> elements, submit button inputs support the following attributes: attribute
description formaction the url to which to submit the form's data; overrides the form's action attribute, if any formenctype a string specifying the encoding type to use for the form data formmethod the http method (get or post) to use when submitting the form.
<isindex> - HTML: Hypertext Markup Language
isindex element deprecated in html 4.01 isindex in html 3.2 isindex in html 2.0 as well the
description of the behavior in queries and indexes (html 2.0) isindex in html+ ...
<slot> - HTML: Hypertext Markup Language
background: #217ac0; color: white; padding: 2px 6px; border: 1px solid #cee9f9; border-radius: 4px; } .attributes { margin-left: 22px; font-size: 90% } .attributes p { margin-left: 16px; font-style: italic } </style> <details> <summary> <code class="name"><<slot name="element-name">need name</slot>></code> <i class="desc"><slot name="
description">need
description</slot></i> </summary> <div class="attributes"> <h4>attributes</h4> <slot name="attributes"><p>none</p></slot> </div> </details> <hr> </template> note: you can see this complete example in action at element-details (see it running live).
<video>: The Video Embed element - HTML: Hypertext Markup Language
mdn adding captions and subtitles to html5 video web video text tracks format (webvtt) webaim: captions, transcripts, and audio
descriptions mdn understanding wcag, guideline 1.2 explanations understanding success criterion 1.2.1 | w3c understanding wcag 2.0 understanding success criterion 1.2.2 | w3c understanding wcag 2.0 technical summary content categories flow content, phrasing content, embedded content.
Evolution of HTTP - HTTP
there were no status or error codes: in case of a problem, a specific html file was send back with the
description of the problem contained in it, for human consumption.
Identifying resources on the Web - HTTP
common schemes are: scheme
description data data uris file host-specific file names ftp file transfer protocol http/https hyper text transfer protocol (secure) javascript url-embedded javascript code mailto electronic mail address ssh secure shell tel telephone urn uniform resource names view-source source code o...
MIME types (IANA media types) - HTTP
orer, opera, safari svg scalable vector graphics image/svg+xml .svg chrome, edge, firefox, internet explorer, opera, safari tiff tagged image file format image/tiff .tif, .tiff none built-in; add-ons required webp web picture format image/webp .webp chrome, edge, firefox, opera the abbreviation for each format links to a longer
description of the format, its capabilities, and detailed browser compatibility information; including which versions introduced support and specific special features that may have been introduced later.
<menclose> - MathML
possible values are: value sample rendering rendering in your browser
description longdiv (default) a2 + b2 long division symbol actuarial a2 + b2 actuarial symbol radical a2 + b2 square root symbol.
Digital audio concepts - Web media technologies
since the sample rate corresponds to the number of "slices" a sound wave is divided into for each second of time, it's sometimes thought of as a frequency (in the sense that it's a
description of something that repeats periodically, not in terms of actual audio frequency), and the samples per second measurement therefore uses the hertz as its unit.
Codecs used by WebRTC - Web media technologies
that's done for each transceiver on the rtcpeerconnection; once all of the transceivers have been updated, we call the onnegotiationneeded event handler, which will create a new offer, update the local
description, send the offer along to the remote peer, and so on, thereby triggering the renegotiation of the connection.
Privacy, permissions, and information security
web technologies and features used to enforce security and privacy technology or feature
description certificate transparency an open standard for monitoring and auditing certificates, creating a database of public logs that can be used to help identify incorrect or malicious certificates content security policy provides the ability to define the extent to which a document's content can be accessed by other devices over the web; used in particular to prevent or mitig...
display - SVG: Scalable Vector Graphics
&& list-item<display-internal> = table-row-group | table-header-group | table-footer-group | table-row | table-cell | table-column-group | table-column | table-caption | ruby-base | ruby-text | ruby-base-container | ruby-text-container<display-box> = contents | none<display-legacy> = inline-block | inline-list-item | inline-table | inline-flex | inline-grid animatable yes for a
description of the values, please refer to the css display property.
filter - SVG: Scalable Vector Graphics
html, body, svg { height: 100%; } <svg viewbox="0 0 100 100" xmlns="http://www.w3.org/2000/svg"> <filter id="blur"> <fegaussianblur stddeviation="2" /> </filter> <rect x="10" y="10" width="80" height="80" filter="url(#blur)" /> </svg> usage notes value none | <filter-function-list> default value none animatable yes for a
description of the values see the css filter property.
font-family - SVG: Scalable Vector Graphics
y="arial, helvetica, sans-serif">sans serif</text> <text x="100" y="20" font-family="monospace">monospace</text> </svg> usage notes value [ <family-name> | <generic-family> ]#where <family-name> = <string> | <custom-ident>+<generic-family> = serif | sans-serif | cursive | fantasy | monospace default value depends on user agent animatable yes for a
description of the values, please refer to the css font-family property.
font-size - SVG: Scalable Vector Graphics
ath>, <tref>, and <tspan> html, body, svg { height: 100%; } <svg viewbox="0 0 200 30" xmlns="http://www.w3.org/2000/svg"> <text y="20" font-size="smaller">smaller</text> <text x="100" y="20" font-size="2em">2em</text> </svg> usage notes value <absolute-size> | <relative-size> | <length-percentage> default value medium animatable yes for a
description of the values, please refer to the css font-size property.
font-style - SVG: Scalable Vector Graphics
tpath>, <tref>, and <tspan> html, body, svg { height: 100%; } <svg viewbox="0 0 250 30" xmlns="http://www.w3.org/2000/svg"> <text y="20" font-style="normal">normal font style</text> <text x="150" y="20" font-style="italic">italic font style</text> </svg> usage notes value normal | italic | oblique default value normal animatable yes for a
description of the values, please refer to the css font-style property.
font-variant - SVG: Scalable Vector Graphics
lue-name> ) || annotation( <feature-value-name> ) || [ small-caps | all-small-caps | petite-caps | all-petite-caps | unicase | titling-caps ] || <numeric-figure-values> || <numeric-spacing-values> || <numeric-fraction-values> || ordinal || slashed-zero || <east-asian-variant-values> || <east-asian-width-values> || ruby ] default value normal animatable yes for a
description of the values, please refer to the css font-variant property.
font-weight - SVG: Scalable Vector Graphics
h>, <tref>, and <tspan> html, body, svg { height: 100%; } <svg viewbox="0 0 200 30" xmlns="http://www.w3.org/2000/svg"> <text y="20" font-weight="normal">normal text</text> <text x="100" y="20" font-weight="bold">bold text</text> </svg> usage notes value normal | bold | bolder | lighter | <number> default value normal animatable yes for a
description of the values, please refer to the css font-weight property.
href - SVG: Scalable Vector Graphics
refer to the
descriptions of the individual animation elements for any restrictions on what types of elements can be targets of particular types of animations.
letter-spacing - SVG: Scalable Vector Graphics
ath>, <tref>, and <tspan> html, body, svg { height: 100%; } <svg viewbox="0 0 400 30" xmlns="http://www.w3.org/2000/svg"> <text y="20" letter-spacing="2">bigger letter-spacing</text> <text x="200" y="20" letter-spacing="-0.5">smaller letter-spacing</text> </svg> usage notes value normal | <length> default value normal animatable yes for a
description of the values, please refer to the css letter-spacing property.
mode - SVG: Scalable Vector Graphics
s/6457/mdn_logo_only_color.png" width="200" height="200" style="filter:url(#blending1);"/> <image xlink:href="//developer.mozilla.org/files/6457/mdn_logo_only_color.png" width="200" height="200" style="filter:url(#blending2); transform:translatex(220px);"/> </svg> usage notes value <blend-mode> default value normal animatable yes for a
description of the values, see <blend-mode>.
overflow - SVG: Scalable Vector Graphics
<pattern>, <symbol>, <svg>, and <text> html, body, svg { height: 100%; } <svg viewbox="0 0 200 30" xmlns="http://www.w3.org/2000/svg" overflow="auto"> <text y="20">this text is wider than the svg, so there should be a scrollbar shown.</text> </svg> usage notes value visible | hidden | scroll | auto default value visible animatable yes for a
description of the values, please see the css overflow property.
text-decoration - SVG: Scalable Vector Graphics
" xmlns="http://www.w3.org/2000/svg"> <text y="20" text-decoration="underline">underlined text</text> <text x="0" y="40" text-decoration="line-through">struck-through text</text> </svg> usage notes value <'text-decoration-line'> || <'text-decoration-style'> || <'text-decoration-color'> default value see individual properties animatable yes for a
description of the values, please refer to the css text-decoration property.
u1 - SVG: Scalable Vector Graphics
the u1 attribute specifies list of unicode characters (refer to the
description of the unicode attribute of the <glyph> element for a
description of how to express individual unicode characters) and/or ranges of unicode characters, which identify a set of possible first glyphs in a kerning pair.
u2 - SVG: Scalable Vector Graphics
the u2 attribute specifies list of unicode characters (refer to the
description of the unicode attribute of the <glyph> element for a
description of how to express individual unicode characters) and/or ranges of unicode characters, which identify a set of possible second glyphs in a kerning pair.
unicode-bidi - SVG: Scalable Vector Graphics
as a presentation attribute, it can be applied to any element but it has effect only on the following eleven elements: <altglyph>, <textpath>, <text>, <tref>, and <tspan> context notes value normal | embed | isolate | bidi-override | isolate-override | plaintext default value normal animatable no for a
description of the values, please refer to the css unicode-bidi property.
word-spacing - SVG: Scalable Vector Graphics
ef>, and <tspan> html, body, svg { height: 100%; } <svg viewbox="0 0 250 50" xmlns="http://www.w3.org/2000/svg"> <text y="20" word-spacing="2">bigger spacing between words</text> <text x="0" y="40" word-spacing="-0.5">smaller spacing between words</text> </svg> usage notes value normal | <length> animatable yes default values normal for a
description of the values, please refer to the css letter-spacing property.
<a> - SVG: Scalable Vector Graphics
aria-details, aria-disabled, aria-dropeffect, aria-errormessage, aria-expanded, aria-flowto, aria-grabbed, aria-haspopup, aria-hidden, aria-invalid, aria-keyshortcuts, aria-label, aria-labelledby, aria-level, aria-live, aria-modal, aria-multiline, aria-multiselectable, aria-orientation, aria-owns, aria-placeholder, aria-posinset, aria-pressed, aria-readonly, aria-relevant, aria-required, aria-role
description, aria-rowcount, aria-rowindex, aria-rowspan, aria-selected, aria-setsize, aria-sort, aria-valuemax, aria-valuemin, aria-valuenow, aria-valuetext, role usage notes categoriescontainer elementpermitted contentany number of the following elements, in any order:animation elementsdescriptive elementsshape elementsstructural elementsgradient elements<a>, <altglyphdef>, <clippath>, <color-profile>, <...
<circle> - SVG: Scalable Vector Graphics
aria-details, aria-disabled, aria-dropeffect, aria-errormessage, aria-expanded, aria-flowto, aria-grabbed, aria-haspopup, aria-hidden, aria-invalid, aria-keyshortcuts, aria-label, aria-labelledby, aria-level, aria-live, aria-modal, aria-multiline, aria-multiselectable, aria-orientation, aria-owns, aria-placeholder, aria-posinset, aria-pressed, aria-readonly, aria-relevant, aria-required, aria-role
description, aria-rowcount, aria-rowindex, aria-rowspan, aria-selected, aria-setsize, aria-sort, aria-valuemax, aria-valuemin, aria-valuenow, aria-valuetext, role usage notes categoriesbasic shape element, graphics element, shape elementpermitted contentany number of the following elements, in any order:animation elementsdescriptive elements specifications specification status comment ...
<ellipse> - SVG: Scalable Vector Graphics
aria-details, aria-disabled, aria-dropeffect, aria-errormessage, aria-expanded, aria-flowto, aria-grabbed, aria-haspopup, aria-hidden, aria-invalid, aria-keyshortcuts, aria-label, aria-labelledby, aria-level, aria-live, aria-modal, aria-multiline, aria-multiselectable, aria-orientation, aria-owns, aria-placeholder, aria-posinset, aria-pressed, aria-readonly, aria-relevant, aria-required, aria-role
description, aria-rowcount, aria-rowindex, aria-rowspan, aria-selected, aria-setsize, aria-sort, aria-valuemax, aria-valuemin, aria-valuenow, aria-valuetext, role usage notes categoriesbasic shape element, graphics element, shape elementpermitted contentany number of the following elements, in any order:animation elementsdescriptive elements specifications specification status comment ...
<foreignObject> - SVG: Scalable Vector Graphics
aria-details, aria-disabled, aria-dropeffect, aria-errormessage, aria-expanded, aria-flowto, aria-grabbed, aria-haspopup, aria-hidden, aria-invalid, aria-keyshortcuts, aria-label, aria-labelledby, aria-level, aria-live, aria-modal, aria-multiline, aria-multiselectable, aria-orientation, aria-owns, aria-placeholder, aria-posinset, aria-pressed, aria-readonly, aria-relevant, aria-required, aria-role
description, aria-rowcount, aria-rowindex, aria-rowspan, aria-selected, aria-setsize, aria-sort, aria-valuemax, aria-valuemin, aria-valuenow, aria-valuetext, role usage notes categoriesnonepermitted contentany elements or character data specifications specification status comment scalable vector graphics (svg) 2the definition of '<foreignobject>' in that specification.
<g> - SVG: Scalable Vector Graphics
aria-details, aria-disabled, aria-dropeffect, aria-errormessage, aria-expanded, aria-flowto, aria-grabbed, aria-haspopup, aria-hidden, aria-invalid, aria-keyshortcuts, aria-label, aria-labelledby, aria-level, aria-live, aria-modal, aria-multiline, aria-multiselectable, aria-orientation, aria-owns, aria-placeholder, aria-posinset, aria-pressed, aria-readonly, aria-relevant, aria-required, aria-role
description, aria-rowcount, aria-rowindex, aria-rowspan, aria-selected, aria-setsize, aria-sort, aria-valuemax, aria-valuemin, aria-valuenow, aria-valuetext, role usage notes categoriescontainer element, structural elementpermitted contentany number of the following elements, in any order:animation elementsdescriptive elementsshape elementsstructural elementsgradient elements<a>, <altglyphdef>, <clippath>...
<line> - SVG: Scalable Vector Graphics
aria-details, aria-disabled, aria-dropeffect, aria-errormessage, aria-expanded, aria-flowto, aria-grabbed, aria-haspopup, aria-hidden, aria-invalid, aria-keyshortcuts, aria-label, aria-labelledby, aria-level, aria-live, aria-modal, aria-multiline, aria-multiselectable, aria-orientation, aria-owns, aria-placeholder, aria-posinset, aria-pressed, aria-readonly, aria-relevant, aria-required, aria-role
description, aria-rowcount, aria-rowindex, aria-rowspan, aria-selected, aria-setsize, aria-sort, aria-valuemax, aria-valuemin, aria-valuenow, aria-valuetext, role usage notes categoriesbasic shape element, graphics element, shape elementpermitted contentany number of the following elements, in any order:animation elementsdescriptive elements specifications specification status comment ...
<marker> - SVG: Scalable Vector Graphics
aria-details, aria-disabled, aria-dropeffect, aria-errormessage, aria-expanded, aria-flowto, aria-grabbed, aria-haspopup, aria-hidden, aria-invalid, aria-keyshortcuts, aria-label, aria-labelledby, aria-level, aria-live, aria-modal, aria-multiline, aria-multiselectable, aria-orientation, aria-owns, aria-placeholder, aria-posinset, aria-pressed, aria-readonly, aria-relevant, aria-required, aria-role
description, aria-rowcount, aria-rowindex, aria-rowspan, aria-selected, aria-setsize, aria-sort, aria-valuemax, aria-valuemin, aria-valuenow, aria-valuetext, role usage notes categoriescontainer elementpermitted contentany number of the following elements, in any order:animation elementsdescriptive elementsshape elementsstructural elementsgradient elements<a>, <altglyphdef>, <clippath>, <color-profile>, <...
<path> - SVG: Scalable Vector Graphics
aria-details, aria-disabled, aria-dropeffect, aria-errormessage, aria-expanded, aria-flowto, aria-grabbed, aria-haspopup, aria-hidden, aria-invalid, aria-keyshortcuts, aria-label, aria-labelledby, aria-level, aria-live, aria-modal, aria-multiline, aria-multiselectable, aria-orientation, aria-owns, aria-placeholder, aria-posinset, aria-pressed, aria-readonly, aria-relevant, aria-required, aria-role
description, aria-rowcount, aria-rowindex, aria-rowspan, aria-selected, aria-setsize, aria-sort, aria-valuemax, aria-valuemin, aria-valuenow, aria-valuetext, role usage notes categoriesgraphics element, shape elementpermitted contentany number of the following elements, in any order:animation elementsdescriptive elements specifications specification status comment svg pathsth...
<polygon> - SVG: Scalable Vector Graphics
aria-details, aria-disabled, aria-dropeffect, aria-errormessage, aria-expanded, aria-flowto, aria-grabbed, aria-haspopup, aria-hidden, aria-invalid, aria-keyshortcuts, aria-label, aria-labelledby, aria-level, aria-live, aria-modal, aria-multiline, aria-multiselectable, aria-orientation, aria-owns, aria-placeholder, aria-posinset, aria-pressed, aria-readonly, aria-relevant, aria-required, aria-role
description, aria-rowcount, aria-rowindex, aria-rowspan, aria-selected, aria-setsize, aria-sort, aria-valuemax, aria-valuemin, aria-valuenow, aria-valuetext, role usage notes categoriesbasic shape element, graphics element, shape elementpermitted contentany number of the following elements, in any order:animation elementsdescriptive elements specifications specification status comment ...
<polyline> - SVG: Scalable Vector Graphics
aria-details, aria-disabled, aria-dropeffect, aria-errormessage, aria-expanded, aria-flowto, aria-grabbed, aria-haspopup, aria-hidden, aria-invalid, aria-keyshortcuts, aria-label, aria-labelledby, aria-level, aria-live, aria-modal, aria-multiline, aria-multiselectable, aria-orientation, aria-owns, aria-placeholder, aria-posinset, aria-pressed, aria-readonly, aria-relevant, aria-required, aria-role
description, aria-rowcount, aria-rowindex, aria-rowspan, aria-selected, aria-setsize, aria-sort, aria-valuemax, aria-valuemin, aria-valuenow, aria-valuetext, role usage notes categoriesbasic shape element, graphics element, shape elementpermitted contentany number of the following elements, in any order:animation elementsdescriptive elements specifications specification status comment ...
<rect> - SVG: Scalable Vector Graphics
aria-details, aria-disabled, aria-dropeffect, aria-errormessage, aria-expanded, aria-flowto, aria-grabbed, aria-haspopup, aria-hidden, aria-invalid, aria-keyshortcuts, aria-label, aria-labelledby, aria-level, aria-live, aria-modal, aria-multiline, aria-multiselectable, aria-orientation, aria-owns, aria-placeholder, aria-posinset, aria-pressed, aria-readonly, aria-relevant, aria-required, aria-role
description, aria-rowcount, aria-rowindex, aria-rowspan, aria-selected, aria-setsize, aria-sort, aria-valuemax, aria-valuemin, aria-valuenow, aria-valuetext, role usage notes categoriesbasic shape element, graphics element, shape elementpermitted contentany number of the following elements, in any order:animation elementsdescriptive elements specifications specification status comment ...
<svg> - SVG: Scalable Vector Graphics
aria-details, aria-disabled, aria-dropeffect, aria-errormessage, aria-expanded, aria-flowto, aria-grabbed, aria-haspopup, aria-hidden, aria-invalid, aria-keyshortcuts, aria-label, aria-labelledby, aria-level, aria-live, aria-modal, aria-multiline, aria-multiselectable, aria-orientation, aria-owns, aria-placeholder, aria-posinset, aria-pressed, aria-readonly, aria-relevant, aria-required, aria-role
description, aria-rowcount, aria-rowindex, aria-rowspan, aria-selected, aria-setsize, aria-sort, aria-valuemax, aria-valuemin, aria-valuenow, aria-valuetext, role usage notes categoriescontainer element, structural elementpermitted contentany number of the following elements, in any order:animation elementsdescriptive elementsshape elementsstructural elementsgradient elements<a>, <altglyphdef>, <clippath>...
<symbol> - SVG: Scalable Vector Graphics
aria-details, aria-disabled, aria-dropeffect, aria-errormessage, aria-expanded, aria-flowto, aria-grabbed, aria-haspopup, aria-hidden, aria-invalid, aria-keyshortcuts, aria-label, aria-labelledby, aria-level, aria-live, aria-modal, aria-multiline, aria-multiselectable, aria-orientation, aria-owns, aria-placeholder, aria-posinset, aria-pressed, aria-readonly, aria-relevant, aria-required, aria-role
description, aria-rowcount, aria-rowindex, aria-rowspan, aria-selected, aria-setsize, aria-sort, aria-valuemax, aria-valuemin, aria-valuenow, aria-valuetext, role usage notes categoriescontainer element, structural elementpermitted contentany number of the following elements, in any order:animation elementsdescriptive elementsshape elementsstructural elementsgradient elements<a>, <altglyphdef>, <clippath>...
<text> - SVG: Scalable Vector Graphics
aria-details, aria-disabled, aria-dropeffect, aria-errormessage, aria-expanded, aria-flowto, aria-grabbed, aria-haspopup, aria-hidden, aria-invalid, aria-keyshortcuts, aria-label, aria-labelledby, aria-level, aria-live, aria-modal, aria-multiline, aria-multiselectable, aria-orientation, aria-owns, aria-placeholder, aria-posinset, aria-pressed, aria-readonly, aria-relevant, aria-required, aria-role
description, aria-rowcount, aria-rowindex, aria-rowspan, aria-selected, aria-setsize, aria-sort, aria-valuemax, aria-valuemin, aria-valuenow, aria-valuetext, role usage notes categoriesgraphics element, text content elementpermitted contentcharacter data and any number of the following elements, in any order:animation elementsdescriptive elementstext content elements<a> specifications specifica...
<textPath> - SVG: Scalable Vector Graphics
aria-details, aria-disabled, aria-dropeffect, aria-errormessage, aria-expanded, aria-flowto, aria-grabbed, aria-haspopup, aria-hidden, aria-invalid, aria-keyshortcuts, aria-label, aria-labelledby, aria-level, aria-live, aria-modal, aria-multiline, aria-multiselectable, aria-orientation, aria-owns, aria-placeholder, aria-posinset, aria-pressed, aria-readonly, aria-relevant, aria-required, aria-role
description, aria-rowcount, aria-rowindex, aria-rowspan, aria-selected, aria-setsize, aria-sort, aria-valuemax, aria-valuemin, aria-valuenow, aria-valuetext, role xlink attributes xlink:title usage notes categoriestext content element, text content child elementpermitted contentcharacter data and any number of the following elements, in any order:descriptive elements<a>, <altglyph>, <animate>, <animatec...
<tspan> - SVG: Scalable Vector Graphics
aria-details, aria-disabled, aria-dropeffect, aria-errormessage, aria-expanded, aria-flowto, aria-grabbed, aria-haspopup, aria-hidden, aria-invalid, aria-keyshortcuts, aria-label, aria-labelledby, aria-level, aria-live, aria-modal, aria-multiline, aria-multiselectable, aria-orientation, aria-owns, aria-placeholder, aria-posinset, aria-pressed, aria-readonly, aria-relevant, aria-required, aria-role
description, aria-rowcount, aria-rowindex, aria-rowspan, aria-selected, aria-setsize, aria-sort, aria-valuemax, aria-valuemin, aria-valuenow, aria-valuetext, role usage notes categoriestext content element, text content child elementpermitted contentcharacter data and any number of the following elements, in any order:descriptive elements<a>, <altglyph>, <animate>, <animatecolor>, <set>, <tref>, <tspan> ...
<use> - SVG: Scalable Vector Graphics
aria-details, aria-disabled, aria-dropeffect, aria-errormessage, aria-expanded, aria-flowto, aria-grabbed, aria-haspopup, aria-hidden, aria-invalid, aria-keyshortcuts, aria-label, aria-labelledby, aria-level, aria-live, aria-modal, aria-multiline, aria-multiselectable, aria-orientation, aria-owns, aria-placeholder, aria-posinset, aria-pressed, aria-readonly, aria-relevant, aria-required, aria-role
description, aria-rowcount, aria-rowindex, aria-rowspan, aria-selected, aria-setsize, aria-sort, aria-valuemax, aria-valuemin, aria-valuenow, aria-valuetext, role xlink attributes xlink:href, xlink:title usage notes categoriesgraphics element, graphics referencing element, structural elementpermitted contentany number of the following elements, in any order:animation elementsdescriptive elements speci...
Basic shapes - SVG: Scalable Vector Graphics
some of the parameters that determine their position and size are given, but an element reference would probably contain more accurate and complete
descriptions along with other properties that won't be covered in here.
XML introduction - XML: Extensible Markup Language
there are five of these characters that you should know: entity character
description < < less than sign > > greater than sign & & ampersand " " one double-quotation mark ' ' one apostrophe (or single-quotation mark) even though there are only 5 declared entities, more can be added using the document's document type definition.
Axes - XPath
the following is an extremely brief
description of the thirteen available axes and the degree of support available in gecko.
Functions - XPath
xslt/xpath reference: xslt elements, exslt functions, xpath functions, xpath axes the following is an annotated list of core xpath functions and xslt-specific additions to xpath, including a
description, syntax, a list of arguments, result-type, source in the appropriate w3c recommendation, and degree of present gecko support.
Introduction to using XPath in JavaScript - XPath
eelements[@*[local-name() = "href" and namespace-uri() = "http://www.w3.org/1999/xlink"]]'; // grabs elements with any single attribute that has both the local name 'href' and the xlink namespace var thislevel = xml.evaluate(xpathels, xml, null, xpathresult.any_type, null); var thisitemel = thislevel.iteratenext(); xpathresult defined constants result type defined constant value
description any_type 0 a result set containing whatever type naturally results from the evaluation of the expression.
XPath
xpath:functions list and
description of the core xpath functions and xslt-specific additions to xpath.
XSLT elements reference - XSLT: Extensible Stylesheet Language Transformations
for example, assume that a variable "image-dir" is defined as follows: <xsl:variable name="image-dir">/images</xsl:variable> the expression to be evaluated is placed inside curly brackets: <img src="{$image-dir}/mygraphic.jpg"/> this would result in the following: <img src="/images/mygraphic.jpg"/> the element annotations that follow include a
description, a syntax listing, a list of required and optional attributes, a
description of type and position, its source in the w3c recommendation and an explanation of the degree of present gecko support.
Index - XSLT: Extensible Stylesheet Language Transformations
14 an overview needshelp, needsmarkupwork, transforming_xml_with_xslt, xml, xslt the extensible stylesheet language/transform is a very powerful language, and a complete discussion of it is well beyond the scope of this article, but a brief discussion of some basic concepts will be helpful in understanding the
description of netscape's capabilities that follows.
Web technology for developers
accessibilitycss houdinicss: cascading style sheetsdemos of open web technologiesdeveloper guidesexsltevent referencehtml: hypertext markup languagehttpjavascriptmathmlopensearch
description formatprivacy, permissions, and information securityprogressive web apps (pwas)svg: scalable vector graphicstutorialsweb apisweb componentsweb performanceweb app manifestsweb media technologiesweb securityweb technology referencexml: extensible markup languagexpathxslt: extensible stylesheet language transformations ...
Compiling from Rust to WebAssembly - WebAssembly
open this file, and change its contents to look like this: [package] name = "hello-wasm" version = "0.1.0" authors = ["your name <you@example.com>"]
description = "a sample project with wasm-pack" license = "mit/apache-2.0" repository = "https://github.com/yourgithubusername/hello-wasm" [lib] crate-type = ["cdylib"] [dependencies] wasm-bindgen = "0.2" fill in your own repository and use the same info that git uses for the authors field.