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