Libical API Documentation  2.99
icalperiod.h
Go to the documentation of this file.
1 /*======================================================================
2  FILE: icalperiod.h
3  CREATOR: eric 26 Jan 2001
4 
5  (C) COPYRIGHT 2000, Eric Busboom <eric@softwarestudio.org>
6  http://www.softwarestudio.org
7 
8  This library is free software; you can redistribute it and/or modify
9  it under the terms of either:
10 
11  The LGPL as published by the Free Software Foundation, version
12  2.1, available at: http://www.gnu.org/licenses/lgpl-2.1.html
13 
14  Or:
15 
16  The Mozilla Public License Version 2.0. You may obtain a copy of
17  the License at http://www.mozilla.org/MPL/
18 
19  The Original Code is eric. The Initial Developer of the Original
20  Code is Eric Busboom
21 ======================================================================*/
22 
23 #ifndef ICALPERIOD_H
24 #define ICALPERIOD_H
25 
31 #include "libical_ical_export.h"
32 #include "icalduration.h"
33 #include "icaltime.h"
34 
39 {
40  struct icaltimetype start;
41  struct icaltimetype end;
42  struct icaldurationtype duration;
43 };
44 
76 LIBICAL_ICAL_EXPORT struct icalperiodtype icalperiodtype_from_string(const char *str);
77 
102 LIBICAL_ICAL_EXPORT const char *icalperiodtype_as_ical_string(struct icalperiodtype p);
103 
130 LIBICAL_ICAL_EXPORT char *icalperiodtype_as_ical_string_r(struct icalperiodtype p);
131 
148 LIBICAL_ICAL_EXPORT struct icalperiodtype icalperiodtype_null_period(void);
149 
164 LIBICAL_ICAL_EXPORT int icalperiodtype_is_null_period(struct icalperiodtype p);
165 
179 LIBICAL_ICAL_EXPORT int icalperiodtype_is_valid_period(struct icalperiodtype p);
180 
181 #endif /* !ICALTIME_H */
Methods for working with durations in iCal.
char * icalperiodtype_as_ical_string_r(struct icalperiodtype p)
Converts an icalperiodtype into an iCal-formatted string.
Definition: icalperiod.c:104
Struct to represent a period in time.
Definition: icalperiod.h:38
struct icaltimetype is a pseudo-object that abstracts time handling.
int icalperiodtype_is_null_period(struct icalperiodtype p)
Definition: icalperiod.c:145
A struct representing a duration.
Definition: icalduration.h:37
Definition: icaltime.h:105
int icalperiodtype_is_valid_period(struct icalperiodtype p)
Definition: icalperiod.c:155
const char * icalperiodtype_as_ical_string(struct icalperiodtype p)
Converts an icalperiodtype into an iCal-formatted string.
Definition: icalperiod.c:95