Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIComponentManagerObsolete Interface Reference

import "nsIComponentManagerObsolete.idl";

Inheritance diagram for nsIComponentManagerObsolete:
Inheritance graph
[legend]
Collaboration diagram for nsIComponentManagerObsolete:
Collaboration graph
[legend]

List of all members.

Public Member Functions

nsIFactory findFactory (in nsCIDRef aClass)
 findFactory
voidPtr getClassObject (in nsCIDRef aClass, in nsIIDRef aIID)
 getClassObject
nsresult contractIDToClassID (in string aContractID, out nsCID aClass)
 contractIDToClassID
string CLSIDToContractID (in nsCIDRef aClass, out string aClassName)
 classIDToContractid
voidPtr createInstance (in nsCIDRef aClass, in nsISupports aDelegate, in nsIIDRef aIID)
 createInstance
voidPtr createInstanceByContractID (in string aContractID, in nsISupports aDelegate, in nsIIDRef IID)
 createInstanceByContractID
string registryLocationForSpec (in nsIFile aSpec)
 registryLocationForSpec
nsIFile specForRegistryLocation (in string aLocation)
 specForRegistyLocation
void registerFactory (in nsCIDRef aClass, in string aClassName, in string aContractID, in nsIFactory aFactory, in boolean aReplace)
 registerFactory
void registerComponent (in nsCIDRef aClass, in string aClassName, in string aContractID, in string aLocation, in boolean aReplace, in boolean aPersist)
 registerComponent
void registerComponentWithType (in nsCIDRef aClass, in string aClassName, in string aContractID, in nsIFile aSpec, in string aLocation, in boolean aReplace, in boolean aPersist, in string aType)
 registerComponentWithType
void registerComponentSpec (in nsCIDRef aClass, in string aClassName, in string aContractID, in nsIFile aLibrary, in boolean aReplace, in boolean aPersist)
 registerComponentSpec
void registerComponentLib (in nsCIDRef aClass, in string aClassName, in string aContractID, in string aDllName, in boolean aReplace, in boolean aPersist)
 registerComponentLib
void unregisterFactory (in nsCIDRef aClass, in nsIFactory aFactory)
 unregisterFactory
void unregisterComponent (in nsCIDRef aClass, in string aLocation)
 unregisterComponent
void unregisterComponentSpec (in nsCIDRef aClass, in nsIFile aLibrarySpec)
 unregisterComponentSpec
void freeLibraries ()
 freeLibraries
void autoRegister (in long when, in nsIFile directory)
 autoRegister
void autoRegisterComponent (in long when, in nsIFile aFileLocation)
 autoRegisterComponent
void autoUnregisterComponent (in long when, in nsIFile aFileLocation)
 autoUnregisterComponent
boolean isRegistered (in nsCIDRef aClass)
 isRegistered
nsIEnumerator enumerateCLSIDs ()
 enumerateCLSIDs
nsIEnumerator enumerateContractIDs ()
 enumerateContractIDs

Public Attributes

const long NS_Startup = 0
 ID values for 'when'.
const long NS_Script = 1
const long NS_Timer = 2
const long NS_Shutdown = 3

Detailed Description

Definition at line 45 of file nsIComponentManagerObsolete.idl.


Member Function Documentation

autoRegister

Enumerates directory looking for modules of all types and registers modules who have changed (modtime or size) since the last time autoRegister() was invoked.

Parameters:
when: ID values of when the call is being made.
directory: Directory the will be enumerated.

autoRegisterComponent

Loads module using appropriate loader and gives it an opportunity to register its CIDs if module's modtime or size changed since the last time this was called.

Parameters:
when: ID values of when the call is being made.
aFileLocation: File specification of module.

autoUnregisterComponent

Loads module using approriate loader and gives it an opportunity to unregister its CIDs

string nsIComponentManagerObsolete::CLSIDToContractID ( in nsCIDRef  aClass,
out string  aClassName 
)

classIDToContractid

Get the ContractID for a given ClassID. A ClassIDs may implement multiple ContractIDs. This function return the last registered ContractID.

Parameters:
aClass: ClassID for which ContractID is requested.
Returns:
aClassName : returns class name asssociated with aClass
: ContractID last registered for aClass

Here is the caller graph for this function:

contractIDToClassID

Get the ClassID for a given ContractID. Many ClassIDs may implement a ContractID. In such a situation, this returns the preferred ClassID, which happens to be the last registered ClassID.

Parameters:
aContractID: Contractid for which ClassID is requested
Returns:
aClass : ClassID return
voidPtr nsIComponentManagerObsolete::createInstance ( in nsCIDRef  aClass,
in nsISupports  aDelegate,
in nsIIDRef  aIID 
)

createInstance

Create an instance of the CID aClass and return the interface aIID.

Parameters:
aClass: ClassID of object instance requested
aDelegate: Used for aggregation
aIID: IID of interface requested
voidPtr nsIComponentManagerObsolete::createInstanceByContractID ( in string  aContractID,
in nsISupports  aDelegate,
in nsIIDRef  IID 
)

createInstanceByContractID

Create an instance of the CID that implements aContractID and return the interface aIID. This is a convenience function that effectively does ContractIDToClassID() followed by CreateInstance().

Parameters:
aContractID: aContractID of object instance requested
aDelegate: Used for aggregation
aIID: IID of interface requested

enumerateCLSIDs

Enumerate the list of all registered ClassIDs.

Returns:
: enumerator for ClassIDs.

enumerateContractIDs

Enumerate the list of all registered ContractIDs.

Returns:
: enumerator for ContractIDs.

findFactory

Returns the factory object that can be used to create instances of CID aClass

Parameters:
aClassThe classid of the factory that is being requested

freeLibraries

Enumerates all loaded modules and unloads unused modules.

voidPtr nsIComponentManagerObsolete::getClassObject ( in nsCIDRef  aClass,
in nsIIDRef  aIID 
)

getClassObject

Parameters:
aClass: CID of the class whose class object is requested
aIID: IID of an interface that the class object is known to to implement. nsISupports and nsIFactory are known to be implemented by the class object.

isRegistered

Returns true if a factory or module is registered for CID aClass.

Parameters:
aClass: ClassID queried for registeration
Returns:
: true if a factory or module is registered for CID aClass. false otherwise.
void nsIComponentManagerObsolete::registerComponent ( in nsCIDRef  aClass,
in string  aClassName,
in string  aContractID,
in string  aLocation,
in boolean  aReplace,
in boolean  aPersist 
)

registerComponent

Register a native dll module via its registry representation as returned by registryLocationForSpec() as the container of CID implemenation aClass and associate aContractID and aClassName to the CID aClass. Native dll component type is assumed.

Parameters:
aClass: CID implemenation contained in module
aClassName: Class name associated with CID aClass
aContractID: ContractID associated with CID aClass
aLocation: Location of module (dll). Format of this is the registry representation as returned by registryLocationForSpec()
aReplace: Boolean that indicates whether to replace a previous module registration for aClass.
aPersist: Remember this registration across sessions.
void nsIComponentManagerObsolete::registerComponentLib ( in nsCIDRef  aClass,
in string  aClassName,
in string  aContractID,
in string  aDllName,
in boolean  aReplace,
in boolean  aPersist 
)

registerComponentLib

Register a native dll module via its dll name (not full path) as the container of CID implemenation aClass and associate aContractID and aClassName to the CID aClass. Native dll component type is assumed and the system services will be used to load this dll.

Parameters:
aClass: CID implemenation contained in module
aClassName: Class name associated with CID aClass
aContractID: ContractID associated with CID aClass
aDllNameLocation: Dll name of module.
aReplace: Boolean that indicates whether to replace a previous module registration for aClass.
aPersist: Remember this registration across sessions.
void nsIComponentManagerObsolete::registerComponentSpec ( in nsCIDRef  aClass,
in string  aClassName,
in string  aContractID,
in nsIFile  aLibrary,
in boolean  aReplace,
in boolean  aPersist 
)

registerComponentSpec

Register a native dll module via its file specification as the container of CID implemenation aClass and associate aContractID and aClassName to the CID aClass. Native dll component type is assumed.

Parameters:
aClass: CID implemenation contained in module
aClassName: Class name associated with CID aClass
aContractID: ContractID associated with CID aClass
aLibrary: File specification Location of module (dll).
aReplace: Boolean that indicates whether to replace a previous module registration for aClass.
aPersist: Remember this registration across sessions.
void nsIComponentManagerObsolete::registerComponentWithType ( in nsCIDRef  aClass,
in string  aClassName,
in string  aContractID,
in nsIFile  aSpec,
in string  aLocation,
in boolean  aReplace,
in boolean  aPersist,
in string  aType 
)

registerComponentWithType

Register a module's location via its registry representation as returned by registryLocationForSpec() as the container of CID implemenation aClass of type aType and associate aContractID and aClassName to the CID aClass.

Parameters:
aClass: CID implemenation contained in module
aClassName: Class name associated with CID aClass
aContractID: ContractID associated with CID aClass
aSpec: Filename spec for module's location.
aLocation: Location of module of type aType. Format of this string is the registry representation as returned by registryLocationForSpec()
aReplace: Boolean that indicates whether to replace a previous loader registration for aClass.
aPersist: Remember this registration across sessions.
aType: Component Type of CID aClass.
void nsIComponentManagerObsolete::registerFactory ( in nsCIDRef  aClass,
in string  aClassName,
in string  aContractID,
in nsIFactory  aFactory,
in boolean  aReplace 
)

registerFactory

Register a factory and ContractID associated with CID aClass

Parameters:
aClass: CID of object
aClassName: Class Name of CID
aContractID: ContractID associated with CID aClass
aFactory: Factory that will be registered for CID aClass
aReplace: Boolean that indicates whether to replace a previous registration for the CID aClass.

registryLocationForSpec

Given a file specification, return the registry representation of the filename. Files that are found relative to the components directory will have a registry representation "rel:<relative-native-path>" while filenames that are not, will have "abs:<full-native-path>".

specForRegistyLocation

Create a file specification for the registry representation (rel:/abs:) got via registryLocationForSpec.

void nsIComponentManagerObsolete::unregisterComponent ( in nsCIDRef  aClass,
in string  aLocation 
)

unregisterComponent

Disassociate module aLocation represented as registry location as returned by registryLocationForSpec() as containing ClassID aClass.

Parameters:
aClass: ClassID being unregistered
aLocation: Location of module. Format of this is the registry representation as returned by registryLocationForSpec(). Components of any type will be unregistered.
void nsIComponentManagerObsolete::unregisterComponentSpec ( in nsCIDRef  aClass,
in nsIFile  aLibrarySpec 
)

unregisterComponentSpec

Disassociate module references by file specification aLibrarySpec as containing ClassID aClass.

unregisterFactory

Unregister a factory associated with CID aClass.

Parameters:
aClass: ClassID being unregistered
aFactory: Factory previously registered to create instances of ClassID aClass.

Member Data Documentation

Definition at line 281 of file nsIComponentManagerObsolete.idl.

Definition at line 283 of file nsIComponentManagerObsolete.idl.

ID values for 'when'.

Definition at line 280 of file nsIComponentManagerObsolete.idl.

Definition at line 282 of file nsIComponentManagerObsolete.idl.


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