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         gint page;
 167         gint rotation;
 168         gdouble scale;
 169
 170         GdkPixbuf *thumbnail;
 171 };
 172
 173 struct _EvJobThumbnailClass
 174 {
 175         EvJobClass parent_class;
 176 };
 177
 178 struct _EvJobFonts
 179 {
 180         EvJob parent;
 181         gboolean scan_completed;
 182 };
 183
 184 struct _EvJobFontsClass
 185 {
 186         EvJobClass parent_class;
 187 };
 188
 189 struct _EvJobLoad
 190 {
 191         EvJob parent;
 192
 193         EvLinkDest *dest;
 194         EvWindowRunMode mode;
 195         gchar *search_string;
 196         GError *error;
 197         gchar *uri;
 198 };
 199
 200 struct _EvJobLoadClass
 201 {
 202         EvJobClass parent_class;
 203 };
 204
 205 struct _EvJobSave
 206 {
 207         EvJob parent;
 208
 209         GError *error;
 210         gchar *uri;
 211         gchar *document_uri;
 212 };
 213
 214 struct _EvJobSaveClass
 215 {
 216         EvJobClass parent_class;
 217 };
 218
 219 struct _EvJobPrint
 220 {
 221         EvJob parent;
 222
 223         GError *error;
 224         const gchar *format;
 225         gchar  *temp_file;
 226         EvPrintRange *ranges;
 227         gint n_ranges;
 228         EvPrintPageSet page_set;
 229         gint copies;
 230         gint pages_per_sheet;
 231         gboolean collate;
 232         gboolean reverse;
 233         gdouble width;
 234         gdouble height;
 235 };
 236
 237 struct _EvJobPrintClass
 238 {
 239         EvJobClass parent_class;
 240 };
 241
 242 /* Base job class */
 243 GType           ev_job_get_type           (void) G_GNUC_CONST;
 244 void            ev_job_finished           (EvJob          *job);
 245
 246 /* EvJobLinks */
 247 GType           ev_job_links_get_type     (void) G_GNUC_CONST;
 248 EvJob          *ev_job_links_new          (EvDocument     *document);
 249 void            ev_job_links_run          (EvJobLinks     *thumbnail);
 250
 251 /* EvJobRender */
 252 GType           ev_job_render_get_type    (void) G_GNUC_CONST;
 253 EvJob          *ev_job_render_new         (EvDocument      *document,
 254                                            EvRenderContext *rc,
 255                                            gint             width,
 256                                            gint             height,
 257                                            EvRectangle     *selection_points,
 258                                            EvSelectionStyle selection_style,
 259                                            GdkColor        *text,
 260                                            GdkColor        *base,
 261                                            gboolean         include_forms,
 262                                            gboolean         include_links,
 263                                            gboolean         include_images,
 264                                            gboolean         include_text,
 265                                            gboolean         include_selection);
 266 void            ev_job_render_run         (EvJobRender     *thumbnail);
 267
 268 /* EvJobThumbnail */
 269 GType           ev_job_thumbnail_get_type (void) G_GNUC_CONST;
 270 EvJob          *ev_job_thumbnail_new      (EvDocument      *document,
 271                                            gint             page,
 272                                            gint             rotation,
 273                                            gdouble          scale);
 274 void            ev_job_thumbnail_run      (EvJobThumbnail  *thumbnail);
 275
 276 /* EvJobFonts */
 277 GType           ev_job_fonts_get_type     (void) G_GNUC_CONST;
 278 EvJob          *ev_job_fonts_new          (EvDocument      *document);
 279 void            ev_job_fonts_run          (EvJobFonts      *fonts);
 280
 281 /* EvJobLoad */
 282 GType           ev_job_load_get_type      (void) G_GNUC_CONST;
 283 EvJob          *ev_job_load_new           (const gchar     *uri,
 284                                            EvLinkDest      *dest,
 285                                            EvWindowRunMode  mode,
 286                                            const gchar     *search_string);
 287 void            ev_job_load_set_uri       (EvJobLoad       *load,
 288                                            const gchar     *uri);
 289 void            ev_job_load_run           (EvJobLoad       *load);
 290
 291 /* EvJobSave */
 292 GType           ev_job_save_get_type      (void) G_GNUC_CONST;
 293 EvJob          *ev_job_save_new           (EvDocument      *document,
 294                                            const gchar     *uri,
 295                                            const gchar     *document_uri);
 296 void            ev_job_save_run           (EvJobSave       *save);
 297
 298 /* EvJobPrint */
 299 GType           ev_job_print_get_type     (void) G_GNUC_CONST;
 300 EvJob          *ev_job_print_new          (EvDocument      *document,
 301                                            const gchar     *format,
 302                                            gdouble          width,
 303                                            gdouble          height,
 304                                            EvPrintRange    *ranges,
 305                                            gint             n_ranges,
 306                                            EvPrintPageSet   page_set,
 307                                            gint             pages_per_sheet,
 308                                            gint             copies,
 309                                            gdouble          collate,
 310                                            gdouble          reverse);
 311 void            ev_job_print_run          (EvJobPrint      *print);
 312
 313 G_END_DECLS
 314
 315 #endif /* __EV_JOBS_H__ */