aboutsummaryrefslogtreecommitdiffstats
path: root/calendar/cal-util/cal-component.h
blob: 8b32acdf2d0b29fa3b2510e97c72bafbb5bec8e3 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/* Evolution calendar - iCalendar component object
 *
 * Copyright (C) 2000 Helix Code, Inc.
 *
 * Author: Federico Mena-Quintero <federico@helixcode.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef CAL_COMPONENT_H
#define CAL_COMPONENT_H

#include <libgnome/gnome-defs.h>
#include <time.h>
#include <gtk/gtkobject.h>
#include <ical.h>

BEGIN_GNOME_DECLS



#define CAL_COMPONENT_TYPE            (cal_component_get_type ())
#define CAL_COMPONENT(obj)            (GTK_CHECK_CAST ((obj), CAL_COMPONENT_TYPE, CalComponent))
#define CAL_COMPONENT_CLASS(klass)    (GTK_CHECK_CLASS_CAST ((klass), CAL_COMPONENT_TYPE,   \
                       CalComponentClass))
#define IS_CAL_COMPONENT(obj)         (GTK_CHECK_TYPE ((obj), CAL_COMPONENT_TYPE))
#define IS_CAL_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), CAL_COMPONENT_TYPE))

/* Types of calendar components to be stored by a CalComponent, as per RFC 2445.
 * We don't put the alarm component type here since we store alarms as separate
 * structures inside the other "real" components.
 */
typedef enum {
    CAL_COMPONENT_NO_TYPE,
    CAL_COMPONENT_EVENT,
    CAL_COMPONENT_TODO,
    CAL_COMPONENT_JOURNAL,
    CAL_COMPONENT_FREEBUSY,
    CAL_COMPONENT_TIMEZONE
} CalComponentVType;

/* Structures to return properties and their parameters */

typedef struct {
    /* Summary string */
    const char *value;

    /* Alternate representation URI */
    const char *altrep;
} CalComponentPropSummary;

typedef struct {
    /* Description string */
    const char *value;

    /* Alternate representation URI */
    const char *altrep;
} CalComponentDescription;

typedef struct {
    /* Actual date/time value */
    struct icaltimetype *value;

    /* Timezone ID */
    const char *tzid;
} CalComponentDateTime;

typedef struct _CalComponent CalComponent;
typedef struct _CalComponentClass CalComponentClass;

struct _CalComponent {
    GtkObject object;

    /* Private data */
    gpointer priv;
};

struct _CalComponentClass {
    GtkObjectClass parent_class;
};

GtkType cal_component_get_type (void);

char *cal_component_gen_uid (void);

CalComponent *cal_component_new (void);

void cal_component_set_new_vtype (CalComponent *comp, CalComponentVType type);

void cal_component_set_icalcomponent (CalComponent *comp, icalcomponent *icalcomp);
icalcomponent *cal_component_get_icalcomponent (CalComponent *comp);

CalComponentVType cal_component_get_vtype (CalComponent *comp);

const char *cal_component_get_uid (CalComponent *comp);
void cal_component_set_uid (CalComponent *comp, const char *uid);

void cal_component_get_summary (CalComponent *comp, CalComponentPropSummary *summary);
void cal_component_set_summary (CalComponent *comp, const CalComponentPropSummary *summary);

void cal_component_get_description_list (CalComponent *comp, GSList **desc_list);
void cal_component_set_description_list (CalComponent *comp, GSList *desc_list);
void cal_component_free_description_list (GSList *desc_list);

void cal_component_free_datetime (CalComponentDateTime *dt);

void cal_component_get_dtstart (CalComponent *comp, CalComponentDateTime *dt);
void cal_component_set_dtstart (CalComponent *comp, CalComponentDateTime *dt);

void cal_component_get_dtend (CalComponent *comp, CalComponentDateTime *dt);
void cal_component_set_dtend (CalComponent *comp, CalComponentDateTime *dt);

void cal_component_get_due (CalComponent *comp, CalComponentDateTime *dt);
void cal_component_set_due (CalComponent *comp, CalComponentDateTime *dt);

void cal_component_get_categories_list (CalComponent *comp, GSList **categ_list);
void cal_component_set_categories_list (CalComponent *comp, GSList *categ_list);
void cal_component_free_categories_list (GSList *categ_list);



END_GNOME_DECLS

#endif