| GData Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | ||||
#include <gdata/gd/gdata-gd-reminder.h>
GDataGDReminder;
GDataGDReminderClass;
GDataGDReminder * gdata_gd_reminder_new (const gchar *method,
GTimeVal *absolute_time,
gint relative_time);
gint gdata_gd_reminder_compare (const GDataGDReminder *a,
const GDataGDReminder *b);
const gchar * gdata_gd_reminder_get_method (GDataGDReminder *self);
void gdata_gd_reminder_set_method (GDataGDReminder *self,
const gchar *method);
void gdata_gd_reminder_get_absolute_time (GDataGDReminder *self,
GTimeVal *absolute_time);
void gdata_gd_reminder_set_absolute_time (GDataGDReminder *self,
GTimeVal *absolute_time);
gboolean gdata_gd_reminder_is_absolute_time (GDataGDReminder *self);
gint gdata_gd_reminder_get_relative_time (GDataGDReminder *self);
void gdata_gd_reminder_set_relative_time (GDataGDReminder *self,
gint relative_time);
"absolute-time" GTimeVal* : Read / Write "is-absolute-time" gboolean : Read "method" gchar* : Read / Write "relative-time" gint : Read / Write
typedef struct _GDataGDReminder GDataGDReminder;
All the fields in the GDataGDReminder structure are private and should never be accessed directly.
typedef struct {
} GDataGDReminderClass;
All the fields in the GDataGDReminderClass structure are private and should never be accessed directly.
Since 0.4.0
GDataGDReminder * gdata_gd_reminder_new (const gchar *method,GTimeVal *absolute_time,gint relative_time);
Creates a new GDataGDReminder. More information is available in the GData specification.
|
the notification method the reminder should use, or NULL
|
|
the absolute time for the reminder, or NULL
|
|
the relative time for the reminder, in minutes, or -1
|
Returns : |
a new GDataGDReminder, or NULL; unref with g_object_unref()
|
Since 0.2.0
gint gdata_gd_reminder_compare (const GDataGDReminder *a,const GDataGDReminder *b);
Compares the two reminders in a strcmp() fashion. NULL values are handled gracefully, with
0 returned if both a and b are NULL, -1 if a is NULL and 1 if b is NULL.
The comparison of non-NULL values is done on the basis all the properties of the GDataGDReminders.
|
a GDataGDReminder, or NULL
|
|
another GDataGDReminder, or NULL
|
Returns : |
0 if a equals b, -1 or 1 as appropriate otherwise
|
Since 0.4.0
const gchar * gdata_gd_reminder_get_method (GDataGDReminder *self);
Gets the "method" property.
|
a GDataGDReminder |
Returns : |
the method, or NULL
|
Since 0.4.0
void gdata_gd_reminder_set_method (GDataGDReminder *self,const gchar *method);
Sets the "method" property to method.
Set method to NULL to unset the property.
|
a GDataGDReminder |
|
the new method, or NULL
|
Since 0.4.0
void gdata_gd_reminder_get_absolute_time (GDataGDReminder *self,GTimeVal *absolute_time);
Gets the "absolute-time" property and returns it in absolute_time. If the
property is unset, both fields of start_time are set to 0.
|
a GDataGDReminder |
|
return location for the absolute time |
Since 0.4.0
void gdata_gd_reminder_set_absolute_time (GDataGDReminder *self,GTimeVal *absolute_time);
Sets the "absolute-time" property to absolute_time.
Set absolute_time to NULL to unset the property.
|
a GDataGDReminder |
|
the new absolute time, or NULL
|
Since 0.4.0
gboolean gdata_gd_reminder_is_absolute_time (GDataGDReminder *self);
Returns whether the reminder is specified as an absolute time, or as a number of minutes after the corresponding event's start time.
|
a GDataGDReminder |
Returns : |
TRUE if the reminder is absolute, FALSE otherwise
|
Since 0.4.0
gint gdata_gd_reminder_get_relative_time (GDataGDReminder *self);
Gets the "relative-time" property.
|
a GDataGDReminder |
Returns : |
the relative time, or -1
|
Since 0.4.0
void gdata_gd_reminder_set_relative_time (GDataGDReminder *self,gint relative_time);
Sets the "relative-time" property to relative_time.
Set relative_time to -1 to unset the property.
|
a GDataGDReminder |
|
the new relative time, or -1
|
Since 0.4.0
"absolute-time" property "absolute-time" GTimeVal* : Read / Write
Absolute time at which the reminder should be issued.
For more information, see the GData specification.
Since 0.4.0
"is-absolute-time" property "is-absolute-time" gboolean : Read
Whether the reminder is specified in terms of an absolute or relative time.
For more information, see the GData specification.
Default value: FALSE
Since 0.4.0
"method" property "method" gchar* : Read / Write
The notification method the reminder should use.
For more information, see the GData specification.
Default value: NULL
Since 0.4.0
"relative-time" property "relative-time" gint : Read / Write
Time at which the reminder should be issued, in minutes relative to the start time of the corresponding event.
For more information, see the GData specification.
Allowed values: >= G_MAXULONG
Default value: -1
Since 0.4.0