MrpCalendarPriv

typedef struct _MrpCalendarPriv MrpCalendarPriv;

A private struct for internal use only. The definition of this structure is not publically available.

MrpCalendar

typedef struct _MrpCalendar MrpCalendar;

Object representing a calendar in the project.

MrpInterval

typedef struct _MrpInterval MrpInterval;

Represents a time interval.

mrp_calendar_new ()

MrpCalendar* mrp_calendar_new               (const gchar *name,
                                             MrpProject *project);

Creates a new MrpCalendar. The calendar will be empty so you need to set the default week and/or override days, see mrp_calendar_set_default_days() and mrp_calendar_set_days().

mrp_calendar_copy ()

MrpCalendar* mrp_calendar_copy              (const gchar *name,
                                             MrpCalendar *calendar);

Copies calendar, making the new calendar a base calendar, that does not have a parent.

mrp_calendar_derive ()

MrpCalendar* mrp_calendar_derive            (const gchar *name,
                                             MrpCalendar *parent);

Derives a new calendar from parent. The new calendar will inherit all properties from parent, so if no days are overridden, the calendars will be identical.

mrp_calendar_reparent ()

void        mrp_calendar_reparent           (MrpCalendar *new_parent,
                                             MrpCalendar *child);

Changes the parent of calendar so that it inherits new_parent, instead of its old parent.

mrp_calendar_remove ()

void        mrp_calendar_remove             (MrpCalendar *calendar);

Removes calendar from the project. If the calendar is used by the project, a new calendar is set for the project. If the calendar has a parent, the parent is used, otherwise the first child of the root is used. For resources, the calendar is exchanged for the parent if one exists, otherwise the resource calendar is unset, so that the project default will be used.

mrp_calendar_get_name ()

const gchar* mrp_calendar_get_name          (MrpCalendar *calendar);

Retrieves the name of the calendar.

mrp_calendar_set_name ()

void        mrp_calendar_set_name           (MrpCalendar *calendar,
                                             const gchar *name);

Sets the name of the calendar.

mrp_calendar_day_set_intervals ()

void        mrp_calendar_day_set_intervals  (MrpCalendar *calendar,
                                             MrpDay *day,
                                             GList *intervals);

Overrides the working time for the day type day when used in calendar.

mrp_calendar_day_get_intervals ()

GList*      mrp_calendar_day_get_intervals  (MrpCalendar *calendar,
                                             MrpDay *day,
                                             gboolean check_ancestors);

Retrieves the working time for the given day/calendar combination. If check_ancestors is TRUE, the calendar hierarchy is searched until a calendar that has set the working time for this day type is found. If FALSE, the returned list will be empty if there is no explicit working time set for calendar.

mrp_calendar_day_get_total_work ()

gint        mrp_calendar_day_get_total_work (MrpCalendar *calendar,
                                             MrpDay *day);

Calculates the total amount of work for day in calendar.

mrp_calendar_get_day ()

MrpDay*     mrp_calendar_get_day            (MrpCalendar *calendar,
                                             mrptime date,
                                             gboolean check_ancestors);

Retrieves the day type for the given date and calender. If check_ancestors is TRUE, the parent and grandparent, and so on, is searched if calendar does not have an overridden day type for the specified date.

mrp_calendar_get_default_day ()

MrpDay*     mrp_calendar_get_default_day    (MrpCalendar *calendar,
                                             gint week_day);

Retrieves the default day for calendar.

mrp_calendar_set_default_days ()

void        mrp_calendar_set_default_days   (MrpCalendar *calendar,
                                             gint week_day,
                                             ...);

Sets days in the default week for calendar. Those are the days that are used as fallback is a date is not overridden.

mrp_calendar_set_days ()

void        mrp_calendar_set_days           (MrpCalendar *calendar,
                                             mrptime date,
                                             ...);

Overrides specific dates in calendar, setting the type of day to use for those dates.

mrp_calendar_get_parent ()

MrpCalendar* mrp_calendar_get_parent        (MrpCalendar *calendar);

Retrieves the parent calendar of calendar. The parent is the calendar that a calendar falls back to if a date or day type is not overridden.

mrp_calendar_get_children ()

GList*      mrp_calendar_get_children       (MrpCalendar *calendar);

Retreives a list of the children, i.e. the calenderas that are immediately derived from calendar.

mrp_interval_new ()

MrpInterval* mrp_interval_new               (mrptime start,
                                             mrptime end);

Creates a new MrpInterval ranging from start to end.

mrp_interval_copy ()

MrpInterval* mrp_interval_copy              (MrpInterval *interval);

Copies interval.

mrp_interval_ref ()

MrpInterval* mrp_interval_ref               (MrpInterval *interval);

Increases the reference count on interval.

mrp_interval_unref ()

void        mrp_interval_unref              (MrpInterval *interval);

Decreases the reference count on interval. When the count goes to 0, the interval is freed.

mrp_interval_get_absolute ()

void        mrp_interval_get_absolute       (MrpInterval *interval,
                                             mrptime offset,
                                             mrptime *start,
                                             mrptime *end);

Retrieves the start and end time of interval, with an optional offset.

The "name" property

  "name"                 gchararray            : Read / Write

The name of the calendar.

Default value: "empty"

The "project" property

  "project"              gpointer              : Read / Write

The project this calendar belongs to.

The "calendar-changed" signal

void        user_function                  (MrpCalendar *mrpcalendar,
                                            gpointer     user_data)        : Run last