JanaNote

JanaNote — A note/memo/journal component interface

Synopsis

                    JanaNote;
gchar *             jana_note_get_author                (JanaNote *note);
gchar *             jana_note_get_recipient             (JanaNote *note);
gchar *             jana_note_get_body                  (JanaNote *note);
JanaTime *          jana_note_get_creation_time         (JanaNote *note);
JanaTime *          jana_note_get_modified_time         (JanaNote *note);
void                jana_note_set_author                (JanaNote *note,
                                                         const gchar *author);
void                jana_note_set_recipient             (JanaNote *note,
                                                         const gchar *recipient);
void                jana_note_set_body                  (JanaNote *note,
                                                         const gchar *body);
void                jana_note_set_creation_time         (JanaNote *note,
                                                         JanaTime *time);

Object Hierarchy

  GInterface
   +----JanaNote

Prerequisites

JanaNote requires GObject.

Description

JanaNote is the interface for components that store miscellaneus textual information.

Details

JanaNote

typedef struct _JanaNote JanaNote;

The JanaNote struct contains only private data.


jana_note_get_author ()

gchar *             jana_note_get_author                (JanaNote *note);

Retrieves the author of the note.

note :

A JanaNote

Returns :

A newly allocated string containing the author of the note, or NULL.

jana_note_get_recipient ()

gchar *             jana_note_get_recipient             (JanaNote *note);

Retrieves the recipient of the note.

note :

A JanaNote

Returns :

A newly allocated string containing the recipient of the note, or NULL.

jana_note_get_body ()

gchar *             jana_note_get_body                  (JanaNote *note);

Retrieves the note body.

note :

A JanaNote

Returns :

A newly allocated string containing the body of the note, or NULL.

jana_note_get_creation_time ()

JanaTime *          jana_note_get_creation_time         (JanaNote *note);

Retrieves the creation time of the note.

note :

A JanaNote

Returns :

A JanaTime filled with the creation time of the note.

jana_note_get_modified_time ()

JanaTime *          jana_note_get_modified_time         (JanaNote *note);

Retrieves the time of the last modification to this note.

note :

A JanaNote

Returns :

A JanaTime filled with the last modification time of the note.

jana_note_set_author ()

void                jana_note_set_author                (JanaNote *note,
                                                         const gchar *author);

Sets the author of the note.

note :

A JanaNote

author :

The author of the note, or NULL

jana_note_set_recipient ()

void                jana_note_set_recipient             (JanaNote *note,
                                                         const gchar *recipient);

Sets the recipient of the note.

note :

A JanaNote

recipient :

The recipient of the note, or NULL

jana_note_set_body ()

void                jana_note_set_body                  (JanaNote *note,
                                                         const gchar *body);

Sets the body of the note.

note :

A JanaNote

body :

The note body

jana_note_set_creation_time ()

void                jana_note_set_creation_time         (JanaNote *note,
                                                         JanaTime *time);

Sets the creation time of the note. The creation time is automatically set to the current local time when created, but this allows it to be overridden. This can be useful to back-date notes, for example, or to set a particular timezone on a note.

note :

A JanaNote

time :

A JanaTime

See Also

JanaComponent