RNotes

RNotes

Synopsis




#define             R_NOTES_TYPE
#define             R_NOTES                             (obj)
#define             R_NOTES_CLASS                       (klass)
#define             IS_R_NOTES                          (obj)
#define             IS_R_NOTES_CLASS                    (klass)
#define             R_NOTES_GET_CLASS                   (klass)
                    RNotesPrivate;
                    RNotes;
GType               r_notes_get_type                    (void);
RNotes*             r_notes_new                         (void);
void                r_notes_free                        (RNotes *notes);
gboolean            r_notes_search                      (RNotes *notes,
                                                         const gchar *str);
RNotes*             r_notes_copy                        (RNotes *notes);
void                r_notes_set_know_birthday           (RNotes *notes,
                                                         gboolean know);
void                r_notes_set_know_anniversary        (RNotes *notes,
                                                         gboolean know);
void                r_notes_set_birthday                (RNotes *notes,
                                                         gint day,
                                                         gint month,
                                                         gint year);
void                r_notes_set_anniversary             (RNotes *notes,
                                                         gint day,
                                                         gint month,
                                                         gint year);
RDate*              r_notes_get_birthday                (RNotes *notes);
RDate*              r_notes_get_anniversary             (RNotes *notes);
gboolean            r_notes_have_data                   (RNotes *notes);
gboolean            r_notes_know_birthday               (RNotes *notes);
gboolean            r_notes_know_anniversary            (RNotes *notes);
gchar*              r_notes_get_birth_day               (RNotes *notes);
gchar*              r_notes_get_birth_month             (RNotes *notes);
gchar*              r_notes_get_birth_year              (RNotes *notes);
gchar*              r_notes_get_anniversary_day         (RNotes *notes);
gchar*              r_notes_get_anniversary_month       (RNotes *notes);
gchar*              r_notes_get_anniversary_year        (RNotes *notes);
gchar*              r_notes_get_birth_date              (RNotes *notes);
gchar*              r_notes_get_anniversary_date        (RNotes *notes);
void                r_notes_append_other_notes          (RNotes *notes,
                                                         gchar *other_note);

Object Hierarchy


  GObject
   +----RNotes

Properties


  "has-partner"              gboolean              : Read / Write / Construct
  "other-notes"              gchararray            : Read / Write / Construct
  "partner-name"             gchararray            : Read / Write / Construct
  "pubkey"                   gchararray            : Read / Write / Construct

Description

Details

R_NOTES_TYPE

#define R_NOTES_TYPE             (r_notes_get_type())


R_NOTES()

#define             R_NOTES(obj)

obj :


R_NOTES_CLASS()

#define             R_NOTES_CLASS(klass)

klass :


IS_R_NOTES()

#define             IS_R_NOTES(obj)

obj :


IS_R_NOTES_CLASS()

#define             IS_R_NOTES_CLASS(klass)

klass :


R_NOTES_GET_CLASS()

#define             R_NOTES_GET_CLASS(klass)

klass :


RNotesPrivate

typedef struct _RNotesPrivate RNotesPrivate;


RNotes

typedef struct _RNotes RNotes;


r_notes_get_type ()

GType               r_notes_get_type                    (void);

Returns :


r_notes_new ()

RNotes*             r_notes_new                         (void);

create a new RNotes

Returns :

a RNotes*

r_notes_free ()

void                r_notes_free                        (RNotes *notes);

free memory owned by notes

notes :

a RNotes

r_notes_search ()

gboolean            r_notes_search                      (RNotes *notes,
                                                         const gchar *str);

notes :

str :

Returns :


r_notes_copy ()

RNotes*             r_notes_copy                        (RNotes *notes);

copy the given notes

notes :

a RNotes

Returns :

a new allocated RNotes*

r_notes_set_know_birthday ()

void                r_notes_set_know_birthday           (RNotes *notes,
                                                         gboolean know);

set the know birthday flag

notes :

a RNotes

know :

gboolean

r_notes_set_know_anniversary ()

void                r_notes_set_know_anniversary        (RNotes *notes,
                                                         gboolean know);

set the know anniversary flag

notes :

a RNotes

know :

gboolean

r_notes_set_birthday ()

void                r_notes_set_birthday                (RNotes *notes,
                                                         gint day,
                                                         gint month,
                                                         gint year);

set the partner's birthday

notes :

a RNotes

day :

month :

year :


r_notes_set_anniversary ()

void                r_notes_set_anniversary             (RNotes *notes,
                                                         gint day,
                                                         gint month,
                                                         gint year);

set the contact's and his/her partner anniversary

notes :

a RNotes

day :

month :

year :


r_notes_get_birthday ()

RDate*              r_notes_get_birthday                (RNotes *notes);

notes :

Returns :


r_notes_get_anniversary ()

RDate*              r_notes_get_anniversary             (RNotes *notes);

notes :

Returns :


r_notes_have_data ()

gboolean            r_notes_have_data                   (RNotes *notes);

notes :

Returns :


r_notes_know_birthday ()

gboolean            r_notes_know_birthday               (RNotes *notes);

notes :

Returns :


r_notes_know_anniversary ()

gboolean            r_notes_know_anniversary            (RNotes *notes);

get the known_anniversary flag value

notes :

a RNotes

Returns :

gboolean. TRUE if contact and his/her partner's anniversary is known, FALSE otherwise

r_notes_get_birth_day ()

gchar*              r_notes_get_birth_day               (RNotes *notes);

get the partner's birth day. Caller must free the returned value

notes :

a RNotes

Returns :

a gchar*

r_notes_get_birth_month ()

gchar*              r_notes_get_birth_month             (RNotes *notes);

get the partner's birth month. Caller must free the returned value

notes :

a RNotes

Returns :

a gchar*

r_notes_get_birth_year ()

gchar*              r_notes_get_birth_year              (RNotes *notes);

get the partner's birth year. Caller must free the returned value

notes :

a RNotes

Returns :

a gchar*

r_notes_get_anniversary_day ()

gchar*              r_notes_get_anniversary_day         (RNotes *notes);

get the anniversary day. Caller must free the returned value

notes :

a RNotes

Returns :

a gchar*

r_notes_get_anniversary_month ()

gchar*              r_notes_get_anniversary_month       (RNotes *notes);

get the anniversary month. Caller must free the returned value

notes :

a RNotes

Returns :

a gchar*

r_notes_get_anniversary_year ()

gchar*              r_notes_get_anniversary_year        (RNotes *notes);

get the anniversary year. Caller must free the returned value

notes :

a RNotes

Returns :

a gchar*

r_notes_get_birth_date ()

gchar*              r_notes_get_birth_date              (RNotes *notes);

get partner's birthday, or unknown. Caller must free the returned value

notes :

a RNotes

Returns :

a gchar*

r_notes_get_anniversary_date ()

gchar*              r_notes_get_anniversary_date        (RNotes *notes);

get contact and partner's anniversary, or unknown. Caller must free the returned value

notes :

a RNotes

Returns :

a gchar*

r_notes_append_other_notes ()

void                r_notes_append_other_notes          (RNotes *notes,
                                                         gchar *other_note);

append to other note

notes :

a RNotes

other_note :

Property Details

The "has-partner" property

  "has-partner"              gboolean              : Read / Write / Construct

contact has got a partner

Default value: FALSE


The "other-notes" property

  "other-notes"              gchararray            : Read / Write / Construct

contact's hobbies and other notes.

Default value: NULL


The "partner-name" property

  "partner-name"             gchararray            : Read / Write / Construct

partner's name (first name last name)

Default value: NULL


The "pubkey" property

  "pubkey"                   gchararray            : Read / Write / Construct

contact's public key

Default value: NULL