[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-pim
Subject:    Re: [Kde-pim] Cleaning up in libkcal
From:       Allen Winter <winter () kde ! org>
Date:       2004-11-01 18:25:31
Message-ID: 200411011325.31314.winter () kde ! org
[Download RAW message or body]

On Monday 01 November 2004 12:30 pm, Mark Bucciarelli wrote:
> On Monday 01 November 2004 11:32, Allen Winter wrote:
> 
> > I propose the following changes:
> >
> >     /**
> >       Builds and then returns a list of all events that match for the
> >       date specified. useful for dayView, etc. etc.
> >       The calendar filter is applied.
> >     */
> >     Event::List events( const QDate &date,
> >                                   EventSortField sortField =
> > EventSortUnsorted, SortDirection sortDirection = SortDirectionAscending
> > ); /**
> 
> No comments on your suggested changes other than you seem to have a good 
> handle on this stuff.
> 
Sometimes yes... sometimes no.

> But a general API doc comment--I would give more detail on what "match for 
> the date specified" means.
> 
> From reading calendar.cpp and calendarlocal.cpp, I gather this is what 
> "match" means:
> 
> <possible-text>
> Whether or not an event is returned is defined by the resources's 
> implementation of the Calendar::rawEventsForDate( const QDate, ... ) 
> virtual method.
> 
> For the CalendarLocal class, this method selects any event that starts on 
> or before the given date and ends on or after the same.  Recurring events 
> are selected if one recurrence falls on the given date.  If the event is a 
> multi-day recurrence, it is selected if the given date falls within one of 
> the multi-day occurences.
> 
> If an event does not have either a start or end date, it is not selected. 
> [Note: Maybe.  I don't know QDate comparisons well enough to be sure of 
> this statement.]
> 
> If you pass in a date that is not valid or is null, no events are returned.  
> [Note: Maybe.  I don't know QDate comparisons well enough to be sure of 
> this statement.]
> </possible-text>
> 
> I'm a bit surprised that the definition of "match" depends on the resource.  
> I'm probably missing something there.
> 
We need to document (doxygen) the API.

Regards,
Allen
_______________________________________________
kde-pim mailing list
kde-pim@kde.org
https://mail.kde.org/mailman/listinfo/kde-pim
kde-pim home page at http://pim.kde.org/
[prev in list] [next in list] [prev in thread] [next in thread]