ECalListener
3
LIBECAL Library

# ECalListener

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

## Synopsis

    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);

## Description

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

## Details

### 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.

## See Also

ECal, ECalViewListener