MrpProjectPriv

typedef struct _MrpProjectPriv MrpProjectPriv;

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

MrpProject

typedef struct _MrpProject MrpProject;

Object representing a project.

MrpTaskTraverseFunc ()

gboolean    (*MrpTaskTraverseFunc)          (MrpTask *,
                                             gpointer );

A function to use with mrp_project_task_traverse(). task is the currently traversed task, and data is the user data passed to the mrp_project_task_traverse(). The traversal can be stopped by returning TRUE.

mrp_project_new ()

MrpProject* mrp_project_new                 (MrpApplication *app);

Creates a new MrpProject.

mrp_project_is_empty ()

gboolean    mrp_project_is_empty            (MrpProject *project);

Checks whether a project is empty.

mrp_project_needs_saving ()

gboolean    mrp_project_needs_saving        (MrpProject *project);

Checks if project needs saving

mrp_project_get_project_start ()

mrptime     mrp_project_get_project_start   (MrpProject *project);

Fetches the project start from project.

mrp_project_set_project_start ()

void        mrp_project_set_project_start   (MrpProject *project,
                                             mrptime start);

Set the project start.

mrp_project_load ()

gboolean    mrp_project_load                (MrpProject *project,
                                             const gchar *uri,
                                             GError **error);

Loads a project stored at uri into project.

mrp_project_save ()

gboolean    mrp_project_save                (MrpProject *project,
                                             gboolean force,
                                             GError **error);

Saves a project.

mrp_project_save_to_xml ()

gboolean    mrp_project_save_to_xml         (MrpProject *project,
                                             gchar **str,
                                             GError **error);

Saves a project as XML to a string buffer.

mrp_project_load_from_xml ()

gboolean    mrp_project_load_from_xml       (MrpProject *project,
                                             const gchar *str,
                                             GError **error);

Loads a project from XML data into project.

mrp_project_save_as ()

gboolean    mrp_project_save_as             (MrpProject *project,
                                             const gchar *uri,
                                             gboolean force,
                                             GError **error);

Saves a project to a specific URI.

mrp_project_close ()

void        mrp_project_close               (MrpProject *project);

Closes a project.

mrp_project_get_uri ()

const gchar* mrp_project_get_uri            (MrpProject *project);

Fetches the URI from project.

mrp_project_get_resource_by_name ()

MrpResource* mrp_project_get_resource_by_name
                                            (MrpProject *project,
                                             const gchar *name);

Retrieves the first resource in the list that match the name.

mrp_project_get_resources ()

GList*      mrp_project_get_resources       (MrpProject *project);

Fetches the list of resources in project. This list should not be freed and if caller needs to manipulate it, a copy needs to be made first.

mrp_project_add_resource ()

void        mrp_project_add_resource        (MrpProject *project,
                                             MrpResource *resource);

Adds resource to the list of resources in project.

mrp_project_remove_resource ()

void        mrp_project_remove_resource     (MrpProject *project,
                                             MrpResource *resource);

Removes resource from project.

mrp_project_get_group_by_name ()

MrpGroup*   mrp_project_get_group_by_name   (MrpProject *project,
                                             const gchar *name);

Retrieves the first group with name that matches name

mrp_project_get_groups ()

GList*      mrp_project_get_groups          (MrpProject *project);

Fetches the list of groups in project. The list should not be freed and if caller needs to manipulate it, a copy needs to be made first.

mrp_project_add_group ()

void        mrp_project_add_group           (MrpProject *project,
                                             MrpGroup *group);

Adds group to the list of groups in project.

mrp_project_remove_group ()

void        mrp_project_remove_group        (MrpProject *project,
                                             MrpGroup *group);

Removes group from project.

mrp_project_get_task_by_name ()

MrpTask*    mrp_project_get_task_by_name    (MrpProject *project,
                                             const gchar *name);

Retrieves the first task with name matching name. Uses task_traverse to traverse all tasks.

mrp_project_get_all_tasks ()

GList*      mrp_project_get_all_tasks       (MrpProject *project);

Returns a new list of the tasks in project. The caller needs to free the list with g_list_free(), but not the values in it.

mrp_project_insert_task ()

void        mrp_project_insert_task         (MrpProject *project,
                                             MrpTask *parent,
                                             gint position,
                                             MrpTask *task);

Insert task in the task tree with parent at position among other children.

mrp_project_remove_task ()

void        mrp_project_remove_task         (MrpProject *project,
                                             MrpTask *task);

Removes task from the task tree in project.

mrp_project_move_task ()

gboolean    mrp_project_move_task           (MrpProject *project,
                                             MrpTask *task,
                                             MrpTask *sibling,
                                             MrpTask *parent,
                                             gboolean before,
                                             GError **error);

Move the task in the task tree. If sibling is NULL task will be placed first among the children of parent if before is TRUE, otherwise it will be placed last. If sibling is set, task will be placed before or after sibling depending on the value of before.

mrp_project_get_root_task ()

MrpTask*    mrp_project_get_root_task       (MrpProject *project);

Fetches the root task from project.

mrp_project_task_traverse ()

void        mrp_project_task_traverse       (MrpProject *project,
                                             MrpTask *root,
                                             MrpTaskTraverseFunc func,
                                             gpointer user_data);

Calls func on each task under root in the task tree. user_data is passed to func. If func returns TRUE, the traversal is stopped.

mrp_project_reschedule ()

void        mrp_project_reschedule          (MrpProject *project);

Reschedules the project, calculating task start/end/duration etc.

mrp_project_calculate_task_work ()

gint        mrp_project_calculate_task_work (MrpProject *project,
                                             MrpTask *task,
                                             mrptime start,
                                             mrptime finish);

Calculates the work needed to achieve the given start and finish time, with the allocated resources' calendards in consideration.

mrp_project_get_properties_from_type ()

GList*      mrp_project_get_properties_from_type
                                            (MrpProject *project,
                                             GType object_type);

Fetches a list of the properties belonging to project and applies to object_type. The list should not be freed and needs to be copied before modified.

mrp_project_add_property ()

void        mrp_project_add_property        (MrpProject *project,
                                             GType object_type,
                                             MrpProperty *property,
                                             gboolean user_defined);

Add a custom property to project. The object_type specifies what kind of objects the property applies to. user_defined specifies whether the property is created by the user or by some plugin.

mrp_project_remove_property ()

void        mrp_project_remove_property     (MrpProject *project,
                                             GType object_type,
                                             const gchar *name);

Removes the property corresponding to object_type and name from project.

mrp_project_get_property ()

MrpProperty* mrp_project_get_property       (MrpProject *project,
                                             const gchar *name,
                                             GType object_type);

Fetches an MrpProperty that corresponds to name and object_type. This is mainly for language bindings and should not be used for other cases.

mrp_project_has_property ()

gboolean    mrp_project_has_property        (MrpProject *project,
                                             GType owner_type,
                                             const gchar *name);

Checks if project has a property named name applying to object of type object_type.

mrp_project_get_root_calendar ()

MrpCalendar* mrp_project_get_root_calendar  (MrpProject *project);

Fetches the root calendar of project.

mrp_project_get_calendar ()

MrpCalendar* mrp_project_get_calendar       (MrpProject *project);

Fetches the calendar used by project.

The "calendar" property

  "calendar"             MrpCalendar           : Read / Write

The calendar used in the project.

The "default-group" property

  "default-group"        MrpGroup              : Read / Write

Default group for new resources.

The "manager" property

  "manager"              gchararray            : Read / Write

The manager of the project.

Default value: ""

The "name" property

  "name"                 gchararray            : Read / Write

The name of the project.

Default value: ""

The "organization" property

  "organization"         gchararray            : Read / Write

The organization behind the project.

Default value: ""

The "phase" property

  "phase"                gchararray            : Read / Write

The phase the project is in.

Default value: ""

The "phases" property

  "phases"               gpointer              : Read / Write

The various phases the project can be in.

The "project-start" property

  "project-start"        glong                 : Read / Write

The start date of the project.

Allowed values: >= 0

Default value: 0

The "calendar-tree-changed" signal

void        user_function                  (MrpProject  *mrpproject,
                                            MrpCalendar *arg1,
                                            gpointer     user_data)       : Run last

The "day-added" signal

void        user_function                  (MrpProject *mrpproject,
                                            gpointer    arg1,
                                            gpointer    user_data)       : Run last

The "day-changed" signal

void        user_function                  (MrpProject *mrpproject,
                                            gpointer    arg1,
                                            gpointer    user_data)       : Run last

The "day-removed" signal

void        user_function                  (MrpProject *mrpproject,
                                            gpointer    arg1,
                                            gpointer    user_data)       : Run last

The "default-group-changed" signal

void        user_function                  (MrpProject *mrpproject,
                                            MrpGroup   *arg1,
                                            gpointer    user_data)       : Run last

The "group-added" signal

void        user_function                  (MrpProject *mrpproject,
                                            MrpGroup   *arg1,
                                            gpointer    user_data)       : Run last

The "group-removed" signal

void        user_function                  (MrpProject *mrpproject,
                                            MrpGroup   *arg1,
                                            gpointer    user_data)       : Run last

The "loaded" signal

void        user_function                  (MrpProject *mrpproject,
                                            gpointer    user_data)       : Run last

The "needs-saving-changed" signal

void        user_function                  (MrpProject *mrpproject,
                                            gboolean    arg1,
                                            gpointer    user_data)       : Run last

The "property-added" signal

void        user_function                  (MrpProject *mrpproject,
                                            glong       arg1,
                                            gpointer    arg2,
                                            gpointer    user_data)       : Run last

The "property-changed" signal

void        user_function                  (MrpProject *mrpproject,
                                            gpointer    arg1,
                                            gpointer    user_data)       : Run last

The "property-removed" signal

void        user_function                  (MrpProject *mrpproject,
                                            gpointer    arg1,
                                            gpointer    user_data)       : Run last

The "resource-added" signal

void        user_function                  (MrpProject  *mrpproject,
                                            MrpResource *arg1,
                                            gpointer     user_data)       : Run last

The "resource-removed" signal

void        user_function                  (MrpProject  *mrpproject,
                                            MrpResource *arg1,
                                            gpointer     user_data)       : Run last

The "task-inserted" signal

void        user_function                  (MrpProject *mrpproject,
                                            MrpTask    *arg1,
                                            gpointer    user_data)       : Run last

The "task-moved" signal

void        user_function                  (MrpProject *mrpproject,
                                            MrpTask    *arg1,
                                            gpointer    user_data)       : Run last

The "task-removed" signal

void        user_function                  (MrpProject *mrpproject,
                                            MrpTask    *arg1,
                                            gpointer    user_data)       : Run last