libkcal

icalparameter.h

Go to the documentation of this file.
00001 /* -*- Mode: C -*- */
00002 /*======================================================================
00003   FILE: icalparam.h
00004   CREATOR: eric 20 March 1999
00005 
00006 
00007 
00008   
00009 
00010  (C) COPYRIGHT 2000, Eric Busboom <eric@softwarestudio.org>
00011      http://www.softwarestudio.org
00012 
00013  This program is free software; you can redistribute it and/or modify
00014  it under the terms of either: 
00015 
00016     The LGPL as published by the Free Software Foundation, version
00017     2.1, available at: http://www.fsf.org/copyleft/lesser.html
00018 
00019   Or:
00020 
00021     The Mozilla Public License Version 1.0. You may obtain a copy of
00022     the License at http://www.mozilla.org/MPL/
00023 
00024   The original code is icalparam.h
00025 
00026   ======================================================================*/
00027 
00028 #ifndef ICALPARAM_H
00029 #define ICALPARAM_H
00030 
00031 #include "icalderivedparameter.h"
00032 
00033 /* Declared in icalderivedparameter.h */
00034 /*typedef struct icalparameter_impl icalparameter;*/
00035 
00036 icalparameter* icalparameter_new(icalparameter_kind kind);
00037 icalparameter* icalparameter_new_clone(icalparameter* p);
00038 
00039 /* Create from string of form "PARAMNAME=VALUE" */
00040 icalparameter* icalparameter_new_from_string(const char* value);
00041 
00042 /* Create from just the value, the part after the "=" */
00043 icalparameter* icalparameter_new_from_value_string(icalparameter_kind kind, const char* value);
00044 
00045 void icalparameter_free(icalparameter* parameter);
00046 
00047 char* icalparameter_as_ical_string(icalparameter* parameter);
00048 
00049 int icalparameter_is_valid(icalparameter* parameter);
00050 
00051 icalparameter_kind icalparameter_isa(icalparameter* parameter);
00052 
00053 int icalparameter_isa_parameter(void* param);
00054 
00055 /* Access the name of an X parameer */
00056 void icalparameter_set_xname (icalparameter* param, const char* v);
00057 const char* icalparameter_get_xname(icalparameter* param);
00058 void icalparameter_set_xvalue (icalparameter* param, const char* v);
00059 const char* icalparameter_get_xvalue(icalparameter* param);
00060 
00061 /* Convert enumerations */
00062 
00063 const char* icalparameter_kind_to_string(icalparameter_kind kind);
00064 icalparameter_kind icalparameter_string_to_kind(const char* string);
00065 
00066 
00067 
00068 #endif