ICalValue

ICalValue

Functions

Types and Values

Object Hierarchy

    GObject
    ╰── ICalObject
        ╰── ICalValue

Description

Functions

i_cal_value_new ()

ICalValue *
i_cal_value_new (ICalValueKind kind);

Creates a new ICalValue with specific kind.

Parameters

kind

A ICalValueKind

 

Returns

The newly created ICalValue.

[transfer full]

Since: 1.0


i_cal_value_clone ()

ICalValue *
i_cal_value_clone (const ICalValue *value);

Deeply clone a ICalValue.

Parameters

value

The ICalValue to be cloned

 

Returns

The newly created ICalValue with the same property as value .

[transfer full]

Since: 1.0


i_cal_value_new_from_string ()

ICalValue *
i_cal_value_new_from_string (ICalValueKind kind,
                             const gchar *str);

Creates a new ICalValue based on the ICalValueKind and a string.

Parameters

kind

A ICalValueKind

 

str

A string

 

Returns

The newly created ICalValue based on the kind and str .

[transfer full]

Since: 1.0


i_cal_value_free ()

void
i_cal_value_free (ICalValue *value);

Frees a ICalValue.

[skip]

Parameters

value

The ICalValue to be freed

 

Since: 1.0


i_cal_value_is_valid ()

gboolean
i_cal_value_is_valid (const ICalValue *value);

Checks if ICalValue is valid.

Parameters

value

The ICalValue to be checked

 

Returns

1 if valid, 0 if not.

Since: 1.0


i_cal_value_as_ical_string ()

gchar *
i_cal_value_as_ical_string (const ICalValue *value);

Converts the ICalValue to a string.

Parameters

value

A ICalValue

 

Returns

The string representation.

[transfer full]

Since: 1.0


i_cal_value_isa ()

ICalValueKind
i_cal_value_isa (const ICalValue *value);

Gets the kind of ICalValue.

Parameters

value

A ICalValue

 

Returns

The kind of value .

Since: 1.0


i_cal_value_isa_value ()

gint
i_cal_value_isa_value (ICalValue *value);

Checks whether the native part of ICalValue is an icalvalue.

Parameters

value

A ICalValue

 

Returns

1 if yes, 0 if not.

Since: 1.0


i_cal_value_compare ()

ICalParameterXliccomparetype
i_cal_value_compare (const ICalValue *a,
                     const ICalValue *b);

Compares two ICalValue.

Parameters

a

A ICalValue

 

b

A ICalValue

 

Returns

The compare result.

Since: 1.0


i_cal_value_kind_from_string ()

ICalValueKind
i_cal_value_kind_from_string (const gchar *str);

Converts a string to ICalValueKind.

Parameters

str

A string

 

Returns

A ICalValueKind.

Since: 1.0


i_cal_value_kind_to_string ()

const gchar *
i_cal_value_kind_to_string (const ICalValueKind kind);

Converts the ICalValueKind to a string.

Parameters

kind

A ICalValueKind

 

Returns

The string representation of ICalValueKind.

Since: 1.0


i_cal_value_kind_is_valid ()

gboolean
i_cal_value_kind_is_valid (const ICalValueKind kind);

Checks whether the ICalValueKind is valid.

Parameters

kind

The ICalValueKind to be checked

 

Returns

1 if yes, 0 if not.

Since: 1.0


i_cal_value_encode_ical_string ()

gchar *
i_cal_value_encode_ical_string (const gchar *szText);

Encodes a character string in ical format, escape certain characters, etc.

Parameters

szText

A string

 

Returns

The encoded string. NULL if fail.

[nullable][transfer full]

Since: 1.0


i_cal_value_decode_ical_string ()

gchar *
i_cal_value_decode_ical_string (const gchar *szText);

Extracts the original character string encoded by the above function.

Parameters

szText

A string

 

Returns

The decoded string. NULL if fail.

[nullable][transfer full]

Since: 1.0

Types and Values

ICalValue

typedef struct _ICalValue ICalValue;

This is the ICalValue instance.


struct ICalValueClass

struct ICalValueClass {
};

This is the ICalValue class.