Class

ICalGLibVcardParameter

Description [src]

final class ICalGLib.VcardParameter : ICalGLib.Object
{
  /* No available fields */
}

This is the ICalVcardParameter instance.

Hierarchy

hierarchy this ICalVcardParameter ancestor_0 ICalObject ancestor_0--this ancestor_1 GObject ancestor_1--ancestor_0

Ancestors

Constructors

i_cal_vcard_parameter_new

Creates a new ICalVcardParameter of the kind type.

since: 4.0

i_cal_vcard_parameter_new_altid

Creates a new ICalVcardParameter holding ALTID.

since: 4.0

i_cal_vcard_parameter_new_author

Creates a new ICalVcardParameter holding AUTHOR.

since: 4.0

i_cal_vcard_parameter_new_authorname

Creates a new ICalVcardParameter holding AUTHORNAME.

since: 4.0

i_cal_vcard_parameter_new_calscale

Creates a new ICalVcardParameter holding CALSCALE.

since: 4.0

i_cal_vcard_parameter_new_cc

Creates a new ICalVcardParameter holding CC.

since: 4.0

i_cal_vcard_parameter_new_context

Creates a new ICalVcardParameter holding CONTEXT.

since: 4.0

i_cal_vcard_parameter_new_created

Creates a new ICalVcardParameter holding CREATED.

since: 4.0

i_cal_vcard_parameter_new_derived

Creates a new ICalVcardParameter holding DERIVED.

since: 4.0

i_cal_vcard_parameter_new_encoding

Creates a new ICalVcardParameter holding ENCODING.

since: 4.0

i_cal_vcard_parameter_new_from_string

Creates an ICalVcardParameter from a string of form “PARAMNAME=VALUE”.

since: 4.0

i_cal_vcard_parameter_new_from_value_string

Creates a new ICalVcardParameter of kind and value.

since: 4.0

i_cal_vcard_parameter_new_full

Create a new libical-glib object from the native libical object and the owner.

since: 1.0

i_cal_vcard_parameter_new_geo

Creates a new ICalVcardParameter holding GEO.

since: 4.0

i_cal_vcard_parameter_new_iana

Creates a new ICalVcardParameter holding IANA.

since: 4.0

i_cal_vcard_parameter_new_index

Creates a new ICalVcardParameter holding INDEX.

since: 4.0

i_cal_vcard_parameter_new_jscomps

Creates a new ICalVcardParameter holding JSCOMPS.

since: 4.0

i_cal_vcard_parameter_new_jsptr

Creates a new ICalVcardParameter holding JSPTR.

since: 4.0

i_cal_vcard_parameter_new_label

Creates a new ICalVcardParameter holding LABEL.

since: 4.0

i_cal_vcard_parameter_new_language

Creates a new ICalVcardParameter holding LANGUAGE.

since: 4.0

i_cal_vcard_parameter_new_level

Creates a new ICalVcardParameter holding LEVEL.

since: 4.0

i_cal_vcard_parameter_new_mediatype

Creates a new ICalVcardParameter holding MEDIATYPE.

since: 4.0

i_cal_vcard_parameter_new_phonetic

Creates a new ICalVcardParameter holding PHONETIC.

since: 4.0

i_cal_vcard_parameter_new_pid

Creates a new ICalVcardParameter holding PID.

since: 4.0

i_cal_vcard_parameter_new_pid_list

Creates a new ICalVcardParameter holding PID.

since: 4.0

i_cal_vcard_parameter_new_pref

Creates a new ICalVcardParameter holding PREF.

since: 4.0

i_cal_vcard_parameter_new_propid

Creates a new ICalVcardParameter holding PROPID.

since: 4.0

i_cal_vcard_parameter_new_script

Creates a new ICalVcardParameter holding SCRIPT.

since: 4.0

i_cal_vcard_parameter_new_servicetype

Creates a new ICalVcardParameter holding SERVICETYPE.

since: 4.0

i_cal_vcard_parameter_new_sortas

Creates a new ICalVcardParameter holding SORTAS.

since: 4.0

i_cal_vcard_parameter_new_sortas_list

Creates a new ICalVcardParameter holding SORTAS.

since: 4.0

i_cal_vcard_parameter_new_type

Creates a new ICalVcardParameter holding TYPE.

since: 4.0

i_cal_vcard_parameter_new_tz

Creates a new ICalVcardParameter holding TZ.

since: 4.0

i_cal_vcard_parameter_new_username

Creates a new ICalVcardParameter holding USERNAME.

since: 4.0

i_cal_vcard_parameter_new_value

Creates a new ICalVcardParameter holding VALUE.

since: 4.0

i_cal_vcard_parameter_new_x

Creates a new ICalVcardParameter holding X.

since: 4.0

i_cal_vcard_parameter_new_xliccomparetype

Creates a new ICalVcardParameter holding XLICCOMPARETYPE.

since: 4.0

i_cal_vcard_parameter_new_xlicerrortype

Creates a new ICalVcardParameter holding XLICERRORTYPE.

since: 4.0

Functions

i_cal_vcard_parameter_enum_from_string

Converts a string representation of a parameter enum to a its numeric value.

since: 4.0

i_cal_vcard_parameter_enum_to_string

Converts an integer representation of a parameter enum to a string.

since: 4.0

i_cal_vcard_parameter_kind_is_valid

Checks whether ICalVcardParameterKind is valid.

since: 4.0

i_cal_vcard_parameter_kind_to_string

Converts the kind to the string representation.

since: 4.0

i_cal_vcard_parameter_kind_value_kind

Returns corresponding ICalVcardValueKind for the given kind and sets whether the kind is a multivalued parameter.

since: 4.0

i_cal_vcard_parameter_string_to_kind

Converts a string to the ICalVcardParameterKind.

since: 4.0

i_cal_vcard_parameter_value_to_value_kind

Converts the ICalVcardParameterValue to ICalVcardValueKind.

since: 4.0

Instance methods

i_cal_vcard_parameter_add_pid

Adds a string into the self of PID.

since: 4.0

i_cal_vcard_parameter_add_sortas

Adds a string into the self of SORTAS.

since: 4.0

i_cal_vcard_parameter_add_type

Adds an element.

since: 4.0

i_cal_vcard_parameter_add_value_from_string

Adds a param value from string value. This can be used for parameters which can hold multiple values.

since: 4.0

i_cal_vcard_parameter_as_vcard_string

Converts an ICalVcardParameter to the string representation.

since: 4.0

i_cal_vcard_parameter_clone

Deep clones the param.

since: 4.0

i_cal_vcard_parameter_free

Frees the native part of the ICalVcardParameter.

since: 4.0

i_cal_vcard_parameter_get_altid

Returns value of the ALTID self.

since: 4.0

i_cal_vcard_parameter_get_author

Returns value of the AUTHOR self.

since: 4.0

i_cal_vcard_parameter_get_authorname

Returns value of the AUTHORNAME self.

since: 4.0

i_cal_vcard_parameter_get_calscale

Returns value of the CALSCALE self.

since: 4.0

i_cal_vcard_parameter_get_cc

Returns value of the CC self.

since: 4.0

i_cal_vcard_parameter_get_context

Returns value of the CONTEXT self.

since: 4.0

i_cal_vcard_parameter_get_created

Returns value of the CREATED self.

since: 4.0

i_cal_vcard_parameter_get_derived

Returns value of the DERIVED self.

since: 4.0

i_cal_vcard_parameter_get_encoding

Returns value of the ENCODING self.

since: 4.0

i_cal_vcard_parameter_get_geo

Returns value of the GEO self.

since: 4.0

i_cal_vcard_parameter_get_iana

Returns value of the IANA self.

since: 4.0

i_cal_vcard_parameter_get_iana_name

Gets the iana_name property of the native part of the ICalVcardParameter.

since: 4.0

i_cal_vcard_parameter_get_iana_value

Gets the iana_value property of the native part of the ICalVcardParameter.

since: 4.0

i_cal_vcard_parameter_get_index

Returns value of the INDEX self.

since: 4.0

i_cal_vcard_parameter_get_jscomps

Returns value of the JSCOMPS self.

since: 4.0

i_cal_vcard_parameter_get_jsptr

Returns value of the JSPTR self.

since: 4.0

i_cal_vcard_parameter_get_label

Returns value of the LABEL self.

since: 4.0

i_cal_vcard_parameter_get_language

Returns value of the LANGUAGE self.

since: 4.0

i_cal_vcard_parameter_get_level

Returns value of the LEVEL self.

since: 4.0

i_cal_vcard_parameter_get_mediatype

Returns value of the MEDIATYPE self.

since: 4.0

i_cal_vcard_parameter_get_parent

Gets the parent ICalVcardProperty of the specified ICalVcardParameter.

since: 4.0

i_cal_vcard_parameter_get_phonetic

Returns value of the PHONETIC self.

since: 4.0

i_cal_vcard_parameter_get_pid

Gets the value of the self of PID.

since: 4.0

i_cal_vcard_parameter_get_pid_nth

Returns the n-th element of the self of PID.

since: 4.0

i_cal_vcard_parameter_get_pid_size

Returns number of elements in the self of PID.

since: 4.0

i_cal_vcard_parameter_get_pref

Returns value of the PREF self.

since: 4.0

i_cal_vcard_parameter_get_propid

Returns value of the PROPID self.

since: 4.0

i_cal_vcard_parameter_get_script

Returns value of the SCRIPT self.

since: 4.0

i_cal_vcard_parameter_get_servicetype

Returns value of the SERVICETYPE self.

since: 4.0

i_cal_vcard_parameter_get_sortas

Gets the value of the self of SORTAS.

since: 4.0

i_cal_vcard_parameter_get_sortas_nth

Returns the n-th element of the self of SORTAS.

since: 4.0

i_cal_vcard_parameter_get_sortas_size

Returns number of elements in the self of SORTAS.

since: 4.0

i_cal_vcard_parameter_get_type_nth

Returns the n-th element of the self of TYPE.

since: 4.0

i_cal_vcard_parameter_get_type_size

Returns number of elements in the self of TYPE.

since: 4.0

i_cal_vcard_parameter_get_type_value

Gets the value of the self of TYPE.

since: 4.0

i_cal_vcard_parameter_get_tz

Returns value of the TZ self.

since: 4.0

i_cal_vcard_parameter_get_username

Returns value of the USERNAME self.

since: 4.0

i_cal_vcard_parameter_get_value

Returns value of the VALUE self.

since: 4.0

i_cal_vcard_parameter_get_x

Returns value of the X self.

since: 4.0

i_cal_vcard_parameter_get_xliccomparetype

Returns value of the XLICCOMPARETYPE self.

since: 4.0

i_cal_vcard_parameter_get_xlicerrortype

Returns value of the XLICERRORTYPE self.

since: 4.0

i_cal_vcard_parameter_get_xname

Gets the xname property of the native part of the ICalVcardParameter.

since: 4.0

i_cal_vcard_parameter_get_xvalue

Gets the xvalue property of the native part of the ICalVcardParameter.

since: 4.0

i_cal_vcard_parameter_has_same_name

Checks whether native parts of two ICalVcardParameters have the same name.

since: 4.0

i_cal_vcard_parameter_is_multivalued

Returns whether param is a multivalued parameter. Multivalued parameters can hold more than one value.

since: 4.0

i_cal_vcard_parameter_is_structured

Returns whether param is a structured parameter. Structured parameters have their value encoded in a specific format.

since: 4.0

i_cal_vcard_parameter_isa

Returns the kind of an ICalVcardParameter.

since: 4.0

i_cal_vcard_parameter_isa_parameter

Checks whether the native part of the ICalVcardParameter is of type ICalVcardParameter.

since: 4.0

i_cal_vcard_parameter_remove_pid

Removes a string from the self of PID.

since: 4.0

i_cal_vcard_parameter_remove_sortas

Removes a string from the self of SORTAS.

since: 4.0

i_cal_vcard_parameter_remove_type

Removes an element with the provided value.

since: 4.0

i_cal_vcard_parameter_set_altid

Sets value to the ALTID self.

since: 4.0

i_cal_vcard_parameter_set_author

Sets value to the AUTHOR self.

since: 4.0

i_cal_vcard_parameter_set_authorname

Sets value to the AUTHORNAME self.

since: 4.0

i_cal_vcard_parameter_set_calscale

Sets value to the CALSCALE self.

since: 4.0

i_cal_vcard_parameter_set_cc

Sets value to the CC self.

since: 4.0

i_cal_vcard_parameter_set_context

Sets value to the CONTEXT self.

since: 4.0

i_cal_vcard_parameter_set_created

Sets value to the CREATED self.

since: 4.0

i_cal_vcard_parameter_set_derived

Sets value to the DERIVED self.

since: 4.0

i_cal_vcard_parameter_set_encoding

Sets value to the ENCODING self.

since: 4.0

i_cal_vcard_parameter_set_geo

Sets value to the GEO self.

since: 4.0

i_cal_vcard_parameter_set_iana

Sets value to the IANA self.

since: 4.0

i_cal_vcard_parameter_set_iana_name

Sets the iana_name property of the native part of the ICalVcardParameter.

since: 4.0

i_cal_vcard_parameter_set_iana_value

Sets the iana_value property of the native part of the ICalVcardParameter.

since: 4.0

i_cal_vcard_parameter_set_index

Sets value to the INDEX self.

since: 4.0

i_cal_vcard_parameter_set_jscomps

Sets value to the JSCOMPS self.

since: 4.0

i_cal_vcard_parameter_set_jsptr

Sets value to the JSPTR self.

since: 4.0

i_cal_vcard_parameter_set_label

Sets value to the LABEL self.

since: 4.0

i_cal_vcard_parameter_set_language

Sets value to the LANGUAGE self.

since: 4.0

i_cal_vcard_parameter_set_level

Sets value to the LEVEL self.

since: 4.0

i_cal_vcard_parameter_set_mediatype

Sets value to the MEDIATYPE self.

since: 4.0

i_cal_vcard_parameter_set_parent

Sets the parent ICalVcardProperty of an ICalVcardParameter.

since: 4.0

i_cal_vcard_parameter_set_phonetic

Sets value to the PHONETIC self.

since: 4.0

i_cal_vcard_parameter_set_pid

Sets the value of the self of PID.

since: 4.0

i_cal_vcard_parameter_set_pref

Sets value to the PREF self.

since: 4.0

i_cal_vcard_parameter_set_propid

Sets value to the PROPID self.

since: 4.0

i_cal_vcard_parameter_set_script

Sets value to the SCRIPT self.

since: 4.0

i_cal_vcard_parameter_set_servicetype

Sets value to the SERVICETYPE self.

since: 4.0

i_cal_vcard_parameter_set_sortas

Sets the value of the self of SORTAS.

since: 4.0

i_cal_vcard_parameter_set_type_value

Sets the value of the self of TYPE.

since: 4.0

i_cal_vcard_parameter_set_tz

Sets value to the TZ self.

since: 4.0

i_cal_vcard_parameter_set_username

Sets value to the USERNAME self.

since: 4.0

i_cal_vcard_parameter_set_value

Sets value to the VALUE self.

since: 4.0

i_cal_vcard_parameter_set_value_from_string

Sets a param value from string value.

since: 4.0

i_cal_vcard_parameter_set_x

Sets value to the X self.

since: 4.0

i_cal_vcard_parameter_set_xliccomparetype

Sets value to the XLICCOMPARETYPE self.

since: 4.0

i_cal_vcard_parameter_set_xlicerrortype

Sets value to the XLICERRORTYPE self.

since: 4.0

i_cal_vcard_parameter_set_xname

Sets the xname property of the native part of the ICalVcardParameter.

since: 4.0

i_cal_vcard_parameter_set_xvalue

Sets the xvalue property of the native part of the ICalVcardParameter.

since: 4.0

Methods inherited from ICalObject (12)
i_cal_object_add_depender

Adds a depender into the list of objects which should not be destroyed before this iobject. It’s usually used for cases where the iobject uses native libical structure from the depender. The depender is referenced. It’s illegal to try to add one depender multiple times.

since: 1.0

i_cal_object_get_always_destroy

Obtain the ICalObject::always-destroy property value.

since: 3.0.11

i_cal_object_get_is_global_memory

Obtains whether the native libical structure is a global shared memory, thus should not be destroyed. This can be set only during construction time.

since: 1.0

i_cal_object_get_native

Obtain native libical structure pointer associated with this iobject.

since: 1.0

i_cal_object_get_native_destroy_func

Obtain a pointer to a function responsible to free the libical native structure.

since: 1.0

i_cal_object_ref_owner

Obtain current owner of the native libical structure. The returned pointer, if not NULL, is referenced for thread safety. Unref it with g_object_unref when done with it.

since: 1.0

i_cal_object_remove_depender

Removes a depender from the list of objects which should not be destroyed before this iobject, previously added with i_cal_object_add_depender(). It’s illegal to try to remove the depender which is not in the internal list.

since: 1.0

i_cal_object_remove_owner

Unref and remove the owner.

since: 1.0

i_cal_object_set_always_destroy

Sets the ICalObject::always-destroy property value. When TRUE, the native libical structure is always freed, even when an owner of the iobject is set.

since: 3.0.11

i_cal_object_set_native_destroy_func

Sets a function to be used to destroy the native libical structure.

since: 1.0

i_cal_object_set_owner

Sets an owner of the native libical structure, that is an object responsible for a destroy of the native libical structure.

since: 1.0

i_cal_object_steal_native

Obtain native libical structure pointer associated with this iobject and sets the one at iobject to NULL, thus it’s invalid since now on.

since: 1.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Properties inherited from ICalObject (5)
ICalGLib.Object:always-destroy

Whether free the native libical structure on ICalObjects finalize even if the object has set an owner.

since: 3.0.11

ICalGLib.Object:is-global-memory

Whether the native libical structure is from a global shared memory. If TRUE, then it is not freed on ICalObjects finalize.

ICalGLib.Object:native

The native libical structure for this ICalObject.

ICalGLib.Object:native-destroy-func

GDestroyNotify function to use to destroy the native libical pointer.

ICalGLib.Object:owner

Owner of the native libical structure. If set, then it is responsible for a free of the native libical structure.

Signals

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct ICalGLibVcardParameterClass {
  /* no available fields */
}

This is the ICalVcardParameter class.