# MIMEDirVTodo

## Name

MIMEDirVTodo -- iCalendar todo object

## Synopsis

    #include <mimedir/mimedir-vtodo.h>

                        MIMEDirVTodo;

    MIMEDirVTodo*       mimedir_vtodo_new                   (void);
    MIMEDirVTodo*       mimedir_vtodo_new_from_profile      (MIMEDirProfile *profile,
                                                             GError **error);
    gboolean            mimedir_vtodo_read_from_profile     (MIMEDirVTodo *vtodo,
                                                             MIMEDirProfile *profile,
                                                             GError **error);
    gboolean            mimedir_vtodo_write_to_channel      (MIMEDirVTodo *vtodo,
                                                             GIOChannel *channel,
                                                             GError **error);
    MIMEDirProfile*     mimedir_vtodo_write_to_profile      (MIMEDirVTodo *vtodo);
    gchar*              mimedir_vtodo_write_to_string       (MIMEDirVTodo *vtodo);

## Description

## Details

### MIMEDirVTodo

    typedef struct {
    	MIMEDirVComponent parent;

    	MIMEDirVTodoPriv *priv;
    } MIMEDirVTodo;

### mimedir_vtodo_new ()

    MIMEDirVTodo*       mimedir_vtodo_new                   (void);

Creates a new (empty) vTodo object.

Returns : | a new vTodo object

### mimedir_vtodo_new_from_profile ()

    MIMEDirVTodo*       mimedir_vtodo_new_from_profile      (MIMEDirProfile *profile,
                                                             GError **error);

Create a new vTodo object and fills it with data retrieved from the supplied profile object. If an error occurs during the read, `error` will be set and `NULL` will be returned.

`profile` : | a MIMEDirProfile object
`error` : | error storage location or `NULL`
Returns : | the new vTodo object or `NULL`

### mimedir_vtodo_read_from_profile ()

    gboolean            mimedir_vtodo_read_from_profile     (MIMEDirVTodo *vtodo,
                                                             MIMEDirProfile *profile,
                                                             GError **error);

Clears the supplied vTodo object and re-initializes it with data read from the supplied profile. If an error occurs during the read, `error` will be set and `FALSE` will be returned. Otherwise, `TRUE` is returned.

`vtodo` : | a vTodo object
`profile` : | a profile object
`error` : | error storage location or `NULL`
Returns : | success indicator

### mimedir_vtodo_write_to_channel ()

    gboolean            mimedir_vtodo_write_to_channel      (MIMEDirVTodo *vtodo,
                                                             GIOChannel *channel,
                                                             GError **error);

Saves the vtodo object to the supplied I/O channel. If an error occurs during the write, `error` will be set and `FALSE` will be returned. Otherwise, `TRUE` is returned.

`vtodo` : | a vtodo
`channel` : | I/O channel to save to
`error` : | error storage location or `NULL`
Returns : | success indicator

### mimedir_vtodo_write_to_profile ()

    MIMEDirProfile*     mimedir_vtodo_write_to_profile      (MIMEDirVTodo *vtodo);

Saves the vtodo object to a newly allocated profile object.

`vtodo` : | a vtodo
Returns : | a new profile

### mimedir_vtodo_write_to_string ()

    gchar*              mimedir_vtodo_write_to_string       (MIMEDirVTodo *vtodo);

Saves the vtodo object to a newly allocated memory buffer. You should free the returned buffer with `g_free()`.

`vtodo` : | a vtodo
Returns : | a newly allocated memory buffer