gammu-calendar.h

Go to the documentation of this file.

#ifndef __gammu_calendar_h
#define __gammu_calendar_h

#ifdef  __cplusplus
extern "C" {
#endif

#include <gammu-datetime.h>
#include <gammu-limits.h>
#include <gammu-debug.h>

typedef struct {
        int StartDay;
        int AutoDelete;
} GSM_CalendarSettings;

typedef struct {
        int Free;
        int Used;
} GSM_ToDoStatus;

typedef struct {
        int Free;
        int Used;
} GSM_CalendarStatus;

typedef enum {
        GSM_CAL_REMINDER = 1,
        GSM_CAL_CALL,
        GSM_CAL_MEETING,
        GSM_CAL_BIRTHDAY,
        GSM_CAL_MEMO,
        GSM_CAL_TRAVEL,
        GSM_CAL_VACATION,
        GSM_CAL_T_ATHL,
        GSM_CAL_T_BALL,
        GSM_CAL_T_CYCL,
        GSM_CAL_T_BUDO,
        GSM_CAL_T_DANC,
        GSM_CAL_T_EXTR,
        GSM_CAL_T_FOOT,
        GSM_CAL_T_GOLF,
        GSM_CAL_T_GYM,
        GSM_CAL_T_HORS,
        GSM_CAL_T_HOCK,
        GSM_CAL_T_RACE,
        GSM_CAL_T_RUGB,
        GSM_CAL_T_SAIL,
        GSM_CAL_T_STRE,
        GSM_CAL_T_SWIM,
        GSM_CAL_T_TENN,
        GSM_CAL_T_TRAV,
        GSM_CAL_T_WINT,
        GSM_CAL_ALARM,
        GSM_CAL_DAILY_ALARM,
        GSM_CAL_SHOPPING,
} GSM_CalendarNoteType;

typedef enum {
        CAL_START_DATETIME = 1,
        CAL_END_DATETIME,
        CAL_TONE_ALARM_DATETIME,
        CAL_SILENT_ALARM_DATETIME,
        CAL_TEXT,
        CAL_DESCRIPTION,
        CAL_LOCATION,
        CAL_PHONE,
        CAL_PRIVATE,
        CAL_CONTACTID,          /* 10 */
        CAL_REPEAT_DAYOFWEEK,
        CAL_REPEAT_DAY,
        CAL_REPEAT_DAYOFYEAR,
        CAL_REPEAT_WEEKOFMONTH,
        CAL_REPEAT_MONTH,
        CAL_REPEAT_FREQUENCY,
        CAL_REPEAT_STARTDATE,
        CAL_REPEAT_STOPDATE,
        CAL_REPEAT_COUNT,
        CAL_LUID,               /* 20 */
        CAL_LAST_MODIFIED,
} GSM_CalendarType;

typedef struct {
        GSM_CalendarType EntryType;
        GSM_DateTime Date;
        int Number;
        GSM_Error AddError;
        unsigned char Text[(GSM_MAX_CALENDAR_TEXT_LENGTH + 1) * 2];
} GSM_SubCalendarEntry;

typedef struct {
        GSM_CalendarNoteType Type;
        int Location;
        int EntriesNum;
        GSM_SubCalendarEntry Entries[GSM_CALENDAR_ENTRIES];
} GSM_CalendarEntry;

void GSM_CalendarFindDefaultTextTimeAlarmPhone(GSM_CalendarEntry * entry,
                                               int *Text, int *Time, int *Alarm,
                                               int *Phone, int *EndTime,
                                               int *Location);

typedef enum {
        TODO_END_DATETIME = 1,
        TODO_COMPLETED,
        TODO_ALARM_DATETIME,
        TODO_SILENT_ALARM_DATETIME,
        TODO_TEXT,
        TODO_DESCRIPTION,
        TODO_LOCATION,
        TODO_PRIVATE,
        TODO_CATEGORY,
        TODO_CONTACTID,
        TODO_PHONE,
        TODO_LUID,
        TODO_LAST_MODIFIED,
        TODO_START_DATETIME,
        TODO_COMPLETED_DATETIME,
} GSM_ToDoType;

typedef enum {
        GSM_Priority_None = 0,
        GSM_Priority_High,
        GSM_Priority_Medium,
        GSM_Priority_Low,
        GSM_Priority_INVALID
} GSM_ToDo_Priority;

typedef struct {
        GSM_ToDoType EntryType;
        GSM_DateTime Date;
        unsigned int Number;
        unsigned char Text[(GSM_MAX_TODO_TEXT_LENGTH + 1) * 2];
} GSM_SubToDoEntry;

typedef struct {
        GSM_CalendarNoteType Type;
        GSM_ToDo_Priority Priority;
        int Location;
        int EntriesNum;
        GSM_SubToDoEntry Entries[GSM_TODO_ENTRIES];
} GSM_ToDoEntry;

typedef struct {
        int Location;
        char Text[(GSM_MAX_NOTE_TEXT_LENGTH + 1) * 2];
} GSM_NoteEntry;

typedef struct {
        int Location;
        GSM_DateTime DateTime;
        gboolean Repeating;
        unsigned char Text[(GSM_MAX_CALENDAR_TEXT_LENGTH + 1) * 2];
} GSM_Alarm;

typedef enum {
        Nokia_VToDo = 1,
        SonyEricsson_VToDo,
        Mozilla_VToDo,
} GSM_VToDoVersion;

typedef enum {
        Nokia_VCalendar = 1,
        Siemens_VCalendar,
        SonyEricsson_VCalendar,
        Mozilla_iCalendar,
} GSM_VCalendarVersion;

GSM_Error GSM_EncodeVTODO(char *Buffer, const size_t buff_len, size_t * Length,
                          const GSM_ToDoEntry * note, const gboolean header,
                          const GSM_VToDoVersion Version);

GSM_Error GSM_EncodeVCALENDAR(char *Buffer, const size_t buff_len,
                              size_t * Length, GSM_CalendarEntry * note,
                              const gboolean header,
                              const GSM_VCalendarVersion Version);

GSM_Error GSM_DecodeVNOTE(char *Buffer, size_t * Pos, GSM_NoteEntry * Note);

GSM_Error GSM_EncodeVNTFile(char *Buffer, const size_t buff_len,
                            size_t * Length, GSM_NoteEntry * Note);

GSM_Error GSM_DecodeVCALENDAR_VTODO(GSM_Debug_Info * di, char *Buffer,
                                    size_t * Pos, GSM_CalendarEntry * Calendar,
                                    GSM_ToDoEntry * ToDo,
                                    GSM_VCalendarVersion CalVer,
                                    GSM_VToDoVersion ToDoVer);

gboolean GSM_IsCalendarNoteFromThePast(GSM_CalendarEntry * note);

GSM_Error GSM_GetAlarm(GSM_StateMachine * s, GSM_Alarm * Alarm);

GSM_Error GSM_SetAlarm(GSM_StateMachine * s, GSM_Alarm * Alarm);

GSM_Error GSM_GetToDoStatus(GSM_StateMachine * s, GSM_ToDoStatus * status);

GSM_Error GSM_GetToDo(GSM_StateMachine * s, GSM_ToDoEntry * ToDo);

GSM_Error GSM_GetNextToDo(GSM_StateMachine * s, GSM_ToDoEntry * ToDo,
                          gboolean start);
GSM_Error GSM_SetToDo(GSM_StateMachine * s, GSM_ToDoEntry * ToDo);

GSM_Error GSM_AddToDo(GSM_StateMachine * s, GSM_ToDoEntry * ToDo);

GSM_Error GSM_DeleteToDo(GSM_StateMachine * s, GSM_ToDoEntry * ToDo);

GSM_Error GSM_DeleteAllToDo(GSM_StateMachine * s);

GSM_Error GSM_GetCalendarStatus(GSM_StateMachine * s,
                                GSM_CalendarStatus * Status);
GSM_Error GSM_GetCalendar(GSM_StateMachine * s, GSM_CalendarEntry * Note);

GSM_Error GSM_GetNextCalendar(GSM_StateMachine * s, GSM_CalendarEntry * Note,
                              gboolean start);
GSM_Error GSM_SetCalendar(GSM_StateMachine * s, GSM_CalendarEntry * Note);

GSM_Error GSM_AddCalendar(GSM_StateMachine * s, GSM_CalendarEntry * Note);

GSM_Error GSM_DeleteCalendar(GSM_StateMachine * s, GSM_CalendarEntry * Note);

GSM_Error GSM_DeleteAllCalendar(GSM_StateMachine * s);

GSM_Error GSM_GetCalendarSettings(GSM_StateMachine * s,
                                  GSM_CalendarSettings * settings);
GSM_Error GSM_SetCalendarSettings(GSM_StateMachine * s,
                                  GSM_CalendarSettings * settings);
GSM_Error GSM_GetNotesStatus(GSM_StateMachine * s, GSM_ToDoStatus * status);

GSM_Error GSM_GetNote(GSM_StateMachine * s, GSM_NoteEntry * Note);

GSM_Error GSM_GetNextNote(GSM_StateMachine * s, GSM_NoteEntry * Note,
                          gboolean start);
GSM_Error GSM_SetNote(GSM_StateMachine * s, GSM_NoteEntry * Note);

GSM_Error GSM_AddNote(GSM_StateMachine * s, GSM_NoteEntry * Note);

GSM_Error GSM_DeleteNote(GSM_StateMachine * s, GSM_NoteEntry * Note);

GSM_Error GSM_DeleteAllNotes(GSM_StateMachine * s);

#ifdef  __cplusplus
}
#endif
#endif

/* Editor configuration
 * vim: noexpandtab sw=8 ts=8 sts=8 tw=72:
 */