sbIJobProgressService Interface Reference

The beginnings of a service to track all background tasks. More...

import"sbIJobProgressService.idl";

Inheritance diagram for sbIJobProgressService:
[legend]
Collaboration diagram for sbIJobProgressService:
[legend]

Public Member Functions

void showProgressDialog (in sbIJobProgress aJobProgress, in nsIDOMWindow aWindow, in unsigned long aTimeout)
 Display a progress dialog for an object implementing sbIJobProgress. More...
 

Detailed Description

The beginnings of a service to track all background tasks.

This interface will eventually become a generic place to register long-running sbIJobProgress implementing tasks.

Until this materializes all sbIJobProgressService can do is help launch a modal job progress dialog.

Note
This interface is guaranteed to change

Definition at line 46 of file sbIJobProgressService.idl.

Member Function Documentation

void sbIJobProgressService::showProgressDialog ( in sbIJobProgress  aJobProgress,
in nsIDOMWindow  aWindow,
in unsigned long  aTimeout 
)

Display a progress dialog for an object implementing sbIJobProgress.

If the job has not completed in a given amount of time, display a modal progress dialog.

Parameters
aJobProgresssbIJobProgress interface to be displayed.
aWindowParent window for the dialog. Can be null.
aTimeoutTime to wait before opening a dialog. Defaults to 1 second. Pass 0 to open the dialog immediately.

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