err.no Git - sope/blob - sope-ical/NGiCal/iCalRecurrenceCalculator.h

   1 /*
   2   Copyright (C) 2004-2005 SKYRIX Software AG
   3
   4   This file is part of SOPE.
   5
   6   SOPE is free software; you can redistribute it and/or modify it under
   7   the terms of the GNU Lesser General Public License as published by the
   8   Free Software Foundation; either version 2, or (at your option) any
   9   later version.
  10
  11   SOPE is distributed in the hope that it will be useful, but WITHOUT ANY
  12   WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
  14   License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public
  17   License along with SOPE; see the file COPYING.  If not, write to the
  18   Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19   02111-1307, USA.
  20 */
  21
  22 #ifndef __NGiCal_iCalRecurrenceCalculator_H_
  23 #define __NGiCal_iCalRecurrenceCalculator_H_
  24
  25 #import <Foundation/NSObject.h>
  26
  27 /*
  28   iCalRecurrenceCalculator
  29
  30   Provides an API for performing common calculations performed in conjunction
  31   with iCalRecurrenceRule objects.
  32
  33   TODO: rather move this functionality to iCalRecurrenceRule?
  34 */
  35
  36 @class NSArray;
  37 @class iCalRecurrenceRule, NGCalendarDateRange;
  38
  39 @interface iCalRecurrenceCalculator : NSObject
  40 {
  41   NGCalendarDateRange *firstRange;
  42   iCalRecurrenceRule  *rrule;
  43 }
  44
  45 + (NSArray *)recurrenceRangesWithinCalendarDateRange:(NGCalendarDateRange *)_r
  46   firstInstanceCalendarDateRange:(NGCalendarDateRange *)_fir
  47   recurrenceRules:(NSArray *)_rRules
  48   exceptionRules:(NSArray *)_exRules
  49   exceptionDates:(NSArray *)_exDates;
  50
  51 + (id)recurrenceCalculatorForRecurrenceRule:(iCalRecurrenceRule *)_rrule
  52   withFirstInstanceCalendarDateRange:(NGCalendarDateRange *)_range;
  53
  54 - (id)initWithRecurrenceRule:(iCalRecurrenceRule *)_rrule
  55   firstInstanceCalendarDateRange:(NGCalendarDateRange *)_range;
  56
  57 - (NSArray *)recurrenceRangesWithinCalendarDateRange:(NGCalendarDateRange *)_r;
  58 - (BOOL)doesRecurrWithinCalendarDateRange:(NGCalendarDateRange *)_range;
  59
  60 - (NGCalendarDateRange *)firstInstanceCalendarDateRange;
  61 - (NGCalendarDateRange *)lastInstanceCalendarDateRange; /* might be nil */
  62
  63 @end
  64
  65 #endif  /* __NGiCal_iCalRecurrenceCalculator_H_ */