Back to index

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

import "nsIFileSpec.idl";

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

List of all members.

Public Member Functions

void fromFileSpec ([const ] in nsIFileSpec original)
void error ()
boolean isValid ()
boolean failed ()
boolean isChildOf (in nsIFileSpec possibleParent)
void setFromFileSpec ([const ] in nsFileSpecRef spec)
void makeUnique ()
void makeUniqueWithSuggestedName (in string suggestedName)
void makeUniqueDir ()
void makeUniqueDirWithSuggestedName (in string suggestedName)
boolean modDateChanged (in unsigned long oldStamp)
boolean isDirectory ()
boolean isFile ()
boolean exists ()
boolean isHidden ()
boolean equals (in nsIFileSpec spec)
void appendRelativeUnixPath (in string relativePath)
void createDir ()
void touch ()
boolean isSymlink ()
void resolveSymlink ()
void delete (in boolean recursive)
void truncate (in long aNewLength)
void rename ([const ] in string newLeafName)
void copyToDir ([const ] in nsIFileSpec newParentDir)
void moveToDir ([const ] in nsIFileSpec newParentDir)
void execute ([const ] in string args)
void openStreamForReading ()
void openStreamForWriting ()
void openStreamForReadingAndWriting ()
void closeStream ()
boolean isStreamOpen ()
boolean eof ()
long read (inout string buffer, in long requestedCount)
void readLine (inout string line, in long bufferSize, out boolean wasTruncated)
long write (in string data, in long requestedCount)
 Check eof() before each call.
void flush ()
void seek (in long offset)
long tell ()
void endLine ()

Public Attributes

attribute string URLString
attribute string unixStyleFilePath
attribute string persistentDescriptorString
attribute string nativePath
readonly attribute string NSPRPath
attribute string leafName
readonly attribute nsIFileSpec parent
readonly attribute nsIInputStream inputStream
readonly attribute nsIOutputStream outputStream
readonly attribute nsFileSpec fileSpec
attribute string fileContents
readonly attribute unsigned long modDate
readonly attribute unsigned long fileSize
readonly attribute long long diskSpaceAvailable
attribute AString unicodePath

Detailed Description

Definition at line 79 of file nsIFileSpec.idl.


Member Function Documentation

void nsIFileSpec::copyToDir ( [const ] in nsIFileSpec  newParentDir)
void nsIFileSpec::execute ( [const ] in string  args)

Implemented in NS_COM_OBSOLETE, and NS_COM_OBSOLETE.

void nsIFileSpec::fromFileSpec ( [const ] in nsIFileSpec  original)
boolean nsIFileSpec::modDateChanged ( in unsigned long  oldStamp)
void nsIFileSpec::moveToDir ( [const ] in nsIFileSpec  newParentDir)
long nsIFileSpec::read ( inout string  buffer,
in long  requestedCount 
)
void nsIFileSpec::readLine ( inout string  line,
in long  bufferSize,
out boolean  wasTruncated 
)
void nsIFileSpec::rename ( [const ] in string  newLeafName)

Here is the caller graph for this function:

Implemented in NS_COM_OBSOLETE.

void nsIFileSpec::truncate ( in long  aNewLength)
long nsIFileSpec::write ( in string  data,
in long  requestedCount 
)

Check eof() before each call.

CAUTION: false result only indicates line was truncated to fit buffer, or an error occurred (OTHER THAN eof).


Member Data Documentation

Definition at line 123 of file nsIFileSpec.idl.

Definition at line 104 of file nsIFileSpec.idl.

Definition at line 122 of file nsIFileSpec.idl.

Definition at line 101 of file nsIFileSpec.idl.

Definition at line 98 of file nsIFileSpec.idl.

Definition at line 95 of file nsIFileSpec.idl.

readonly attribute unsigned long nsIFileSpec::modDate

Definition at line 112 of file nsIFileSpec.idl.

Definition at line 86 of file nsIFileSpec.idl.

Definition at line 88 of file nsIFileSpec.idl.

Definition at line 99 of file nsIFileSpec.idl.

Definition at line 97 of file nsIFileSpec.idl.

Definition at line 85 of file nsIFileSpec.idl.

Definition at line 160 of file nsIFileSpec.idl.

Definition at line 84 of file nsIFileSpec.idl.

Definition at line 83 of file nsIFileSpec.idl.


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