Back to index

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

import "calIStatusObserver.idl";

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

List of all members.

Public Member Functions

void initialize (in nsIDOMChromeWindow aWindow)
void startMeteors (in unsigned long aProgressMode, in unsigned long aCalendarCount)
 Starts the display of an operation to check a series of calendars This operation may either be determined or undetermined.
void stopMeteors ()
 stops the display of an progressed operation
void calendarCompleted (in calICalendar aCalendar)
 increments the display value denoting that a calendar has been processed

Public Attributes

readonly attribute unsigned long spinning
const unsigned long NO_PROGRESS = 0
 A constant that denotes that no operation is running.
const unsigned long DETERMINED_PROGRESS = 1
 A constant that refers to whether an operation is determined.
const unsigned long UNDETERMINED_PROGRESS = 2
 A constant that refers to whether an operation is undetermined.

Detailed Description

Definition at line 42 of file calIStatusObserver.idl.


Member Function Documentation

increments the display value denoting that a calendar has been processed

void calIStatusObserver::startMeteors ( in unsigned long  aProgressMode,
in unsigned long  aCalendarCount 
)

Starts the display of an operation to check a series of calendars This operation may either be determined or undetermined.

Parameters:
aProgressModeAn integer value that can accept DETERMINED_PROGRESS, UNDETERMINED_PROGRESS or NO_PROGRESS
aCalendarsCountIf the first parameter is DETERMINED_PROGRESS aCalendarCount is the number of Calendars which completion is to be displayed

stops the display of an progressed operation


Member Data Documentation

A constant that refers to whether an operation is determined.

Definition at line 86 of file calIStatusObserver.idl.

A constant that denotes that no operation is running.

Definition at line 81 of file calIStatusObserver.idl.

Returns:
An integer value denoting wheter a progress is running or not; if it returns DETERMINED_PROGRESS a determined progress is running; if it returns UNDETERMINED_PROGRESS an undetermined progress is running; if it returns NO_PROGRESS no Progress is running.

Definition at line 76 of file calIStatusObserver.idl.

A constant that refers to whether an operation is undetermined.

Definition at line 91 of file calIStatusObserver.idl.


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