ECalListener
3
LIBECAL Library

# ECalListener

Listens for responses and event notifications sent by an e-cal.

## Synopsis

                        ECalListener;
    void                (*ECalListenerCalSetModeFn)         (ECalListener *listener,
                                                             GNOME_Evolution_Calendar_CalListener_SetModeStatus status,
                                                             GNOME_Evolution_Calendar_CalMode mode,
                                                             gpointer data);
    ECalListener*       e_cal_listener_construct            (ECalListener *listener,
                                                             ECalListenerCalSetModeFn cal_set_mode_fn,
                                                             gpointer fn_data);
    ECalListener*       e_cal_listener_new                  (ECalListenerCalSetModeFn cal_set_mode_fn,
                                                             gpointer fn_data);
    void                e_cal_listener_stop_notification    (ECalListener *listener);

## Object Hierarchy

      GObject
       +----BonoboObject
             +----ECalListener

## Signals

      "add-timezone"                                   : Run Last
      "alarm-address"                                  : Run Last
      "attachment-list"                                : Run Last
      "auth-required"                                  : Run Last
      "backend-error"                                  : Run Last
      "cal-address"                                    : Run Last
      "create-object"                                  : Run Last
      "default-object"                                 : Run Last
      "discard-alarm"                                  : Run Last
      "get-changes"                                    : Run Last
      "get-free-busy"                                  : Run Last
      "get-timezone"                                   : Run Last
      "ldap-attribute"                                 : Run Last
      "modify-object"                                  : Run Last
      "object"                                         : Run Last
      "object-list"                                    : Run Last
      "open"                                           : Run Last
      "query"                                          : Run Last
      "read-only"                                      : Run Last
      "receive-objects"                                : Run Last
      "remove"                                         : Run Last
      "remove-object"                                  : Run Last
      "send-objects"                                   : Run Last
      "set-default-timezone"                           : Run Last
      "static-capabilities"                            : Run Last

## Description

Contrast with the e-cal-view-listener, which listens to e-cal-view.

## Details

### ECalListener

    typedef struct _ECalListener ECalListener;

### ECalListenerCalSetModeFn ()

    void                (*ECalListenerCalSetModeFn)         (ECalListener *listener,
                                                             GNOME_Evolution_Calendar_CalListener_SetModeStatus status,
                                                             GNOME_Evolution_Calendar_CalMode mode,
                                                             gpointer data);

`listener` :

`status` :

`mode` :

`data` :

### e_cal_listener_construct ()

    ECalListener*       e_cal_listener_construct            (ECalListener *listener,
                                                             ECalListenerCalSetModeFn cal_set_mode_fn,
                                                             gpointer fn_data);

Constructs all internal information for a calendar listener. This function usually does not need to be called, unless creating a ECalListener-derived class.

`listener` :

  A calendar listener.

`cal_set_mode_fn` :

  Function callback for notification that a calendar changed modes.

`fn_data` :

  Closure data pointer that will be passed to the notification functions.

Returns :

  the calendar listener ready to be used.

### e_cal_listener_new ()

    ECalListener*       e_cal_listener_new                  (ECalListenerCalSetModeFn cal_set_mode_fn,
                                                             gpointer fn_data);

Creates a new ECalListener object.

`cal_set_mode_fn` :

  Function callback for notification that a calendar changed modes.

`fn_data` :

  Closure data pointer that will be passed to the notification functions.

Returns :

  A newly-created ECalListener object.

### e_cal_listener_stop_notification ()

    void                e_cal_listener_stop_notification    (ECalListener *listener);

Informs a calendar listener that no further notification is desired. The callbacks specified when the listener was created will no longer be invoked after this function is called.

`listener` :

  A calendar listener.

## Signal Details

### The `"add-timezone"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gchar        *arg2,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`arg2` :

`user_data` :

  user data set when the signal handler was connected.

### The `"alarm-address"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gchar        *arg2,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`arg2` :

`user_data` :

  user data set when the signal handler was connected.

### The `"attachment-list"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gpointer      arg2,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`arg2` :

`user_data` :

  user data set when the signal handler was connected.

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

    void                user_function                      (ECalListener *ecallistener,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`user_data` :

  user data set when the signal handler was connected.

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

    void                user_function                      (ECalListener *ecallistener,
                                                            gchar        *arg1,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`user_data` :

  user data set when the signal handler was connected.

### The `"cal-address"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gchar        *arg2,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`arg2` :

`user_data` :

  user data set when the signal handler was connected.

### The `"create-object"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gchar        *arg2,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`arg2` :

`user_data` :

  user data set when the signal handler was connected.

### The `"default-object"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gchar        *arg2,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`arg2` :

`user_data` :

  user data set when the signal handler was connected.

### The `"discard-alarm"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`user_data` :

  user data set when the signal handler was connected.

### The `"get-changes"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gpointer      arg2,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`Param3` :

`user_data` :

  user data set when the signal handler was connected.

### The `"get-free-busy"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gpointer      arg2,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`Param3` :

`user_data` :

  user data set when the signal handler was connected.

### The `"get-timezone"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gchar        *arg2,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`arg2` :

`user_data` :

  user data set when the signal handler was connected.

### The `"ldap-attribute"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gchar        *arg2,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`arg2` :

`user_data` :

  user data set when the signal handler was connected.

### The `"modify-object"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`user_data` :

  user data set when the signal handler was connected.

### The `"object"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gchar        *arg2,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`arg2` :

`user_data` :

  user data set when the signal handler was connected.

### The `"object-list"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gpointer      arg2,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`arg2` :

`user_data` :

  user data set when the signal handler was connected.

### The `"open"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`user_data` :

  user data set when the signal handler was connected.

### The `"query"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gpointer      arg2,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`arg2` :

`user_data` :

  user data set when the signal handler was connected.

### The `"read-only"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gboolean      arg2,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`arg2` :

`user_data` :

  user data set when the signal handler was connected.

### The `"receive-objects"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`user_data` :

  user data set when the signal handler was connected.

### The `"remove"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`user_data` :

  user data set when the signal handler was connected.

### The `"remove-object"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`user_data` :

  user data set when the signal handler was connected.

### The `"send-objects"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gpointer      arg2,
                                                            gchar        *arg3,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`Param3` :

`Param4` :

`user_data` :

  user data set when the signal handler was connected.

### The `"set-default-timezone"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`user_data` :

  user data set when the signal handler was connected.

### The `"static-capabilities"` signal

    void                user_function                      (ECalListener *ecallistener,
                                                            gint          arg1,
                                                            gchar        *arg2,
                                                            gpointer      user_data)         : Run Last

`ecallistener` :

  the object which received the signal.

`arg1` :

`arg2` :

`user_data` :

  user data set when the signal handler was connected.

## See Also

ECal, ECalViewListener