e-data-cal-common
3
LIBEDATA-CAL Library

# e-data-cal-common

## Synopsis

                        ECalBackend;
                        ECalBackendClass;
                        EDataCal;
                        EDataCalClass;
                        EDataCalView;
                        EDataCalViewClass;
                        ECalBackendSExp;
                        ECalBackendSExpClass;

## Object Hierarchy

      GObject
       +----ECalBackend
             +----ECalBackendSync

      GObject
       +----BonoboObject
             +----EDataCal

      GObject
       +----BonoboObject
             +----EDataCalView

      GObject
       +----ECalBackendSExp

## Properties

      "kind"                     gulong                : Read / Write / Construct Only
      "source"                   ESource*              : Read / Write / Construct Only
      "uri"                      gchar*                : Read / Write / Construct Only
      "backend"                  ECalBackend*          : Read / Write / Construct Only
      "listener"                 gpointer              : Read / Write / Construct Only
      "sexp"                     ECalBackendSExp*      : Read / Write / Construct Only

## Signals

      "last-client-gone"                               : Run First
      "opened"                                         : Run First
      "removed"                                        : Run First
      "last-listener-gone"                             : Run First

## Description

## Details

### ECalBackend

    typedef struct _ECalBackend ECalBackend;

### ECalBackendClass

    typedef struct {
    	GObjectClass parent_class;

    	/* Notification signals */
    	void (* last_client_gone) (ECalBackend *backend);
    	void (* cal_added) (ECalBackend *backend, EDataCal *cal);

    	gboolean (* is_loaded) (ECalBackend *backend);

    	/* FIXME What to pass back here */
    	void (* opened) (ECalBackend *backend, int status);
    	void (* removed) (ECalBackend *backend, int status);
    	void (* obj_updated) (ECalBackend *backend, const char *uid);

    	/* Virtual methods */
    	void (* is_read_only) (ECalBackend *backend, EDataCal *cal);
    	void (* get_cal_address) (ECalBackend *backend, EDataCal *cal);
    	void (* get_alarm_email_address) (ECalBackend *backend, EDataCal *cal);
    	void (* get_ldap_attribute) (ECalBackend *backend, EDataCal *cal);
    	void (* get_static_capabilities) (ECalBackend *backend, EDataCal *cal);

    	void (* open) (ECalBackend *backend, EDataCal *cal, gboolean only_if_exists, const char *username, const char *password);
    	void (* remove) (ECalBackend *backend, EDataCal *cal);

    	/* Object related virtual methods */
    	void (* create_object) (ECalBackend *backend, EDataCal *cal, const char *calobj);
    	void (* modify_object) (ECalBackend *backend, EDataCal *cal, const char *calobj, CalObjModType mod);
    	void (* remove_object) (ECalBackend *backend, EDataCal *cal, const char *uid, const char *rid, CalObjModType mod);

    	void (* discard_alarm) (ECalBackend *backend, EDataCal *cal, const char *uid, const char *auid);

    	void (* receive_objects) (ECalBackend *backend, EDataCal *cal, const char *calobj);
    	void (* send_objects) (ECalBackend *backend, EDataCal *cal, const char *calobj);

    	void (* get_default_object) (ECalBackend *backend, EDataCal *cal);
    	void (* get_object) (ECalBackend *backend, EDataCal *cal, const char *uid, const char *rid);
    	void (* get_object_list) (ECalBackend *backend, EDataCal *cal, const char *sexp);

    	void (* get_attachment_list) (ECalBackend *backend, EDataCal *cal, const char *uid, const char *rid);

    	/* Timezone related virtual methods */
    	void (* get_timezone) (ECalBackend *backend, EDataCal *cal, const char *tzid);
    	void (* add_timezone) (ECalBackend *backend, EDataCal *cal, const char *object);
    	void (* set_default_zone) (ECalBackend *backend, EDataCal *cal, const char *tzobj);
    	void (* set_default_timezone) (ECalBackend *backend, EDataCal *cal, const char *tzid);

    	void (* start_query) (ECalBackend *backend, EDataCalView *query);

    	/* Mode relate virtual methods */
    	CalMode (* get_mode) (ECalBackend *backend);
    	void    (* set_mode) (ECalBackend *backend, CalMode mode);

    	void (* get_free_busy) (ECalBackend *backend, EDataCal *cal, GList *users, time_t start, time_t end);
    	void (* get_changes) (ECalBackend *backend, EDataCal *cal, const char *change_id);

    	/* Internal methods for use only in the pcs */
    	icaltimezone *(* internal_get_default_timezone) (ECalBackend *backend);
    	icaltimezone *(* internal_get_timezone) (ECalBackend *backend, const char *tzid);
    } ECalBackendClass;

### EDataCal

    typedef struct _EDataCal EDataCal;

### EDataCalClass

    typedef struct {
    	BonoboObjectClass parent_class;

    	POA_GNOME_Evolution_Calendar_Cal__epv epv;
    } EDataCalClass;

### EDataCalView

    typedef struct _EDataCalView EDataCalView;

### EDataCalViewClass

    typedef struct {
    	BonoboObjectClass parent_class;

    	POA_GNOME_Evolution_Calendar_CalView__epv epv;

    	/* Notification signals */
    	void (* last_listener_gone) (EDataCalView *query);
    } EDataCalViewClass;

### ECalBackendSExp

    typedef struct _ECalBackendSExp ECalBackendSExp;

### ECalBackendSExpClass

    typedef struct {
    	GObjectClass parent_class;
    } ECalBackendSExpClass;

## Property Details

### The `"kind"` property

      "kind"                     gulong                : Read / Write / Construct Only

Allowed values: <= 25

### The `"source"` property

      "source"                   ESource*              : Read / Write / Construct Only

### The `"uri"` property

      "uri"                      gchar*                : Read / Write / Construct Only

Default value: ""

### The `"backend"` property

      "backend"                  ECalBackend*          : Read / Write / Construct Only

### The `"listener"` property

      "listener"                 gpointer              : Read / Write / Construct Only

### The `"sexp"` property

      "sexp"                     ECalBackendSExp*      : Read / Write / Construct Only

## Signal Details

### The `"last-client-gone"` signal

    void                user_function                      (ECalBackend *ecalbackend,
                                                            gpointer     user_data)        : Run First

`ecalbackend` :

  the object which received the signal.

`user_data` :

  user data set when the signal handler was connected.

### The `"opened"` signal

    void                user_function                      (ECalBackend *ecalbackend,
                                                            gint         arg1,
                                                            gpointer     user_data)        : Run First

`ecalbackend` :

  the object which received the signal.

`arg1` :

`user_data` :

  user data set when the signal handler was connected.

### The `"removed"` signal

    void                user_function                      (ECalBackend *ecalbackend,
                                                            gint         arg1,
                                                            gpointer     user_data)        : Run First

`ecalbackend` :

  the object which received the signal.

`arg1` :

`user_data` :

  user data set when the signal handler was connected.

### The `"last-listener-gone"` signal

    void                user_function                      (EDataCalView *edatacalview,
                                                            gpointer      user_data)         : Run First

`edatacalview` :

  the object which received the signal.

`user_data` :

  user data set when the signal handler was connected.