Bommels05/Mozilla
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added comments for GetAllEvents()

Browse Source 
git-svn-id: svn://10.0.0.236/trunk@163300 18797224-902f-48f8-a5cc-f745e15eee43
This commit is contained in:
mostafah%oeone.com
2004-10-06 15:26:10 +00:00
parent 4e9e745a24
commit 0c5e98b0de
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
mozilla/calendar/libxpical/oeIICal.idl
View File

@@ -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