src/metadata.h

   1 /*
   2  * Copyright (C) 2004 John Ellis
   3  * Copyright (C) 2008 - 2016 The Geeqie Team
   4  *
   5  * Authors: John Ellis, Laurent Monin
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #ifndef METADATA_H
  23 #define METADATA_H
  24
  25 #define COMMENT_KEY "Xmp.dc.description"
  26 #define KEYWORD_KEY "Xmp.dc.subject"
  27 #define ORIENTATION_KEY "Xmp.tiff.Orientation"
  28
  29 void metadata_cache_free(FileData *fd);
  30
  31 gboolean metadata_write_queue_remove(FileData *fd);
  32 gboolean metadata_write_queue_remove_list(GList *list);
  33 gboolean metadata_write_perform(FileData *fd);
  34 gboolean metadata_write_queue_confirm(gboolean force_dialog, FileUtilDoneFunc done_func, gpointer done_data);
  35 void metadata_notify_cb(FileData *fd, NotifyType type, gpointer data);
  36
  37 gint metadata_queue_length(void);
  38
  39 gboolean metadata_write_revert(FileData *fd, const gchar *key);
  40 gboolean metadata_write_list(FileData *fd, const gchar *key, const GList *values);
  41 gboolean metadata_write_string(FileData *fd, const gchar *key, const char *value);
  42 gboolean metadata_write_int(FileData *fd, const gchar *key, guint64 value);
  43
  44 GList *metadata_read_list(FileData *fd, const gchar *key, MetadataFormat format);
  45 gchar *metadata_read_string(FileData *fd, const gchar *key, MetadataFormat format);
  46 guint64 metadata_read_int(FileData *fd, const gchar *key, guint64 fallback);
  47 gdouble metadata_read_GPS_coord(FileData *fd, const gchar *key, gdouble fallback);
  48
  49 gboolean metadata_append_string(FileData *fd, const gchar *key, const char *value);
  50 gboolean metadata_append_list(FileData *fd, const gchar *key, const GList *values);
  51
  52 GList *string_to_keywords_list(const gchar *text);
  53
  54 gboolean meta_data_get_keyword_mark(FileData *fd, gint n, gpointer data);
  55 gboolean meta_data_set_keyword_mark(FileData *fd, gint n, gboolean value, gpointer data);
  56
  57
  58 enum {
  59         KEYWORD_COLUMN_MARK,
  60         KEYWORD_COLUMN_NAME,
  61         KEYWORD_COLUMN_CASEFOLD,
  62         KEYWORD_COLUMN_IS_KEYWORD,
  63         KEYWORD_COLUMN_HIDE_IN,
  64         KEYWORD_COLUMN_COUNT
  65 };
  66
  67 extern GtkTreeStore *keyword_tree;
  68
  69 void meta_data_connect_mark_with_keyword(GtkTreeModel *keyword_tree, GtkTreeIter *kw_iter, gint mark);
  70
  71
  72 gchar *keyword_get_name(GtkTreeModel *keyword_tree, GtkTreeIter *iter);
  73 gchar *keyword_get_casefold(GtkTreeModel *keyword_tree, GtkTreeIter *iter);
  74 gboolean keyword_get_is_keyword(GtkTreeModel *keyword_tree, GtkTreeIter *iter);
  75
  76 gboolean keyword_compare(GtkTreeModel *keyword_tree, GtkTreeIter *a, GtkTreeIter *b);
  77 gboolean keyword_same_parent(GtkTreeModel *keyword_tree, GtkTreeIter *a, GtkTreeIter *b);
  78 gboolean keyword_exists(GtkTreeModel *keyword_tree, GtkTreeIter *parent_ptr, GtkTreeIter *sibling, const gchar *name, gboolean exclude_sibling, GtkTreeIter *result);
  79
  80 void keyword_copy(GtkTreeStore *keyword_tree, GtkTreeIter *to, GtkTreeIter *from);
  81 void keyword_copy_recursive(GtkTreeStore *keyword_tree, GtkTreeIter *to, GtkTreeIter *from);
  82 void keyword_move_recursive(GtkTreeStore *keyword_tree, GtkTreeIter *to, GtkTreeIter *from);
  83
  84 GList *keyword_tree_get_path(GtkTreeModel *keyword_tree, GtkTreeIter *iter_ptr);
  85 gboolean keyword_tree_get_iter(GtkTreeModel *keyword_tree, GtkTreeIter *iter_ptr, GList *path);
  86
  87 void keyword_set(GtkTreeStore *keyword_tree, GtkTreeIter *iter, const gchar *name, gboolean is_keyword);
  88 gboolean keyword_tree_is_set(GtkTreeModel *keyword_tree, GtkTreeIter *iter, GList *kw_list);
  89 void keyword_tree_set(GtkTreeModel *keyword_tree, GtkTreeIter *iter_ptr, GList **kw_list);
  90 GList *keyword_tree_get(GtkTreeModel *keyword_tree, GtkTreeIter *iter_ptr);
  91 void keyword_tree_reset(GtkTreeModel *keyword_tree, GtkTreeIter *iter_ptr, GList **kw_list);
  92
  93 void keyword_delete(GtkTreeStore *keyword_tree, GtkTreeIter *iter_ptr);
  94
  95
  96 void keyword_hide_in(GtkTreeStore *keyword_tree, GtkTreeIter *iter, gpointer id);
  97 void keyword_show_in(GtkTreeStore *keyword_tree, GtkTreeIter *iter, gpointer id);
  98 gboolean keyword_is_hidden_in(GtkTreeModel *keyword_tree, GtkTreeIter *iter, gpointer id);
  99 void keyword_show_all_in(GtkTreeStore *keyword_tree, gpointer id);
 100 void keyword_hide_unset_in(GtkTreeStore *keyword_tree, gpointer id, GList *keywords);
 101 void keyword_show_set_in(GtkTreeStore *keyword_tree, gpointer id, GList *keywords);
 102
 103 void keyword_tree_new_default(void);
 104 void keyword_tree_new(void);
 105
 106 void keyword_tree_write_config(GString *outstr, gint indent);
 107 GtkTreeIter *keyword_add_from_config(GtkTreeStore *keyword_tree, GtkTreeIter *parent, const gchar **attribute_names, const gchar **attribute_values);
 108
 109 #endif
 110 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */