You are currently viewing a snapshot of taken on April 21, 2008. Most of this content is highly out of date (some pages haven't been updated since the project began in 1998) and exists for historical purposes only. If there are any pages on this archive site that you think should be added back to, please file a bug.


Embedding Gecko API

Embedding API Reference

The following is a listing of interfaces related to the embedding of Gecko, the rendering engine of Netscape 6 and up and Mozilla. Only interfaces that have been marked @status frozen are documented. This document includes interfaces frozen through the Mozilla 1.4 release. As more and more interfaces are frozen, it is possible that an interface may be frozen but not yet listed here. To check what other interfaces may have been frozen that did not make this document, use the Mozilla cross-referencing tool at

In addition, all DOM related interfaces are listed not here, but in their own API Reference, at That document is JavaScript oriented, but the information applies equally to C++ code.

The listings in this document, on the other hand, are based on the implementation-language-neutral Interface Description Language files. Each listing contains an abstract of the interface, its scriptability status, and a detailed description of interface methods, constants, and attributes.

Note: When implementing in C++, most methods will return an nsresult, a standard error code indicating the status of the operation. Any other value that needs to be "returned" should be dealt with as a trailing output parameter. In JavaScript, methods will return as indicated in the IDL description. Also in C++, all IDL attributes are mapped to getter and setter methods, of the type Get[Attribute] and Set[Attribute]. Readonly attributes have only a getter method. JavaScript deals with attributes as properties.

Written by:Ellen Evans | Comments, questions, complaints? Bug 143387
Zip file of entire Reference here