icalparameter.h

Go to the documentation of this file.

/*======================================================================
  FILE: icalparam.h
  CREATOR: eric 20 March 1999
 
 (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
 
 This library is free software; you can redistribute it and/or modify
 it under the terms of either:
 
    The LGPL as published by the Free Software Foundation, version
    2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
 
 Or:
 
    The Mozilla Public License Version 2.0. You may obtain a copy of
    the License at https://www.mozilla.org/MPL/
======================================================================*/
 
#ifndef ICALPARAMETER_H
#define ICALPARAMETER_H
 
#include "libical_ical_export.h"
#include "icalderivedparameter.h"
 
/* Declared in icalderivedparameter.h */
/*typedef struct icalparameter_impl icalparameter;*/
 
LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new(icalparameter_kind kind);
 
LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_clone(icalparameter *p);
 
LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_from_string(const char *value);
 
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(icalparameter *parameter);
 
LIBICAL_ICAL_EXPORT int 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(icalparameter *param);
 
LIBICAL_ICAL_EXPORT void icalparameter_set_xvalue(icalparameter *param, const char *v);
 
LIBICAL_ICAL_EXPORT const char *icalparameter_get_xvalue(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(icalparameter *param);
 
LIBICAL_ICAL_EXPORT void icalparameter_set_iana_value(icalparameter *param, const char *v);
 
LIBICAL_ICAL_EXPORT const char *icalparameter_get_iana_value(icalparameter *param);
 
LIBICAL_ICAL_EXPORT int icalparameter_has_same_name(icalparameter *param1, 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 int icalparameter_kind_is_valid(const icalparameter_kind kind);
 
#endif