libdocument/ev-attachment.h

   1 /* this file is part of evince, a gnome document viewer
   2  *
   3  *  Copyright (C) 2006 Carlos Garcia Campos <carlosgc@gnome.org>
   4  *
   5  * Evince is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * Evince is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  */
  19
  20 #if !defined (__EV_EVINCE_DOCUMENT_H_INSIDE__) && !defined (EVINCE_COMPILATION)
  21 #error "Only <evince-document.h> can be included directly."
  22 #endif
  23
  24 #ifndef __EV_ATTACHMENT_H__
  25 #define __EV_ATTACHMENT_H__
  26
  27 #include <glib-object.h>
  28 #include <gio/gio.h>
  29
  30 G_BEGIN_DECLS
  31
  32 typedef struct _EvAttachment        EvAttachment;
  33 typedef struct _EvAttachmentClass   EvAttachmentClass;
  34 typedef struct _EvAttachmentPrivate EvAttachmentPrivate;
  35
  36 #define EV_TYPE_ATTACHMENT              (ev_attachment_get_type())
  37 #define EV_ATTACHMENT(object)           (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_ATTACHMENT, EvAttachment))
  38 #define EV_ATTACHMENT_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_ATTACHMENT, EvAttachmentClass))
  39 #define EV_IS_ATTACHMENT(object)        (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_ATTACHMENT))
  40 #define EV_IS_ATTACHMENT_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), EV_TYPE_ATTACHMENT))
  41 #define EV_ATTACHMENT_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_ATTACHMENT, EvAttachmentClass))
  42
  43 #define EV_ATTACHMENT_ERROR (ev_attachment_error_quark ())
  44
  45 struct _EvAttachment {
  46         GObject base_instance;
  47
  48         EvAttachmentPrivate *priv;
  49 };
  50
  51 struct _EvAttachmentClass {
  52         GObjectClass base_class;
  53 };
  54
  55 GType         ev_attachment_get_type             (void) G_GNUC_CONST;
  56 GQuark        ev_attachment_error_quark          (void) G_GNUC_CONST;
  57 EvAttachment *ev_attachment_new                  (const gchar  *name,
  58                                                   const gchar  *description,
  59                                                   GTime         mtime,
  60                                                   GTime         ctime,
  61                                                   gsize         size,
  62                                                   gpointer      data);
  63
  64 const gchar *ev_attachment_get_name              (EvAttachment *attachment);
  65 const gchar *ev_attachment_get_description       (EvAttachment *attachment);
  66 GTime        ev_attachment_get_modification_date (EvAttachment *attachment);
  67 GTime        ev_attachment_get_creation_date     (EvAttachment *attachment);
  68 const gchar *ev_attachment_get_mime_type         (EvAttachment *attachment);
  69 gboolean     ev_attachment_save                  (EvAttachment *attachment,
  70                                                   GFile        *file,
  71                                                   GError      **error);
  72 gboolean     ev_attachment_open                  (EvAttachment *attachment,
  73                                                   GdkScreen    *screen,
  74                                                   guint32       timestamp,
  75                                                   GError      **error);
  76
  77 G_END_DECLS
  78
  79 #endif /* __EV_ATTACHMENT_H__ */