/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */

/*
 *  Pix
 *
 *  Copyright (C) 2009 Free Software Foundation, Inc.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef GTH_ORGANIZE_TASK_H
#define GTH_ORGANIZE_TASK_H

#include <glib-object.h>
#include <pix.h>
#include "gth-catalog.h"

typedef enum {
	GTH_GROUP_POLICY_DIGITALIZED_DATE,
	GTH_GROUP_POLICY_MODIFIED_DATE,
	GTH_GROUP_POLICY_TAG,
	GTH_GROUP_POLICY_TAG_EMBEDDED
} GthGroupPolicy;

#define GTH_TYPE_ORGANIZE_TASK         (gth_organize_task_get_type ())
#define GTH_ORGANIZE_TASK(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), GTH_TYPE_ORGANIZE_TASK, GthOrganizeTask))
#define GTH_ORGANIZE_TASK_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST ((k), GTH_TYPE_ORGANIZE_TASK, GthOrganizeTaskClass))
#define GTH_IS_ORGANIZE_TASK(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTH_TYPE_ORGANIZE_TASK))
#define GTH_IS_ORGANIZE_TASK_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), GTH_TYPE_ORGANIZE_TASK))
#define GTH_ORGANIZE_TASK_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS((o), GTH_TYPE_ORGANIZE_TASK, GthOrganizeTaskClass))

typedef struct _GthOrganizeTask         GthOrganizeTask;
typedef struct _GthOrganizeTaskPrivate  GthOrganizeTaskPrivate;
typedef struct _GthOrganizeTaskClass    GthOrganizeTaskClass;

struct _GthOrganizeTask
{
	GthTask __parent;
	GthOrganizeTaskPrivate *priv;
};

struct _GthOrganizeTaskClass
{
	GthTaskClass __parent_class;
};

/* GthGroupPolicyData: data used by the "gth-organize-task-create-catalog" hook */

typedef struct {
	GthOrganizeTask *task;         /* in */
	GthDateTime     *date_time;    /* in (optional) */
	const char      *tag;          /* in (optional) */
	GFile           *catalog_file; /* out */
	GthCatalog      *catalog;      /* out */
} GthGroupPolicyData;

GType           gth_organize_task_get_type                 (void) G_GNUC_CONST;
GthTask *       gth_organize_task_new                      (GthBrowser      *browser,
							    GFile           *folder,
							    GthGroupPolicy   group_policy);
void            gth_organize_task_set_recursive            (GthOrganizeTask *self,
							    gboolean         recursive);
void            gth_organize_task_set_create_singletons    (GthOrganizeTask *self,
						            gboolean         create);
void            gth_organize_task_set_singletons_catalog   (GthOrganizeTask *self,
							    const char      *catalog_name);
GFile *         gth_organize_task_get_folder               (GthOrganizeTask *self);
GthGroupPolicy  gth_organize_task_get_group_policy         (GthOrganizeTask *self);
gboolean        gth_organize_task_get_recursive            (GthOrganizeTask *self);

#endif /* GTH_ORGANIZE_TASK_H */