Gecko Embedding API Reference

  • Revision slug: Gecko_Embedding_API_Reference
  • Revision title: Gecko Embedding API Reference
  • Revision id: 96760
  • Created:
  • Creator: Sheppy
  • Is current revision? No
  • Comment 26 words added

Revision Content

Public Interfaces

nsISupports

Base Component Object Model interface. This interface provides runtime interface discovery and a reference counted memory model fashioned after the Microsoft COM IUnknown interface. Interface status... none Interface definition: nsISupportsUtils.h

nsIInterfaceRequestor

This Interface provides an interface discovery mechanism which does not imply aggregation. Interface status... none Interface definition: nsIInterfaceRequestor.idl

nsIWeakReference

This interface is used to retern a proxy reference to a component. Interface status... complete Interface definition: nsIWeakReference.idl

nsISimpleEmunerator

This interface provides a simple enumeration abstraction. Interface status... complete Interface definition: nsISimpleEnumerator.idl

nsIServiceManager

This interface allows access to global services within mozilla. Interface status... none Interface definition: nsIServiceManager.h

nsIShutdownListener

This interface is used to receive notifications when the Service Manager is being shutdown. Interface status... none Interface definition: nsIServiceManager.h

nsIComponentManager

This interface allows new instances of registered XPCOM components to be instantiated. Interface status... none Interface definition: nsIComponentManager.idl

nsIFactory

This interface is used by the Component Manager to create new instances of a particular XPCOM component. Each component must provide a factory implementation for creating new instances. Interface status... none Interface definition: nsIFactory.idl

nsIMemory

This interface provides access to the global memory management functionality. Interface status: being reviewed Interface definition: nsIMemory.idl

nsIDOMWindow

This interface is used to represent the window containing a specific document. Interface status... being reviewed Interface definition: nsIDOMWindow.idl

nsIBaseWindow

This interface provides access to various window operations. Interface status... being reviewed Interface definition: nsIBaseWindow.idl

nsIRequest

This interface provides a means to control various operations. Interface status... complete Interface definition: nsIRequest.idl

nsIWebBrowser

This is the primary interface to the WebBrowser component Interface status... complete Interface definition: nsIWebBrowser.idl

nsIWebBrowserSetup

This interface is used to enable or disable various capabilities of a nsWebBrowser instance. Interface status... complete Interface definition: nsIWebBrowserSetup.idl

nsIWebBrowserChrome

This interface provides access to the window containing an nsWebBrowser instance. Interface status... being reviewed Interface definition: nsIWebBrowserChrome.idl

nsIWebNavigation

This interface exposes the web navigation functionality of the nsWebBrowser component. Interface status... being reviewed Interface definition: nsIWebNavigation.idl

nsIWebBrowserPersist

This interface exposes the save-as functionality of the nsWebBrowser component. Interface status... being reviewed Interface definition: nsIWebBrowserPersist.idl

nsIWebBrowserPrint

This interface allows printing of individual (or a collection of) DOM Windows within a nsWebBrowser component. Interface status: being reviewed Interfaced definition: nsIWebBrowserPrint.idl

nsIWebBrowserFind

This interface exposes the searching capabilities of the nsWebBrowser component. Interface status: none Interface definition: nsIWebBrowserFind.idl

nsIWebBrowserFocus

This interface provides access to the focus information of a nsWebBrowser instance. Interface status: being reviewed Interface definition: nsIWebBrowserFocus.idl

nsIWebProgress

The nsIWebProgress interface is used to add or remove nsIWebProgressListener instances to observe the loading of asynchronous requests (usually in the context of a DOM window).

nsIWebProgressListener

The nsIWebProgress interface is used to add or remove nsIWebProgressListener instances to observe the loading of asynchronous requests (usually in the context of a DOM window).

nsIPrompt

nsIPrefs

nsIProfile

The {{ interface("nsIProfile") }} interface provides access to the Profile Manager, which lets you create and manage user profiles. Obsolete.

nsIDirectoryServiceProvider

The nsIDirectoryServiceProvider interface is used by the Directory Service to get file locations.

nsILocalFile

The nsILocalFile interface represents a file or directory location in a platform-independent manner that is accessible on the local filesystem. It extends nsIFile.

nsIFile

This interface is the only correct cross-platform way to specify a file. Strings are not such a way. Despite the fact that they work on Windows or Unix, they will not work here.

nsIClipboardCommands

An interface for embedding clients who wish to interact with the system-wide OS clipboard. Mozilla does not use a private clipboard, instead it places its data directly onto the system clipboard. The webshell implements this interface.

nsISelection

Interface for manipulating and querying the current selected range of nodes within the document.

nsIURILoader

The uri dispatcher is responsible for taking uri's, determining the content and routing the opened url to the correct content handler.

nsIURIContentListener

nsIURIContentListener is an interface used by components which want to know (and have a chance to handle) a particular content type. Typical usage scenarios will include running applications which register a nsIURIContentListener for each of its content windows with the uri dispatcher service.

Revision Source

<h3 name="Public_Interfaces"> Public Interfaces </h3>
<h4 name="nsISupports"> <a href="en/NsISupports">nsISupports</a> </h4>
<p>Base Component Object Model interface. This interface provides runtime interface discovery and a reference counted memory model fashioned after the Microsoft COM IUnknown interface.
<b>Interface status...</b> none
<b>Interface definition:</b> <a class="external" href="http://lxr.mozilla.org/seamonkey/source/xpcom/base/nsISupportsUtils.h#92">nsISupportsUtils.h</a>
</p>
<h4 name="nsIInterfaceRequestor"> <a href="en/NsIInterfaceRequestor">nsIInterfaceRequestor</a> </h4>
<p>This Interface provides an interface discovery mechanism which does not imply aggregation.
<b>Interface status...</b> none
<b>Interface definition:</b> <a class="external" href="http://lxr.mozilla.org/seamonkey/source/xpcom/base/nsIInterfaceRequestor.idl">nsIInterfaceRequestor.idl</a>
</p>
<h4 name="nsIWeakReference"> <a href="en/NsIWeakReference">nsIWeakReference</a> </h4>
<p>This interface is used to retern a proxy reference to a component.
<b>Interface status...</b> <a class="external" href="http://www.mozilla.org/projects/embedding/apiReviewNotes.html#nsIWeakReference">complete</a>
<b>Interface definition:</b> <a class="external" href="http://lxr.mozilla.org/seamonkey/source/xpcom/base/nsIWeakReference.idl">nsIWeakReference.idl</a>
</p>
<h4 name="nsISimpleEmunerator"> <a href="en/NsISimpleEmunerator">nsISimpleEmunerator</a> </h4>
<p>This interface provides a simple enumeration abstraction.
<b>Interface status...</b> <a class="external" href="http://www.mozilla.org/projects/embedding/apiReviewNotes.html#nsISimpleEnumerator">complete</a>
<b>Interface definition:</b> nsISimpleEnumerator.idl
</p>
<h4 name="nsIServiceManager"> <a href="en/NsIServiceManager">nsIServiceManager</a> </h4>
<p>This interface allows access to global services within mozilla.
<b>Interface status...</b> none
<b>Interface definition:</b> <a class="external" href="http://lxr.mozilla.org/seamonkey/source/xpcom/components/nsIServiceManager.h">nsIServiceManager.h</a>
</p>
<h4 name="nsIShutdownListener"> <a href="en/NsIShutdownListener">nsIShutdownListener</a> </h4>
<p>This interface is used to receive notifications when the Service Manager is being shutdown.
<b>Interface status...</b> none
<b>Interface definition:</b> <a class="external" href="http://lxr.mozilla.org/seamonkey/source/xpcom/components/nsIServiceManager.h#150">nsIServiceManager.h</a>
</p>
<h4 name="nsIComponentManager"> <a href="en/NsIComponentManager">nsIComponentManager</a> </h4>
<p>This interface allows new instances of registered XPCOM components to be instantiated.
<b>Interface status...</b> none
<b>Interface definition:</b> <a class="external" href="http://lxr.mozilla.org/seamonkey/source/xpcom/components/nsIComponentManager.idl">nsIComponentManager.idl</a><br><a class="external" href="http://lxr.mozilla.org/seamonkey/source/xpcom/components/nsIComponentManager.idl">
</a></p><a class="external" href="http://lxr.mozilla.org/seamonkey/source/xpcom/components/nsIComponentManager.idl">
</a><h4 name="nsIFactory"><a class="external" href="http://lxr.mozilla.org/seamonkey/source/xpcom/components/nsIComponentManager.idl"> </a><a href="en/NsIFactory">nsIFactory</a> </h4>
<p>This interface is used by the Component Manager to create new instances of a particular XPCOM component. Each component must provide a factory implementation for creating new instances.
<b>Interface status...</b> none
<b>Interface definition:</b> <a class="external" href="http://lxr.mozilla.org/seamonkey/source/xpcom/components/nsIFactory.idl">nsIFactory.idl</a><br><a class="external" href="http://lxr.mozilla.org/seamonkey/source/xpcom/components/nsIFactory.idl">
</a></p><a class="external" href="http://lxr.mozilla.org/seamonkey/source/xpcom/components/nsIFactory.idl">
</a><h4 name="nsIMemory"><a class="external" href="http://lxr.mozilla.org/seamonkey/source/xpcom/components/nsIFactory.idl"> </a><a href="en/NsIMemory">nsIMemory</a> </h4>
<p>This interface provides access to the global memory management functionality.
<b>Interface status:</b> <a class="external" href="http://www.mozilla.org/projects/embedding/apiReviewNotes.html#nsIMemory">being reviewed</a>
<b>Interface definition:</b> <a class="external" href="http://lxr.mozilla.org/seamonkey/source/xpcom/base/nsIMemory.idl">nsIMemory.idl</a>
</p>
<h4 name="nsIDOMWindow"> <a class="external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIDOMWindow.html">nsIDOMWindow</a> </h4>
<p>This interface is used to represent the window containing a specific document.
<b>Interface status...</b> <a class="external" href="http://www.mozilla.org/projects/embedding/apiReviewNotes.html#nsIDOMWindow">being reviewed</a>
<b>Interface definition:</b> <a class="external" href="http://lxr.mozilla.org/seamonkey/source/dom/public/idl/base/nsIDOMWindow.idl">nsIDOMWindow.idl</a>
</p>
<h4 name="nsIBaseWindow"> <a class="external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIBaseWindow.html">nsIBaseWindow</a> </h4>
<p>This interface provides access to various window operations.
<b>Interface status...</b> <a class="external" href="http://www.mozilla.org/projects/embedding/apiReviewNotes.html#nsIBaseWindow">being reviewed</a>
<b>Interface definition:</b> <a class="external" href="http://lxr.mozilla.org/seamonkey/source/widget/public/nsIBaseWindow.idl">nsIBaseWindow.idl</a>
</p>
<h4 name="nsIRequest"> <a class="external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIRequest.html">nsIRequest</a> </h4>
<p>This interface provides a means to control various operations.
<b>Interface status...</b> complete
<b>Interface definition:</b> <a class="external" href="http://lxr.mozilla.org/seamonkey/source/netwerk/base/public/nsIRequest.idl">nsIRequest.idl</a>
</p>
<h4 name="nsIWebBrowser"> <a class="external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIWebBrowser.html">nsIWebBrowser</a> </h4>
<p>This is the primary interface to the WebBrowser component
<b>Interface status...</b> complete
<b>Interface definition:</b> <a class="external" href="http://lxr.mozilla.org/seamonkey/source/embedding/browser/webBrowser/nsIWebBrowser.idl">nsIWebBrowser.idl</a>
</p>
<h4 name="nsIWebBrowserSetup"> <a class="external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIWebBrowserSetup.html">nsIWebBrowserSetup</a> </h4>
<p>This interface is used to enable or disable various capabilities of a nsWebBrowser instance.
<b>Interface status...</b> complete
<b>Interface definition:</b> <a class="external" href="http://lxr.mozilla.org/seamonkey/source/embedding/browser/webBrowser/nsIWebBrowserSetup.idl">nsIWebBrowserSetup.idl</a>
</p>
<h4 name="nsIWebBrowserChrome"> <a class="external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIWebBrowserChrome.html">nsIWebBrowserChrome</a> </h4>
<p>This interface provides access to the window containing an nsWebBrowser instance.
<b>Interface status...</b> <a class="external" href="http://www.mozilla.org/projects/embedding/apiReviewNotes.html#nsIWebBrowserChrome">being reviewed</a>
<b>Interface definition:</b> <a class="external" href="http://lxr.mozilla.org/seamonkey/source/embedding/browser/webBrowser/nsIWebBrowserChrome.idl">nsIWebBrowserChrome.idl</a>
</p>
<h4 name="nsIWebNavigation"> <a class="external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIWebNavigation.html">nsIWebNavigation</a> </h4>
<p>This interface exposes the web navigation functionality of the nsWebBrowser component.
<b>Interface status...</b> <a class="external" href="http://www.mozilla.org/projects/embedding/apiReviewNotes.html#nsIWebNavigation">being reviewed</a>
<b>Interface definition:</b> <a class="external" href="http://lxr.mozilla.org/seamonkey/source/docshell/base/nsIWebNavigation.idl">nsIWebNavigation.idl</a>
</p>
<h4 name="nsIWebBrowserPersist"> <a class="external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIWebBrowserPersist.html">nsIWebBrowserPersist</a> </h4>
<p>This interface exposes the save-as functionality of the nsWebBrowser component.
<b>Interface status...</b> <a class="external" href="http://www.mozilla.org/projects/embedding/apiReviewNotes.html#nsIWebBrowserPersist">being reviewed</a>
<b>Interface definition:</b> <a class="external" href="http://lxr.mozilla.org/seamonkey/source/embedding/browser/webBrowser/nsIWebBrowserPersist.idl">nsIWebBrowserPersist.idl</a><br><a class="external" href="http://lxr.mozilla.org/seamonkey/source/embedding/browser/webBrowser/nsIWebBrowserPersist.idl">
</a></p><a class="external" href="http://lxr.mozilla.org/seamonkey/source/embedding/browser/webBrowser/nsIWebBrowserPersist.idl">
</a><h4 name="nsIWebBrowserPrint"><a class="external" href="http://lxr.mozilla.org/seamonkey/source/embedding/browser/webBrowser/nsIWebBrowserPersist.idl"> </a><a class="external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIWebBrowserPrint.html">nsIWebBrowserPrint</a> </h4>
<p>This interface allows printing of individual (or a collection of) DOM Windows within a nsWebBrowser component.
<b>Interface status:</b> <a class="external" href="http://www.mozilla.org/projects/embedding/apiReviewNotes.html#nsIWebBrowserPrint">being reviewed</a>
<b>Interfaced definition:</b> <a class="external" href="http://lxr.mozilla.org/seamonkey/source/embedding/browser/webBrowser/nsIWebBrowserPrint.idl">nsIWebBrowserPrint.idl</a><br><a class="external" href="http://lxr.mozilla.org/seamonkey/source/embedding/browser/webBrowser/nsIWebBrowserPrint.idl">
</a></p><a class="external" href="http://lxr.mozilla.org/seamonkey/source/embedding/browser/webBrowser/nsIWebBrowserPrint.idl">
</a><h4 name="nsIWebBrowserFind"><a class="external" href="http://lxr.mozilla.org/seamonkey/source/embedding/browser/webBrowser/nsIWebBrowserPrint.idl"> </a><a class="external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIWebBrowserFind.html">nsIWebBrowserFind</a> </h4>
<p>This interface exposes the searching capabilities of the nsWebBrowser component.
<b>Interface status:</b> none
<b>Interface definition:</b> <a class="external" href="http://lxr.mozilla.org/seamonkey/source/embedding/browser/webBrowser/nsIWebBrowserFind.idl">nsIWebBrowserFind.idl</a>
</p>
<h4 name="nsIWebBrowserFocus"> <a class="external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIWebBrowserFocus.html">nsIWebBrowserFocus</a> </h4>
<p>This interface provides access to the focus information of a nsWebBrowser instance.
Interface status: <a class="external" href="http://www.mozilla.org/projects/embedding/apiReviewNotes.html#nsIWebBrowserFocus">being reviewed</a>
<b>Interface definition:</b> <a class="external" href="http://lxr.mozilla.org/seamonkey/source/embedding/browser/webBrowser/nsIWebBrowserFocus.idl">nsIWebBrowserFocus.idl</a>
</p>
<h4 name="nsIWebProgress"> <a class="external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIWebProgress.html">nsIWebProgress</a> </h4>
<p>The nsIWebProgress interface is used to add or remove <a href="en/NsIWebProgressListener">nsIWebProgressListener</a> instances to observe the loading of asynchronous requests (usually in the context of a DOM window).
</p>
<h4 name="nsIWebProgressListener"> <a href="en/NsIWebProgressListener">nsIWebProgressListener</a> </h4>
<p>The nsIWebProgress interface is used to add or remove nsIWebProgressListener instances to observe the loading of asynchronous requests (usually in the context of a DOM window). </p>
<h4 name="nsIPrompt"> <a class="external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIPrompt.html">nsIPrompt</a> </h4>
<h4 name="nsIPrefs"> nsIPrefs </h4>
<h4>nsIProfile</h4>
<p>The {{ interface("nsIProfile") }} interface provides access to the Profile Manager, which lets you create and manage user profiles. Obsolete.</p><h4 name="nsIDirectoryServiceProvider"> <a href="en/NsIDirectoryServiceProvider">nsIDirectoryServiceProvider</a> </h4>
<p>The nsIDirectoryServiceProvider interface is used by the Directory Service to get file locations. </p>
<h4 name="nsILocalFile"> <a href="en/NsILocalFile">nsILocalFile</a> </h4>
<p>The nsILocalFile interface represents a file or directory location in a platform-independent manner that is accessible on the local filesystem. It extends <a href="en/NsIFile">nsIFile</a>.
</p>
<h4 name="nsIFile"> <a href="en/NsIFile">nsIFile</a> </h4>
<p>This interface is the only correct cross-platform way to specify a file. Strings are not such a way. Despite the fact that they work on Windows or Unix, they will not work here. </p>
<h4 name="nsIClipboardCommands"> <a class="external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIClipboardCommands.html">nsIClipboardCommands</a> </h4>
<p>An interface for embedding clients who wish to interact with the system-wide OS clipboard. Mozilla does not use a private clipboard, instead it places its data directly onto the system clipboard. The webshell implements this interface.
</p>
<h4 name="nsISelection"> <a class="external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsISelection.html">nsISelection</a> </h4>
<p>Interface for manipulating and querying the current selected range of nodes within the document. </p>
<h4 name="nsIURILoader"> <a class="external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIURILoader.html">nsIURILoader</a> </h4>
<p>The uri dispatcher is responsible for taking uri's, determining the content and routing the opened url to the correct content handler.
</p>
<h4 name="nsIURIContentListener"> <a class="external" href="http://www.xulplanet.com/references/xpcomref/ifaces/nsIURIContentListener.html">nsIURIContentListener</a> </h4>
<p>nsIURIContentListener is an interface used by components which want to know (and have a chance to handle) a particular content type. Typical usage scenarios will include running applications which register a nsIURIContentListener for each of its content windows with the uri dispatcher service.
</p>
Revert to this revision