e-cal-component-text

e-cal-component-text — An ECalComponentText structure

Functions

Types and Values

Object Hierarchy

    GBoxed
    ╰── ECalComponentText

Includes

#include <libecal/libecal.h>

Description

Contains functions to work with the ECalComponentText structure.

Functions

e_cal_component_text_new ()

ECalComponentText *
e_cal_component_text_new (const gchar *value,
                          const gchar *altrep);

Creates a new ECalComponentText describing text properties. The returned structure should be freed with e_cal_component_text_free(), when no longer needed.

Parameters

value

description text.

[nullable]

altrep

alternate representation URI.

[nullable]

Returns

a newly allocated ECalComponentText.

[transfer full]

Since: 3.34


e_cal_component_text_copy ()

ECalComponentText *
e_cal_component_text_copy (const ECalComponentText *text);

Parameters

text

an ECalComponentText to copy.

[not nullable]

Returns

a newly allocated ECalComponentText, copy of text . The returned structure should be freed with e_cal_component_text_free(), when no longer needed.

[transfer full]

Since: 3.34


e_cal_component_text_free ()

void
e_cal_component_text_free (gpointer text);

Free the text , previously allocated by e_cal_component_text_new() or e_cal_component_text_copy().

[skip]

Parameters

text

an ECalComponentText to free.

[type ECalComponentText][nullable]

Since: 3.34


e_cal_component_text_get_value ()

const gchar *
e_cal_component_text_get_value (const ECalComponentText *text);

Parameters

text

an ECalComponentText

 

Returns

the description string of the text

Since: 3.34


e_cal_component_text_set_value ()

void
e_cal_component_text_set_value (ECalComponentText *text,
                                const gchar *value);

Set the value as the description string of the text .

Parameters

text

an ECalComponentText

 

value

description string to set.

[nullable]

Since: 3.34


e_cal_component_text_get_altrep ()

const gchar *
e_cal_component_text_get_altrep (const ECalComponentText *text);

Parameters

text

an ECalComponentText

 

Returns

the alternate representation URI of the text

Since: 3.34


e_cal_component_text_set_altrep ()

void
e_cal_component_text_set_altrep (ECalComponentText *text,
                                 const gchar *altrep);

Set the altrep as the alternate representation URI of the text .

Parameters

text

an ECalComponentText

 

altrep

alternate representation URI to set.

[nullable]

Since: 3.34

Types and Values

ECalComponentText

typedef struct _ECalComponentText ECalComponentText;

Contains description string and an alternate representation URI for text properties. Use the functions below to work with it.