err.no Git - sope/blob - sope-ical/NGiCal/iCalRecurrenceRule.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_iCalRecurrenceRule_H_
  23 #define __NGiCal_iCalRecurrenceRule_H_
  24
  25 #import <Foundation/NSObject.h>
  26
  27 /*
  28   iCalRecurrenceRule
  29
  30   Encapsulates a (probably complex) recurrence rule by offering
  31   a high level API.
  32
  33   NOTE: as of now, only a very limited subset of RFC2445 is implemented.
  34         Please see the unit tests for what is covered.
  35 */
  36
  37 // TODO: we could use string constants?
  38 typedef enum {
  39   iCalRecurrenceFrequenceSecondly = 1,
  40   iCalRecurrenceFrequenceMinutely = 2,
  41   iCalRecurrenceFrequenceHourly   = 3,
  42   iCalRecurrenceFrequenceDaily    = 4,
  43   iCalRecurrenceFrequenceWeekly   = 5,
  44   iCalRecurrenceFrequenceMonthly  = 6,
  45   iCalRecurrenceFrequenceYearly   = 7,
  46 } iCalRecurrenceFrequency;
  47
  48 typedef enum {
  49   iCalWeekDayMonday    = 1,
  50   iCalWeekDayTuesday   = 2,
  51   iCalWeekDayWednesday = 4,
  52   iCalWeekDayThursday  = 8,
  53   iCalWeekDayFriday    = 16,
  54   iCalWeekDaySaturday  = 32,
  55   iCalWeekDaySunday    = 64,
  56 } iCalWeekDay;
  57
  58 @class NSString, NSCalendarDate, NGCalendarDateRange, NSArray;
  59
  60 @interface iCalRecurrenceRule : NSObject
  61 {
  62   iCalRecurrenceFrequency frequency;
  63   int            interval;
  64   unsigned       repeatCount;
  65   NSCalendarDate *untilDate;
  66   struct {
  67     unsigned weekStart: 7;
  68     unsigned mask:      7;
  69     unsigned useOccurence:1;
  70     unsigned reserved:1;
  71   } byDay;
  72   int byDayOccurence1;
  73   NSArray        *byMonthDay;
  74
  75   NSString       *rrule;
  76 }
  77
  78 + (id)recurrenceRuleWithICalRepresentation:(NSString *)_iCalRep;
  79 - (id)initWithString:(NSString *)_str;
  80
  81 /* accessors */
  82
  83 - (void)setFrequency:(iCalRecurrenceFrequency)_frequency;
  84 - (iCalRecurrenceFrequency)frequency;
  85
  86 - (void)setRepeatInterval:(int)_repeatInterval;
  87 - (int)repeatInterval;
  88
  89 - (void)setWeekStart:(iCalWeekDay)_weekStart;
  90 - (iCalWeekDay)weekStart;
  91
  92 - (void)setByDayMask:(unsigned)_mask;
  93 - (unsigned)byDayMask;
  94 - (int)byDayOccurence1;
  95
  96 - (NSArray *)byMonthDay;
  97
  98 /* count and untilDate are mutually exclusive */
  99
 100 - (void)setRepeatCount:(unsigned)_repeatCount;
 101 - (unsigned)repeatCount;
 102
 103 - (void)setUntilDate:(NSCalendarDate *)_untilDate;
 104 - (NSCalendarDate *)untilDate;
 105
 106 - (BOOL)isInfinite;
 107
 108 /* parse complete iCal RRULE */
 109
 110 - (void)setRrule:(NSString *)_rrule; // TODO: weird name? (better: RRule?)
 111
 112 - (NSString *)iCalRepresentation;
 113
 114 @end
 115
 116 #endif  /* __NGiCal_iCalRecurrenceRule_H_ */