KPComment

KPComment — Class for comments in KPTrainingLog

Synopsis




KPComment*  kp_comment_new                  (const gchar *title,
                                             const gchar *text);
KPComment*  kp_comment_copy                 (KPComment *comment);
void        kp_comment_set_title            (KPComment *comment,
                                             const gchar *title);
void        kp_comment_set_text             (KPComment *comment,
                                             const gchar *text);
gchar*      kp_comment_get_title            (KPComment *comment);
gchar*      kp_comment_get_text             (KPComment *comment);
gchar*      kp_comment_get_formatted_date   (KPComment *comment);

Description

KPComment class provides things which are needed for comments in the training log.

Details

kp_comment_new ()

KPComment*  kp_comment_new                  (const gchar *title,
                                             const gchar *text);

Create a new instance of KPComment.

title : The title of the comment
text : The comment
Returns : A KPComment

kp_comment_copy ()

KPComment*  kp_comment_copy                 (KPComment *comment);

comment :
Returns :

kp_comment_set_title ()

void        kp_comment_set_title            (KPComment *comment,
                                             const gchar *title);

Set the title of the comment.

comment : A KPComment
title : The title to set

kp_comment_set_text ()

void        kp_comment_set_text             (KPComment *comment,
                                             const gchar *text);

Set the body of the comment to text.

comment : A KPComment
text : The body of the comment

kp_comment_get_title ()

gchar*      kp_comment_get_title            (KPComment *comment);

Retrieve the title of the comment.

comment : A KPComment
Returns : A newly-allocated string that must be freed or NULL.

kp_comment_get_text ()

gchar*      kp_comment_get_text             (KPComment *comment);

Retrieve the body of the comment.

comment : A KPComment
Returns : A newly-allocated string that must be freed or NULL.

kp_comment_get_formatted_date ()

gchar*      kp_comment_get_formatted_date   (KPComment *comment);

comment :
Returns :

See Also

KPWorkout,KPSplitWorkout