Libical API Documentation 3.0

icalparameter_cxx.h
Go to the documentation of this file.
1
20#ifndef ICALPARAMETER_CXX_H
21#define ICALPARAMETER_CXX_H
22
23#include "libical_ical_export.h"
24#include "icptrholder_cxx.h"
25
26 extern "C"
27{
28#include "icalerror.h"
29#include "icalparameter.h"
30}
31
32#include <string>
33
34 namespace LibICal
35{
36
37 class LIBICAL_ICAL_EXPORT ICalParameter
38{
39 public:
40 ICalParameter();
41 ICalParameter(const ICalParameter &);
42 ICalParameter &operator=(const ICalParameter &);
43 ~ICalParameter();
44
45 explicit ICalParameter(icalparameter *v);
46
47 // Create from string of form "PARAMNAME=VALUE"
48 explicit ICalParameter(const std::string &str);
49
50 // Create from just the value, the part after the "="
51 explicit ICalParameter(const icalparameter_kind &kind);
52 ICalParameter(const icalparameter_kind &kind, const std::string &str);
53
54 operator icalparameter *()
55 {
56 return imp;
57 }
58
59 void detach();
60
61 public:
62 std::string as_ical_string();
63 bool is_valid();
64 icalparameter_kind isa();
65 int isa_parameter(void *param);
66
67 public:
68 /* Access the name of an X parameter */
69 static void set_xname(ICalParameter &param, const std::string &v);
70 static std::string get_xname(ICalParameter &param);
71 static void set_xvalue(ICalParameter &param, const std::string &v);
72 static std::string get_xvalue(ICalParameter &param);
73
74 /* Convert enumerations */
75 static std::string kind_to_string(const icalparameter_kind &kind);
76 static icalparameter_kind string_to_kind(const std::string &str);
77
78 public:
79 /* DELEGATED-FROM */
80 std::string get_delegatedfrom() const;
81 void set_delegatedfrom(const std::string &v);
82
83 /* RELATED */
84 icalparameter_related get_related() const;
85 void set_related(const icalparameter_related &v);
86
87 /* SENT-BY */
88 std::string get_sentby() const;
89 void set_sentby(const std::string &v);
90
91 /* LANGUAGE */
92 std::string get_language() const;
93 void set_language(const std::string &v);
94
95 /* RELTYPE */
96 icalparameter_reltype get_reltype() const;
97 void set_reltype(const icalparameter_reltype &v);
98
99 /* ENCODING */
100 icalparameter_encoding get_encoding() const;
101 void set_encoding(const icalparameter_encoding &v);
102
103 /* ALTREP */
104 std::string get_altrep() const;
105 void set_altrep(const std::string &v);
106
107 /* FMTTYPE */
108 std::string get_fmttype() const;
109 void set_fmttype(const std::string &v);
110
111 /* FBTYPE */
112 icalparameter_fbtype get_fbtype() const;
113 void set_fbtype(const icalparameter_fbtype &v);
114
115 /* RSVP */
116 icalparameter_rsvp get_rsvp() const;
117 void set_rsvp(const icalparameter_rsvp &v);
118
119 /* RANGE */
120 icalparameter_range get_range() const;
121 void set_range(const icalparameter_range &v);
122
123 /* DELEGATED-TO */
124 std::string get_delegatedto() const;
125 void set_delegatedto(const std::string &v);
126
127 /* CN */
128 std::string get_cn() const;
129 void set_cn(const std::string &v);
130
131 /* ROLE */
132 icalparameter_role get_role() const;
133 void set_role(const icalparameter_role &v);
134
135 /* X-LIC-COMPARETYPE */
136 icalparameter_xliccomparetype get_xliccomparetype() const;
137 void set_xliccomparetype(const icalparameter_xliccomparetype &v);
138
139 /* PARTSTAT */
140 icalparameter_partstat get_partstat() const;
141 void set_partstat(const icalparameter_partstat &v);
142
143 /* X-LIC-ERRORTYPE */
144 icalparameter_xlicerrortype get_xlicerrortype() const;
145 void set_xlicerrortype(const icalparameter_xlicerrortype &v);
146
147 /* MEMBER */
148 std::string get_member() const;
149 void set_member(const std::string &v);
150
151 /* X */
152 std::string get_x() const;
153 void set_x(const std::string &v);
154
155 /* CUTYPE */
156 icalparameter_cutype get_cutype() const;
157 void set_cutype(const icalparameter_cutype &v);
158
159 /* TZID */
160 std::string get_tzid() const;
161 void set_tzid(const std::string &v);
162
163 /* VALUE */
164 icalparameter_value get_value() const;
165 void set_value(const icalparameter_value &v);
166
167 /* DIR */
168 std::string get_dir() const;
169 void set_dir(const std::string &v);
170
171 private:
172 icalparameter *imp;
173};
174
175} // namespace LibICal
176
177#endif
LibICal::ICalParameter
Definition: icalparameter_cxx.h:38
icalerror.h
Error handling for libical.
icalparameter.h
icptrholder_cxx.h
C++ template classes for managing C++ pointers returned by VComponent::get_..._component,...