added 2010 to copyright text
[geeqie.git] / src / metadata.h
1 /*
2  * Geeqie
3  * (C) 2004 John Ellis
4  * Copyright (C) 2008 - 2010 The Geeqie Team
5  *
6  * Author: John Ellis, Laurent Monin
7  *
8  * This software is released under the GNU General Public License (GNU GPL).
9  * Please read the included file COPYING for more information.
10  * This software comes with no warranty of any kind, use at your own risk!
11  */
12
13
14 #ifndef METADATA_H
15 #define METADATA_H
16
17 #define COMMENT_KEY "Xmp.dc.description"
18 #define KEYWORD_KEY "Xmp.dc.subject"
19 #define ORIENTATION_KEY "Xmp.tiff.Orientation"
20
21 gboolean metadata_write_queue_remove(FileData *fd);
22 gboolean metadata_write_queue_remove_list(GList *list);
23 gboolean metadata_write_perform(FileData *fd);
24 gboolean metadata_write_queue_confirm(gboolean force_dialog, FileUtilDoneFunc done_func, gpointer done_data);
25 void metadata_notify_cb(FileData *fd, NotifyType type, gpointer data);
26
27 gint metadata_queue_length(void);
28
29 gboolean metadata_write_revert(FileData *fd, const gchar *key);
30 gboolean metadata_write_list(FileData *fd, const gchar *key, const GList *values);
31 gboolean metadata_write_string(FileData *fd, const gchar *key, const char *value);
32 gboolean metadata_write_int(FileData *fd, const gchar *key, guint64 value);
33
34 GList *metadata_read_list(FileData *fd, const gchar *key, MetadataFormat format);
35 gchar *metadata_read_string(FileData *fd, const gchar *key, MetadataFormat format);
36 guint64 metadata_read_int(FileData *fd, const gchar *key, guint64 fallback);
37 gdouble metadata_read_GPS_coord(FileData *fd, const gchar *key, gdouble fallback);
38
39 gboolean metadata_append_string(FileData *fd, const gchar *key, const char *value);
40 gboolean metadata_append_list(FileData *fd, const gchar *key, const GList *values);
41
42 GList *string_to_keywords_list(const gchar *text);
43
44 gboolean meta_data_get_keyword_mark(FileData *fd, gint n, gpointer data);
45 gboolean meta_data_set_keyword_mark(FileData *fd, gint n, gboolean value, gpointer data);
46
47
48 enum {
49         KEYWORD_COLUMN_MARK,
50         KEYWORD_COLUMN_NAME,
51         KEYWORD_COLUMN_CASEFOLD,
52         KEYWORD_COLUMN_IS_KEYWORD,
53         KEYWORD_COLUMN_HIDE_IN,
54         KEYWORD_COLUMN_COUNT
55 };
56
57 extern GtkTreeStore *keyword_tree;
58
59 void meta_data_connect_mark_with_keyword(GtkTreeModel *keyword_tree, GtkTreeIter *kw_iter, gint mark);
60
61
62 gchar *keyword_get_name(GtkTreeModel *keyword_tree, GtkTreeIter *iter);
63 gchar *keyword_get_casefold(GtkTreeModel *keyword_tree, GtkTreeIter *iter);
64 gboolean keyword_get_is_keyword(GtkTreeModel *keyword_tree, GtkTreeIter *iter);
65
66 gboolean keyword_compare(GtkTreeModel *keyword_tree, GtkTreeIter *a, GtkTreeIter *b);
67 gboolean keyword_same_parent(GtkTreeModel *keyword_tree, GtkTreeIter *a, GtkTreeIter *b);
68 gboolean keyword_exists(GtkTreeModel *keyword_tree, GtkTreeIter *parent_ptr, GtkTreeIter *sibling, const gchar *name, gboolean exclude_sibling, GtkTreeIter *result);
69
70 void keyword_copy(GtkTreeStore *keyword_tree, GtkTreeIter *to, GtkTreeIter *from);
71 void keyword_copy_recursive(GtkTreeStore *keyword_tree, GtkTreeIter *to, GtkTreeIter *from);
72 void keyword_move_recursive(GtkTreeStore *keyword_tree, GtkTreeIter *to, GtkTreeIter *from);
73
74 GList *keyword_tree_get_path(GtkTreeModel *keyword_tree, GtkTreeIter *iter_ptr);
75 gboolean keyword_tree_get_iter(GtkTreeModel *keyword_tree, GtkTreeIter *iter_ptr, GList *path);
76
77 void keyword_set(GtkTreeStore *keyword_tree, GtkTreeIter *iter, const gchar *name, gboolean is_keyword);
78 gboolean keyword_tree_is_set(GtkTreeModel *keyword_tree, GtkTreeIter *iter, GList *kw_list);
79 void keyword_tree_set(GtkTreeModel *keyword_tree, GtkTreeIter *iter_ptr, GList **kw_list);
80 void keyword_tree_reset(GtkTreeModel *keyword_tree, GtkTreeIter *iter_ptr, GList **kw_list);
81
82 void keyword_delete(GtkTreeStore *keyword_tree, GtkTreeIter *iter_ptr);
83
84
85 void keyword_hide_in(GtkTreeStore *keyword_tree, GtkTreeIter *iter, gpointer id);
86 void keyword_show_in(GtkTreeStore *keyword_tree, GtkTreeIter *iter, gpointer id);
87 gboolean keyword_is_hidden_in(GtkTreeModel *keyword_tree, GtkTreeIter *iter, gpointer id);
88 void keyword_show_all_in(GtkTreeStore *keyword_tree, gpointer id);
89 void keyword_hide_unset_in(GtkTreeStore *keyword_tree, gpointer id, GList *keywords);
90 void keyword_show_set_in(GtkTreeStore *keyword_tree, gpointer id, GList *keywords);
91
92 void keyword_tree_new_default(void);
93 void keyword_tree_new(void);
94
95 void keyword_tree_write_config(GString *outstr, gint indent);
96 GtkTreeIter *keyword_add_from_config(GtkTreeStore *keyword_tree, GtkTreeIter *parent, const gchar **attribute_names, const gchar **attribute_values);
97
98 #endif
99 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */