Interface to control UI aspects of sbIJobProgress. More...
import"sbIJobProgressUI.idl";
Public Attributes | |
readonly attribute DOMString | crop |
Public Attributes inherited from sbIJobProgress | |
const unsigned short | STATUS_FAILED = 0x00 |
Constant indicating that the job has completed with errors. More... | |
const unsigned short | STATUS_SUCCEEDED = 0x10 |
Constant indicating that the job has completed. More... | |
const unsigned short | STATUS_RUNNING = 0x20 |
Constant indicating that the job is active. More... | |
readonly attribute unsigned short | status |
Current status of the job. More... | |
readonly attribute boolean | blocked |
If true, progress of job is blocked (e.g., due to locked resource). More... | |
readonly attribute AString | statusText |
Localized message describing the status of the job. More... | |
readonly attribute AString | titleText |
Localized message describing the type or purpose of the job. More... | |
readonly attribute unsigned long | progress |
Number of work units completed. More... | |
readonly attribute unsigned long | total |
Total number of work units to be completed May be set to 0 if the job length is indeterminate. More... | |
readonly attribute unsigned long | errorCount |
Number of errors that have been encountered. More... | |
Additional Inherited Members | |
Public Member Functions inherited from sbIJobProgress | |
nsIStringEnumerator | getErrorMessages () |
Enumerate all the errors encountered during the job. More... | |
void | addJobProgressListener (in sbIJobProgressListener aListener) |
Add a listener to be notified when significant job progress has been made. More... | |
void | removeJobProgressListener (in sbIJobProgressListener aListener) |
Remove a previously added listener. More... | |
Interface to control UI aspects of sbIJobProgress.
This interfaces exists as a hint to how a sbIJobProgress should be displayed. Actual UI may choose to ignore any hints.
Definition at line 38 of file sbIJobProgressUI.idl.
readonly attribute DOMString sbIJobProgressUI::crop |
how the status text in the job progress display should be cropped
Definition at line 43 of file sbIJobProgressUI.idl.