![]() |
![]() |
![]() |
GPE Manual: libeventdb Reference Manual | |
---|---|---|---|---|
#define SECONDS_IN_DAY #define MON #define TUE #define WED #define THU #define FRI #define SAT #define SUN #define TYPE_EVENT #define EVENT (obj) #define EVENT_CLASS (klass) #define IS_EVENT (obj) #define IS_EVENT_CLASS (klass) #define EVENT_GET_CLASS (obj) EventClass; Event; GType event_get_type (void); EventCalendar; #define TYPE_EVENT_CALENDAR #define EVENT_CALENDAR (obj) #define EVENT_CALENDAR_CLASS (klass) #define IS_EVENT_CALENDAR (obj) #define IS_EVENT_CALENDAR_CLASS (klass) #define EVENT_CALENDAR_GET_CLASS (obj) GType event_calendar_get_type (void); EventDB; #define TYPE_EVENT_DB #define EVENT_DB (obj) #define EVENT_DB_CLASS (klass) #define IS_EVENT_DB (obj) #define IS_EVENT_DB_CLASS (klass) #define EVENT_DB_GET_CLASS (obj) GType event_db_get_type (void); void (*EventDBAlarmFiredFunc) (EventDB *, Event *); void (*EventDBError) (EventDB *, const char *); void event_db_error_punt (EventDB *edb, GError *error); EventDB* event_db_new (const char *filename, GError **error); Event* event_db_next_alarm (EventDB *edb, time_t now, GError **error); GSList* event_db_list_for_period (EventDB *evd, time_t start, time_t end, GError **error); GSList* event_db_list_alarms_for_period (EventDB *evd, time_t start, time_t end, GError **error); GSList* event_db_untimed_list_for_period (EventDB *evd, time_t start, time_t end, GError **error); GSList* event_db_list_unacknowledged_alarms (EventDB *edb, GError **error); Event* event_db_find_by_uid (EventDB *edb, guint uid, GError **error); Event* event_db_find_by_eventid (EventDB *edb, const char *eventid, GError **error); EventCalendar* event_db_find_calendar_by_uid (EventDB *edb, guint uid, GError **error); EventCalendar* event_db_find_calendar_by_name (EventDB *edb, const gchar *name, GError **error); GSList* event_db_list_event_calendars (EventDB *edb, GError **error); EventCalendar* event_db_get_default_calendar (EventDB *edb, const char *title, GError **error); void event_db_set_default_calendar (EventDB *edb, EventCalendar *ec, GError **error); void (*EventCalendarNew) (EventDB *edb, EventCalendar *ec); void (*EventCalendarDeleted) (EventDB *edb, EventCalendar *ec); void (*EventCalendarReparented) (EventDB *edb, EventCalendar *ec); void (*EventCalendarChanged) (EventDB *edb, EventCalendar *ec); void (*EventCalendarModified) (EventDB *edb, EventCalendar *ec); EventDB* event_calendar_get_event_db (EventCalendar *ev); EventCalendar* event_calendar_new (EventDB *edb, GError **error); EventCalendar* event_calendar_new_full (EventDB *edb, EventCalendar *parent, gboolean visible, const char *title, const char *description, const char *url, struct _GdkColor *color, int mode, int sync_interval, GError **error); void event_calendar_delete (EventCalendar *event_calendar, gboolean delete_events, EventCalendar *new_parent, GError **error); guint event_calendar_get_uid (EventCalendar *ec); gboolean event_calendar_get_visible (EventCalendar *ec, GError **error); void event_calendar_set_visible (EventCalendar *ec, gboolean visible, GError **error); gboolean event_calendar_valid_parent (EventCalendar *ec, EventCalendar *new_parent, GError **error); EventCalendar* event_calendar_get_parent (EventCalendar *ec, GError **error); void event_calendar_set_parent (EventCalendar *ec, EventCalendar *p, GError **error); char* event_calendar_get_title (EventCalendar *ec, GError **error); void event_calendar_set_title (EventCalendar *ec, const char *title, GError **error); char* event_calendar_get_description (EventCalendar *ec, GError **error); void event_calendar_set_description (EventCalendar *ec, const char *description, GError **error); char* event_calendar_get_url (EventCalendar *ev, GError **error); void event_calendar_set_url (EventCalendar *ec, const char *url, GError **error); char* event_calendar_get_username (EventCalendar *ev, GError **error); void event_calendar_set_username (EventCalendar *ec, const char *username, GError **error); char* event_calendar_get_password (EventCalendar *ev, GError **error); void event_calendar_set_password (EventCalendar *ec, const char *password, GError **error); int event_calendar_get_mode (EventCalendar *ec, GError **error); void event_calendar_set_mode (EventCalendar *ec, int mode, GError **error); gboolean event_calendar_get_color (EventCalendar *ec, struct _GdkColor *color, GError **error); void event_calendar_set_color (EventCalendar *ec, const struct _GdkColor *color, GError **error); int event_calendar_get_sync_interval (EventCalendar *ec, GError **error); void event_calendar_set_sync_interval (EventCalendar *ec, int sync_interval, GError **error); time_t event_calendar_get_last_pull (EventCalendar *ec, GError **error); void event_calendar_set_last_pull (EventCalendar *ec, time_t last_pull, GError **error); time_t event_calendar_get_last_push (EventCalendar *ec, GError **error); void event_calendar_set_last_push (EventCalendar *ec, time_t last_push, GError **error); time_t event_calendar_get_last_modification (EventCalendar *ec, GError **error); GSList* event_calendar_list_events (EventCalendar *ec, GError **error); GSList* event_calendar_list_events_modified_between (EventCalendar *ec, time_t start, time_t end, GError **error); GSList* event_calendar_list_deleted (EventCalendar *ec, GError **error); void event_calendar_flush_deleted (EventCalendar *ec, GError **error); GSList* event_calendar_list_calendars (EventCalendar *ec, GError **error); void (*EventNew) (EventDB *edb, Event *ev); void (*EventRemoved) (EventDB *edb, Event *ev); void (*EventModified) (EventDB *edb, Event *ev); gint event_compare_func (gconstpointer a, gconstpointer b); gint event_alarm_compare_func (gconstpointer a, gconstpointer b); Event* event_new (EventDB *edb, EventCalendar *ec, const char *eventid, GError **error); gboolean event_flush (Event *ev, GError **error); gboolean event_remove (Event *ev, GError **error); void event_list_unref (GSList *l); EventDB* event_get_event_db (Event *ev); EventCalendar* event_get_calendar (Event *ev, GError **error); void event_set_calendar (Event *ev, EventCalendar *ec, GError **error); gboolean event_get_color (Event *ev, struct _GdkColor *color, GError **error); gboolean event_get_visible (Event *ev, GError **error); time_t event_get_start (Event *ev); unsigned long event_get_duration (Event *ev); void event_set_duration (Event *ev, long duration , GError **error); unsigned long event_get_alarm (Event *ev); void event_set_alarm (Event *ev, long alarm , GError **error); void event_acknowledge (Event *ev, GError **error); guint32 event_get_sequence (Event *ev, GError **error); void event_set_sequence (Event *ev, guint32 sequence, GError **error); time_t event_get_last_modification (Event *event); #define event_is_recurrence (ev) enum event_recurrence_type event_get_recurrence_type (Event *ev); void event_set_recurrence_type (Event *ev, enum event_recurrence_type type, GError **error); time_t event_get_recurrence_start (Event *ev); void event_set_recurrence_start (Event *ev, time_t start, GError **error); time_t event_get_recurrence_end (Event *ev); void event_set_recurrence_end (Event *ev, time_t end, GError **error); guint32 event_get_recurrence_count (Event *ev); void event_set_recurrence_count (Event *ev, guint32 count, GError **error); guint32 event_get_recurrence_increment (Event *ev); void event_set_recurrence_increment (Event *ev, guint32 increment, GError **error); GSList* event_get_recurrence_byday (Event *ev, GError **error); void event_set_recurrence_byday (Event *event, GSList *list, GError **error); void event_add_recurrence_exception (Event *ev, time_t start, GError **error); gboolean event_get_untimed (Event *ev); void event_set_untimed (Event *ev, gboolean value, GError **error); unsigned long event_get_uid (Event *ev); char* event_get_eventid (Event *ev, GError **error); char* event_get_summary (Event *ev, GError **error); void event_set_summary (Event *ev, const char *summary, GError **error); char* event_get_description (Event *ev, GError **error); void event_set_description (Event *ev, const char *description, GError **error); char* event_get_location (Event *ev, GError **error); void event_set_location (Event *ev, const char *location, GError **error); GSList* event_get_categories (Event *ev, GError **error); void event_add_category (Event *ev, int category, GError **error); void event_set_categories (Event *ev, GSList *categories, GError **error);
GObject +----Event +----EventSource
GObject +----EventCalendar
GObject +----EventDB
"alarm-fired" : Run Last "calendar-changed" : Run Last "calendar-deleted" : Run Last "calendar-modified" : Run Last "calendar-new" : Run Last "calendar-reparented" : Run Last "error" : Run Last "event-modified" : Run Last "event-new" : Run Last "event-removed" : Run Last "alarm-fired" : Run Last "calendar-changed" : Run Last "calendar-deleted" : Run Last "calendar-modified" : Run Last "calendar-new" : Run Last "calendar-reparented" : Run Last "error" : Run Last "event-modified" : Run Last "event-new" : Run Last "event-removed" : Run Last
EventDB* event_db_new (const char *filename, GError **error);
filename : |
|
error : |
|
Returns : |
Event* event_db_next_alarm (EventDB *edb, time_t now, GError **error);
edb : |
|
now : |
|
error : |
|
Returns : |
GSList* event_db_list_for_period (EventDB *evd, time_t start, time_t end, GError **error);
evd : |
|
start : |
|
end : |
|
error : |
|
Returns : |
GSList* event_db_list_alarms_for_period (EventDB *evd, time_t start, time_t end, GError **error);
evd : |
|
start : |
|
end : |
|
error : |
|
Returns : |
GSList* event_db_untimed_list_for_period (EventDB *evd, time_t start, time_t end, GError **error);
evd : |
|
start : |
|
end : |
|
error : |
|
Returns : |
GSList* event_db_list_unacknowledged_alarms (EventDB *edb, GError **error);
edb : |
|
error : |
|
Returns : |
Event* event_db_find_by_uid (EventDB *edb, guint uid, GError **error);
edb : |
|
uid : |
|
error : |
|
Returns : |
Event* event_db_find_by_eventid (EventDB *edb, const char *eventid, GError **error);
edb : |
|
eventid : |
|
error : |
|
Returns : |
EventCalendar* event_db_find_calendar_by_uid (EventDB *edb, guint uid, GError **error);
edb : |
|
uid : |
|
error : |
|
Returns : |
EventCalendar* event_db_find_calendar_by_name (EventDB *edb, const gchar *name, GError **error);
Get a desired calendar by name.
edb : |
|
name : |
|
error : |
|
Returns : |
GSList* event_db_list_event_calendars (EventDB *edb, GError **error);
edb : |
|
error : |
|
Returns : |
EventCalendar* event_db_get_default_calendar (EventDB *edb, const char *title, GError **error);
edb : |
|
title : |
|
error : |
|
Returns : |
void event_db_set_default_calendar (EventDB *edb, EventCalendar *ec, GError **error);
edb : |
|
ec : |
|
error : |
void (*EventCalendarReparented) (EventDB *edb, EventCalendar *ec);
edb : |
|
ec : |
void (*EventCalendarModified) (EventDB *edb, EventCalendar *ec);
edb : |
|
ec : |
EventDB* event_calendar_get_event_db (EventCalendar *ev);
ev : |
|
Returns : |
EventCalendar* event_calendar_new (EventDB *edb, GError **error);
edb : |
|
error : |
|
Returns : |
EventCalendar* event_calendar_new_full (EventDB *edb, EventCalendar *parent, gboolean visible, const char *title, const char *description, const char *url, struct _GdkColor *color, int mode, int sync_interval, GError **error);
edb : |
|
parent : |
|
visible : |
|
title : |
|
description : |
|
url : |
|
color : |
|
mode : |
|
sync_interval : |
|
error : |
|
Returns : |
void event_calendar_delete (EventCalendar *event_calendar, gboolean delete_events, EventCalendar *new_parent, GError **error);
event_calendar : |
|
delete_events : |
|
new_parent : |
|
error : |
gboolean event_calendar_get_visible (EventCalendar *ec, GError **error);
ec : |
|
error : |
|
Returns : |
void event_calendar_set_visible (EventCalendar *ec, gboolean visible, GError **error);
ec : |
|
visible : |
|
error : |
gboolean event_calendar_valid_parent (EventCalendar *ec, EventCalendar *new_parent, GError **error);
ec : |
|
new_parent : |
|
error : |
|
Returns : |
EventCalendar* event_calendar_get_parent (EventCalendar *ec, GError **error);
ec : |
|
error : |
|
Returns : |
void event_calendar_set_parent (EventCalendar *ec, EventCalendar *p, GError **error);
ec : |
|
p : |
|
error : |
char* event_calendar_get_title (EventCalendar *ec, GError **error);
ec : |
|
error : |
|
Returns : |
void event_calendar_set_title (EventCalendar *ec, const char *title, GError **error);
ec : |
|
title : |
|
error : |
char* event_calendar_get_description (EventCalendar *ec, GError **error);
ec : |
|
error : |
|
Returns : |
void event_calendar_set_description (EventCalendar *ec, const char *description, GError **error);
ec : |
|
description : |
|
error : |
char* event_calendar_get_url (EventCalendar *ev, GError **error);
ev : |
|
error : |
|
Returns : |
void event_calendar_set_url (EventCalendar *ec, const char *url, GError **error);
ec : |
|
url : |
|
error : |
char* event_calendar_get_username (EventCalendar *ev, GError **error);
ev : |
|
error : |
|
Returns : |
void event_calendar_set_username (EventCalendar *ec, const char *username, GError **error);
ec : |
|
username : |
|
error : |
char* event_calendar_get_password (EventCalendar *ev, GError **error);
ev : |
|
error : |
|
Returns : |
void event_calendar_set_password (EventCalendar *ec, const char *password, GError **error);
ec : |
|
password : |
|
error : |
int event_calendar_get_mode (EventCalendar *ec, GError **error);
ec : |
|
error : |
|
Returns : |
void event_calendar_set_mode (EventCalendar *ec, int mode, GError **error);
ec : |
|
mode : |
|
error : |
gboolean event_calendar_get_color (EventCalendar *ec, struct _GdkColor *color, GError **error);
ec : |
|
color : |
|
error : |
|
Returns : |
void event_calendar_set_color (EventCalendar *ec, const struct _GdkColor *color, GError **error);
ec : |
|
color : |
|
error : |
int event_calendar_get_sync_interval (EventCalendar *ec, GError **error);
ec : |
|
error : |
|
Returns : |
void event_calendar_set_sync_interval (EventCalendar *ec, int sync_interval, GError **error);
ec : |
|
sync_interval : |
|
error : |
time_t event_calendar_get_last_pull (EventCalendar *ec, GError **error);
ec : |
|
error : |
|
Returns : |
void event_calendar_set_last_pull (EventCalendar *ec, time_t last_pull, GError **error);
ec : |
|
last_pull : |
|
error : |
time_t event_calendar_get_last_push (EventCalendar *ec, GError **error);
ec : |
|
error : |
|
Returns : |
void event_calendar_set_last_push (EventCalendar *ec, time_t last_push, GError **error);
ec : |
|
last_push : |
|
error : |
time_t event_calendar_get_last_modification (EventCalendar *ec, GError **error);
ec : |
|
error : |
|
Returns : |
GSList* event_calendar_list_events (EventCalendar *ec, GError **error);
ec : |
|
error : |
|
Returns : |
GSList* event_calendar_list_events_modified_between (EventCalendar *ec, time_t start, time_t end, GError **error);
ec : |
|
start : |
|
end : |
|
error : |
|
Returns : |
GSList* event_calendar_list_deleted (EventCalendar *ec, GError **error);
Retrieve a list of deleted events since the last
event_calendar_flush_deleted()
call. The events contain a very
basic set of information only and should be used to indicate wether
a particular event was deleted or not only. The returned list of
events needs to be freed by the caller.
ec : |
|
error : |
|
Returns : |
void event_calendar_flush_deleted (EventCalendar *ec, GError **error);
ec : |
|
error : |
GSList* event_calendar_list_calendars (EventCalendar *ec, GError **error);
ec : |
|
error : |
|
Returns : |
gint event_alarm_compare_func (gconstpointer a, gconstpointer b);
a : |
|
b : |
|
Returns : |
Event* event_new (EventDB *edb, EventCalendar *ec, const char *eventid, GError **error);
edb : |
|
ec : |
|
eventid : |
|
error : |
|
Returns : |
void event_list_unref (GSList *l);
g_object_unref each Event * on the list and destroy the list.
l : |
EventCalendar* event_get_calendar (Event *ev, GError **error);
ev : |
|
error : |
|
Returns : |
void event_set_calendar (Event *ev, EventCalendar *ec, GError **error);
ev : |
|
ec : |
|
error : |
gboolean event_get_color (Event *ev, struct _GdkColor *color, GError **error);
ev : |
|
color : |
|
error : |
|
Returns : |
void event_set_duration (Event *ev, long duration , GError **error);
ev : |
|
Param2 : |
|
error : |
void event_set_alarm (Event *ev, long alarm , GError **error);
ev : |
|
Param2 : |
|
error : |
guint32 event_get_sequence (Event *ev, GError **error);
ev : |
|
error : |
|
Returns : |
void event_set_sequence (Event *ev, guint32 sequence, GError **error);
ev : |
|
sequence : |
|
error : |
enum event_recurrence_type event_get_recurrence_type (Event *ev);
ev : |
|
Returns : |
void event_set_recurrence_type (Event *ev, enum event_recurrence_type type, GError **error);
ev : |
|
type : |
|
error : |
void event_set_recurrence_start (Event *ev, time_t start, GError **error);
ev : |
|
start : |
|
error : |
void event_set_recurrence_end (Event *ev, time_t end, GError **error);
ev : |
|
end : |
|
error : |
void event_set_recurrence_count (Event *ev, guint32 count, GError **error);
ev : |
|
count : |
|
error : |
guint32 event_get_recurrence_increment (Event *ev);
ev : |
|
Returns : |
void event_set_recurrence_increment (Event *ev, guint32 increment, GError **error);
ev : |
|
increment : |
|
error : |
GSList* event_get_recurrence_byday (Event *ev, GError **error);
ev : |
|
error : |
|
Returns : |
void event_set_recurrence_byday (Event *event, GSList *list, GError **error);
event : |
|
list : |
|
error : |
void event_add_recurrence_exception (Event *ev, time_t start, GError **error);
ev : |
|
start : |
|
error : |
void event_set_untimed (Event *ev, gboolean value, GError **error);
ev : |
|
value : |
|
error : |
void event_set_summary (Event *ev, const char *summary, GError **error);
ev : |
|
summary : |
|
error : |
char* event_get_description (Event *ev, GError **error);
ev : |
|
error : |
|
Returns : |
void event_set_description (Event *ev, const char *description, GError **error);
ev : |
|
description : |
|
error : |
void event_set_location (Event *ev, const char *location, GError **error);
ev : |
|
location : |
|
error : |
GSList* event_get_categories (Event *ev, GError **error);
ev : |
|
error : |
|
Returns : |
void event_add_category (Event *ev, int category, GError **error);
ev : |
|
category : |
|
error : |
void user_function (EventDB *eventdb, gpointer arg1, gpointer user_data) : Run Last
@: @:
void user_function (EventDB *eventdb, gpointer arg1, gpointer user_data) : Run Last
@: @:
void user_function (EventDB *eventdb, gpointer arg1, gpointer user_data) : Run Last
@: @:
void user_function (EventDB *eventdb, gpointer arg1, gpointer user_data) : Run Last
@: @:
void user_function (EventDB *eventdb, gpointer arg1, gpointer user_data) : Run Last
@: @:
void user_function (EventDB *eventdb, gpointer arg1, gpointer user_data) : Run Last
@: @:
void user_function (EventDB *eventdb, gpointer arg1, gpointer user_data) : Run Last
@: @:
void user_function (EventDB *eventdb, gpointer arg1, gpointer user_data) : Run Last
@: @:
void user_function (EventDB *eventdb, gpointer arg1, gpointer user_data) : Run Last
@: @:
void user_function (EventDB *eventdb, gpointer arg1, gpointer user_data) : Run Last
@: @:
void user_function (EventDB *eventdb, gpointer arg1, gpointer user_data) : Run Last
@: @:
void user_function (EventDB *eventdb, gpointer arg1, gpointer user_data) : Run Last
@: @:
void user_function (EventDB *eventdb, gpointer arg1, gpointer user_data) : Run Last
@: @:
void user_function (EventDB *eventdb, gpointer arg1, gpointer user_data) : Run Last
@: @:
void user_function (EventDB *eventdb, gpointer arg1, gpointer user_data) : Run Last
@: @:
void user_function (EventDB *eventdb, gpointer arg1, gpointer user_data) : Run Last
@: @:
void user_function (EventDB *eventdb, gpointer arg1, gpointer user_data) : Run Last
@: @:
void user_function (EventDB *eventdb, gpointer arg1, gpointer user_data) : Run Last
@: @:
void user_function (EventDB *eventdb, gpointer arg1, gpointer user_data) : Run Last
@: @: