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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
/*======================================================================
FILE: icalproperty.h
CREATOR: eric 20 March 1999
SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com>
SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
======================================================================*/
#ifndef ICALPROPERTY_H
#define ICALPROPERTY_H
#include "libical_deprecated.h"
#include "libical_ical_export.h"
#include "icalderivedproperty.h" /* To get icalproperty_kind enumerations */
#include <stdarg.h> /* for va_... */
/** @file icalproperty.h */
LIBICAL_ICAL_EXPORT icalproperty *icalproperty_new(icalproperty_kind kind);
LIBICAL_ICAL_EXPORT icalproperty *icalproperty_new_impl(icalproperty_kind kind);
/** @brief Deeply clones an icalproperty.
*
* Returns a pointer to the memory for the newly cloned icalproperty.
* @since 3.1.0
*/
LIBICAL_ICAL_EXPORT icalproperty *icalproperty_clone(const icalproperty *prop);
LIBICAL_ICAL_EXPORT icalproperty *icalproperty_new_from_string(const char *str);
LIBICAL_ICAL_EXPORT const char *icalproperty_as_ical_string(icalproperty *prop);
LIBICAL_ICAL_EXPORT char *icalproperty_as_ical_string_r(icalproperty *prop);
LIBICAL_ICAL_EXPORT void icalproperty_free(icalproperty *prop);
LIBICAL_ICAL_EXPORT icalproperty_kind icalproperty_isa(icalproperty *property);
LIBICAL_ICAL_EXPORT int icalproperty_isa_property(void *property);
LIBICAL_ICAL_EXPORT void icalproperty_add_parameters(struct icalproperty_impl *prop, va_list args);
LIBICAL_ICAL_EXPORT void icalproperty_add_parameter(icalproperty *prop, icalparameter *parameter);
LIBICAL_ICAL_EXPORT void icalproperty_set_parameter(icalproperty *prop, icalparameter *parameter);
LIBICAL_ICAL_EXPORT void icalproperty_set_parameter_from_string(icalproperty *prop,
const char *name,
const char *value);
LIBICAL_ICAL_EXPORT const char *icalproperty_get_parameter_as_string(icalproperty *prop,
const char *name);
LIBICAL_ICAL_EXPORT char *icalproperty_get_parameter_as_string_r(icalproperty *prop,
const char *name);
/** @brief Removes all parameters with the specified kind.
*
* @param prop A valid icalproperty.
* @param kind The kind to remove (ex. ICAL_TZID_PARAMETER)
*
* See icalproperty_remove_parameter_by_name() and
* icalproperty_remove_parameter_by_ref() for alternate ways of
* removing parameters
*/
LIBICAL_ICAL_EXPORT void icalproperty_remove_parameter_by_kind(icalproperty *prop,
icalparameter_kind kind);
/** @brief Removes all parameters with the specified name.
*
* @param prop A valid icalproperty.
* @param name The name of the parameter to remove
*
* This function removes parameters with the given name. The name
* corresponds to either a built-in name (TZID, etc.) or the name of
* an extended parameter (X-FOO)
*
* See icalproperty_remove_parameter_by_kind() and
* icalproperty_remove_parameter_by_ref() for alternate ways of removing
* parameters
*/
LIBICAL_ICAL_EXPORT void icalproperty_remove_parameter_by_name(icalproperty *prop,
const char *name);
/** @brief Removes the specified parameter reference from the property.
*
* @param prop A valid icalproperty.
* @param parameter A reference to a specific icalparameter.
*
* This function removes the specified parameter reference from the
* property.
*/
LIBICAL_ICAL_EXPORT void icalproperty_remove_parameter_by_ref(icalproperty *prop,
icalparameter *param);
LIBICAL_ICAL_EXPORT int icalproperty_count_parameters(const icalproperty *prop);
/* Iterate through the parameters */
LIBICAL_ICAL_EXPORT icalparameter *icalproperty_get_first_parameter(icalproperty *prop,
icalparameter_kind kind);
LIBICAL_ICAL_EXPORT icalparameter *icalproperty_get_next_parameter(icalproperty *prop,
icalparameter_kind kind);
/* Access the value of the property */
LIBICAL_ICAL_EXPORT void icalproperty_set_value(icalproperty *prop, icalvalue *value);
LIBICAL_ICAL_EXPORT void icalproperty_set_value_from_string(icalproperty *prop, const char *value,
const char *kind);
LIBICAL_ICAL_EXPORT icalvalue *icalproperty_get_value(const icalproperty *prop);
LIBICAL_ICAL_EXPORT const char *icalproperty_get_value_as_string(const icalproperty *prop);
LIBICAL_ICAL_EXPORT char *icalproperty_get_value_as_string_r(const icalproperty *prop);
/**
* Sets the parent @p icalproperty for the specified @p icalvalue.
*/
LIBICAL_ICAL_EXPORT void icalvalue_set_parent(icalvalue *value, icalproperty *property);
/**
* Returns the parent @p icalproperty for the specified @p icalvalue.
* @since 3.0
*/
LIBICAL_ICAL_EXPORT icalproperty *icalvalue_get_parent(icalvalue *value);
/* Deal with X properties */
LIBICAL_ICAL_EXPORT void icalproperty_set_x_name(icalproperty *prop, const char *name);
LIBICAL_ICAL_EXPORT const char *icalproperty_get_x_name(icalproperty *prop);
/** Returns the name of the property -- the type name converted to a
* string, or the value of _get_x_name if the type is and X
* property
*/
LIBICAL_ICAL_EXPORT const char *icalproperty_get_property_name(const icalproperty *prop);
LIBICAL_ICAL_EXPORT char *icalproperty_get_property_name_r(const icalproperty *prop);
LIBICAL_ICAL_EXPORT icalvalue_kind icalparameter_value_to_value_kind(icalparameter_value value);
/**
* Sets the parent @p icalproperty for the specified @p icalparameter.
* @since 3.0
*/
LIBICAL_ICAL_EXPORT void icalparameter_set_parent(icalparameter *param, icalproperty *property);
/**
* Returns the parent @p icalproperty for the specified @p icalparameter.
* @since 3.0
*/
LIBICAL_ICAL_EXPORT icalproperty *icalparameter_get_parent(icalparameter *param);
/* Convert kinds to string and get default value type */
LIBICAL_ICAL_EXPORT icalvalue_kind icalproperty_kind_to_value_kind(icalproperty_kind kind);
LIBICAL_ICAL_EXPORT icalproperty_kind icalproperty_value_kind_to_kind(icalvalue_kind kind);
LIBICAL_ICAL_EXPORT const char *icalproperty_kind_to_string(icalproperty_kind kind);
LIBICAL_ICAL_EXPORT icalproperty_kind icalproperty_string_to_kind(const char *string);
/** Check validity of a specific icalproperty_kind **/
LIBICAL_ICAL_EXPORT int icalproperty_kind_is_valid(const icalproperty_kind kind);
LIBICAL_ICAL_EXPORT icalproperty_method icalproperty_string_to_method(const char *str);
LIBICAL_ICAL_EXPORT const char *icalproperty_method_to_string(icalproperty_method method);
LIBICAL_ICAL_EXPORT const char *icalproperty_enum_to_string(int e);
LIBICAL_ICAL_EXPORT char *icalproperty_enum_to_string_r(int e);
LIBICAL_ICAL_EXPORT int icalproperty_kind_and_string_to_enum(const int kind, const char *str);
LIBICAL_ICAL_EXPORT const char *icalproperty_status_to_string(icalproperty_status);
LIBICAL_ICAL_EXPORT icalproperty_status icalproperty_string_to_status(const char *string);
LIBICAL_ICAL_EXPORT int icalproperty_enum_belongs_to_property(icalproperty_kind kind, int e);
/**
* Normalizes (reorders and sorts the parameters) the specified @p icalproperty.
* @since 3.0
*/
LIBICAL_ICAL_EXPORT void icalproperty_normalize(icalproperty *prop);
/**
* @copydoc icalproperty_clone()
* @deprecated use icalproperty_clone() instead
*/
LIBICAL_ICAL_EXPORT LIBICAL_DEPRECATED(icalproperty *icalproperty_new_clone(icalproperty *prop));
#endif /*ICALPROPERTY_H */
|
