Back to index

lightning-sunbird  0.9+nobinonly
Classes | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Attributes | Friends
nsDownload Class Reference

#include <nsDownloadManager.h>

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

List of all members.

Classes

struct  TransferInformation

Public Member Functions

NS_DECL_NSIWEBPROGRESSLISTENER
NS_DECL_NSIWEBPROGRESSLISTENER2
NS_DECL_NSITRANSFER
NS_DECL_NSIDOWNLOAD
NS_DECL_NSIDOWNLOAD_MOZILLA_1_8_BRANCH
NS_DECL_ISUPPORTS 
nsDownload ()
virtual ~nsDownload ()
DownloadState GetDownloadState ()
void SetDownloadState (DownloadState aState)
DownloadType GetDownloadType ()
void SetDownloadType (DownloadType aType)
NS_DECL_NSIWEBPROGRESSLISTENER
NS_DECL_NSIWEBPROGRESSLISTENER2
NS_DECL_NSITRANSFER
NS_DECL_NSIDOWNLOAD
NS_DECL_NSIDOWNLOAD_MOZILLA_1_8_BRANCH
NS_DECL_NSIOBSERVER
NS_DECL_ISUPPORTS 
nsDownload (nsDownloadManager *aManager, nsIURI *aTarget, nsIURI *aSource, nsICancelable *aCancelable)
 ~nsDownload ()
nsresult Cancel ()
nsresult Suspend ()
nsresult SetDisplayName (const PRUnichar *aDisplayName)
nsresult SetTempFile (nsILocalFile *aTempFile)
nsresult Resume ()
void DisplayDownloadFinishedAlert ()
void SetDialogListener (nsIWebProgressListener2 *aInternalListener)
void SetDialog (nsIProgressDialog *aDialog)
nsIProgressDialogGetDialog ()
TransferInformation GetTransferInformation ()
DownloadState GetDownloadState ()
void SetDownloadState (DownloadState aState)
void SetMIMEInfo (nsIMIMEInfo *aMIMEInfo)
void SetStartTime (PRInt64 aStartTime)
void observe (in nsISupports aSubject, in string aTopic, in wstring aData)
 Observe will be called when there is a notification for the topic |aTopic|.
void init (in nsIURI aSource, in nsIURI aTarget, in AString aDisplayName, in nsIMIMEInfo aMIMEInfo, in PRTime startTime, in nsILocalFile aTempFile, in nsICancelable aCancelable)
 Initializes the transfer with certain properties.
void onProgressChange64 (in nsIWebProgress aWebProgress, in nsIRequest aRequest, in long long aCurSelfProgress, in long long aMaxSelfProgress, in long long aCurTotalProgress, in long long aMaxTotalProgress)
 Notification that the progress has changed for one of the requests associated with aWebProgress.
void onStateChange (in nsIWebProgress aWebProgress, in nsIRequest aRequest, in unsigned long aStateFlags, in nsresult aStatus)
 Notification indicating the state has changed for one of the requests associated with aWebProgress.
void onProgressChange (in nsIWebProgress aWebProgress, in nsIRequest aRequest, in long aCurSelfProgress, in long aMaxSelfProgress, in long aCurTotalProgress, in long aMaxTotalProgress)
 Notification that the progress has changed for one of the requests associated with aWebProgress.
void onLocationChange (in nsIWebProgress aWebProgress, in nsIRequest aRequest, in nsIURI aLocation)
 Called when the location of the window being watched changes.
void onStatusChange (in nsIWebProgress aWebProgress, in nsIRequest aRequest, in nsresult aStatus, in wstring aMessage)
 Notification that the status of a request has changed.
void onSecurityChange (in nsIWebProgress aWebProgress, in nsIRequest aRequest, in unsigned long aState)
 Notification called for security progress.

Public Attributes

readonly attribute double speed
 The speed of the transfer in bytes/sec.
readonly attribute nsILocalFile targetFile
 The target of a download is always a file on the local file system.
readonly attribute PRInt32 percentComplete
 The percentage of transfer completed.
readonly attribute PRUint64 amountTransferred
 The amount of kbytes downloaded so far.
readonly attribute PRUint64 size
 The size of file in kbytes.
readonly attribute nsIURI source
 The source of the transfer.
readonly attribute nsIURI target
 The target of the transfer.
readonly attribute nsICancelable cancelable
 Object that can be used to cancel the download.
readonly attribute wstring displayName
 The user-readable description of the transfer.
readonly attribute long long startTime
 The time a transfer was started.
readonly attribute nsIMIMEInfo MIMEInfo
 Optional.
const unsigned long STATE_START = 0x00000001
 State Transition Flags.
const unsigned long STATE_REDIRECTING = 0x00000002
const unsigned long STATE_TRANSFERRING = 0x00000004
const unsigned long STATE_NEGOTIATING = 0x00000008
const unsigned long STATE_STOP = 0x00000010
const unsigned long STATE_IS_REQUEST = 0x00010000
 State Type Flags.
const unsigned long STATE_IS_DOCUMENT = 0x00020000
const unsigned long STATE_IS_NETWORK = 0x00040000
const unsigned long STATE_IS_WINDOW = 0x00080000
const unsigned long STATE_RESTORING = 0x01000000
 State Modifier Flags.
const unsigned long STATE_IS_INSECURE = 0x00000004
 State Security Flags.
const unsigned long STATE_IS_BROKEN = 0x00000001
const unsigned long STATE_IS_SECURE = 0x00000002
const unsigned long STATE_SECURE_HIGH = 0x00040000
 Security Strength Flags.
const unsigned long STATE_SECURE_MED = 0x00010000
const unsigned long STATE_SECURE_LOW = 0x00020000

Protected Member Functions

nsresult SetDownloadManager (nsDownloadManager *aDownloadManager)
nsresult SetDialogListener (nsIWebProgressListener *aInternalListener)
nsresult GetDialogListener (nsIWebProgressListener **aInternalListener)
nsresult SetDialog (nsIProgressDialog *aDialog)
nsresult GetDialog (nsIProgressDialog **aDialog)
nsresult SetTempFile (nsILocalFile *aTempFile)
nsresult GetTempFile (nsILocalFile **aTempFile)
nsresult SetCancelable (nsICancelable *aCancelable)
nsresult SetTarget (nsIURI *aTarget)
nsresult SetDisplayName (const PRUnichar *aDisplayName)
nsresult SetSource (nsIURI *aSource)
nsresult SetMIMEInfo (nsIMIMEInfo *aMIMEInfo)
nsresult SetStartTime (PRInt64 aStartTime)
void Pause (PRBool aPaused)
PRBool IsPaused ()
TransferInformation GetTransferInformation ()

Protected Attributes

nsDownloadManagermDownloadManager
nsCOMPtr< nsIURImTarget

Private Attributes

nsString mDisplayName
nsCOMPtr< nsIURImSource
nsCOMPtr< nsIWebProgressListenermDialogListener
nsCOMPtr< nsICancelablemCancelable
nsCOMPtr< nsIRequestmRequest
nsCOMPtr< nsIProgressDialogmDialog
nsCOMPtr< nsILocalFilemTempFile
nsCOMPtr< nsIMIMEInfomMIMEInfo
DownloadState mDownloadState
DownloadType mDownloadType
PRBool mPaused
PRInt32 mPercentComplete
PRUint64 mCurrBytes
PRUint64 mMaxBytes
PRTime mStartTime
PRTime mLastUpdate
double mSpeed
nsRefPtr< nsDownloadManagermDownloadManager
nsCOMPtr< nsIWebProgressListener2mDialogListener

Friends

class nsDownloadManager

Detailed Description

Definition at line 198 of file nsDownloadManager.h.


Constructor & Destructor Documentation

NS_DECL_NSIWEBPROGRESSLISTENER NS_DECL_NSIWEBPROGRESSLISTENER2 NS_DECL_NSITRANSFER NS_DECL_NSIDOWNLOAD NS_DECL_NSIDOWNLOAD_MOZILLA_1_8_BRANCH NS_DECL_ISUPPORTS nsDownload::nsDownload ( )
nsDownload::~nsDownload ( ) [virtual]

Definition at line 1861 of file nsDownloadManager.cpp.

{  
}
NS_DECL_NSIWEBPROGRESSLISTENER NS_DECL_NSIWEBPROGRESSLISTENER2 NS_DECL_NSITRANSFER NS_DECL_NSIDOWNLOAD NS_DECL_NSIDOWNLOAD_MOZILLA_1_8_BRANCH NS_DECL_NSIOBSERVER NS_DECL_ISUPPORTS nsDownload::nsDownload ( nsDownloadManager aManager,
nsIURI aTarget,
nsIURI aSource,
nsICancelable aCancelable 
)

Member Function Documentation

Definition at line 933 of file nsDownloadManager.cpp.

{
  // Don't cancel if download is already finished or canceled
  if (GetDownloadState() == FINISHED || GetDownloadState() == CANCELED)
    return NS_OK;

  nsresult rv = mCancelable->Cancel(NS_BINDING_ABORTED);
  if (NS_FAILED(rv))
    return rv;
  
  SetDownloadState(CANCELED);

  nsCAutoString path;
  rv = GetFilePathUTF8(mTarget, path);
  if (NS_FAILED(rv))
    return rv;
  mDownloadManager->DownloadEnded(path, nsnull);
  
  // Dump the temp file.  This should really be done when the transfer
  // is cancelled, but there are other cancellation causes that shouldn't
  // remove this. We need to improve those bits.
  if (mTempFile) {
    PRBool exists;
    mTempFile->Exists(&exists);
    if (exists)
      mTempFile->Remove(PR_FALSE);
  }

  // if there's a progress dialog open for the item,
  // we have to notify it that we're cancelling
  nsCOMPtr<nsIObserver> observer = do_QueryInterface(GetDialog());
  if (observer) {
    rv = observer->Observe(NS_STATIC_CAST(nsIDownload*, this), "oncancel", nsnull);
  }
  
  return rv;
}

Here is the call graph for this function:

Definition at line 1187 of file nsDownloadManager.cpp.

{
  nsresult rv;
#ifndef MOZ_THUNDERBIRD
  nsCOMPtr<nsIAlertsService> alertsService(do_GetService(NS_ALERTSERVICE_CONTRACTID, &rv));
  if (NS_FAILED(rv))
    return;

  nsCOMPtr<nsIStringBundle> bundle;
  nsCOMPtr<nsIStringBundleService> bundleService = do_GetService(NS_STRINGBUNDLE_CONTRACTID, &rv);
  if (NS_FAILED(rv))
    return;

  rv = bundleService->CreateBundle(DOWNLOAD_MANAGER_BUNDLE, getter_AddRefs(bundle));
  if (NS_FAILED(rv))
    return;

  nsXPIDLString finishedTitle, finishedText;
  rv = bundle->GetStringFromName(NS_LITERAL_STRING("finishedTitle").get(),
                                 getter_Copies(finishedTitle));
  if (NS_FAILED(rv))
    return;

  const PRUnichar *strings[] = { mDisplayName.get() };
  rv = bundle->FormatStringFromName(NS_LITERAL_STRING("finishedText").get(),
                                    strings, 1, getter_Copies(finishedText));
  if (NS_FAILED(rv))
    return;
  
  nsCAutoString url;
  mTarget->GetSpec(url);
  alertsService->ShowAlertNotification(NS_LITERAL_STRING("moz-icon://") + NS_ConvertUTF8toUTF16(url),
                                       finishedTitle, finishedText, PR_TRUE,
                                       NS_LITERAL_STRING("download"), this);
#endif
}

Here is the call graph for this function:

Definition at line 139 of file nsDownloadManager.h.

                                 {
    return mDialog;
  }

Here is the caller graph for this function:

nsresult nsDownload::GetDialog ( nsIProgressDialog **  aDialog) [protected]

Definition at line 1895 of file nsDownloadManager.cpp.

{
  *aDialog = mDialog;
  NS_IF_ADDREF(*aDialog);
  return NS_OK;
}
nsresult nsDownload::GetDialogListener ( nsIWebProgressListener **  aInternalListener) [protected]

Definition at line 1880 of file nsDownloadManager.cpp.

{
  *aDialogListener = mDialogListener;
  NS_IF_ADDREF(*aDialogListener);
  return NS_OK;
}

Definition at line 154 of file nsDownloadManager.h.

                                   {
    return mDownloadState;
  }

Definition at line 1918 of file nsDownloadManager.cpp.

{
  return mDownloadState;
}

Here is the caller graph for this function:

Definition at line 1930 of file nsDownloadManager.cpp.

{
  return mDownloadType;
}
nsresult nsDownload::GetTempFile ( nsILocalFile **  aTempFile) [protected]

Definition at line 1910 of file nsDownloadManager.cpp.

{
  *aTempFile = mTempFile;
  NS_IF_ADDREF(*aTempFile);
  return NS_OK;
}

Definition at line 151 of file nsDownloadManager.h.

                                               {
    return TransferInformation(mCurrBytes, mMaxBytes);
  }

Definition at line 1986 of file nsDownloadManager.cpp.

{
  return TransferInformation(mCurrBytes, mMaxBytes);
}

Here is the caller graph for this function:

void nsITransfer::init ( in nsIURI  aSource,
in nsIURI  aTarget,
in AString  aDisplayName,
in nsIMIMEInfo  aMIMEInfo,
in PRTime  startTime,
in nsILocalFile  aTempFile,
in nsICancelable  aCancelable 
) [inherited]

Initializes the transfer with certain properties.

This function must be called prior to accessing any properties on this interface.

Parameters:
aSourceThe source URI of the transfer. Must not be null.
aTargetThe target URI of the transfer. Must not be null.
aDisplayNameThe user-readable description of the transfer. Can be empty.
aMIMEInfoThe MIME info associated with the target, including MIME type and helper app when appropriate. This parameter is optional.
startTimeTime when the download started (ie, when the first response from the server was received) XXX presumably wbp and exthandler do this differently
aTempFileThe location of a temporary file; i.e. a file in which the received data will be stored, but which is not equal to the target file. (will be moved to the real target by the caller, when the download is finished) May be null.
aCancelableAn object that can be used to abort the download. Must not be null. Implementations are expected to hold a strong reference to this object until the download is finished, at which point they should release the reference.
PRBool nsDownload::IsPaused ( ) [protected]

Definition at line 2400 of file nsDownloadManager.cpp.

{
  return mPaused;
}
void nsIObserver::observe ( in nsISupports  aSubject,
in string  aTopic,
in wstring  aData 
) [inherited]

Observe will be called when there is a notification for the topic |aTopic|.

This assumes that the object implementing this interface has been registered with an observer service such as the nsIObserverService.

If you expect multiple topics/subjects, the impl is responsible for filtering.

You should not modify, add, remove, or enumerate notifications in the implemention of observe.

Parameters:
aSubject: Notification specific interface pointer.
aTopic: The notification topic or subject.
aData: Notification specific wide string. subject event.
void nsIWebProgressListener::onLocationChange ( in nsIWebProgress  aWebProgress,
in nsIRequest  aRequest,
in nsIURI  aLocation 
) [inherited]

Called when the location of the window being watched changes.

This is not when a load is requested, but rather once it is verified that the load is going to occur in the given window. For instance, a load that starts in a window might send progress and status messages for the new site, but it will not send the onLocationChange until we are sure that we are loading this new page here.

Parameters:
aWebProgressThe nsIWebProgress instance that fired the notification.
aRequestThe associated nsIRequest. This may be null in some cases.
aLocationThe URI of the location that is being loaded.
void nsIWebProgressListener::onProgressChange ( in nsIWebProgress  aWebProgress,
in nsIRequest  aRequest,
in long  aCurSelfProgress,
in long  aMaxSelfProgress,
in long  aCurTotalProgress,
in long  aMaxTotalProgress 
) [inherited]

Notification that the progress has changed for one of the requests associated with aWebProgress.

Progress totals are reset to zero when all requests in aWebProgress complete (corresponding to onStateChange being called with aStateFlags including the STATE_STOP and STATE_IS_WINDOW flags).

Parameters:
aWebProgressThe nsIWebProgress instance that fired the notification.
aRequestThe nsIRequest that has new progress.
aCurSelfProgressThe current progress for aRequest.
aMaxSelfProgressThe maximum progress for aRequest.
aCurTotalProgressThe current progress for all requests associated with aWebProgress.
aMaxTotalProgressThe total progress for all requests associated with aWebProgress.

NOTE: If any progress value is unknown, or if its value would exceed the maximum value of type long, then its value is replaced with -1.

NOTE: If the object also implements nsIWebProgressListener2 and the caller knows about that interface, this function will not be called. Instead, nsIWebProgressListener2::onProgressChange64 will be called.

void nsIWebProgressListener2::onProgressChange64 ( in nsIWebProgress  aWebProgress,
in nsIRequest  aRequest,
in long long  aCurSelfProgress,
in long long  aMaxSelfProgress,
in long long  aCurTotalProgress,
in long long  aMaxTotalProgress 
) [inherited]

Notification that the progress has changed for one of the requests associated with aWebProgress.

Progress totals are reset to zero when all requests in aWebProgress complete (corresponding to onStateChange being called with aStateFlags including the STATE_STOP and STATE_IS_WINDOW flags).

This function is identical to nsIWebProgressListener::onProgressChange, except that this function supports 64-bit values.

Parameters:
aWebProgressThe nsIWebProgress instance that fired the notification.
aRequestThe nsIRequest that has new progress.
aCurSelfProgressThe current progress for aRequest.
aMaxSelfProgressThe maximum progress for aRequest.
aCurTotalProgressThe current progress for all requests associated with aWebProgress.
aMaxTotalProgressThe total progress for all requests associated with aWebProgress.

NOTE: If any progress value is unknown, then its value is replaced with -1.

See also:
nsIWebProgressListener2::onProgressChange64
void nsIWebProgressListener::onSecurityChange ( in nsIWebProgress  aWebProgress,
in nsIRequest  aRequest,
in unsigned long  aState 
) [inherited]

Notification called for security progress.

This method will be called on security transitions (eg HTTP -> HTTPS, HTTPS -> HTTP, FOO -> HTTPS) and after document load completion. It might also be called if an error occurs during network loading.

Parameters:
aWebProgressThe nsIWebProgress instance that fired the notification.
aRequestThe nsIRequest that has new security state.
aStateA value composed of the Security State Flags and the Security Strength Flags listed above. Any undefined bits are reserved for future use.

NOTE: These notifications will only occur if a security package is installed.

void nsIWebProgressListener::onStateChange ( in nsIWebProgress  aWebProgress,
in nsIRequest  aRequest,
in unsigned long  aStateFlags,
in nsresult  aStatus 
) [inherited]

Notification indicating the state has changed for one of the requests associated with aWebProgress.

Parameters:
aWebProgressThe nsIWebProgress instance that fired the notification
aRequestThe nsIRequest that has changed state.
aStateFlagsFlags indicating the new state. This value is a combination of one of the State Transition Flags and one or more of the State Type Flags defined above. Any undefined bits are reserved for future use.
aStatusError status code associated with the state change. This parameter should be ignored unless aStateFlags includes the STATE_STOP bit. The status code indicates success or failure of the request associated with the state change. NOTE: aStatus may be a success code even for server generated errors, such as the HTTP 404 error. In such cases, the request itself should be queried for extended error information (e.g., for HTTP requests see nsIHttpChannel).
void nsIWebProgressListener::onStatusChange ( in nsIWebProgress  aWebProgress,
in nsIRequest  aRequest,
in nsresult  aStatus,
in wstring  aMessage 
) [inherited]

Notification that the status of a request has changed.

The status message is intended to be displayed to the user (e.g., in the status bar of the browser).

Parameters:
aWebProgressThe nsIWebProgress instance that fired the notification.
aRequestThe nsIRequest that has new status.
aStatusThis value is not an error code. Instead, it is a numeric value that indicates the current status of the request. This interface does not define the set of possible status codes. NOTE: Some status values are defined by nsITransport and nsISocketTransport.
aMessageLocalized text corresponding to aStatus.
void nsDownload::Pause ( PRBool  aPaused) [protected]

Definition at line 2381 of file nsDownloadManager.cpp.

Here is the caller graph for this function:

Definition at line 994 of file nsDownloadManager.cpp.

{
  if (!mRequest)
    return NS_ERROR_UNEXPECTED;
  return mRequest->Resume();
}
nsresult nsDownload::SetCancelable ( nsICancelable aCancelable) [protected]

Definition at line 1942 of file nsDownloadManager.cpp.

{
  mCancelable = aCancelable;
  return NS_OK;
}
void nsDownload::SetDialog ( nsIProgressDialog aDialog) [inline]

Definition at line 135 of file nsDownloadManager.h.

                                             {
    mDialog = aDialog;
  }
nsresult nsDownload::SetDialog ( nsIProgressDialog aDialog) [protected]

Definition at line 1888 of file nsDownloadManager.cpp.

{
  mDialog = aDialog;
  return NS_OK;
}
void nsDownload::SetDialogListener ( nsIWebProgressListener2 aInternalListener) [inline]

Definition at line 132 of file nsDownloadManager.h.

                                                                     {
    mDialogListener = aInternalListener;
  }
nsresult nsDownload::SetDialogListener ( nsIWebProgressListener aInternalListener) [protected]

Definition at line 1873 of file nsDownloadManager.cpp.

{
  mDialogListener = aDialogListener;
  return NS_OK;
}
nsresult nsDownload::SetDisplayName ( const PRUnichar aDisplayName) [protected]

Definition at line 1964 of file nsDownloadManager.cpp.

{
  mDisplayName = aDisplayName;

  nsCOMPtr<nsIRDFDataSource> ds;
  mDownloadManager->GetDatasource(getter_AddRefs(ds));

  nsCOMPtr<nsIRDFLiteral> nameLiteral;
  nsCOMPtr<nsIRDFResource> res;
  nsAutoString path;
  nsresult rv = GetFilePathFromURI(mTarget, path);
  if (NS_FAILED(rv)) return rv;

  gRDFService->GetUnicodeResource(path, getter_AddRefs(res));
  
  gRDFService->GetLiteral(aDisplayName, getter_AddRefs(nameLiteral));
  ds->Assert(res, gNC_Name, nameLiteral, PR_TRUE);

  return NS_OK;
}

Here is the call graph for this function:

nsresult nsDownload::SetDownloadManager ( nsDownloadManager aDownloadManager) [protected]

Definition at line 1866 of file nsDownloadManager.cpp.

{
  mDownloadManager = aDownloadManager;
  return NS_OK;
}

Definition at line 157 of file nsDownloadManager.h.

                                              {
    mDownloadState = aState;
  }

Definition at line 1924 of file nsDownloadManager.cpp.

{
  mDownloadState = aState;
}

Here is the caller graph for this function:

Definition at line 1936 of file nsDownloadManager.cpp.

{
  mDownloadType = aType;
}
void nsDownload::SetMIMEInfo ( nsIMIMEInfo aMIMEInfo) [inline]

Definition at line 160 of file nsDownloadManager.h.

                                           {
    mMIMEInfo = aMIMEInfo;
  }
nsresult nsDownload::SetMIMEInfo ( nsIMIMEInfo aMIMEInfo) [protected]

Definition at line 2000 of file nsDownloadManager.cpp.

{
  mMIMEInfo = aMIMEInfo;
  return NS_OK;
}
nsresult nsDownload::SetSource ( nsIURI aSource) [protected]

Definition at line 1949 of file nsDownloadManager.cpp.

{
  mSource = aSource;
  return NS_OK;
}
void nsDownload::SetStartTime ( PRInt64  aStartTime) [inline]

Definition at line 163 of file nsDownloadManager.h.

                                        {
    mStartTime = aStartTime;
    mLastUpdate = aStartTime;
  }
nsresult nsDownload::SetStartTime ( PRInt64  aStartTime) [protected]

Definition at line 1992 of file nsDownloadManager.cpp.

{
  mStartTime = aStartTime;
  mLastUpdate = aStartTime;
  return NS_OK;
}
nsresult nsDownload::SetTarget ( nsIURI aTarget) [protected]

Definition at line 1956 of file nsDownloadManager.cpp.

{
  mTarget = aTarget;
  return NS_OK;
}
nsresult nsDownload::SetTempFile ( nsILocalFile aTempFile) [protected]

Definition at line 1903 of file nsDownloadManager.cpp.

{
  mTempFile = aTempFile;
  return NS_OK;
}

Definition at line 925 of file nsDownloadManager.cpp.

{
  if (!mRequest)
    return NS_ERROR_UNEXPECTED;
  return mRequest->Suspend();
}

Friends And Related Function Documentation

friend class nsDownloadManager [friend]

Definition at line 269 of file nsDownloadManager.h.


Member Data Documentation

The amount of kbytes downloaded so far.

Definition at line 65 of file nsIDownload.idl.

Object that can be used to cancel the download.

Will be null after the download is finished.

Definition at line 87 of file nsIDownload.idl.

readonly attribute wstring nsIDownload::displayName [inherited]

The user-readable description of the transfer.

Definition at line 92 of file nsIDownload.idl.

Definition at line 252 of file nsDownloadManager.h.

Definition at line 263 of file nsDownloadManager.h.

Definition at line 254 of file nsDownloadManager.h.

Definition at line 174 of file nsDownloadManager.h.

Definition at line 251 of file nsDownloadManager.h.

Definition at line 248 of file nsDownloadManager.h.

Definition at line 168 of file nsDownloadManager.h.

Definition at line 244 of file nsDownloadManager.h.

Definition at line 258 of file nsDownloadManager.h.

Definition at line 259 of file nsDownloadManager.h.

Optional.

If set, it will contain the target's relevant MIME information. This includes it's MIME Type, helper app, and whether that helper should be executed.

Definition at line 104 of file nsIDownload.idl.

Definition at line 266 of file nsDownloadManager.h.

Definition at line 264 of file nsDownloadManager.h.

Definition at line 256 of file nsDownloadManager.h.

Definition at line 261 of file nsDownloadManager.h.

Definition at line 262 of file nsDownloadManager.h.

Definition at line 253 of file nsDownloadManager.h.

Definition at line 250 of file nsDownloadManager.h.

double nsDownload::mSpeed [private]

Definition at line 267 of file nsDownloadManager.h.

Definition at line 265 of file nsDownloadManager.h.

Definition at line 245 of file nsDownloadManager.h.

Definition at line 255 of file nsDownloadManager.h.

The percentage of transfer completed.

If the file size is unknown it'll be -1 here.

Definition at line 60 of file nsIDownload.idl.

readonly attribute PRUint64 nsIDownload::size [inherited]

The size of file in kbytes.

Unknown size is represented by 0.

Definition at line 71 of file nsIDownload.idl.

readonly attribute nsIURI nsIDownload::source [inherited]

The source of the transfer.

Definition at line 76 of file nsIDownload.idl.

readonly attribute double nsIDownload_MOZILLA_1_8_BRANCH::speed [inherited]

The speed of the transfer in bytes/sec.

Definition at line 113 of file nsIDownload.idl.

readonly attribute long long nsIDownload::startTime [inherited]

The time a transfer was started.

Definition at line 97 of file nsIDownload.idl.

const unsigned long nsIWebProgressListener::STATE_IS_BROKEN = 0x00000001 [inherited]

Definition at line 205 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_IS_DOCUMENT = 0x00020000 [inherited]

Definition at line 163 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_IS_INSECURE = 0x00000004 [inherited]

State Security Flags.

These flags describe the security state reported by a call to the onSecurityChange method. These flags are mutually exclusive.

STATE_IS_INSECURE This flag indicates that the data corresponding to the request was received over an insecure channel.

STATE_IS_BROKEN This flag indicates an unknown security state. This may mean that the request is being loaded as part of a page in which some content was received over an insecure channel.

STATE_IS_SECURE This flag indicates that the data corresponding to the request was received over a secure channel. The degree of security is expressed by STATE_SECURE_HIGH, STATE_SECURE_MED, or STATE_SECURE_LOW.

Definition at line 204 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_IS_NETWORK = 0x00040000 [inherited]

Definition at line 164 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_IS_REQUEST = 0x00010000 [inherited]

State Type Flags.

These flags further describe the entity for which the state transition is occuring. These flags are NOT mutually exclusive (i.e., an onStateChange event may indicate some combination of these flags).

STATE_IS_REQUEST This flag indicates that the state transition is for a request, which includes but is not limited to document requests. (See below for a description of document requests.) Other types of requests, such as requests for inline content (e.g., images and stylesheets) are considered normal requests.

STATE_IS_DOCUMENT This flag indicates that the state transition is for a document request. This flag is set in addition to STATE_IS_REQUEST. A document request supports the nsIChannel interface and its loadFlags attribute includes the nsIChannel::LOAD_DOCUMENT_URI flag.

A document request does not complete until all requests associated with the loading of its corresponding document have completed. This includes other document requests (e.g., corresponding to HTML <iframe> elements). The document corresponding to a document request is available via the DOMWindow attribute of onStateChange's aWebProgress parameter.

STATE_IS_NETWORK This flag indicates that the state transition corresponds to the start or stop of activity in the indicated nsIWebProgress instance. This flag is accompanied by either STATE_START or STATE_STOP, and it may be combined with other State Type Flags.

Unlike STATE_IS_WINDOW, this flag is only set when activity within the nsIWebProgress instance being observed starts or stops. If activity only occurs in a child nsIWebProgress instance, then this flag will be set to indicate the start and stop of that activity.

For example, in the case of navigation within a single frame of a HTML frameset, a nsIWebProgressListener instance attached to the nsIWebProgress of the frameset window will receive onStateChange calls with the STATE_IS_NETWORK flag set to indicate the start and stop of said navigation. In other words, an observer of an outer window can determine when activity, that may be constrained to a child window or set of child windows, starts and stops.

STATE_IS_WINDOW This flag indicates that the state transition corresponds to the start or stop of activity in the indicated nsIWebProgress instance. This flag is accompanied by either STATE_START or STATE_STOP, and it may be combined with other State Type Flags.

This flag is similar to STATE_IS_DOCUMENT. However, when a document request completes, two onStateChange calls with STATE_STOP are generated. The document request is passed as aRequest to both calls. The first has STATE_IS_REQUEST and STATE_IS_DOCUMENT set, and the second has the STATE_IS_WINDOW flag set (and possibly the STATE_IS_NETWORK flag set as well -- see above for a description of when the STATE_IS_NETWORK flag may be set). This second STATE_STOP event may be useful as a way to partition the work that occurs when a document request completes.

Definition at line 162 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_IS_SECURE = 0x00000002 [inherited]

Definition at line 206 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_IS_WINDOW = 0x00080000 [inherited]

Definition at line 165 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_NEGOTIATING = 0x00000008 [inherited]

Definition at line 98 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_REDIRECTING = 0x00000002 [inherited]

Definition at line 96 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_RESTORING = 0x01000000 [inherited]

State Modifier Flags.

These flags further describe the transition which is occuring. These flags are NOT mutually exclusive (i.e., an onStateChange event may indicate some combination of these flags).

STATE_RESTORING This flag indicates that the state transition corresponds to the start or stop of activity for restoring a previously-rendered presentation. As such, there is no actual network activity associated with this request, and any modifications made to the document or presentation when it was originally loaded will still be present.

Definition at line 182 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_SECURE_HIGH = 0x00040000 [inherited]

Security Strength Flags.

These flags describe the security strength and accompany STATE_IS_SECURE in a call to the onSecurityChange method. These flags are mutually exclusive.

These flags are not meant to provide a precise description of data transfer security. These are instead intended as a rough indicator that may be used to, for example, color code a security indicator or otherwise provide basic data transfer security feedback to the user.

STATE_SECURE_HIGH This flag indicates a high degree of security.

STATE_SECURE_MED This flag indicates a medium degree of security.

STATE_SECURE_LOW This flag indicates a low degree of security.

Definition at line 229 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_SECURE_LOW = 0x00020000 [inherited]

Definition at line 231 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_SECURE_MED = 0x00010000 [inherited]

Definition at line 230 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_START = 0x00000001 [inherited]

State Transition Flags.

These flags indicate the various states that requests may transition through as they are being loaded. These flags are mutually exclusive.

For any given request, onStateChange is called once with the STATE_START flag, zero or more times with the STATE_TRANSFERRING flag or once with the STATE_REDIRECTING flag, and then finally once with the STATE_STOP flag. NOTE: For document requests, a second STATE_STOP is generated (see the description of STATE_IS_WINDOW for more details).

STATE_START This flag indicates the start of a request. This flag is set when a request is initiated. The request is complete when onStateChange is called for the same request with the STATE_STOP flag set.

STATE_REDIRECTING This flag indicates that a request is being redirected. The request passed to onStateChange is the request that is being redirected. When a redirect occurs, a new request is generated automatically to process the new request. Expect a corresponding STATE_START event for the new request, and a STATE_STOP for the redirected request.

STATE_TRANSFERRING This flag indicates that data for a request is being transferred to an end consumer. This flag indicates that the request has been targeted, and that the user may start seeing content corresponding to the request.

STATE_NEGOTIATING This flag is not used.

STATE_STOP This flag indicates the completion of a request. The aStatus parameter to onStateChange indicates the final status of the request.

Definition at line 95 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_STOP = 0x00000010 [inherited]

Definition at line 99 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_TRANSFERRING = 0x00000004 [inherited]

Definition at line 97 of file nsIWebProgressListener.idl.

readonly attribute nsIURI nsIDownload::target [inherited]

The target of the transfer.

Definition at line 81 of file nsIDownload.idl.

The target of a download is always a file on the local file system.

Definition at line 54 of file nsIDownload.idl.


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