vcardparameter.h

Go to the documentation of this file.

/*======================================================================
 FILE: vcardparameter.h
 CREATOR: Ken Murchison 24 Aug 2022 <murch@fastmailteam.com>
 
 SPDX-FileCopyrightText: 2022, Fastmail Pty. Ltd. (https://fastmail.com)
 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0
 ======================================================================*/

 
#ifndef VCARDPARAMETER_H
#define VCARDPARAMETER_H
 
#include "libical_vcard_export.h"
#include "vcardderivedparameter.h"
#include "vcardderivedvalue.h"
 
/* Declared in vcardderivedparameter.h */
/*typedef struct vcardparameter_impl vcardparameter;*/

LIBICAL_VCARD_EXPORT vcardparameter *vcardparameter_new(vcardparameter_kind kind);

LIBICAL_VCARD_EXPORT vcardparameter *vcardparameter_clone(const vcardparameter *old);

LIBICAL_VCARD_EXPORT vcardparameter *vcardparameter_new_from_string(const char *str);

LIBICAL_VCARD_EXPORT vcardparameter *vcardparameter_new_from_value_string(vcardparameter_kind kind,
                                                                          const char *value);
 
LIBICAL_VCARD_EXPORT void vcardparameter_set_value_from_string(vcardparameter *param,
                                                               const char *val);
LIBICAL_VCARD_EXPORT void vcardparameter_add_value_from_string(vcardparameter *param,
                                                               const char *val);

LIBICAL_VCARD_EXPORT void vcardparameter_free(vcardparameter *parameter);

LIBICAL_VCARD_EXPORT char *vcardparameter_as_vcard_string(vcardparameter *parameter);

LIBICAL_VCARD_EXPORT char *vcardparameter_as_vcard_string_r(vcardparameter *parameter);

LIBICAL_VCARD_EXPORT vcardparameter_kind vcardparameter_isa(const vcardparameter *parameter);

LIBICAL_VCARD_EXPORT bool vcardparameter_isa_parameter(void *param);
 
/* Access the name of an X parameter */

LIBICAL_VCARD_EXPORT void vcardparameter_set_xname(vcardparameter *param, const char *v);

LIBICAL_VCARD_EXPORT const char *vcardparameter_get_xname(const vcardparameter *param);

LIBICAL_VCARD_EXPORT void vcardparameter_set_xvalue(vcardparameter *param, const char *v);

LIBICAL_VCARD_EXPORT const char *vcardparameter_get_xvalue(const vcardparameter *param);
 
/* Access the name of an IANA parameter */

LIBICAL_VCARD_EXPORT void vcardparameter_set_iana_name(vcardparameter *param, const char *v);

LIBICAL_VCARD_EXPORT const char *vcardparameter_get_iana_name(const vcardparameter *param);

LIBICAL_VCARD_EXPORT void vcardparameter_set_iana_value(vcardparameter *param, const char *v);

LIBICAL_VCARD_EXPORT const char *vcardparameter_get_iana_value(const vcardparameter *param);

LIBICAL_VCARD_EXPORT bool vcardparameter_has_same_name(const vcardparameter *param1, const vcardparameter *param2);
 
/* Convert enumerations */

LIBICAL_VCARD_EXPORT const char *vcardparameter_kind_to_string(vcardparameter_kind kind);

LIBICAL_VCARD_EXPORT vcardparameter_kind vcardparameter_string_to_kind(const char *string);

LIBICAL_VCARD_EXPORT bool vcardparameter_kind_is_valid(const vcardparameter_kind kind);
 
LIBICAL_VCARD_EXPORT vcardvalue_kind vcardparameter_kind_value_kind(const vcardparameter_kind kind,
                                                                    int *is_multivalued);
 
LIBICAL_VCARD_EXPORT bool vcardparameter_is_multivalued(const vcardparameter *param);
 
LIBICAL_VCARD_EXPORT bool vcardparameter_is_structured(const vcardparameter *param);
 
#endif