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

   1 /*
   2   Copyright (C) 2000-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_iCalEvent_H__
  23 #define __NGiCal_iCalEvent_H__
  24
  25 #include <NGiCal/iCalRepeatableEntityObject.h>
  26 #import <Foundation/NSDate.h>
  27
  28 /*
  29   iCalEvent
  30
  31   This class keeps the attributes of an iCalendar event record, that is,
  32   an appointment.
  33 */
  34
  35 @class NSString, NSMutableArray, NSCalendarDate, NGCalendarDateRange;
  36 @class iCalPerson, iCalEventChanges, iCalRecurrenceRule;
  37
  38 @interface iCalEvent : iCalRepeatableEntityObject
  39 {
  40   NSCalendarDate *endDate;
  41   NSString       *duration;
  42   NSString       *transparency;
  43 }
  44
  45 /* accessors */
  46
  47 - (void)setEndDate:(NSCalendarDate *)_date;
  48 - (NSCalendarDate *)endDate;
  49 - (BOOL)hasEndDate;
  50
  51 - (void)setDuration:(NSString *)_value;
  52 - (NSString *)duration;
  53 - (BOOL)hasDuration;
  54 - (NSTimeInterval)durationAsTimeInterval;
  55
  56 - (void)setTransparency:(NSString *)_transparency;
  57 - (NSString *)transparency;
  58
  59 /* convenience */
  60
  61 - (BOOL)isOpaque;
  62 - (BOOL)isAllDay;
  63
  64 - (BOOL)isWithinCalendarDateRange:(NGCalendarDateRange *)_range;
  65 - (NSArray *)recurrenceRangesWithinCalendarDateRange:(NGCalendarDateRange *)_r;
  66
  67 - (NSCalendarDate *)lastPossibleRecurrenceStartDate;
  68
  69 /* calculating changes */
  70
  71 - (iCalEventChanges *)getChangesRelativeToEvent:(iCalEvent *)_event;
  72
  73 /* generating iCal content */
  74
  75 - (NSString *)vEventString;
  76
  77 @end
  78
  79 #endif /* __NGiCal_iCalEvent_H__ */