Back to index

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

High-level interface to allow providers to be plugable. More...

import "calICalendarProvider.idl";

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

List of all members.

Public Member Functions

void createCalendar (in AUTF8String aName, in nsIURI aURL, in calIProviderListener aListener)
 Create a new empty calendar.
void deleteCalendar (in calICalendar aCalendar, in calIProviderListener aListener)
 Delete a calendar.
calICalendar getCalendar (in nsIURI aURL)
 Get a new calendar object with existing calendar data.

Public Attributes

readonly attribute nsIURI prefChromeOverlay
 XUL overlay for configuring a calendar of this type.
readonly attribute AUTF8String displayName
 The way to refer to this provider in UI for the end-user (eg "Shared ICS File").

Detailed Description

High-level interface to allow providers to be plugable.

Definition at line 49 of file calICalendarProvider.idl.


Member Function Documentation

void calICalendarProvider::createCalendar ( in AUTF8String  aName,
in nsIURI  aURL,
in calIProviderListener  aListener 
)

Create a new empty calendar.

This will typically create a new empty file, and then call getCalendar()

Parameters:
aNamethe display name of the calendar to be created
aURLURL of the calendar to be created.
aListenerwhere to call the results back to

Delete a calendar.

Deletes the actual underlying calendar, which could be (for example) a file or a calendar on a server

Parameters:
aCalendarthe calendar to delete
aListenerwhere to call the results back to

Get a new calendar object with existing calendar data.

Parameters:
aURLURL of the calendar to be created.

Member Data Documentation

The way to refer to this provider in UI for the end-user (eg "Shared ICS File").

Definition at line 60 of file calICalendarProvider.idl.

XUL overlay for configuring a calendar of this type.

Definition at line 54 of file calICalendarProvider.idl.


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