![]() |
![]() |
![]() |
Evolution-Data-Server Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
#include <libedata-cal/libedata-cal.h> struct ECalBackendStore; struct ECalBackendStoreClass; ECalBackendStore * e_cal_backend_store_new (const gchar *path
,ETimezoneCache *cache
); const gchar * e_cal_backend_store_get_path (ECalBackendStore *store
); ETimezoneCache * e_cal_backend_store_ref_timezone_cache (ECalBackendStore *store
); gboolean e_cal_backend_store_load (ECalBackendStore *store
); gboolean e_cal_backend_store_is_loaded (ECalBackendStore *store
); gboolean e_cal_backend_store_clean (ECalBackendStore *store
); ECalComponent * e_cal_backend_store_get_component (ECalBackendStore *store
,const gchar *uid
,const gchar *rid
); gboolean e_cal_backend_store_put_component_with_time_range (ECalBackendStore *store
,ECalComponent *comp
,time_t occurence_start
,time_t occurence_end
); gboolean e_cal_backend_store_put_component (ECalBackendStore *store
,ECalComponent *comp
); gboolean e_cal_backend_store_remove_component (ECalBackendStore *store
,const gchar *uid
,const gchar *rid
); gboolean e_cal_backend_store_has_component (ECalBackendStore *store
,const gchar *uid
,const gchar *rid
); const icaltimezone * e_cal_backend_store_get_default_timezone (ECalBackendStore *store
); gboolean e_cal_backend_store_set_default_timezone (ECalBackendStore *store
,icaltimezone *zone
); GSList * e_cal_backend_store_get_components_by_uid (ECalBackendStore *store
,const gchar *uid
); gchar * e_cal_backend_store_get_components_by_uid_as_ical_string (ECalBackendStore *store
,const gchar *uid
); GSList * e_cal_backend_store_get_components (ECalBackendStore *store
); GSList * e_cal_backend_store_get_components_occuring_in_range (ECalBackendStore *store
,time_t start
,time_t end
); GSList * e_cal_backend_store_get_component_ids (ECalBackendStore *store
); const gchar * e_cal_backend_store_get_key_value (ECalBackendStore *store
,const gchar *key
); gboolean e_cal_backend_store_put_key_value (ECalBackendStore *store
,const gchar *key
,const gchar *value
); void e_cal_backend_store_thaw_changes (ECalBackendStore *store
); void e_cal_backend_store_freeze_changes (ECalBackendStore *store
); void e_cal_backend_store_interval_tree_add_comp (ECalBackendStore *store
,ECalComponent *comp
,time_t occurence_start
,time_t occurence_end
);
struct ECalBackendStore { };
Contains only private data that should be read and manipulated using the functions below.
Since 2.28
struct ECalBackendStoreClass { /* virtual methods */ gboolean (*load) (ECalBackendStore *store); gboolean (*clean) (ECalBackendStore *store); ECalComponent * (*get_component) (ECalBackendStore *store, const gchar *uid, const gchar *rid); gboolean (*put_component) (ECalBackendStore *store, ECalComponent *comp); gboolean (*remove_component) (ECalBackendStore *store, const gchar *uid, const gchar *rid); gboolean (*has_component) (ECalBackendStore *store, const gchar *uid, const gchar *rid); GSList * (*get_components_by_uid)(ECalBackendStore *store, const gchar *uid); GSList * (*get_components) (ECalBackendStore *store); GSList * (*get_component_ids) (ECalBackendStore *store); const icaltimezone * (*get_default_timezone) (ECalBackendStore *store); gboolean (*set_default_timezone) (ECalBackendStore *store, icaltimezone *zone); void (*thaw_changes) (ECalBackendStore *store); void (*freeze_changes) (ECalBackendStore *store); const gchar * (*get_key_value) (ECalBackendStore *store, const gchar *key); gboolean (*put_key_value) (ECalBackendStore *store, const gchar *key, const gchar *value); };
Class structure for the ECalBackendStore class.
FIXME: Doxument me | |
FIXME: Doxument me | |
FIXME: Doxument me | |
FIXME: Doxument me | |
FIXME: Doxument me | |
FIXME: Doxument me | |
FIXME: Doxument me | |
FIXME: Doxument me | |
FIXME: Doxument me | |
FIXME: Doxument me | |
FIXME: Doxument me | |
FIXME: Doxument me | |
FIXME: Doxument me | |
FIXME: Doxument me | |
FIXME: Doxument me |
Since 2.28
ECalBackendStore * e_cal_backend_store_new (const gchar *path
,ETimezoneCache *cache
);
Creates a new ECalBackendStore from path
and cache
.
|
the directory for the store file |
|
an ETimezoneCache |
Returns : |
a new ECalBackendStore |
Since 3.8
const gchar * e_cal_backend_store_get_path (ECalBackendStore *store
);
|
an ECalBackendStore |
Since 2.28
ETimezoneCache * e_cal_backend_store_ref_timezone_cache
(ECalBackendStore *store
);
Returns the ETimezoneCache passed to e_cal_backend_store_new()
.
The returned ETimezoneCache is referenced for thread-safety and must
be unreferenced with g_object_unref()
when finished with it.
|
an ECalBackendStore |
Returns : |
an ETimezoneCache |
Since 3.8
gboolean e_cal_backend_store_load (ECalBackendStore *store
);
|
an ECalBackendStore |
Since 2.28
gboolean e_cal_backend_store_clean (ECalBackendStore *store
);
|
an ECalBackendStore |
Since 2.28
ECalComponent * e_cal_backend_store_get_component (ECalBackendStore *store
,const gchar *uid
,const gchar *rid
);
Fetches a component by uid
and rid
|
an ECalBackendStore |
|
the uid of the component to fetch |
|
the recurrence id of the component to fetch |
Returns : |
An ECalComponent |
Since 2.28
gboolean e_cal_backend_store_put_component_with_time_range (ECalBackendStore *store
,ECalComponent *comp
,time_t occurence_start
,time_t occurence_end
);
|
an ECalBackendStore |
|
the ECalComonent to add |
|
start time of this component |
|
end time of this component |
Returns : |
whether comp was successfully added |
Since 2.32
gboolean e_cal_backend_store_put_component (ECalBackendStore *store
,ECalComponent *comp
);
|
an ECalBackendStore |
|
the ECalComonent to add |
Returns : |
whether comp was successfully added |
Since 2.28
gboolean e_cal_backend_store_remove_component (ECalBackendStore *store
,const gchar *uid
,const gchar *rid
);
|
an ECalBackendStore |
|
the uid of the component to remove |
|
the recurrence id of the component to remove |
Returns : |
whether the component was successfully removed |
Since 2.28
gboolean e_cal_backend_store_has_component (ECalBackendStore *store
,const gchar *uid
,const gchar *rid
);
|
an ECalBackendStore |
|
the uid of the component to check |
|
the recurrence id of the component to check |
Returns : |
Whether there was a component for uid and rid
|
Since 2.28
const icaltimezone * e_cal_backend_store_get_default_timezone
(ECalBackendStore *store
);
Fetch the default timezone
|
an ECalBackendStore |
Returns : |
The default timezone. [transfer none] |
Since 2.28
gboolean e_cal_backend_store_set_default_timezone (ECalBackendStore *store
,icaltimezone *zone
);
|
an ECalBackendStore |
|
the timezone to set |
Returns : |
whether the timezone was successfully set |
Since 2.28
GSList * e_cal_backend_store_get_components_by_uid (ECalBackendStore *store
,const gchar *uid
);
|
an ECalBackendStore |
|
the uid of the components to fetch |
Returns : |
a list of components matching uid
|
Since 2.28
gchar * e_cal_backend_store_get_components_by_uid_as_ical_string (ECalBackendStore *store
,const gchar *uid
);
|
an ECalBackendStore |
|
a component UID |
Returns : |
Newly allocated ical string containing all
instances with given uid . Free returned pointer with g_free() ,
when no longer needed. |
Since 3.10
GSList * e_cal_backend_store_get_components (ECalBackendStore *store
);
|
an ECalBackendStore |
Returns : |
the list of components in store
|
Since 2.28
GSList * e_cal_backend_store_get_components_occuring_in_range (ECalBackendStore *store
,time_t start
,time_t end
);
Retrieves a list of components stored in the store, that are occuring in time range [start, end].
|
An ECalBackendStore object. |
|
Start time |
|
End time |
Returns : |
A list of the components. Each item in the list is an ECalComponent, which should be freed when no longer needed. [transfer full] |
Since 2.32
GSList * e_cal_backend_store_get_component_ids
(ECalBackendStore *store
);
|
an ECalBackendStore |
Since 2.28
const gchar * e_cal_backend_store_get_key_value (ECalBackendStore *store
,const gchar *key
);
|
an ECalBackendStore |
|
the key for the value to fetch |
Returns : |
The value matching key . [transfer none]
|
Since 2.28
gboolean e_cal_backend_store_put_key_value (ECalBackendStore *store
,const gchar *key
,const gchar *value
);
|
an ECalBackendStore |
|
the key for the value to set |
|
the value to set for key
|
Returns : |
whether value was successfully set for key
|
Since 2.28
void e_cal_backend_store_thaw_changes (ECalBackendStore *store
);
|
an ECalBackendStore |
Since 2.28
void e_cal_backend_store_freeze_changes (ECalBackendStore *store
);
|
an ECalBackendStore |
Since 2.28
void e_cal_backend_store_interval_tree_add_comp (ECalBackendStore *store
,ECalComponent *comp
,time_t occurence_start
,time_t occurence_end
);
|
an ECalBackendStore |
|
the ECalComponent to add |
|
start time for comp
|
|
end time for comp
|
Since 2.32