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