## EDataCal

EDataCal — Implementation of the calendar CORBA client interface.

## Synopsis

    #define             E_DATA_CAL_ERROR
                        EDataCal;
    EDataCal *          e_data_cal_new                      (ECalBackend *backend,
                                                             ESource *source);
    ECalBackend *       e_data_cal_get_backend              (EDataCal *cal);
    ESource*            e_data_cal_get_source               (EDataCal *cal);
    void                e_data_cal_notify_read_only         (EDataCal *cal,
                                                             EDataCalCallStatus status,
                                                             gboolean read_only);
    void                e_data_cal_notify_cal_address       (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *address);
    void                e_data_cal_notify_alarm_email_address
                                                            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *address);
    void                e_data_cal_notify_ldap_attribute    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *attribute);
    void                e_data_cal_notify_static_capabilities
                                                            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *capabilities);
    void                e_data_cal_notify_open              (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status);
    void                e_data_cal_notify_refresh           (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status);
    void                e_data_cal_notify_remove            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status);
    void                e_data_cal_notify_object_created    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *uid,
                                                             const gchar *object);
    void                e_data_cal_notify_object_modified   (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *old_object,
                                                             const gchar *object);
    void                e_data_cal_notify_object_removed    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const ECalComponentId *id,
                                                             const gchar *old_object,
                                                             const gchar *object);
    void                e_data_cal_notify_alarm_discarded   (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status);
    void                e_data_cal_notify_objects_received  (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status);
    void                e_data_cal_notify_objects_sent      (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             GList *users,
                                                             const gchar *calobj);
    void                e_data_cal_notify_default_object    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *object);
    void                e_data_cal_notify_object            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *object);
    void                e_data_cal_notify_object_list       (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             GList *objects);
    void                e_data_cal_notify_query             (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *query_path);
    void                e_data_cal_notify_timezone_requested
                                                            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *object);
    void                e_data_cal_notify_timezone_added    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *tzid);
    void                e_data_cal_notify_default_timezone_set
                                                            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status);
    void                e_data_cal_notify_changes           (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             GList *adds,
                                                             GList *modifies,
                                                             GList *deletes);
    void                e_data_cal_notify_free_busy         (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             GList *freebusy);
    void                e_data_cal_notify_mode              (EDataCal *cal,
                                                             EDataCalViewListenerSetModeStatus status,
                                                             EDataCalMode mode);
    void                e_data_cal_notify_auth_required     (EDataCal *cal);
    void                e_data_cal_notify_error             (EDataCal *cal,
                                                             const gchar *message);
    void                e_data_cal_notify_attachment_list   (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             GSList *objects);

## Object Hierarchy

      GObject
       +----EDataCal

## Signals

      "auth-required"                                  : Run Last / Has Details
      "backend-error"                                  : Run Last / Has Details
      "mode"                                           : Run Last / Has Details
      "readonly"                                       : Run Last / Has Details

## Description

## Details

### E_DATA_CAL_ERROR

    #define E_DATA_CAL_ERROR e_data_cal_error_quark ()

Since 2.30

### EDataCal

    typedef struct _EDataCal EDataCal;

### e_data_cal_new ()

    EDataCal *          e_data_cal_new                      (ECalBackend *backend,
                                                             ESource *source);

`backend` : |
`source` : |
Returns : |

### e_data_cal_get_backend ()

    ECalBackend *       e_data_cal_get_backend              (EDataCal *cal);

`cal` : |
Returns : |

### e_data_cal_get_source ()

    ESource*            e_data_cal_get_source               (EDataCal *cal);

Returns the ESource for `cal`.

`cal` : | an EDataCal
Returns : | the ESource for `cal`

Since 2.30

### e_data_cal_notify_read_only ()

    void                e_data_cal_notify_read_only         (EDataCal *cal,
                                                             EDataCalCallStatus status,
                                                             gboolean read_only);

Notifies listeners of the completion of the is_read_only method call.

`cal` : | A calendar client interface.
`status` : | Status code.
`read_only` : | Read only value.

### e_data_cal_notify_cal_address ()

    void                e_data_cal_notify_cal_address       (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *address);

Notifies listeners of the completion of the get_cal_address method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.
`address` : | Calendar address.

### e_data_cal_notify_alarm_email_address ()

    void                e_data_cal_notify_alarm_email_address
                                                            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *address);

Notifies listeners of the completion of the get_alarm_email_address method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.
`address` : | Alarm email address.

### e_data_cal_notify_ldap_attribute ()

    void                e_data_cal_notify_ldap_attribute    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *attribute);

Notifies listeners of the completion of the get_ldap_attribute method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.
`attribute` : |

### e_data_cal_notify_static_capabilities ()

    void                e_data_cal_notify_static_capabilities
                                                            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *capabilities);

Notifies listeners of the completion of the get_static_capabilities method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.
`capabilities` : | Static capabilities from the backend.

### e_data_cal_notify_open ()

    void                e_data_cal_notify_open              (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status);

Notifies listeners of the completion of the open method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.

### e_data_cal_notify_refresh ()

    void                e_data_cal_notify_refresh           (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status);

Notifies listeners of the completion of the refresh method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.

Since 2.30

### e_data_cal_notify_remove ()

    void                e_data_cal_notify_remove            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status);

Notifies listeners of the completion of the remove method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.

### e_data_cal_notify_object_created ()

    void                e_data_cal_notify_object_created    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *uid,
                                                             const gchar *object);

Notifies listeners of the completion of the create_object method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.
`uid` : | UID of the object created.
`object` : | The object created as an iCalendar string.

### e_data_cal_notify_object_modified ()

    void                e_data_cal_notify_object_modified   (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *old_object,
                                                             const gchar *object);

Notifies listeners of the completion of the modify_object method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.
`old_object` : | The old object as an iCalendar string.
`object` : | The modified object as an iCalendar string.

### e_data_cal_notify_object_removed ()

    void                e_data_cal_notify_object_removed    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const ECalComponentId *id,
                                                             const gchar *old_object,
                                                             const gchar *object);

Notifies listeners of the completion of the remove_object method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.
`id` : |
`old_object` : | The old object as an iCalendar string.
`object` : | The new object as an iCalendar string. This will not be NULL only when removing instances of a recurring appointment.

### e_data_cal_notify_alarm_discarded ()

    void                e_data_cal_notify_alarm_discarded   (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status);

Notifies listeners of the completion of the discard_alarm method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.

### e_data_cal_notify_objects_received ()

    void                e_data_cal_notify_objects_received  (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status);

Notifies listeners of the completion of the receive_objects method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.

### e_data_cal_notify_objects_sent ()

    void                e_data_cal_notify_objects_sent      (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             GList *users,
                                                             const gchar *calobj);

Notifies listeners of the completion of the send_objects method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.
`users` : | List of users.
`calobj` : | An iCalendar string representing the object sent.

### e_data_cal_notify_default_object ()

    void                e_data_cal_notify_default_object    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *object);

Notifies listeners of the completion of the get_default_object method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.
`object` : | The default object as an iCalendar string.

### e_data_cal_notify_object ()

    void                e_data_cal_notify_object            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *object);

Notifies listeners of the completion of the get_object method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.
`object` : | The object retrieved as an iCalendar string.

### e_data_cal_notify_object_list ()

    void                e_data_cal_notify_object_list       (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             GList *objects);

Notifies listeners of the completion of the get_object_list method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.
`objects` : | List of retrieved objects.

### e_data_cal_notify_query ()

    void                e_data_cal_notify_query             (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *query_path);

`cal` : |
`context` : |
`status` : |
`query_path` : |

### e_data_cal_notify_timezone_requested ()

    void                e_data_cal_notify_timezone_requested
                                                            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *object);

Notifies listeners of the completion of the get_timezone method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.
`object` : | The requested timezone as an iCalendar string.

### e_data_cal_notify_timezone_added ()

    void                e_data_cal_notify_timezone_added    (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             const gchar *tzid);

Notifies listeners of the completion of the add_timezone method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.
`tzid` : | ID of the added timezone.

### e_data_cal_notify_default_timezone_set ()

    void                e_data_cal_notify_default_timezone_set
                                                            (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status);

Notifies listeners of the completion of the set_default_timezone method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.

### e_data_cal_notify_changes ()

    void                e_data_cal_notify_changes           (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             GList *adds,
                                                             GList *modifies,
                                                             GList *deletes);

Notifies listeners of the completion of the get_changes method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.
`adds` : | List of additions.
`modifies` : | List of modifications.
`deletes` : | List of removals.

### e_data_cal_notify_free_busy ()

    void                e_data_cal_notify_free_busy         (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             GList *freebusy);

Notifies listeners of the completion of the get_free_busy method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.
`freebusy` : | List of free/busy objects.

### e_data_cal_notify_mode ()

    void                e_data_cal_notify_mode              (EDataCal *cal,
                                                             EDataCalViewListenerSetModeStatus status,
                                                             EDataCalMode mode);

Notifies the listener of the results of a set_mode call.

`cal` : | A calendar client interface.
`status` : | Status of the mode set.
`mode` : | The current mode.

### e_data_cal_notify_auth_required ()

    void                e_data_cal_notify_auth_required     (EDataCal *cal);

Notifies listeners that authorization is required to open the calendar.

`cal` : | A calendar client interface.

### e_data_cal_notify_error ()

    void                e_data_cal_notify_error             (EDataCal *cal,
                                                             const gchar *message);

Notify a calendar client of an error occurred in the backend.

`cal` : | A calendar client interface.
`message` : | Error message.

### e_data_cal_notify_attachment_list ()

    void                e_data_cal_notify_attachment_list   (EDataCal *cal,
                                                             EServerMethodContext context,
                                                             EDataCalCallStatus status,
                                                             GSList *objects);

Notifies listeners of the completion of the get_attachment_list method call.+ */ void e_data_cal_notify_attachment_list (EDataCal *cal, EServerMethodContext context, EDataCalCallStatus status, GSList *attachments) { DBusGMethodInvocation *method = context; gchar **seq; GSList *l; gint i;

seq = g_new0 (gchar *, g_slist_length (attachments)); for (l = attachments, i = 0; l; l = l->next, i++) { seq[i] = g_strdup (l->data); }

if (status != Success) dbus_g_method_return_error (method, g_error_new (E_DATA_CAL_ERROR, status, _("Could not retrieve attachment list"))); else dbus_g_method_return (method, seq); }

/** e_data_cal_notify_query: `cal`: A calendar client interface. `status`: Status code. `query`: The new live query.

Notifies listeners of the completion of the get_query method call.

`cal` : | A calendar client interface.
`context` : |
`status` : | Status code.
`objects` : |

## Signal Details

### The `"auth-required"` signal

    void                user_function                      (EDataCal *edatacal,
                                                            gpointer  user_data)      : Run Last / Has Details

`edatacal` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.

### The `"backend-error"` signal

    void                user_function                      (EDataCal *edatacal,
                                                            gchar    *arg1,
                                                            gpointer  user_data)      : Run Last / Has Details

`edatacal` : | the object which received the signal.
`arg1` : |
`user_data` : | user data set when the signal handler was connected.

### The `"mode"` signal

    void                user_function                      (EDataCal *edatacal,
                                                            gint      arg1,
                                                            gpointer  user_data)      : Run Last / Has Details

`edatacal` : | the object which received the signal.
`arg1` : |
`user_data` : | user data set when the signal handler was connected.

### The `"readonly"` signal

    void                user_function                      (EDataCal *edatacal,
                                                            gboolean  arg1,
                                                            gpointer  user_data)      : Run Last / Has Details

`edatacal` : | the object which received the signal.
`arg1` : |
`user_data` : | user data set when the signal handler was connected.