shell/ev-jobs.h

   1 /* this file is part of evince, a gnome document viewer
   2  *
   3  *  Copyright (C) 2005 Red Hat, Inc
   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., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifndef __EV_JOBS_H__
  21 #define __EV_JOBS_H__
  22
  23 #include <gtk/gtk.h>
  24 #include "ev-document.h"
  25
  26 G_BEGIN_DECLS
  27
  28 typedef struct _EvJob EvJob;
  29 typedef struct _EvJobClass EvJobClass;
  30
  31 typedef struct _EvJobRender EvJobRender;
  32 typedef struct _EvJobRenderClass EvJobRenderClass;
  33
  34 typedef struct _EvJobThumbnail EvJobThumbnail;
  35 typedef struct _EvJobThumbnailClass EvJobThumbnailClass;
  36
  37 typedef struct _EvJobLinks EvJobLinks;
  38 typedef struct _EvJobLinksClass EvJobLinksClass;
  39
  40 typedef struct _EvJobLoad EvJobLoad;
  41 typedef struct _EvJobLoadClass EvJobLoadClass;
  42
  43 #define EV_TYPE_JOB                          (ev_job_get_type())
  44 #define EV_JOB(object)                       (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB, EvJob))
  45 #define EV_JOB_CLASS(klass)                  (G_TYPE_CHACK_CLASS_CAST((klass), EV_TYPE_JOB, EvJobClass))
  46 #define EV_IS_JOB(object)                    (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB))
  47
  48 #define EV_TYPE_JOB_LINKS                    (ev_job_links_get_type())
  49 #define EV_JOB_LINKS(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LINKS, EvJobLinks))
  50 #define EV_JOB_LINKS_CLASS(klass)            (G_TYPE_CHACK_CLASS_CAST((klass), EV_TYPE_JOB_LINKS, EvJobLinksClass))
  51 #define EV_IS_JOB_LINKS(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LINKS))
  52
  53 #define EV_TYPE_JOB_RENDER                   (ev_job_render_get_type())
  54 #define EV_JOB_RENDER(object)                (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_RENDER, EvJobRender))
  55 #define EV_JOB_RENDER_CLASS(klass)           (G_TYPE_CHACK_CLASS_CAST((klass), EV_TYPE_JOB_RENDER, EvJobRenderClass))
  56 #define EV_IS_JOB_RENDER(object)             (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_RENDER))
  57
  58 #define EV_TYPE_JOB_THUMBNAIL                (ev_job_thumbnail_get_type())
  59 #define EV_JOB_THUMBNAIL(object)             (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnail))
  60 #define EV_JOB_THUMBNAIL_CLASS(klass)        (G_TYPE_CHACK_CLASS_CAST((klass), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnailClass))
  61 #define EV_IS_JOB_THUMBNAIL(object)          (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_THUMBNAIL))
  62
  63 #define EV_TYPE_JOB_LOAD                     (ev_job_load_get_type())
  64 #define EV_JOB_LOAD(object)                  (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LOAD, EvJobLoad))
  65 #define EV_JOB_LOAD_CLASS(klass)             (G_TYPE_CHACK_CLASS_CAST((klass), EV_TYPE_JOB_LOAD, EvJobLoadClass))
  66 #define EV_IS_JOB_LOAD(object)               (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LOAD))
  67
  68 typedef enum {
  69         EV_JOB_PRIORITY_LOW,
  70         EV_JOB_PRIORITY_HIGH,
  71 } EvJobPriority;
  72
  73 struct _EvJob
  74 {
  75         GObject parent;
  76         EvDocument *document;
  77         gboolean finished;
  78         gboolean async;
  79 };
  80
  81 struct _EvJobClass
  82 {
  83         GObjectClass parent_class;
  84
  85         void    (* finished) (EvJob *job);
  86 };
  87
  88 struct _EvJobLinks
  89 {
  90         EvJob parent;
  91
  92         GtkTreeModel *model;
  93 };
  94
  95 struct _EvJobLinksClass
  96 {
  97         EvJobClass parent_class;
  98 };
  99
 100 struct _EvJobRender
 101 {
 102         EvJob parent;
 103
 104         gint page;
 105         double scale;
 106         gint target_width;
 107         gint target_height;
 108         GdkPixbuf *pixbuf;
 109         GList *link_mapping;
 110         gboolean include_links;
 111 };
 112
 113 struct _EvJobRenderClass
 114 {
 115         EvJobClass parent_class;
 116 };
 117
 118 struct _EvJobThumbnail
 119 {
 120         EvJob parent;
 121
 122         gint page;
 123         gint requested_width;
 124         GdkPixbuf *thumbnail;
 125 };
 126
 127 struct _EvJobThumbnailClass
 128 {
 129         EvJobClass parent_class;
 130 };
 131
 132 struct _EvJobLoad
 133 {
 134         EvJob parent;
 135         GError *error;
 136         gchar *uri;
 137 };
 138
 139 struct _EvJobLoadClass
 140 {
 141         EvJobClass parent_class;
 142 };
 143
 144 /* Base job class */
 145 GType           ev_job_get_type           (void);
 146 void            ev_job_finished           (EvJob          *job);
 147
 148 /* EvJobLinks */
 149 GType           ev_job_links_get_type     (void);
 150 EvJob          *ev_job_links_new          (EvDocument     *document);
 151 void            ev_job_links_run          (EvJobLinks     *thumbnail);
 152
 153 /* EvJobRender */
 154 GType           ev_job_render_get_type    (void);
 155 EvJob          *ev_job_render_new         (EvDocument     *document,
 156                                            gint            page,
 157                                            double          scale,
 158                                            gint            width,
 159                                            gint            height,
 160                                            gboolean        include_links);
 161 void            ev_job_render_run         (EvJobRender    *thumbnail);
 162
 163 /* EvJobThumbnail */
 164 GType           ev_job_thumbnail_get_type (void);
 165 EvJob          *ev_job_thumbnail_new      (EvDocument     *document,
 166                                            gint            page,
 167                                            gint            requested_width);
 168 void            ev_job_thumbnail_run      (EvJobThumbnail *thumbnail);
 169
 170 /* EvJobLoad */
 171 GType           ev_job_load_get_type      (void);
 172 EvJob          *ev_job_load_new           (EvDocument      *document,
 173                                            const gchar     *uri);
 174 void            ev_job_load_run           (EvJobLoad       *load);
 175
 176 G_END_DECLS
 177
 178 #endif /* __EV_JOBS_H__ */