Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
org.mozilla.xpcom.IGRE Interface Reference
Inheritance diagram for org.mozilla.xpcom.IGRE:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void initEmbedding (File aLibXULDirectory, File aAppDirectory, IAppFileLocProvider aAppDirProvider) throws XPCOMException
 Initializes libXUL for embedding purposes.
void termEmbedding ()
 Terminates libXUL embedding.
ProfileLock lockProfileDirectory (File aDirectory) throws XPCOMException
 Lock a profile directory using platform-specific semantics.
void notifyProfile ()
 Fire notifications to inform the toolkit about a new profile.

Detailed Description

Definition at line 42 of file IGRE.java.


Member Function Documentation

void org.mozilla.xpcom.IGRE.initEmbedding ( File  aLibXULDirectory,
File  aAppDirectory,
IAppFileLocProvider  aAppDirProvider 
) throws XPCOMException

Initializes libXUL for embedding purposes.

NOTE: This function must be called from the "main" thread.

NOTE: At the present time, this function may only be called once in a given process. Use termEmbedding to clean up and free resources allocated by initEmbedding.

Parameters:
aLibXULDirectoryThe directory in which the libXUL shared library was found.
aAppDirectoryThe directory in which the application components and resources can be found. This will map to the "resource:app" directory service key.
aAppDirProviderA directory provider for the application. This provider will be aggregated by a libXUL provider which will provide the base required GRE keys.
Exceptions:
XPCOMExceptionif a failure occurred during initialization

Implemented in org.mozilla.xpcom.Mozilla, and org.mozilla.xpcom.internal.GREImpl.

Here is the caller graph for this function:

Lock a profile directory using platform-specific semantics.

Parameters:
aDirectoryThe profile directory to lock.
Returns:
A lock object. The directory will remain locked until the lock is released by invoking the release method, or by the termination of the JVM, whichever comes first.
Exceptions:
XPCOMExceptionif a failure occurred

Implemented in org.mozilla.xpcom.Mozilla, and org.mozilla.xpcom.internal.GREImpl.

Here is the caller graph for this function:

Fire notifications to inform the toolkit about a new profile.

This method should be called after initEmbedding if the embedder wishes to run with a profile.

Normally the embedder should call lockProfileDirectory to lock the directory before calling this method.

NOTE: There are two possibilities for selecting a profile:

  • Select the profile before calling initEmbedding. The aAppDirProvider object passed to initEmbedding should provide the NS_APP_USER_PROFILE_50_DIR key, and may also provide the following keys:
    • NS_APP_USER_PROFILE_LOCAL_50_DIR
    • NS_APP_PROFILE_DIR_STARTUP
    • NS_APP_PROFILE_LOCAL_DIR_STARTUP
    In this scenario notifyProfile should be called immediately after initEmbedding. Component registration information will be stored in the profile and JS components may be stored in the fastload cache.
  • Select a profile some time after calling initEmbedding. In this case the embedder must install a directory service provider which provides NS_APP_USER_PROFILE_50_DIR and optionally NS_APP_USER_PROFILE_LOCAL_50_DIR. Component registration information will be stored in the application directory and JS components will not fastload.

Implemented in org.mozilla.xpcom.Mozilla, and org.mozilla.xpcom.internal.GREImpl.

Here is the caller graph for this function:

Terminates libXUL embedding.

NOTE: Release any references to XPCOM objects that you may be holding before calling this function.

Implemented in org.mozilla.xpcom.Mozilla, and org.mozilla.xpcom.internal.GREImpl.

Here is the caller graph for this function:


The documentation for this interface was generated from the following file: