JanaEcalComponent: libjana-ecal Reference Manual

JanaEcalComponent

JanaEcalComponent — An implementation of JanaComponent using libecal

Functions

JanaComponent *	jana_ecal_component_new_from_ecalcomp ()
gchar *	jana_ecal_component_get_summary ()
gchar *	jana_ecal_component_get_description ()
gchar *	jana_ecal_component_get_location ()
JanaTime *	jana_ecal_component_get_start ()
JanaTime *	jana_ecal_component_get_end ()
void	jana_ecal_component_set_summary ()
void	jana_ecal_component_set_description ()
void	jana_ecal_component_set_location ()
void	jana_ecal_component_set_start ()
void	jana_ecal_component_set_end ()

Properties

ECalComponent *

ecalcomp

Read / Write / Construct Only

Types and Values

struct

JanaEcalComponent

Object Hierarchy

    GObject
    ╰── JanaEcalComponent
        ├── JanaEcalEvent
        ╰── JanaEcalNote

Implemented Interfaces

JanaEcalComponent implements JanaComponent.

Description

JanaEcalComponent is an implementation of JanaComponent that provides a wrapper over ECalComponent, using libecal.

Functions

jana_ecal_component_new_from_ecalcomp ()

JanaComponent *
jana_ecal_component_new_from_ecalcomp (ECalComponent *component);

Creates a new JanaEcalComponent from an ECalComponent.

Parameters

component

An ECalComponent

Returns

A new JanaEcalComponent that wraps the given ECalComponent, cast as a JanaComponent.

jana_ecal_component_get_summary ()

gchar *
jana_ecal_component_get_summary (JanaEcalComponent *self);

Retrieves the summary from the underlying ECalComponent. This function is intended for using only when extending JanaEcalComponent.

Parameters

self

A JanaEcalComponent

Returns

A newly allocated string with the summary from the underlying ECalComponent, or NULL.

jana_ecal_component_get_description ()

gchar *
jana_ecal_component_get_description (JanaEcalComponent *self);

Retrieves the first description from the underlying ECalComponent. This function is intended for using only when extending JanaEcalComponent.

Parameters

self

A JanaEcalComponent

Returns

A newly allocated string with the first description from the underlying ECalComponent, or NULL.

jana_ecal_component_get_location ()

gchar *
jana_ecal_component_get_location (JanaEcalComponent *self);

Retrieves the location from the underlying ECalComponent. This function is intended for using only when extending JanaEcalComponent.

Parameters

self

A JanaEcalComponent

Returns

A newly allocated string with the location from the underlying ECalComponent, or NULL.

jana_ecal_component_get_start ()

JanaTime *
jana_ecal_component_get_start (JanaEcalComponent *self);

Retrieves the dtstart of the underlying ECalComponent. This function is intended for using only when extending JanaEcalComponent.

Parameters

self

A JanaEcalComponent

Returns

A JanaTime representing the dtstart of the underlying ECalComponent, or NULL.

jana_ecal_component_get_end ()

JanaTime *
jana_ecal_component_get_end (JanaEcalComponent *self);

Retrieves the dtend of the underlying ECalComponent. This function is intended for using only when extending JanaEcalComponent.

Parameters

self

A JanaEcalComponent

Returns

A JanaTime representing the dtend of the underlying ECalComponent, or NULL.

jana_ecal_component_set_summary ()

void
jana_ecal_component_set_summary (JanaEcalComponent *self,
                                 const gchar *summary);

Sets the summary on the underlying ECalComponent. This function is intended for using only when extending JanaEcalComponent.

Parameters

self	A JanaEcalComponent
summary	A UTF-8 string

jana_ecal_component_set_description ()

void
jana_ecal_component_set_description (JanaEcalComponent *self,
                                     const gchar *description);

Sets the description on the underlying ECalComponent. This function is intended for using only when extending JanaEcalComponent.

Parameters

self	A JanaEcalComponent
description	A UTF-8 string

jana_ecal_component_set_location ()

void
jana_ecal_component_set_location (JanaEcalComponent *self,
                                  const gchar *location);

Sets the location on the underlying ECalComponent. This function is intended for using only when extending JanaEcalComponent.

Parameters

self	A JanaEcalComponent
location	A UTF-8 string

jana_ecal_component_set_start ()

void
jana_ecal_component_set_start (JanaEcalComponent *self,
                               JanaTime *start);

Sets the dtstart on the underlying ECalComponent. This function is intended for using only when extending JanaEcalComponent.

Parameters

self	A JanaEcalComponent
start	A JanaTime

jana_ecal_component_set_end ()

void
jana_ecal_component_set_end (JanaEcalComponent *self,
                             JanaTime *end);

Sets the dtend on the underlying ECalComponent. This function is intended for using only when extending JanaEcalComponent.

Parameters

self	A JanaEcalComponent
end	A JanaTime

Types and Values

struct JanaEcalComponent

struct JanaEcalComponent;

The JanaEcalComponent struct contains only private data.

Property Details

The `“ecalcomp”` property

  “ecalcomp”                 ECalComponent *

The ECalComponent represented by this JanaComponent object.

Flags: Read / Write / Construct Only