icalparameter.h

Go to the documentation of this file.

/*======================================================================
  FILE: icalparameter.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 ICALPARAMETER_H
#define ICALPARAMETER_H

#include "libical_ical_export.h"
#include "icalderivedparameter.h"
#include "icalderivedvalue.h"

/* Declared in icalderivedparameter.h */
/*typedef struct icalparameter_impl icalparameter;*/

LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new(icalparameter_kind kind);

LIBICAL_ICAL_EXPORT icalparameter *icalparameter_clone(const icalparameter *old);

LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_from_string(const char *str);

LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_from_value_string(icalparameter_kind kind,
                                                                       const char *value);

LIBICAL_ICAL_EXPORT void icalparameter_free(icalparameter *parameter);

LIBICAL_ICAL_EXPORT char *icalparameter_as_ical_string(icalparameter *parameter);

LIBICAL_ICAL_EXPORT char *icalparameter_as_ical_string_r(icalparameter *parameter);

LIBICAL_ICAL_EXPORT icalparameter_kind icalparameter_isa(const icalparameter *parameter);

LIBICAL_ICAL_EXPORT bool icalparameter_isa_parameter(void *param);

/* Access the name of an X parameter */

LIBICAL_ICAL_EXPORT void icalparameter_set_xname(icalparameter *param, const char *v);

LIBICAL_ICAL_EXPORT const char *icalparameter_get_xname(const icalparameter *param);

LIBICAL_ICAL_EXPORT void icalparameter_set_xvalue(icalparameter *param, const char *v);

LIBICAL_ICAL_EXPORT const char *icalparameter_get_xvalue(const icalparameter *param);

/* Access the name of an IANA parameter */

LIBICAL_ICAL_EXPORT void icalparameter_set_iana_name(icalparameter *param, const char *v);

LIBICAL_ICAL_EXPORT const char *icalparameter_get_iana_name(const icalparameter *param);

LIBICAL_ICAL_EXPORT void icalparameter_set_iana_value(icalparameter *param, const char *v);

LIBICAL_ICAL_EXPORT const char *icalparameter_get_iana_value(const icalparameter *param);

LIBICAL_ICAL_EXPORT bool icalparameter_has_same_name(const icalparameter *param1, const icalparameter *param2);

/* Convert enumerations */

LIBICAL_ICAL_EXPORT const char *icalparameter_kind_to_string(icalparameter_kind kind);

LIBICAL_ICAL_EXPORT icalparameter_kind icalparameter_string_to_kind(const char *string);

LIBICAL_ICAL_EXPORT bool icalparameter_kind_is_valid(const icalparameter_kind kind);

LIBICAL_ICAL_EXPORT icalvalue_kind icalparameter_kind_value_kind(const icalparameter_kind kind, int *is_multivalued);

LIBICAL_ICAL_EXPORT bool icalparameter_is_multivalued(const icalparameter *param);

LIBICAL_ICAL_EXPORT void icalparameter_decode_value(char *value);

#endif