Libical API Documentation 4.0 STABLE VERSION [Visit the v3.0 documentation]
Loading...
Searching...
No Matches
vcardderivedvalue.h File Reference

vCard values. More...

Go to the source code of this file.

Macros

#define VCARDPROPERTY_FIRST_ENUM   10000
#define VCARDPROPERTY_LAST_ENUM   10300

Typedefs

typedef struct vcardvalue_impl vcardvalue

Enumerations

enum  vcard_adr_field {
  VCARD_ADR_PO_BOX = 0 ,
  VCARD_ADR_EXTENDED ,
  VCARD_ADR_STREET ,
  VCARD_ADR_LOCALITY ,
  VCARD_ADR_REGION ,
  VCARD_ADR_POSTAL_CODE ,
  VCARD_ADR_COUNTRY ,
  VCARD_ADR_ROOM ,
  VCARD_ADR_APARTMENT ,
  VCARD_ADR_FLOOR ,
  VCARD_ADR_STREET_NUMBER ,
  VCARD_ADR_STREET_NAME ,
  VCARD_ADR_BUILDING ,
  VCARD_ADR_BLOCK ,
  VCARD_ADR_SUBDISTRICT ,
  VCARD_ADR_DISTRICT ,
  VCARD_ADR_LANDMARK ,
  VCARD_ADR_DIRECTION ,
  VCARD_NUM_ADR_FIELDS
}
enum  vcard_clientpidmap_field {
  VCARD_CLIENTPIDMAP_ID = 0 ,
  VCARD_CLIENTPIDMAP_URI ,
  VCARD_NUM_CLIENTPIDMAP_FIELDS
}
enum  vcard_gender_field {
  VCARD_GENDER_SEX = 0 ,
  VCARD_GENDER_TEXT ,
  VCARD_NUM_GENDER_FIELDS
}
enum  vcard_n_field {
  VCARD_N_FAMILY = 0 ,
  VCARD_N_GIVEN ,
  VCARD_N_ADDITIONAL ,
  VCARD_N_PREFIX ,
  VCARD_N_SUFFIX ,
  VCARD_N_SECONDARY ,
  VCARD_N_GENERATION ,
  VCARD_NUM_N_FIELDS
}
enum  vcardproperty_gramgender {
  VCARD_GRAMGENDER_X = 10200 ,
  VCARD_GRAMGENDER_ANIMATE = 10201 ,
  VCARD_GRAMGENDER_COMMON = 10202 ,
  VCARD_GRAMGENDER_FEMININE = 10203 ,
  VCARD_GRAMGENDER_INANIMATE = 10204 ,
  VCARD_GRAMGENDER_MASCULINE = 10205 ,
  VCARD_GRAMGENDER_NEUTER = 10206 ,
  VCARD_GRAMGENDER_NONE = 10299
}
enum  vcardproperty_kindenum {
  VCARD_KIND_X = 10000 ,
  VCARD_KIND_INDIVIDUAL = 10001 ,
  VCARD_KIND_GROUP = 10002 ,
  VCARD_KIND_ORG = 10003 ,
  VCARD_KIND_LOCATION = 10004 ,
  VCARD_KIND_APPLICATION = 10005 ,
  VCARD_KIND_DEVICE = 10006 ,
  VCARD_KIND_NONE = 10099
}
enum  vcardproperty_version {
  VCARD_VERSION_X = 10100 ,
  VCARD_VERSION_21 = 10101 ,
  VCARD_VERSION_30 = 10102 ,
  VCARD_VERSION_40 = 10103 ,
  VCARD_VERSION_NONE = 10199
}
enum  vcardvalue_kind {
  VCARD_ANY_VALUE =5000 ,
  VCARD_BOOLEAN_VALUE =5008 ,
  VCARD_DATE_VALUE =5003 ,
  VCARD_DATEANDORTIME_VALUE =5006 ,
  VCARD_DATETIME_VALUE =5005 ,
  VCARD_FLOAT_VALUE =5010 ,
  VCARD_GEO_VALUE =5021 ,
  VCARD_GRAMGENDER_VALUE =5018 ,
  VCARD_INTEGER_VALUE =5009 ,
  VCARD_KIND_VALUE =5014 ,
  VCARD_LANGUAGETAG_VALUE =5012 ,
  VCARD_STRUCTURED_VALUE =5017 ,
  VCARD_TEXT_VALUE =5001 ,
  VCARD_TEXTLIST_VALUE =5016 ,
  VCARD_TIME_VALUE =5004 ,
  VCARD_TIMESTAMP_VALUE =5007 ,
  VCARD_TZ_VALUE =5020 ,
  VCARD_URI_VALUE =5002 ,
  VCARD_UTCOFFSET_VALUE =5011 ,
  VCARD_VERSION_VALUE =5015 ,
  VCARD_X_VALUE =5013 ,
  VCARD_NO_VALUE =5099
}

Functions

int vcardvalue_get_boolean (const vcardvalue *value)
vcardtimetype vcardvalue_get_date (const vcardvalue *value)
vcardtimetype vcardvalue_get_dateandortime (const vcardvalue *value)
vcardtimetype vcardvalue_get_datetime (const vcardvalue *value)
float vcardvalue_get_float (const vcardvalue *value)
vcardgeotype vcardvalue_get_geo (const vcardvalue *value)
enum vcardproperty_gramgender vcardvalue_get_gramgender (const vcardvalue *value)
int vcardvalue_get_integer (const vcardvalue *value)
enum vcardproperty_kindenum vcardvalue_get_kind (const vcardvalue *value)
const char * vcardvalue_get_languagetag (const vcardvalue *value)
vcardstructuredtypevcardvalue_get_structured (const vcardvalue *value)
const char * vcardvalue_get_text (const vcardvalue *value)
vcardstrarrayvcardvalue_get_textlist (const vcardvalue *value)
vcardtimetype vcardvalue_get_time (const vcardvalue *value)
vcardtimetype vcardvalue_get_timestamp (const vcardvalue *value)
vcardtztype vcardvalue_get_tz (const vcardvalue *value)
const char * vcardvalue_get_uri (const vcardvalue *value)
int vcardvalue_get_utcoffset (const vcardvalue *value)
enum vcardproperty_version vcardvalue_get_version (const vcardvalue *value)
const char * vcardvalue_get_x (const vcardvalue *value)
vcardvaluevcardvalue_new_boolean (int v)
vcardvaluevcardvalue_new_date (vcardtimetype v)
vcardvaluevcardvalue_new_dateandortime (vcardtimetype v)
vcardvaluevcardvalue_new_datetime (vcardtimetype v)
vcardvaluevcardvalue_new_float (float v)
vcardvaluevcardvalue_new_geo (vcardgeotype v)
vcardvaluevcardvalue_new_gramgender (enum vcardproperty_gramgender v)
vcardvaluevcardvalue_new_integer (int v)
vcardvaluevcardvalue_new_kind (enum vcardproperty_kindenum v)
vcardvaluevcardvalue_new_languagetag (const char *v)
vcardvaluevcardvalue_new_structured (vcardstructuredtype *v)
vcardvaluevcardvalue_new_text (const char *v)
vcardvaluevcardvalue_new_textlist (vcardstrarray *v)
vcardvaluevcardvalue_new_time (vcardtimetype v)
vcardvaluevcardvalue_new_timestamp (vcardtimetype v)
vcardvaluevcardvalue_new_tz (vcardtztype v)
vcardvaluevcardvalue_new_uri (const char *v)
vcardvaluevcardvalue_new_utcoffset (int v)
vcardvaluevcardvalue_new_version (enum vcardproperty_version v)
vcardvaluevcardvalue_new_x (const char *v)
void vcardvalue_set_boolean (vcardvalue *value, int v)
void vcardvalue_set_date (vcardvalue *value, vcardtimetype v)
void vcardvalue_set_dateandortime (vcardvalue *value, vcardtimetype v)
void vcardvalue_set_datetime (vcardvalue *value, vcardtimetype v)
void vcardvalue_set_float (vcardvalue *value, float v)
void vcardvalue_set_geo (vcardvalue *value, vcardgeotype v)
void vcardvalue_set_gramgender (vcardvalue *value, enum vcardproperty_gramgender v)
void vcardvalue_set_integer (vcardvalue *value, int v)
void vcardvalue_set_kind (vcardvalue *value, enum vcardproperty_kindenum v)
void vcardvalue_set_languagetag (vcardvalue *value, const char *v)
void vcardvalue_set_structured (vcardvalue *value, vcardstructuredtype *v)
void vcardvalue_set_text (vcardvalue *value, const char *v)
void vcardvalue_set_textlist (vcardvalue *value, vcardstrarray *v)
void vcardvalue_set_time (vcardvalue *value, vcardtimetype v)
void vcardvalue_set_timestamp (vcardvalue *value, vcardtimetype v)
void vcardvalue_set_tz (vcardvalue *value, vcardtztype v)
void vcardvalue_set_uri (vcardvalue *value, const char *v)
void vcardvalue_set_utcoffset (vcardvalue *value, int v)
void vcardvalue_set_version (vcardvalue *value, enum vcardproperty_version v)
void vcardvalue_set_x (vcardvalue *value, const char *v)

Detailed Description

vCard values.

Definition in file vcardderivedvalue.h.

Macro Definition Documentation

◆ VCARDPROPERTY_FIRST_ENUM

#define VCARDPROPERTY_FIRST_ENUM   10000

Definition at line 116 of file vcardderivedvalue.h.

◆ VCARDPROPERTY_LAST_ENUM

#define VCARDPROPERTY_LAST_ENUM   10300

Definition at line 148 of file vcardderivedvalue.h.

Typedef Documentation

◆ vcardvalue

typedef struct vcardvalue_impl vcardvalue

Definition at line 72 of file vcardderivedvalue.h.

Enumeration Type Documentation

◆ vcard_adr_field

Enumerator
VCARD_ADR_PO_BOX 
VCARD_ADR_EXTENDED 
VCARD_ADR_STREET 
VCARD_ADR_LOCALITY 
VCARD_ADR_REGION 
VCARD_ADR_POSTAL_CODE 
VCARD_ADR_COUNTRY 
VCARD_ADR_ROOM 
VCARD_ADR_APARTMENT 
VCARD_ADR_FLOOR 
VCARD_ADR_STREET_NUMBER 
VCARD_ADR_STREET_NAME 
VCARD_ADR_BUILDING 
VCARD_ADR_BLOCK 
VCARD_ADR_SUBDISTRICT 
VCARD_ADR_DISTRICT 
VCARD_ADR_LANDMARK 
VCARD_ADR_DIRECTION 
VCARD_NUM_ADR_FIELDS 

Definition at line 43 of file vcardderivedvalue.h.

◆ vcard_clientpidmap_field

Enumerator
VCARD_CLIENTPIDMAP_ID 
VCARD_CLIENTPIDMAP_URI 
VCARD_NUM_CLIENTPIDMAP_FIELDS 

Definition at line 66 of file vcardderivedvalue.h.

◆ vcard_gender_field

Enumerator
VCARD_GENDER_SEX 
VCARD_GENDER_TEXT 
VCARD_NUM_GENDER_FIELDS 

Definition at line 37 of file vcardderivedvalue.h.

◆ vcard_n_field

Enumerator
VCARD_N_FAMILY 
VCARD_N_GIVEN 
VCARD_N_ADDITIONAL 
VCARD_N_PREFIX 
VCARD_N_SUFFIX 
VCARD_N_SECONDARY 
VCARD_N_GENERATION 
VCARD_NUM_N_FIELDS 

Definition at line 25 of file vcardderivedvalue.h.

◆ vcardproperty_gramgender

Enumerator
VCARD_GRAMGENDER_X 
VCARD_GRAMGENDER_ANIMATE 
VCARD_GRAMGENDER_COMMON 
VCARD_GRAMGENDER_FEMININE 
VCARD_GRAMGENDER_INANIMATE 
VCARD_GRAMGENDER_MASCULINE 
VCARD_GRAMGENDER_NEUTER 
VCARD_GRAMGENDER_NONE 

Definition at line 118 of file vcardderivedvalue.h.

◆ vcardproperty_kindenum

Enumerator
VCARD_KIND_X 
VCARD_KIND_INDIVIDUAL 
VCARD_KIND_GROUP 
VCARD_KIND_ORG 
VCARD_KIND_LOCATION 
VCARD_KIND_APPLICATION 
VCARD_KIND_DEVICE 
VCARD_KIND_NONE 

Definition at line 129 of file vcardderivedvalue.h.

◆ vcardproperty_version

Enumerator
VCARD_VERSION_X 
VCARD_VERSION_21 
VCARD_VERSION_30 
VCARD_VERSION_40 
VCARD_VERSION_NONE 

Definition at line 140 of file vcardderivedvalue.h.

◆ vcardvalue_kind

Enumerator
VCARD_ANY_VALUE 
VCARD_BOOLEAN_VALUE 
VCARD_DATE_VALUE 
VCARD_DATEANDORTIME_VALUE 
VCARD_DATETIME_VALUE 
VCARD_FLOAT_VALUE 
VCARD_GEO_VALUE 
VCARD_GRAMGENDER_VALUE 
VCARD_INTEGER_VALUE 
VCARD_KIND_VALUE 
VCARD_LANGUAGETAG_VALUE 
VCARD_STRUCTURED_VALUE 
VCARD_TEXT_VALUE 
VCARD_TEXTLIST_VALUE 
VCARD_TIME_VALUE 
VCARD_TIMESTAMP_VALUE 
VCARD_TZ_VALUE 
VCARD_URI_VALUE 
VCARD_UTCOFFSET_VALUE 
VCARD_VERSION_VALUE 
VCARD_X_VALUE 
VCARD_NO_VALUE 

Definition at line 91 of file vcardderivedvalue.h.

Function Documentation

◆ vcardvalue_get_boolean()

int vcardvalue_get_boolean ( const vcardvalue * value)

◆ vcardvalue_get_date()

vcardtimetype vcardvalue_get_date ( const vcardvalue * value)

◆ vcardvalue_get_dateandortime()

vcardtimetype vcardvalue_get_dateandortime ( const vcardvalue * value)

◆ vcardvalue_get_datetime()

vcardtimetype vcardvalue_get_datetime ( const vcardvalue * value)

◆ vcardvalue_get_float()

float vcardvalue_get_float ( const vcardvalue * value)

◆ vcardvalue_get_geo()

vcardgeotype vcardvalue_get_geo ( const vcardvalue * value)

◆ vcardvalue_get_gramgender()

enum vcardproperty_gramgender vcardvalue_get_gramgender ( const vcardvalue * value)

◆ vcardvalue_get_integer()

int vcardvalue_get_integer ( const vcardvalue * value)

◆ vcardvalue_get_kind()

enum vcardproperty_kindenum vcardvalue_get_kind ( const vcardvalue * value)

◆ vcardvalue_get_languagetag()

const char * vcardvalue_get_languagetag ( const vcardvalue * value)

◆ vcardvalue_get_structured()

vcardstructuredtype * vcardvalue_get_structured ( const vcardvalue * value)

◆ vcardvalue_get_text()

const char * vcardvalue_get_text ( const vcardvalue * value)

◆ vcardvalue_get_textlist()

vcardstrarray * vcardvalue_get_textlist ( const vcardvalue * value)

◆ vcardvalue_get_time()

vcardtimetype vcardvalue_get_time ( const vcardvalue * value)

◆ vcardvalue_get_timestamp()

vcardtimetype vcardvalue_get_timestamp ( const vcardvalue * value)

◆ vcardvalue_get_tz()

vcardtztype vcardvalue_get_tz ( const vcardvalue * value)

◆ vcardvalue_get_uri()

const char * vcardvalue_get_uri ( const vcardvalue * value)

◆ vcardvalue_get_utcoffset()

int vcardvalue_get_utcoffset ( const vcardvalue * value)

◆ vcardvalue_get_version()

enum vcardproperty_version vcardvalue_get_version ( const vcardvalue * value)

◆ vcardvalue_get_x()

const char * vcardvalue_get_x ( const vcardvalue * value)

◆ vcardvalue_new_boolean()

vcardvalue * vcardvalue_new_boolean ( int v)

◆ vcardvalue_new_date()

vcardvalue * vcardvalue_new_date ( vcardtimetype v)

◆ vcardvalue_new_dateandortime()

vcardvalue * vcardvalue_new_dateandortime ( vcardtimetype v)

◆ vcardvalue_new_datetime()

vcardvalue * vcardvalue_new_datetime ( vcardtimetype v)

◆ vcardvalue_new_float()

vcardvalue * vcardvalue_new_float ( float v)

◆ vcardvalue_new_geo()

vcardvalue * vcardvalue_new_geo ( vcardgeotype v)

◆ vcardvalue_new_gramgender()

vcardvalue * vcardvalue_new_gramgender ( enum vcardproperty_gramgender v)

◆ vcardvalue_new_integer()

vcardvalue * vcardvalue_new_integer ( int v)

◆ vcardvalue_new_kind()

vcardvalue * vcardvalue_new_kind ( enum vcardproperty_kindenum v)

◆ vcardvalue_new_languagetag()

vcardvalue * vcardvalue_new_languagetag ( const char * v)

◆ vcardvalue_new_structured()

vcardvalue * vcardvalue_new_structured ( vcardstructuredtype * v)

◆ vcardvalue_new_text()

vcardvalue * vcardvalue_new_text ( const char * v)

◆ vcardvalue_new_textlist()

vcardvalue * vcardvalue_new_textlist ( vcardstrarray * v)

◆ vcardvalue_new_time()

vcardvalue * vcardvalue_new_time ( vcardtimetype v)

◆ vcardvalue_new_timestamp()

vcardvalue * vcardvalue_new_timestamp ( vcardtimetype v)

◆ vcardvalue_new_tz()

vcardvalue * vcardvalue_new_tz ( vcardtztype v)

◆ vcardvalue_new_uri()

vcardvalue * vcardvalue_new_uri ( const char * v)

◆ vcardvalue_new_utcoffset()

vcardvalue * vcardvalue_new_utcoffset ( int v)

◆ vcardvalue_new_version()

vcardvalue * vcardvalue_new_version ( enum vcardproperty_version v)

◆ vcardvalue_new_x()

vcardvalue * vcardvalue_new_x ( const char * v)

◆ vcardvalue_set_boolean()

void vcardvalue_set_boolean ( vcardvalue * value,
int v )

◆ vcardvalue_set_date()

void vcardvalue_set_date ( vcardvalue * value,
vcardtimetype v )

◆ vcardvalue_set_dateandortime()

void vcardvalue_set_dateandortime ( vcardvalue * value,
vcardtimetype v )

◆ vcardvalue_set_datetime()

void vcardvalue_set_datetime ( vcardvalue * value,
vcardtimetype v )

◆ vcardvalue_set_float()

void vcardvalue_set_float ( vcardvalue * value,
float v )

◆ vcardvalue_set_geo()

void vcardvalue_set_geo ( vcardvalue * value,
vcardgeotype v )

◆ vcardvalue_set_gramgender()

void vcardvalue_set_gramgender ( vcardvalue * value,
enum vcardproperty_gramgender v )

◆ vcardvalue_set_integer()

void vcardvalue_set_integer ( vcardvalue * value,
int v )

◆ vcardvalue_set_kind()

void vcardvalue_set_kind ( vcardvalue * value,
enum vcardproperty_kindenum v )

◆ vcardvalue_set_languagetag()

void vcardvalue_set_languagetag ( vcardvalue * value,
const char * v )

◆ vcardvalue_set_structured()

void vcardvalue_set_structured ( vcardvalue * value,
vcardstructuredtype * v )

◆ vcardvalue_set_text()

void vcardvalue_set_text ( vcardvalue * value,
const char * v )

◆ vcardvalue_set_textlist()

void vcardvalue_set_textlist ( vcardvalue * value,
vcardstrarray * v )

◆ vcardvalue_set_time()

void vcardvalue_set_time ( vcardvalue * value,
vcardtimetype v )

◆ vcardvalue_set_timestamp()

void vcardvalue_set_timestamp ( vcardvalue * value,
vcardtimetype v )

◆ vcardvalue_set_tz()

void vcardvalue_set_tz ( vcardvalue * value,
vcardtztype v )

◆ vcardvalue_set_uri()

void vcardvalue_set_uri ( vcardvalue * value,
const char * v )

◆ vcardvalue_set_utcoffset()

void vcardvalue_set_utcoffset ( vcardvalue * value,
int v )

◆ vcardvalue_set_version()

void vcardvalue_set_version ( vcardvalue * value,
enum vcardproperty_version v )

◆ vcardvalue_set_x()

void vcardvalue_set_x ( vcardvalue * value,
const char * v )