Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | Friends
nsToolkitProfile Class Reference
Inheritance diagram for nsToolkitProfile:
Inheritance graph
[legend]
Collaboration diagram for nsToolkitProfile:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ~nsToolkitProfile ()
void remove (in boolean removeFiles)
 Removes the profile from the registry of profiles.
nsIProfileLock lock (out nsIProfileUnlocker aUnlocker)
 Lock this profile using platform-specific locking methods.

Public Attributes

NS_DECL_ISUPPORTS friend class nsToolkitProfileService
nsCOMPtr< nsToolkitProfilemNext
nsToolkitProfilemPrev
readonly attribute nsILocalFile rootDir
 The location of the profile directory.
readonly attribute nsILocalFile localDir
 The location of the profile local directory, which may be the same as the root directory.
attribute AUTF8String name
 The name of the profile.

Private Member Functions

 nsToolkitProfile (const nsACString &aName, nsILocalFile *aRootDir, nsILocalFile *aLocalDir, nsToolkitProfile *aPrev)

Private Attributes

nsCString mName
nsCOMPtr< nsILocalFilemRootDir
nsCOMPtr< nsILocalFilemLocalDir
nsIProfileLockmLock

Friends

class nsToolkitProfileLock

Detailed Description

Definition at line 74 of file nsToolkitProfileService.cpp.


Constructor & Destructor Documentation

Definition at line 84 of file nsToolkitProfileService.cpp.

{ }
nsToolkitProfile::nsToolkitProfile ( const nsACString &  aName,
nsILocalFile aRootDir,
nsILocalFile aLocalDir,
nsToolkitProfile aPrev 
) [private]

Definition at line 176 of file nsToolkitProfileService.cpp.

                                                            :
    mPrev(aPrev),
    mName(aName),
    mRootDir(aRootDir),
    mLocalDir(aLocalDir),
    mLock(nsnull)
{
    NS_ASSERTION(aRootDir, "No file!");

    if (aPrev)
        aPrev->mNext = this;
    else
        nsToolkitProfileService::gService->mFirst = this;
}

Here is the caller graph for this function:


Member Function Documentation

Lock this profile using platform-specific locking methods.

Parameters:
lockFileIf locking fails, this may return a lockFile object which can be used in platform-specific ways to determine which process has the file locked. Null may be passed.
Returns:
An interface which holds a profile lock as long as you reference it.
Exceptions:
NS_ERROR_FILE_ACCESS_DENIEDif the profile was already locked.
void nsIToolkitProfile::remove ( in boolean  removeFiles) [inherited]

Removes the profile from the registry of profiles.

Parameters:
removeFilesIndicates whether or not the profile directory should be removed in addition.

Friends And Related Function Documentation

friend class nsToolkitProfileLock [friend]

Definition at line 92 of file nsToolkitProfileService.cpp.


Member Data Documentation

The location of the profile local directory, which may be the same as the root directory.

See nsIProfileLock::localDirectory.

Definition at line 89 of file nsIToolkitProfile.idl.

Definition at line 96 of file nsToolkitProfileService.cpp.

Definition at line 97 of file nsToolkitProfileService.cpp.

Definition at line 94 of file nsToolkitProfileService.cpp.

Definition at line 81 of file nsToolkitProfileService.cpp.

Definition at line 82 of file nsToolkitProfileService.cpp.

Definition at line 95 of file nsToolkitProfileService.cpp.

attribute AUTF8String nsIToolkitProfile::name [inherited]

The name of the profile.

Definition at line 94 of file nsIToolkitProfile.idl.

Definition at line 80 of file nsToolkitProfileService.cpp.

The location of the profile directory.

Definition at line 83 of file nsIToolkitProfile.idl.


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