Todo

Data Structures
struct	GSM_ToDoStatus
struct	GSM_SubToDoEntry
struct	GSM_ToDoEntry
Enumerations
enum	GSM_ToDoType {   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 }
enum	GSM_ToDo_Priority { GSM_Priority_None = 0, GSM_Priority_High, GSM_Priority_Medium, GSM_Priority_Low }
enum	GSM_VToDoVersion { Nokia_VToDo = 1, SonyEricsson_VToDo, Mozilla_VToDo }
Functions
GSM_Error	GSM_EncodeVTODO (char *Buffer, const size_t buff_len, size_t *Length, GSM_ToDoEntry *note, const bool header, const GSM_VToDoVersion Version)
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, bool 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)

---

Detailed Description

Todo entries manipulations.

---

Enumeration Type Documentation

enum GSM_ToDo_Priority

Priority of to do.

Enumerator:

GSM_Priority_None
GSM_Priority_High
GSM_Priority_Medium
GSM_Priority_Low

Definition at line 421 of file gammu-calendar.h.

             {
        GSM_Priority_None = 0,
        GSM_Priority_High,
        GSM_Priority_Medium,
        GSM_Priority_Low
} GSM_ToDo_Priority;

enum GSM_ToDoType

Types of to do values. In parenthesis is member of GSM_SubToDoEntry, where value is stored.

Enumerator:

TODO_END_DATETIME	Due date. (Date)
TODO_COMPLETED	Whether is completed. (Number)
TODO_ALARM_DATETIME	When should alarm be fired (Date).
TODO_SILENT_ALARM_DATETIME	When should silent alarm be fired (Date).
TODO_TEXT	Text of to do (Text).
TODO_DESCRIPTION	Description of to do (Text).
TODO_LOCATION	Location of to do (Text).
TODO_PRIVATE	Whether entry is private (Number).
TODO_CATEGORY	Category of entry (Number).
TODO_CONTACTID	Related contact ID (Number).
TODO_PHONE	Number to call (Text).
TODO_LUID	IrMC LUID which can be used for synchronisation.
TODO_LAST_MODIFIED	Date and time of last modification.
TODO_START_DATETIME	Start date. (Date)

Definition at line 357 of file gammu-calendar.h.

             {
        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,
} GSM_ToDoType;

enum GSM_VToDoVersion

Format of vTodo.

Enumerator:

Nokia_VToDo	Format compatible with Nokia - limited subsed of standard.
SonyEricsson_VToDo	Format compatible with SonyEricsson - complete standard.
Mozilla_VToDo	Format compatible with Mozilla - iCalendar based.

Definition at line 525 of file gammu-calendar.h.

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

---

Function Documentation

GSM_Error GSM_AddToDo	(	GSM_StateMachine *	s,
		GSM_ToDoEntry *	ToDo
	)

Adds ToDo in phone.

Parameters:

	s	State machine pointer.
	ToDo	ToDo to add.

Returns:

Error code

GSM_Error GSM_DeleteAllToDo

(

GSM_StateMachine *

s

)

Deletes all todo entries in phone.

Parameters:

s

State machine pointer.

Returns:

Error code

GSM_Error GSM_DeleteToDo	(	GSM_StateMachine *	s,
		GSM_ToDoEntry *	ToDo
	)

Deletes ToDo entry in phone.

Parameters:

	s	State machine pointer.
	ToDo	ToDo to delete, only location is actually used.

Returns:

Error code

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

Encodes vTodo to buffer.

Parameters:

	Buffer	Storage for data.
[in]	buff_len	Size of output buffer.
	Length	Pointer to current position in data (will be incremented).
	note	Note to encode.
	header	Whether to include vCalendar header.
	Version	Format of vTodo to create.

Returns:

Error code.

GSM_Error GSM_GetNextToDo	(	GSM_StateMachine *	s,
		GSM_ToDoEntry *	ToDo,
		bool	start
	)

Reads ToDo from phone.

Parameters:

	s	State machine pointer.
	ToDo	Storage for note, if start is false, should contain data from previous read (at least position).
	start	Whether we're doing initial read or continue in reading.

Returns:

Error code

GSM_Error GSM_GetToDo	(	GSM_StateMachine *	s,
		GSM_ToDoEntry *	ToDo
	)

Reads ToDo from phone.

Parameters:

	s	State machine pointer.
	ToDo	Storage for note.

Returns:

Error code

GSM_Error GSM_GetToDoStatus	(	GSM_StateMachine *	s,
		GSM_ToDoStatus *	status
	)

Gets status of ToDos (count of used entries).

Parameters:

	s	State machine pointer.
	status	Storage for todo status.

Returns:

Error code

GSM_Error GSM_SetToDo	(	GSM_StateMachine *	s,
		GSM_ToDoEntry *	ToDo
	)

Sets ToDo in phone.

Parameters:

	s	State machine pointer.
	ToDo	ToDo to set, should contain valid location.

Returns:

Error code