Songbird / Development / Songbird Add-Ons API Documentation

sbIJobProgressService Interface Reference

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

import "sbIJobProgressService.idl";

List of all members.

Public Member Functions

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


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.

The idea is that Songbird may one day have a standardized task manager, looking something like http://dingo.songbirdnest.com/~komi/status-all-over/wireframes/service-pane-status-bar.png

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 50 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:
aJobProgress sbIJobProgress interface to be displayed.
aWindow Parent window for the dialog. Can be null.
aTimeout Time 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:
Generated on Tue Mar 10 14:28:59 2009 for Songbird by  doxygen 1.5.2