ICalParameter

ICalParameter

Synopsis

#define             I_CAL_PARAMETER_TYPE
                    ICalParameter;
struct              ICalParameterClass;
ICalParameter *     i_cal_parameter_new_full            (icalparameter *native,
                                                         GObject *owner);
ICalParameter *     i_cal_parameter_new                 (ICalParameterKind v);
ICalParameter *     i_cal_parameter_new_clone           (ICalParameter *p);
ICalParameter *     i_cal_parameter_new_from_string     (const gchar *value);
ICalParameter *     i_cal_parameter_new_from_value_string
                                                        (ICalParameterKind kind,
                                                         const gchar *value);
void                i_cal_parameter_free                (ICalParameter *parameter);
gchar *             i_cal_parameter_as_ical_string_r    (ICalParameter *parameter);
ICalParameterKind   i_cal_parameter_isa                 (ICalParameter *parameter);
gint                i_cal_parameter_isa_parameter       (ICalParameter *param);
void                i_cal_parameter_set_xname           (ICalParameter *param,
                                                         const gchar *v);
const gchar *       i_cal_parameter_get_xname           (ICalParameter *param);
void                i_cal_parameter_set_xvalue          (ICalParameter *param,
                                                         const gchar *v);
const gchar *       i_cal_parameter_get_xvalue          (ICalParameter *param);
void                i_cal_parameter_set_iana_name       (ICalParameter *param,
                                                         const gchar *v);
const gchar *       i_cal_parameter_get_iana_name       (ICalParameter *param);
void                i_cal_parameter_set_iana_value      (ICalParameter *param,
                                                         const gchar *v);
const gchar *       i_cal_parameter_get_iana_value      (ICalParameter *param);
gint                i_cal_parameter_has_same_name       (ICalParameter *param1,
                                                         ICalParameter *param2);
const gchar *       i_cal_parameter_kind_to_string      (ICalParameterKind kind);
ICalParameterKind   i_cal_parameter_string_to_kind      (const gchar *string);

Object Hierarchy

  GObject
   +----ICalObject
         +----ICalParameter

Description

Details

I_CAL_PARAMETER_TYPE

#define             I_CAL_PARAMETER_TYPE

ICalParameter

typedef struct _ICalParameter ICalParameter;

This is the ICalParameter instance.


struct ICalParameterClass

struct ICalParameterClass {
};

This is the ICalParameter class.


i_cal_parameter_new_full ()

ICalParameter *     i_cal_parameter_new_full            (icalparameter *native,
                                                         GObject *owner);

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

native :

The native libical object.

owner :

The parent.

Returns :

The newly create libical-glib object. [transfer full]

Since 1.0


i_cal_parameter_new ()

ICalParameter *     i_cal_parameter_new                 (ICalParameterKind v);

Create a new ICalParameter according to the kind type

v :

The type of ICalParameter to be created

Returns :

The newly created ICalParameter. [transfer full]

Since 1.0


i_cal_parameter_new_clone ()

ICalParameter *     i_cal_parameter_new_clone           (ICalParameter *p);

Deep clone a ICalParameter

p :

The ICalParameter to be cloned. [in]

Returns :

The newly created ICalParameter with the same properties as the p. [transfer full]

Since 1.0


i_cal_parameter_new_from_string ()

ICalParameter *     i_cal_parameter_new_from_string     (const gchar *value);

Create a ICalParameter from a string of form "PARAMNAME=VALUE".

value :

The string from which the ICalParameter is created. [in][transfer none]

Returns :

The newly created $ICalParameter with the properties specified in the value. [transfer full]

Since 1.0


i_cal_parameter_new_from_value_string ()

ICalParameter *     i_cal_parameter_new_from_value_string
                                                        (ICalParameterKind kind,
                                                         const gchar *value);

Create a new ICalParameter from just the value, the part after the "="

kind :

The kind of ICalParameter to be created.

value :

The string from which ICalParameter to be created.

Returns :

The newly created ICalParameter. [transfer full]

Since 1.0


i_cal_parameter_free ()

void                i_cal_parameter_free                (ICalParameter *parameter);

Free the native part of the ICalParameter.

parameter :

The ICalParameter to be freeed. [in]

Since 1.0


i_cal_parameter_as_ical_string_r ()

gchar *             i_cal_parameter_as_ical_string_r    (ICalParameter *parameter);

Convert an ICalParameter to the string representation.

parameter :

The ICalParameter to be converted. [in]

Returns :

The string representation of the parameter. [transfer full]

Since 1.0


i_cal_parameter_isa ()

ICalParameterKind   i_cal_parameter_isa                 (ICalParameter *parameter);

Check the type of a ICalParameter.

parameter :

The ICalParameter to be determined for the type.

Returns :

The type of the parameter.

Since 1.0


i_cal_parameter_isa_parameter ()

gint                i_cal_parameter_isa_parameter       (ICalParameter *param);

Check whether the native part of the ICalParameter is of type icalparameter.

param :

The ICalParameter to be checked. [in]

Returns :

1 if the native part is of type icalparameter, 0 if not.

Since 1.0


i_cal_parameter_set_xname ()

void                i_cal_parameter_set_xname           (ICalParameter *param,
                                                         const gchar *v);

Set the xname property of the native part of the ICalParameter.

param :

The ICalParameter of which the xname to be set. [in-out]

v :

The name to be set into the param.

Since 1.0


i_cal_parameter_get_xname ()

const gchar *       i_cal_parameter_get_xname           (ICalParameter *param);

Get the xname property of the native part of the ICalParameter.

param :

The ICalParameter to be queried

Returns :

the property of the value. [allow-none]

Since 1.0


i_cal_parameter_set_xvalue ()

void                i_cal_parameter_set_xvalue          (ICalParameter *param,
                                                         const gchar *v);

Set the xvalue property of the native part of the ICalParameter.

param :

The ICalParameter of which the xvalue to be set. [in-out]

v :

The value to be set into the param.

Since 1.0


i_cal_parameter_get_xvalue ()

const gchar *       i_cal_parameter_get_xvalue          (ICalParameter *param);

Get the xvalue property of the native part of the ICalParameter.

param :

The ICalParameter to be queried

Returns :

the property of the value. [allow-none]

Since 1.0


i_cal_parameter_set_iana_name ()

void                i_cal_parameter_set_iana_name       (ICalParameter *param,
                                                         const gchar *v);

Set the iana_name property of the native part of the ICalParameter.

param :

The ICalParameter of which the iana_name to be set. [in-out]

v :

The name to be set into the param.

Since 1.0


i_cal_parameter_get_iana_name ()

const gchar *       i_cal_parameter_get_iana_name       (ICalParameter *param);

Get the iana_name property of the native part of the ICalParameter.

param :

The ICalParameter to be queried

Returns :

the property of the value. [allow-none]

Since 1.0


i_cal_parameter_set_iana_value ()

void                i_cal_parameter_set_iana_value      (ICalParameter *param,
                                                         const gchar *v);

Set the iana_value property of the native part of the ICalParameter.

param :

The ICalParameter of which the iana_value to be set. [in-out]

v :

The value to be set into the param.

Since 1.0


i_cal_parameter_get_iana_value ()

const gchar *       i_cal_parameter_get_iana_value      (ICalParameter *param);

Get the iana_value property of the native part of the ICalParameter.

param :

The ICalParameter to be queried

Returns :

the property of the value. [allow-none]

Since 1.0


i_cal_parameter_has_same_name ()

gint                i_cal_parameter_has_same_name       (ICalParameter *param1,
                                                         ICalParameter *param2);

Check whether native parts of two ICalParameters have the same name

param1 :

The ICalParameter to be checked

param2 :

The ICalParameter to be checked

Returns :

1 if the parameters have the same name, 0 or not.

Since 1.0


i_cal_parameter_kind_to_string ()

const gchar *       i_cal_parameter_kind_to_string      (ICalParameterKind kind);

Convert the ICalParameter to the string representation

kind :

The ICalParameterKind to be converted

Returns :

The string representation of kind.

Since 1.0


i_cal_parameter_string_to_kind ()

ICalParameterKind   i_cal_parameter_string_to_kind      (const gchar *string);

Convert a string to the ICalParameterKind

string :

The string representation of the ICalParameter

Returns :

The ICalParameterKind converted from string

Since 1.0