shell/ev-metadata.h

   1 /* ev-metadata.h
   2  *  this file is part of evince, a gnome document viewer
   3  *
   4  * Copyright (C) 2009 Carlos Garcia Campos  <carlosgc@gnome.org>
   5  *
   6  * Evince is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Evince is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  */
  20
  21 #ifndef EV_METADATA_H
  22 #define EV_METADATA_H
  23
  24 #include <glib-object.h>
  25
  26 G_BEGIN_DECLS
  27
  28 #define EV_TYPE_METADATA         (ev_metadata_get_type())
  29 #define EV_METADATA(object)      (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_METADATA, EvMetadata))
  30 #define EV_METADATA_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_METADATA, EvMetadataClass))
  31 #define EV_IS_METADATA(object)   (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_METADATA))
  32
  33 typedef struct _EvMetadata      EvMetadata;
  34 typedef struct _EvMetadataClass EvMetadataClass;
  35
  36 GType       ev_metadata_get_type              (void) G_GNUC_CONST;
  37 EvMetadata *ev_metadata_new                   (GFile       *file);
  38 gboolean    ev_metadata_is_empty              (EvMetadata  *metadata);
  39
  40 gboolean    ev_metadata_get_string            (EvMetadata  *metadata,
  41                                                const gchar *key,
  42                                                gchar     **value);
  43 gboolean    ev_metadata_set_string            (EvMetadata  *metadata,
  44                                                const gchar *key,
  45                                                const gchar *value);
  46 gboolean    ev_metadata_get_int               (EvMetadata  *metadata,
  47                                                const gchar *key,
  48                                                gint        *value);
  49 gboolean    ev_metadata_set_int               (EvMetadata  *metadata,
  50                                                const gchar *key,
  51                                                gint         value);
  52 gboolean    ev_metadata_get_double            (EvMetadata  *metadata,
  53                                                const gchar *key,
  54                                                gdouble     *value);
  55 gboolean    ev_metadata_set_double            (EvMetadata  *metadata,
  56                                                const gchar *key,
  57                                                gdouble      value);
  58 gboolean    ev_metadata_get_boolean           (EvMetadata  *metadata,
  59                                                const gchar *key,
  60                                                gboolean    *value);
  61 gboolean    ev_metadata_set_boolean           (EvMetadata  *metadata,
  62                                                const gchar *key,
  63                                                gboolean     value);
  64
  65 gboolean    ev_is_metadata_supported_for_file (GFile       *file);
  66
  67 G_END_DECLS
  68
  69 #endif /* EV_METADATA_H */