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 _EvJobFonts EvJobFonts;
  41 typedef struct _EvJobFontsClass EvJobFontsClass;
  42
  43 typedef struct _EvJobXfer EvJobXfer;
  44 typedef struct _EvJobXferClass EvJobXferClass;
  45
  46 #define EV_TYPE_JOB                          (ev_job_get_type())
  47 #define EV_JOB(object)                       (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB, EvJob))
  48 #define EV_JOB_CLASS(klass)                  (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB, EvJobClass))
  49 #define EV_IS_JOB(object)                    (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB))
  50
  51 #define EV_TYPE_JOB_LINKS                    (ev_job_links_get_type())
  52 #define EV_JOB_LINKS(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LINKS, EvJobLinks))
  53 #define EV_JOB_LINKS_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LINKS, EvJobLinksClass))
  54 #define EV_IS_JOB_LINKS(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LINKS))
  55
  56 #define EV_TYPE_JOB_RENDER                   (ev_job_render_get_type())
  57 #define EV_JOB_RENDER(object)                (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_RENDER, EvJobRender))
  58 #define EV_JOB_RENDER_CLASS(klass)           (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_RENDER, EvJobRenderClass))
  59 #define EV_IS_JOB_RENDER(object)             (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_RENDER))
  60
  61 #define EV_TYPE_JOB_THUMBNAIL                (ev_job_thumbnail_get_type())
  62 #define EV_JOB_THUMBNAIL(object)             (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnail))
  63 #define EV_JOB_THUMBNAIL_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnailClass))
  64 #define EV_IS_JOB_THUMBNAIL(object)          (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_THUMBNAIL))
  65
  66 #define EV_TYPE_JOB_FONTS                    (ev_job_fonts_get_type())
  67 #define EV_JOB_FONTS(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_FONTS, EvJobFonts))
  68 #define EV_JOB_FONTS_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_FONTS, EvJobFontsClass))
  69 #define EV_IS_JOB_FONTS(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_FONTS))
  70
  71 #define EV_TYPE_JOB_XFER                     (ev_job_xfer_get_type())
  72 #define EV_JOB_XFER(object)                  (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_XFER, EvJobXfer))
  73 #define EV_JOB_XFER_CLASS(klass)             (G_TYPE_CHACK_CLASS_CAST((klass), EV_TYPE_JOB_XFER, EvJobXferClass))
  74 #define EV_IS_JOB_XFER(object)               (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_XFER))
  75
  76 typedef enum {
  77         EV_JOB_PRIORITY_LOW,
  78         EV_JOB_PRIORITY_HIGH,
  79 } EvJobPriority;
  80
  81 struct _EvJob
  82 {
  83         GObject parent;
  84         EvDocument *document;
  85         gboolean finished;
  86         gboolean async;
  87 };
  88
  89 struct _EvJobClass
  90 {
  91         GObjectClass parent_class;
  92
  93         void    (* finished) (EvJob *job);
  94 };
  95
  96 struct _EvJobLinks
  97 {
  98         EvJob parent;
  99
 100         GtkTreeModel *model;
 101 };
 102
 103 struct _EvJobLinksClass
 104 {
 105         EvJobClass parent_class;
 106 };
 107
 108 struct _EvJobRender
 109 {
 110         EvJob parent;
 111
 112         EvRenderContext *rc;
 113         gint target_width;
 114         gint target_height;
 115         GdkPixbuf *pixbuf;
 116
 117         GList *link_mapping;
 118         GdkRegion *text_mapping;
 119
 120         GdkPixbuf *selection;
 121         GdkRegion *selection_region;
 122         EvRectangle selection_points;
 123         GdkColor base;
 124         GdkColor text;
 125
 126         gint include_links : 1;
 127         gint include_text : 1;
 128         gint include_selection : 1;
 129 };
 130
 131 struct _EvJobRenderClass
 132 {
 133         EvJobClass parent_class;
 134 };
 135
 136 struct _EvJobThumbnail
 137 {
 138         EvJob parent;
 139
 140         gint page;
 141         gint rotation;
 142         gint requested_width;
 143         GdkPixbuf *thumbnail;
 144 };
 145
 146 struct _EvJobThumbnailClass
 147 {
 148         EvJobClass parent_class;
 149 };
 150
 151 struct _EvJobFonts
 152 {
 153         EvJob parent;
 154         gboolean scan_completed;
 155 };
 156
 157 struct _EvJobFontsClass
 158 {
 159         EvJobClass parent_class;
 160 };
 161
 162 struct _EvJobXfer
 163 {
 164         EvJob parent;
 165         EvLinkDest *dest;
 166         GError *error;
 167         char *uri;
 168         char *local_uri;
 169 };
 170
 171 struct _EvJobXferClass
 172 {
 173         EvJobClass parent_class;
 174 };
 175
 176 /* Base job class */
 177 GType           ev_job_get_type           (void);
 178 void            ev_job_finished           (EvJob          *job);
 179
 180 /* EvJobLinks */
 181 GType           ev_job_links_get_type     (void);
 182 EvJob          *ev_job_links_new          (EvDocument     *document);
 183 void            ev_job_links_run          (EvJobLinks     *thumbnail);
 184
 185 /* EvJobRender */
 186 GType           ev_job_render_get_type    (void);
 187 EvJob          *ev_job_render_new         (EvDocument      *document,
 188                                            EvRenderContext *rc,
 189                                            gint             width,
 190                                            gint             height,
 191                                            EvRectangle     *selection_points,
 192                                            GdkColor        *text,
 193                                            GdkColor        *base,
 194                                            gboolean         include_links,
 195                                            gboolean         include_text,
 196                                            gboolean         include_selection);
 197 void            ev_job_render_run         (EvJobRender     *thumbnail);
 198
 199 /* EvJobThumbnail */
 200 GType           ev_job_thumbnail_get_type (void);
 201 EvJob          *ev_job_thumbnail_new      (EvDocument     *document,
 202                                            gint            page,
 203                                            int             rotation,
 204                                            gint            requested_width);
 205 void            ev_job_thumbnail_run      (EvJobThumbnail *thumbnail);
 206
 207 /* EvJobFonts */
 208 GType           ev_job_fonts_get_type     (void);
 209 EvJob          *ev_job_fonts_new          (EvDocument      *document);
 210 void            ev_job_fonts_run          (EvJobFonts      *fonts);
 211
 212 /* EvJobXfer */
 213 GType           ev_job_xfer_get_type      (void);
 214 EvJob          *ev_job_xfer_new           (const gchar     *uri, EvLinkDest *dest);
 215 void            ev_job_xfer_run           (EvJobXfer       *xfer);
 216
 217 G_END_DECLS
 218
 219 #endif /* __EV_JOBS_H__ */