Namespace

ICalGLib – 4.0

iCalendar protocols and protocol data units implementation

Version3
Authorslibical Development Team
LicenseLGPL-2.1-only OR MPL-2.0
Websitehttps://libical.github.io/libical/
Sourcehttps://github.com/libical/libical

Build

C headerslibical-glib/libical-glib.h
pkg-config fileslibical-glib

Dependencies

GObject—2.0 The base type system library
Browse documentation

Additional documentation

Classes

Array

This is the ICalArray instance.

unstable since: 4.0

Attach

This is the ICalAttach instance.

unstable since: 4.0

CompIter

This is the ICalCompIter instance.

unstable since: 4.0

Component

This is the ICalComponent instance.

unstable since: 4.0

Datetimeperiod

This is the ICalDatetimeperiod instance.

unstable since: 4.0

Duration

This is the ICalDuration instance.

unstable since: 4.0

EnumArray

This is the ICalEnumArray instance.

unstable since: 4.0

Geo

This is the ICalGeo instance.

unstable since: 4.0

Object

This is an ICalObject instance struct.

unstable since: 4.0

Parameter

This is the ICalParameter instance.

unstable since: 4.0

ParamIter

This is the ICalParamIter instance.

unstable since: 4.0

Parser

This is the ICalParser instance.

unstable since: 4.0

Period

This is the ICalPeriod instance.

unstable since: 4.0

Property

This is the ICalProperty instance.

unstable since: 4.0

PropIter

This is the ICalPropIter instance.

unstable since: 4.0

RecurIterator

This is the ICalRecurIterator instance.

unstable since: 4.0

Recurrence

This is the ICalRecurrence instance.

unstable since: 4.0

Reqstat

This is the ICalReqstat instance.

unstable since: 4.0

StrArray

This is the ICalStrArray instance.

unstable since: 4.0

Time

This is the ICalTime instance.

unstable since: 4.0

TimeSpan

This is the ICalTimeSpan instance.

unstable since: 4.0

Timezone

This is the ICalTimezone instance.

unstable since: 4.0

Trigger

This is the ICalTrigger instance.

unstable since: 4.0

Value

This is the ICalValue instance.

unstable since: 4.0

VcardComponent

This is the ICalVcardComponent instance.

unstable since: 4.0

VcardEnumArray

This is the ICalVcardEnumArray instance.

unstable since: 4.0

VcardGeo

This is the ICalVcardGeo instance.

unstable since: 4.0

VcardParameter

This is the ICalVcardParameter instance.

unstable since: 4.0

VcardProperty

This is the ICalVcardProperty instance.

unstable since: 4.0

VcardStrArray

This is the ICalVcardStrArray instance.

unstable since: 4.0

VcardStructured

This is the ICalVcardStructured instance.

unstable since: 4.0

VcardTime

This is the ICalVcardTime instance.

unstable since: 4.0

VcardTz

This is the ICalVcardTz instance.

unstable since: 4.0

VcardValue

This is the ICalVcardValue instance.

unstable since: 4.0

Structs

_Array

unstable since: 4.0

_Attach

unstable since: 4.0

_CompIter

unstable since: 4.0

_Component

unstable since: 4.0

_Datetimeperiod

unstable since: 4.0

_Duration

unstable since: 4.0

_EnumArray

unstable since: 4.0

_Geo

unstable since: 4.0

_Parameter

unstable since: 4.0

_ParamIter

unstable since: 4.0

_Parser

unstable since: 4.0

_Period

unstable since: 4.0

_Property

unstable since: 4.0

_PropIter

unstable since: 4.0

_RecurIterator

unstable since: 4.0

_Recurrence

unstable since: 4.0

_Reqstat

unstable since: 4.0

_StrArray

unstable since: 4.0

_Time

unstable since: 4.0

_TimeSpan

unstable since: 4.0

_Timezone

unstable since: 4.0

_Trigger

unstable since: 4.0

_Value

unstable since: 4.0

_VcardComponent

unstable since: 4.0

_VcardEnumArray

unstable since: 4.0

_VcardGeo

unstable since: 4.0

_VcardParameter

unstable since: 4.0

_VcardProperty

unstable since: 4.0

_VcardStrArray

unstable since: 4.0

_VcardStructured

unstable since: 4.0

_VcardTime

unstable since: 4.0

_VcardTz

unstable since: 4.0

_VcardValue

unstable since: 4.0

Enumerations

ComponentKind

unstable since: 4.0

ErrorEnum

unstable since: 4.0

ErrorState

unstable since: 4.0

InvalidRruleHandling

unstable since: 4.0

LimitsKind

The types of limits.

unstable since: 4.0

ParameterAction

unstable since: 4.0

ParameterCutype

unstable since: 4.0

ParameterDerived

unstable since: 4.0

ParameterDisplay

unstable since: 4.0

ParameterEnable

unstable since: 4.0

ParameterEncoding

unstable since: 4.0

ParameterFbtype

unstable since: 4.0

ParameterFeature

unstable since: 4.0

ParameterKind

unstable since: 4.0

ParameterLocal

unstable since: 4.0

ParameterPartstat

unstable since: 4.0

ParameterPatchaction

unstable since: 4.0

ParameterRange

unstable since: 4.0

ParameterRelated

unstable since: 4.0

ParameterReltype

unstable since: 4.0

ParameterRequired

unstable since: 4.0

ParameterRole

unstable since: 4.0

ParameterRsvp

unstable since: 4.0

ParameterScheduleagent

unstable since: 4.0

ParameterScheduleforcesend

unstable since: 4.0

ParameterStayinformed

unstable since: 4.0

ParameterSubstate

unstable since: 4.0

ParameterValue

unstable since: 4.0

ParameterXliccomparetype

unstable since: 4.0

ParameterXlicerrortype

unstable since: 4.0

ParserCtrl

unstable since: 4.0

ParserState

unstable since: 4.0

PropertyAction

unstable since: 4.0

PropertyBusytype

unstable since: 4.0

PropertyCarlevel

unstable since: 4.0

PropertyClassenum

unstable since: 4.0

PropertyCmd

unstable since: 4.0

PropertyKind

unstable since: 4.0

PropertyMethod

unstable since: 4.0

PropertyParticipanttype

unstable since: 4.0

PropertyPollcompletion

unstable since: 4.0

PropertyPollmode

unstable since: 4.0

PropertyProximity

unstable since: 4.0

PropertyQuerylevel

unstable since: 4.0

PropertyResourcetype

unstable since: 4.0

PropertyStatus

unstable since: 4.0

PropertyTaskmode

unstable since: 4.0

PropertyTransp

unstable since: 4.0

PropertyXlicclass

unstable since: 4.0

RecurrenceArraySizes

unstable since: 4.0

RecurrenceByRule

unstable since: 4.0

RecurrenceFrequency

unstable since: 4.0

RecurrenceSkip

unstable since: 4.0

RecurrenceWeekday

unstable since: 4.0

RequestStatus

unstable since: 4.0

RestrictionKind

unstable since: 4.0

Unknowntokenhandling

unstable since: 4.0

ValueKind

unstable since: 4.0

VcardAdrField

unstable since: 4.0

VcardClientpidmapField

unstable since: 4.0

VcardComponentKind

unstable since: 4.0

VcardGenderField

unstable since: 4.0

VcardNField

unstable since: 4.0

VcardParameterCalscale

unstable since: 4.0

VcardParameterDerived

unstable since: 4.0

VcardParameterEncoding

unstable since: 4.0

VcardParameterKind

unstable since: 4.0

VcardParameterLevel

unstable since: 4.0

VcardParameterPhonetic

unstable since: 4.0

VcardParameterType

unstable since: 4.0

VcardParameterValue

unstable since: 4.0

VcardParameterXliccomparetype

unstable since: 4.0

VcardParameterXlicerrortype

unstable since: 4.0

VcardPropertyGramgender

unstable since: 4.0

VcardPropertyKind

unstable since: 4.0

VcardPropertyKindenum

unstable since: 4.0

VcardPropertyVersion

unstable since: 4.0

VcardRestrictionKind

unstable since: 4.0

VcardTimeConvertFlags

unstable since: 4.0

VcardValueKind

unstable since: 4.0

Callbacks

ComponentForeachRecurrenceFunc

unstable since: 4.0

ComponentForeachTZIDFunc

unstable since: 4.0

ParserLineGenFunc

unstable since: 4.0

VcardXpropValueKindFunc

unstable since: 4.0

Functions

enumarray_clone

Creates a deep copy of ICalEnumArray with the same properties as the array.

unstable since: 4.0

enumarray_free

Frees the ICalEnumArray.

unstable since: 4.0

enumarray_remove_element_at

Removes the element at the position from the array.

unstable since: 4.0

error_clear_errno

since: 1.0

error_crash_here

Shout out the errors to the compiler.

since: 1.0

error_error_from_string

Reads an error from a string.

unstable since: 4.0

error_get_error_state

Gets the state of an error.

since: 1.0

error_get_errors_are_fatal

Determine whether errors are fatal.

unstable since: 4.0

error_icalerrno

Returns the error stored in the library. If no error, return I_CAL_NO_ERROR.

since: 1.0

error_perror

Gets the ICalErrorEnum in the string representation. This method called the icalerrorno_return to get the current error.

since: 1.0

error_restore

Restores the error to specified state.

since: 1.0

error_set_errno

Sets the errno.

since: 1.0

error_set_error_state

Sets the state to the corresponding error in the library.

since: 1.0

error_set_errors_are_fatal

Sets whether errors are fatal, that is, whether libical aborts after any processing reports an error.

unstable since: 4.0

error_stop_here

since: 1.0

error_strerror

Translates the ICalErrorEnum to the string representation.

since: 1.0

error_supress

Suppresses the error.

since: 1.0

get_unknown_token_handling_setting

Gets the setting of ICalUnknowntokenhandling.

since: 1.0

i_calerror_backtrace

since: 1.0

limit_get

Gets the value for the corresponding internal library limit.

unstable since: 4.0

limit_set

Sets the value for the corresponding internal library limit.

unstable since: 4.0

memory_add_tmp_buffer

Adds an existing buffer to the buffer ring.

since: 1.0

memory_append_char

Append the character to the buffer. Only use them on normally allocated memory, or on buffers created from icalmemory_new_buffer, never with buffers created by icalmemory_tmp_buffer. If icalmemory_append_string has to resize a buffer on the ring, the ring will loose track of it and you will have memory problems.

since: 1.0

memory_append_decoded_string

Decodes the string as TEXT value and then appends it to the buffer. Only use them on normally allocated memory, or on buffers created from icalmemory_new_buffer, never with buffers created by icalmemory_tmp_buffer. If icalmemory_append_decoded_string has to resize a buffer on the ring, the ring will loose track of it and you will have memory problems.

unstable since: 4.0

memory_append_encoded_string

Encodes the string as TEXT value and then appends it to the buffer. Only use them on normally allocated memory, or on buffers created from icalmemory_new_buffer, never with buffers created by icalmemory_tmp_buffer. If icalmemory_append_encoded_string has to resize a buffer on the ring, the ring will loose track of it and you will have memory problems.

unstable since: 4.0

memory_append_string

Appends the string to the buffer. Only use them on normally allocated memory, or on buffers created from icalmemory_new_buffer, never with buffers created by icalmemory_tmp_buffer. If icalmemory_append_string has to resize a buffer on the ring, the ring will loose track of it and you will have memory problems.

since: 1.0

memory_free_buffer

Frees the buffer.

since: 1.0

memory_free_ring

Frees all the memory used in the ring.

since: 1.0

memory_new_buffer

Creates a new buffer with target size. The caller should deallocate it when necessary.

since: 1.0

memory_resize_buffer

Resizes the buffer to the target size.

since: 1.0

memory_str_to_glib

Transform a string allocated with icalmemory into one that can be freed with g_free.

since: 1.0

memory_strdup

A wrapper around strdup. Partly to trap calls to strdup, partly because in -ansi, gcc on Red Hat claims that strdup is undeclared.

since: 1.0

memory_tmp_buffer

Creates a buffer with target size.

since: 1.0

memory_tmp_copy

Like strdup, but the buffer is on the ring.

since: 1.0

priv_i_cal_vcard_null_geo

Returns null/empty vcardgeotype structure.

since: 1.0

priv_i_cal_vcard_null_tz

Returns null/empty vcardtztype structure.

since: 1.0

recur_expand_recurrence

Fills an array with the ‘count’ number of occurrences generated by the rrule. Note that the times are returned in UTC, but the times are calculated in local time. YOu will have to convert the results back into local time before using them.

since: 1.0

recur_get_invalid_rrule_handling_setting

Returns the current behaviour what to do when an RRULE is invalid.

unstable since: 4.0

recur_set_invalid_rrule_handling_setting

Sets what to do when an invalid RRULE is recognized.

unstable since: 4.0

request_status_code

Returns the code for a request status.

since: 1.0

request_status_desc

Returns the descriptive text for a request status.

since: 1.0

request_status_from_num

Returns a request status for major/minor status numbers.

since: 1.0

request_status_major

Returns the major number for a request status.

since: 1.0

request_status_minor

Returns the minor number for a request status.

since: 1.0

restriction_check

Checks whether the ICalComponent is valid.

since: 1.0

restriction_compare

Compares the kind of restriction and the count to determine whether it is valid.

since: 1.0

set_unknown_token_handling_setting

Sets ICalUnknowntokenhandling.

since: 1.0

vcard_parser_errstr

Converts an error code into its text representation.

unstable since: 4.0

vcard_parser_parse_string

Parses the vCard string str and returns an ICalVcardComponent, or NULL when the parse failed.

unstable since: 4.0

vcard_parser_set_xprop_value_kind

Registers a parser callback to override the default value type of an x-property.

unstable since: 4.0

vcard_restriction_check

Checks whether the comp is valid.

since: 1.0

vcard_restriction_compare

Checks if the given count is in accordance with the given restriction, restr.

since: 1.0

Function Macros

GLIB_DECLARE_DERIVABLE_TYPE

unstable since: 4.0