Back to index

lightning-sunbird  0.9+nobinonly
Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes
mozMySpellDirProvider Class Reference

#include <mozMySpellDirProvider.h>

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

List of all members.

Classes

class  AppendingEnumerator

Public Member Functions

nsISimpleEnumerator getFiles (in string prop)
 getFiles
nsIFile getFile (in string prop, out PRBool persistent)
 getFile

Static Public Member Functions

NS_DECL_ISUPPORTS
NS_DECL_NSIDIRECTORYSERVICEPROVIDER
static
NS_DECL_NSIDIRECTORYSERVICEPROVIDER2
NS_METHOD 
Register (nsIComponentManager *aCompMgr, nsIFile *aPath, const char *aLoaderStr, const char *aType, const nsModuleComponentInfo *aInfo)
static NS_METHOD Unregister (nsIComponentManager *aCompMgr, nsIFile *aPath, const char *aLoaderStr, const nsModuleComponentInfo *aInfo)

Static Public Attributes

static char const *const kContractID = "@mozilla.org/spellcheck/dir-provider;1"

Detailed Description

Definition at line 46 of file mozMySpellDirProvider.h.


Member Function Documentation

nsIFile nsIDirectoryServiceProvider::getFile ( in string  prop,
out PRBool  persistent 
) [inherited]

getFile

Directory Service calls this when it gets the first request for a prop or on every request if the prop is not persistent.

Parameters:
propThe symbolic name of the file.
persistentTRUE - The returned file will be cached by Directory Service. Subsequent requests for this prop will bypass the provider and use the cache. FALSE - The provider will be asked for this prop each time it is requested.
Returns:
The file represented by the property.

getFiles

Directory Service calls this when it gets a request for a prop and the requested type is nsISimpleEnumerator.

Parameters:
propThe symbolic name of the file list.
Returns:
An enumerator for a list of file locations. The elements in the enumeration are nsIFile NS_SUCCESS_AGGREGATE_RESULT if this result should be aggregated with other "lower" providers.
NS_METHOD mozMySpellDirProvider::Register ( nsIComponentManager aCompMgr,
nsIFile aPath,
const char *  aLoaderStr,
const char *  aType,
const nsModuleComponentInfo aInfo 
) [static]

Definition at line 143 of file mozMySpellDirProvider.cpp.

{
  nsresult rv;

  nsCOMPtr<nsICategoryManager> catMan =
    do_GetService(NS_CATEGORYMANAGER_CONTRACTID);
  if (!catMan)
    return NS_ERROR_FAILURE;

  rv = catMan->AddCategoryEntry(XPCOM_DIRECTORY_PROVIDER_CATEGORY,
                            "spellcheck-directory-provider",
                            kContractID, PR_TRUE, PR_TRUE, nsnull);
  return rv;
}

Here is the call graph for this function:

NS_METHOD mozMySpellDirProvider::Unregister ( nsIComponentManager aCompMgr,
nsIFile aPath,
const char *  aLoaderStr,
const nsModuleComponentInfo aInfo 
) [static]

Definition at line 162 of file mozMySpellDirProvider.cpp.

{
  nsresult rv;

  nsCOMPtr<nsICategoryManager> catMan =
    do_GetService(NS_CATEGORYMANAGER_CONTRACTID);
  if (!catMan)
    return NS_ERROR_FAILURE;

  rv = catMan->DeleteCategoryEntry(XPCOM_DIRECTORY_PROVIDER_CATEGORY,
                               "spellcheck-directory-provider",
                               PR_TRUE);
  return rv;
}

Here is the call graph for this function:


Member Data Documentation

char const *const mozMySpellDirProvider::kContractID = "@mozilla.org/spellcheck/dir-provider;1" [static]

Definition at line 63 of file mozMySpellDirProvider.h.


The documentation for this class was generated from the following files: