1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
2 
3 /*
4  *  GThumb
5  *
6  *  Copyright (C) 2009 Free Software Foundation, Inc.
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
20  */
21 
22 #ifndef GTH_ORGANIZE_TASK_H
23 #define GTH_ORGANIZE_TASK_H
24 
25 #include <glib-object.h>
26 #include <gthumb.h>
27 #include "gth-catalog.h"
28 
29 typedef enum {
30 	GTH_GROUP_POLICY_DIGITALIZED_DATE,
31 	GTH_GROUP_POLICY_MODIFIED_DATE,
32 	GTH_GROUP_POLICY_TAG,
33 	GTH_GROUP_POLICY_TAG_EMBEDDED
34 } GthGroupPolicy;
35 
36 #define GTH_TYPE_ORGANIZE_TASK         (gth_organize_task_get_type ())
37 #define GTH_ORGANIZE_TASK(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), GTH_TYPE_ORGANIZE_TASK, GthOrganizeTask))
38 #define GTH_ORGANIZE_TASK_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST ((k), GTH_TYPE_ORGANIZE_TASK, GthOrganizeTaskClass))
39 #define GTH_IS_ORGANIZE_TASK(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTH_TYPE_ORGANIZE_TASK))
40 #define GTH_IS_ORGANIZE_TASK_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), GTH_TYPE_ORGANIZE_TASK))
41 #define GTH_ORGANIZE_TASK_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS((o), GTH_TYPE_ORGANIZE_TASK, GthOrganizeTaskClass))
42 
43 typedef struct _GthOrganizeTask         GthOrganizeTask;
44 typedef struct _GthOrganizeTaskPrivate  GthOrganizeTaskPrivate;
45 typedef struct _GthOrganizeTaskClass    GthOrganizeTaskClass;
46 
47 struct _GthOrganizeTask
48 {
49 	GthTask __parent;
50 	GthOrganizeTaskPrivate *priv;
51 };
52 
53 struct _GthOrganizeTaskClass
54 {
55 	GthTaskClass __parent_class;
56 };
57 
58 /* GthGroupPolicyData: data used by the "gth-organize-task-create-catalog" hook */
59 
60 typedef struct {
61 	GthOrganizeTask *task;         /* in */
62 	GthDateTime     *date_time;    /* in (optional) */
63 	const char      *tag;          /* in (optional) */
64 	GFile           *catalog_file; /* out */
65 	GthCatalog      *catalog;      /* out */
66 } GthGroupPolicyData;
67 
68 GType           gth_organize_task_get_type                 (void) G_GNUC_CONST;
69 GthTask *       gth_organize_task_new                      (GthBrowser      *browser,
70 							    GFile           *folder,
71 							    GthGroupPolicy   group_policy);
72 void            gth_organize_task_set_recursive            (GthOrganizeTask *self,
73 							    gboolean         recursive);
74 void            gth_organize_task_set_create_singletons    (GthOrganizeTask *self,
75 						            gboolean         create);
76 void            gth_organize_task_set_singletons_catalog   (GthOrganizeTask *self,
77 							    const char      *catalog_name);
78 GFile *         gth_organize_task_get_folder               (GthOrganizeTask *self);
79 GthGroupPolicy  gth_organize_task_get_group_policy         (GthOrganizeTask *self);
80 gboolean        gth_organize_task_get_recursive            (GthOrganizeTask *self);
81 
82 #endif /* GTH_ORGANIZE_TASK_H */
83