MrpCalendar

MrpCalendar —

Synopsis


#include <mrproject/mrp-calendar.h>


struct      MrpCalendarDay;
MrpCalendar* mrp_calendar_new               (const gchar *name,
                                             MrpProject *project);
MrpCalendar* mrp_calendar_copy              (const gchar *name,
                                             MrpCalendar *calendar);
MrpCalendar* mrp_calendar_derive            (const gchar *name,
                                             MrpCalendar *parent);
MrpDay*     mrp_calendar_get_day            (MrpCalendar *calendar,
                                             mrptime date,
                                             gboolean check_ancestors);
MrpDay*     mrp_calendar_get_default_day    (MrpCalendar *calendar,
                                             gint week_day);


Description

Details

struct MrpCalendarDay

struct MrpCalendarDay;


mrp_calendar_new ()

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

Creates a new MrpCalendar. The calendar will be empty so you would have to set default days on it.

name : Name of the calendar
project :
Returns : a new MrpCalendar

mrp_calendar_copy ()

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

Copies calendar, the copy will be a base calendar and will not have any parents.

name : Name of the new calendar
calendar : a MrpCalendar to copy
Returns : a new MrpCalendar that is a copy of calendar.

mrp_calendar_derive ()

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

Derives parent so that specific days can be overridden.

name : Name of the new calendar
parent : the MrpCalendar to derive
Returns : a new MrpCalendar that overrides parent.

mrp_calendar_get_day ()

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

calendar :
date :
check_ancestors :
Returns :

mrp_calendar_get_default_day ()

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

calendar :
week_day :
Returns :