Libical API Documentation  3.0
icalparameter.h
Go to the documentation of this file.
1 /*======================================================================
2  FILE: icalparam.h
3  CREATOR: eric 20 March 1999
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 
27 #ifndef ICALPARAMETER_H
28 #define ICALPARAMETER_H
29 
30 #include "libical_ical_export.h"
31 #include "icalderivedparameter.h"
32 
33 /* Declared in icalderivedparameter.h */
34 /*typedef struct icalparameter_impl icalparameter;*/
35 
63 LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new(icalparameter_kind kind);
64 
96 LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_clone(icalparameter *p);
97 
124 LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_from_string(const char *value);
125 
153 LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_from_value_string(icalparameter_kind kind,
154  const char *value);
155 
177 LIBICAL_ICAL_EXPORT void icalparameter_free(icalparameter *parameter);
178 
209 LIBICAL_ICAL_EXPORT char *icalparameter_as_ical_string(icalparameter *parameter);
210 
243 LIBICAL_ICAL_EXPORT char *icalparameter_as_ical_string_r(icalparameter *parameter);
244 
265 LIBICAL_ICAL_EXPORT icalparameter_kind icalparameter_isa(icalparameter *parameter);
266 
290 LIBICAL_ICAL_EXPORT int icalparameter_isa_parameter(void *param);
291 
292 /* Access the name of an X parameter */
293 
322 LIBICAL_ICAL_EXPORT void icalparameter_set_xname(icalparameter *param, const char *v);
323 
352 LIBICAL_ICAL_EXPORT const char *icalparameter_get_xname(icalparameter *param);
353 
383 LIBICAL_ICAL_EXPORT void icalparameter_set_xvalue(icalparameter *param, const char *v);
384 
414 LIBICAL_ICAL_EXPORT const char *icalparameter_get_xvalue(icalparameter *param);
415 
416 /* Access the name of an IANA parameter */
417 
446 LIBICAL_ICAL_EXPORT void icalparameter_set_iana_name(icalparameter *param, const char *v);
447 
476 LIBICAL_ICAL_EXPORT const char *icalparameter_get_iana_name(icalparameter *param);
477 
507 LIBICAL_ICAL_EXPORT void icalparameter_set_iana_value(icalparameter *param, const char *v);
508 
538 LIBICAL_ICAL_EXPORT const char *icalparameter_get_iana_value(icalparameter *param);
539 
567 LIBICAL_ICAL_EXPORT int icalparameter_has_same_name(icalparameter *param1, icalparameter *param2);
568 
569 /* Convert enumerations */
570 
590 LIBICAL_ICAL_EXPORT const char *icalparameter_kind_to_string(icalparameter_kind kind);
591 
613 LIBICAL_ICAL_EXPORT icalparameter_kind icalparameter_string_to_kind(const char *string);
614 
615 #endif
const char * icalparameter_get_iana_value(icalparameter *param)
Returns the IANA value of param.
Definition: icalparameter.c:398
const char * icalparameter_get_iana_name(icalparameter *param)
Returns the IANA name of param.
Definition: icalparameter.c:408
icalparameter * icalparameter_new_clone(icalparameter *p)
Creates new ::icalparameter as a clone of the given one.
Definition: icalparameter.c:85
int icalparameter_has_same_name(icalparameter *param1, icalparameter *param2)
Determines if two parameters have the same name.
Definition: icalparameter.c:428
const char * icalparameter_kind_to_string(icalparameter_kind kind)
Returns a string representing the given ::icalparameter_kind.
char * icalparameter_as_ical_string_r(icalparameter *parameter)
Convert ::icalparameter into an string representation.
Definition: icalparameter.c:271
icalparameter_kind icalparameter_isa(icalparameter *parameter)
Returns the icalparameter_kind of parameter.
Definition: icalparameter.c:323
const char * icalparameter_get_xname(icalparameter *param)
Returns the X-name of param.
Definition: icalparameter.c:363
void icalparameter_set_xvalue(icalparameter *param, const char *v)
Sets the X-value of param to v.
Definition: icalparameter.c:370
void icalparameter_set_xname(icalparameter *param, const char *v)
Sets the X-name of param to v.
Definition: icalparameter.c:347
void icalparameter_set_iana_name(icalparameter *param, const char *v)
Sets the IANA name of param to v.
Definition: icalparameter.c:403
const char * icalparameter_get_xvalue(icalparameter *param)
Returns the X-value of param.
Definition: icalparameter.c:386
icalparameter * icalparameter_new_from_value_string(icalparameter_kind kind, const char *value)
Create ::icalparameter of a given kind with a given value.
icalparameter_kind icalparameter_string_to_kind(const char *string)
Returns the ::icalparameter_kind for a given string.
icalparameter * icalparameter_new_from_string(const char *value)
Create ::icalparameter object from string.
Definition: icalparameter.c:120
int icalparameter_isa_parameter(void *param)
Determine if the given param is an icalparameter.
Definition: icalparameter.c:332
char * icalparameter_as_ical_string(icalparameter *parameter)
Convert ::icalparameter into an string representation.
Definition: icalparameter.c:169
void icalparameter_set_iana_value(icalparameter *param, const char *v)
Sets the IANA value of param to v.
Definition: icalparameter.c:393
icalparameter * icalparameter_new(icalparameter_kind kind)
Creates new ::icalparameter object.
Definition: icalparameter.c:54
void icalparameter_free(icalparameter *parameter)
Frees an ::icalparameter object.
Definition: icalparameter.c:61