From 0c5e98b0de12d53b5e15f1fff802249ac8ab493a Mon Sep 17 00:00:00 2001 From: "mostafah%oeone.com" Date: Wed, 6 Oct 2004 15:26:10 +0000 Subject: [PATCH] Added comments for GetAllEvents() git-svn-id: svn://10.0.0.236/trunk@163300 18797224-902f-48f8-a5cc-f745e15eee43 --- mozilla/calendar/libxpical/oeIICal.idl | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/mozilla/calendar/libxpical/oeIICal.idl b/mozilla/calendar/libxpical/oeIICal.idl index dff10f5fe1b..7165e15f4e7 100644 --- a/mozilla/calendar/libxpical/oeIICal.idl +++ b/mozilla/calendar/libxpical/oeIICal.idl @@ -230,7 +230,20 @@ interface oeIICal : nsISupports void deleteEvent( in string id ); oeIICalEvent fetchEvent( in string id ); // nsISimpleEnumerator searchBySQL( in string sqlstr ); + + /** + * + * GetAllEvents + * + * DESCRIPTION: Returns a list of all the events in this calendar in an enumerator. + * The events are sorted based on the order of their next occurence if they recur in + * the future or their last occurence in the past otherwise. + * Here's a presentation of the sort criteria using the time axis: + * -----(Last occurence of Event1)---(Last occurence of Event2)----(Now)----(Next occurence of Event3)----> + * (Note that Event1 and Event2 will not recur in the future.) + */ nsISimpleEnumerator getAllEvents(); + /** * For all the getEvents* and get*EventForRange methods: * Get events for a certain range. items are oeIICalEventDisplay