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 #include "ev-selection.h"
  27
  28 G_BEGIN_DECLS
  29
  30 typedef struct _EvJob EvJob;
  31 typedef struct _EvJobClass EvJobClass;
  32
  33 typedef struct _EvJobRender EvJobRender;
  34 typedef struct _EvJobRenderClass EvJobRenderClass;
  35
  36 typedef struct _EvJobThumbnail EvJobThumbnail;
  37 typedef struct _EvJobThumbnailClass EvJobThumbnailClass;
  38
  39 typedef struct _EvJobLinks EvJobLinks;
  40 typedef struct _EvJobLinksClass EvJobLinksClass;
  41
  42 typedef struct _EvJobFonts EvJobFonts;
  43 typedef struct _EvJobFontsClass EvJobFontsClass;
  44
  45 typedef struct _EvJobLoad EvJobLoad;
  46 typedef struct _EvJobLoadClass EvJobLoadClass;
  47
  48 typedef struct _EvJobSave EvJobSave;
  49 typedef struct _EvJobSaveClass EvJobSaveClass;
  50
  51 typedef struct _EvJobPrint EvJobPrint;
  52 typedef struct _EvJobPrintClass EvJobPrintClass;
  53
  54 #define EV_TYPE_JOB                          (ev_job_get_type())
  55 #define EV_JOB(object)                       (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB, EvJob))
  56 #define EV_JOB_CLASS(klass)                  (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB, EvJobClass))
  57 #define EV_IS_JOB(object)                    (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB))
  58
  59 #define EV_TYPE_JOB_LINKS                    (ev_job_links_get_type())
  60 #define EV_JOB_LINKS(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LINKS, EvJobLinks))
  61 #define EV_JOB_LINKS_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LINKS, EvJobLinksClass))
  62 #define EV_IS_JOB_LINKS(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LINKS))
  63
  64 #define EV_TYPE_JOB_RENDER                   (ev_job_render_get_type())
  65 #define EV_JOB_RENDER(object)                (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_RENDER, EvJobRender))
  66 #define EV_JOB_RENDER_CLASS(klass)           (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_RENDER, EvJobRenderClass))
  67 #define EV_IS_JOB_RENDER(object)             (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_RENDER))
  68
  69 #define EV_TYPE_JOB_THUMBNAIL                (ev_job_thumbnail_get_type())
  70 #define EV_JOB_THUMBNAIL(object)             (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnail))
  71 #define EV_JOB_THUMBNAIL_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnailClass))
  72 #define EV_IS_JOB_THUMBNAIL(object)          (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_THUMBNAIL))
  73
  74 #define EV_TYPE_JOB_FONTS                    (ev_job_fonts_get_type())
  75 #define EV_JOB_FONTS(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_FONTS, EvJobFonts))
  76 #define EV_JOB_FONTS_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_FONTS, EvJobFontsClass))
  77 #define EV_IS_JOB_FONTS(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_FONTS))
  78
  79 #define EV_TYPE_JOB_LOAD                     (ev_job_load_get_type())
  80 #define EV_JOB_LOAD(object)                  (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LOAD, EvJobLoad))
  81 #define EV_JOB_LOAD_CLASS(klass)             (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LOAD, EvJobLoadClass))
  82 #define EV_IS_JOB_LOAD(object)               (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LOAD))
  83
  84 #define EV_TYPE_JOB_SAVE                     (ev_job_save_get_type())
  85 #define EV_JOB_SAVE(object)                  (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_SAVE, EvJobSave))
  86 #define EV_JOB_SAVE_CLASS(klass)             (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_SAVE, EvJobSaveClass))
  87 #define EV_IS_JOB_SAVE(object)               (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_SAVE))
  88
  89 #define EV_TYPE_JOB_PRINT                    (ev_job_print_get_type())
  90 #define EV_JOB_PRINT(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_PRINT, EvJobPrint))
  91 #define EV_JOB_PRINT_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_PRINT, EvJobPrintClass))
  92 #define EV_IS_JOB_PRINT(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_PRINT))
  93
  94 typedef enum {
  95         EV_JOB_PRIORITY_LOW,
  96         EV_JOB_PRIORITY_HIGH,
  97 } EvJobPriority;
  98
  99 struct _EvJob
 100 {
 101         GObject parent;
 102         EvDocument *document;
 103         gboolean finished;
 104         gboolean async;
 105 };
 106
 107 struct _EvJobClass
 108 {
 109         GObjectClass parent_class;
 110
 111         void    (* finished) (EvJob *job);
 112 };
 113
 114 struct _EvJobLinks
 115 {
 116         EvJob parent;
 117
 118         GtkTreeModel *model;
 119 };
 120
 121 struct _EvJobLinksClass
 122 {
 123         EvJobClass parent_class;
 124 };
 125
 126 struct _EvJobRender
 127 {
 128         EvJob parent;
 129
 130         EvRenderContext *rc;
 131         gboolean page_ready;
 132         gint target_width;
 133         gint target_height;
 134         cairo_surface_t *surface;
 135
 136         GList *link_mapping;
 137         GdkRegion *text_mapping;
 138         GList *image_mapping;
 139         GList *form_field_mapping;
 140
 141         cairo_surface_t *selection;
 142         GdkRegion *selection_region;
 143         EvRectangle selection_points;
 144         EvSelectionStyle selection_style;
 145         GdkColor base;
 146         GdkColor text;
 147
 148         gint include_forms : 1;
 149         gint include_links : 1;
 150         gint include_text : 1;
 151         gint include_selection : 1;
 152         gint include_images : 1;
 153 };
 154
 155 struct _EvJobRenderClass
 156 {
 157         EvJobClass parent_class;
 158
 159         void    (* page_ready) (EvJobRender *job);
 160 };
 161
 162 struct _EvJobThumbnail
 163 {
 164         EvJob parent;
 165
 166         EvRenderContext *rc;
 167         GdkPixbuf *thumbnail;
 168 };
 169
 170 struct _EvJobThumbnailClass
 171 {
 172         EvJobClass parent_class;
 173 };
 174
 175 struct _EvJobFonts
 176 {
 177         EvJob parent;
 178         gboolean scan_completed;
 179 };
 180
 181 struct _EvJobFontsClass
 182 {
 183         EvJobClass parent_class;
 184 };
 185
 186 struct _EvJobLoad
 187 {
 188         EvJob parent;
 189
 190         EvLinkDest *dest;
 191         EvWindowRunMode mode;
 192         gchar *search_string;
 193         GError *error;
 194         gchar *uri;
 195 };
 196
 197 struct _EvJobLoadClass
 198 {
 199         EvJobClass parent_class;
 200 };
 201
 202 struct _EvJobSave
 203 {
 204         EvJob parent;
 205
 206         GError *error;
 207         gchar *uri;
 208         gchar *document_uri;
 209 };
 210
 211 struct _EvJobSaveClass
 212 {
 213         EvJobClass parent_class;
 214 };
 215
 216 struct _EvJobPrint
 217 {
 218         EvJob parent;
 219
 220         GError *error;
 221         const gchar *format;
 222         gchar  *temp_file;
 223         EvPrintRange *ranges;
 224         gint n_ranges;
 225         EvPrintPageSet page_set;
 226         gint copies;
 227         gint pages_per_sheet;
 228         gboolean collate;
 229         gboolean reverse;
 230         gdouble width;
 231         gdouble height;
 232 };
 233
 234 struct _EvJobPrintClass
 235 {
 236         EvJobClass parent_class;
 237 };
 238
 239 /* Base job class */
 240 GType           ev_job_get_type           (void) G_GNUC_CONST;
 241 void            ev_job_finished           (EvJob          *job);
 242
 243 /* EvJobLinks */
 244 GType           ev_job_links_get_type     (void) G_GNUC_CONST;
 245 EvJob          *ev_job_links_new          (EvDocument     *document);
 246 void            ev_job_links_run          (EvJobLinks     *thumbnail);
 247
 248 /* EvJobRender */
 249 GType           ev_job_render_get_type    (void) G_GNUC_CONST;
 250 EvJob          *ev_job_render_new         (EvDocument      *document,
 251                                            EvRenderContext *rc,
 252                                            gint             width,
 253                                            gint             height,
 254                                            EvRectangle     *selection_points,
 255                                            EvSelectionStyle selection_style,
 256                                            GdkColor        *text,
 257                                            GdkColor        *base,
 258                                            gboolean         include_forms,
 259                                            gboolean         include_links,
 260                                            gboolean         include_images,
 261                                            gboolean         include_text,
 262                                            gboolean         include_selection);
 263 void            ev_job_render_run         (EvJobRender     *thumbnail);
 264
 265 /* EvJobThumbnail */
 266 GType           ev_job_thumbnail_get_type (void) G_GNUC_CONST;
 267 EvJob          *ev_job_thumbnail_new      (EvDocument      *document,
 268                                            EvRenderContext *rc);
 269 void            ev_job_thumbnail_run      (EvJobThumbnail  *thumbnail);
 270
 271 /* EvJobFonts */
 272 GType           ev_job_fonts_get_type     (void) G_GNUC_CONST;
 273 EvJob          *ev_job_fonts_new          (EvDocument      *document);
 274 void            ev_job_fonts_run          (EvJobFonts      *fonts);
 275
 276 /* EvJobLoad */
 277 GType           ev_job_load_get_type      (void) G_GNUC_CONST;
 278 EvJob          *ev_job_load_new           (const gchar     *uri,
 279                                            EvLinkDest      *dest,
 280                                            EvWindowRunMode  mode,
 281                                            const gchar     *search_string);
 282 void            ev_job_load_set_uri       (EvJobLoad       *load,
 283                                            const gchar     *uri);
 284 void            ev_job_load_run           (EvJobLoad       *load);
 285
 286 /* EvJobSave */
 287 GType           ev_job_save_get_type      (void) G_GNUC_CONST;
 288 EvJob          *ev_job_save_new           (EvDocument      *document,
 289                                            const gchar     *uri,
 290                                            const gchar     *document_uri);
 291 void            ev_job_save_run           (EvJobSave       *save);
 292
 293 /* EvJobPrint */
 294 GType           ev_job_print_get_type     (void) G_GNUC_CONST;
 295 EvJob          *ev_job_print_new          (EvDocument      *document,
 296                                            const gchar     *format,
 297                                            gdouble          width,
 298                                            gdouble          height,
 299                                            EvPrintRange    *ranges,
 300                                            gint             n_ranges,
 301                                            EvPrintPageSet   page_set,
 302                                            gint             pages_per_sheet,
 303                                            gint             copies,
 304                                            gdouble          collate,
 305                                            gdouble          reverse);
 306 void            ev_job_print_run          (EvJobPrint      *print);
 307
 308 G_END_DECLS
 309
 310 #endif /* __EV_JOBS_H__ */