shell/ev-jobs.h

   1 /* this file is part of evince, a gnome document viewer
   2  *
   3  *  Copyright (C) 2008 Carlos Garcia Campos <carlosgc@gnome.org>
   4  *  Copyright (C) 2005 Red Hat, Inc
   5  *
   6  * Evince is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Evince is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef __EV_JOBS_H__
  22 #define __EV_JOBS_H__
  23
  24 #include <gio/gio.h>
  25 #include <gtk/gtk.h>
  26
  27 #include "ev-document.h"
  28 #include "ev-selection.h"
  29 #include "ev-window.h"
  30
  31 G_BEGIN_DECLS
  32
  33 typedef struct _EvJob EvJob;
  34 typedef struct _EvJobClass EvJobClass;
  35
  36 typedef struct _EvJobRender EvJobRender;
  37 typedef struct _EvJobRenderClass EvJobRenderClass;
  38
  39 typedef struct _EvJobThumbnail EvJobThumbnail;
  40 typedef struct _EvJobThumbnailClass EvJobThumbnailClass;
  41
  42 typedef struct _EvJobLinks EvJobLinks;
  43 typedef struct _EvJobLinksClass EvJobLinksClass;
  44
  45 typedef struct _EvJobAttachments EvJobAttachments;
  46 typedef struct _EvJobAttachmentsClass EvJobAttachmentsClass;
  47
  48 typedef struct _EvJobFonts EvJobFonts;
  49 typedef struct _EvJobFontsClass EvJobFontsClass;
  50
  51 typedef struct _EvJobLoad EvJobLoad;
  52 typedef struct _EvJobLoadClass EvJobLoadClass;
  53
  54 typedef struct _EvJobSave EvJobSave;
  55 typedef struct _EvJobSaveClass EvJobSaveClass;
  56
  57 typedef struct _EvJobPrint EvJobPrint;
  58 typedef struct _EvJobPrintClass EvJobPrintClass;
  59
  60 #define EV_TYPE_JOB                          (ev_job_get_type())
  61 #define EV_JOB(object)                       (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB, EvJob))
  62 #define EV_JOB_CLASS(klass)                  (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB, EvJobClass))
  63 #define EV_IS_JOB(object)                    (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB))
  64 #define EV_JOB_GET_CLASS(object)             (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_JOB, EvJobClass))
  65
  66 #define EV_TYPE_JOB_LINKS                    (ev_job_links_get_type())
  67 #define EV_JOB_LINKS(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LINKS, EvJobLinks))
  68 #define EV_JOB_LINKS_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LINKS, EvJobLinksClass))
  69 #define EV_IS_JOB_LINKS(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LINKS))
  70
  71 #define EV_TYPE_JOB_ATTACHMENTS              (ev_job_attachments_get_type())
  72 #define EV_JOB_ATTACHMENTS(object)           (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_ATTACHMENTS, EvJobAttachments))
  73 #define EV_JOB_ATTACHMENTS_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_ATTACHMENTS, EvJobAttachmentsClass))
  74 #define EV_IS_JOB_ATTACHMENTS(object)        (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_ATTACHMENTS))
  75
  76 #define EV_TYPE_JOB_RENDER                   (ev_job_render_get_type())
  77 #define EV_JOB_RENDER(object)                (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_RENDER, EvJobRender))
  78 #define EV_JOB_RENDER_CLASS(klass)           (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_RENDER, EvJobRenderClass))
  79 #define EV_IS_JOB_RENDER(object)             (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_RENDER))
  80
  81 #define EV_TYPE_JOB_THUMBNAIL                (ev_job_thumbnail_get_type())
  82 #define EV_JOB_THUMBNAIL(object)             (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnail))
  83 #define EV_JOB_THUMBNAIL_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnailClass))
  84 #define EV_IS_JOB_THUMBNAIL(object)          (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_THUMBNAIL))
  85
  86 #define EV_TYPE_JOB_FONTS                    (ev_job_fonts_get_type())
  87 #define EV_JOB_FONTS(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_FONTS, EvJobFonts))
  88 #define EV_JOB_FONTS_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_FONTS, EvJobFontsClass))
  89 #define EV_IS_JOB_FONTS(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_FONTS))
  90
  91 #define EV_TYPE_JOB_LOAD                     (ev_job_load_get_type())
  92 #define EV_JOB_LOAD(object)                  (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LOAD, EvJobLoad))
  93 #define EV_JOB_LOAD_CLASS(klass)             (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LOAD, EvJobLoadClass))
  94 #define EV_IS_JOB_LOAD(object)               (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LOAD))
  95
  96 #define EV_TYPE_JOB_SAVE                     (ev_job_save_get_type())
  97 #define EV_JOB_SAVE(object)                  (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_SAVE, EvJobSave))
  98 #define EV_JOB_SAVE_CLASS(klass)             (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_SAVE, EvJobSaveClass))
  99 #define EV_IS_JOB_SAVE(object)               (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_SAVE))
 100
 101 #define EV_TYPE_JOB_PRINT                    (ev_job_print_get_type())
 102 #define EV_JOB_PRINT(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_PRINT, EvJobPrint))
 103 #define EV_JOB_PRINT_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_PRINT, EvJobPrintClass))
 104 #define EV_IS_JOB_PRINT(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_PRINT))
 105
 106 typedef enum {
 107         EV_JOB_RUN_THREAD,
 108         EV_JOB_RUN_MAIN_LOOP
 109 } EvJobRunMode;
 110
 111 struct _EvJob
 112 {
 113         GObject parent;
 114
 115         EvDocument *document;
 116
 117         EvJobRunMode run_mode;
 118
 119         guint cancelled : 1;
 120         guint finished : 1;
 121         guint failed : 1;
 122
 123         GError *error;
 124         GCancellable *cancellable;
 125
 126         guint idle_finished_id;
 127         guint idle_cancelled_id;
 128 };
 129
 130 struct _EvJobClass
 131 {
 132         GObjectClass parent_class;
 133
 134         gboolean (*run)         (EvJob *job);
 135
 136         /* Signals */
 137         void     (* cancelled)  (EvJob *job);
 138         void     (* finished)   (EvJob *job);
 139 };
 140
 141 struct _EvJobLinks
 142 {
 143         EvJob parent;
 144
 145         GtkTreeModel *model;
 146 };
 147
 148 struct _EvJobLinksClass
 149 {
 150         EvJobClass parent_class;
 151 };
 152
 153 struct _EvJobAttachments
 154 {
 155         EvJob parent;
 156
 157         GList *attachments;
 158 };
 159
 160 struct _EvJobAttachmentsClass
 161 {
 162         EvJobClass parent_class;
 163 };
 164
 165 typedef enum {
 166         EV_RENDER_INCLUDE_NONE      = 0,
 167         EV_RENDER_INCLUDE_LINKS     = 1 << 0,
 168         EV_RENDER_INCLUDE_TEXT      = 1 << 1,
 169         EV_RENDER_INCLUDE_SELECTION = 1 << 2,
 170         EV_RENDER_INCLUDE_IMAGES    = 1 << 3,
 171         EV_RENDER_INCLUDE_FORMS     = 1 << 4,
 172         EV_RENDER_INCLUDE_ALL       = (1 << 5) - 1
 173 } EvRenderFlags;
 174
 175 struct _EvJobRender
 176 {
 177         EvJob parent;
 178
 179         gint page;
 180         gint rotation;
 181         gdouble scale;
 182
 183         EvPage *ev_page;
 184         gboolean page_ready;
 185         gint target_width;
 186         gint target_height;
 187         cairo_surface_t *surface;
 188
 189         GList *link_mapping;
 190         GdkRegion *text_mapping;
 191         GList *image_mapping;
 192         GList *form_field_mapping;
 193
 194         cairo_surface_t *selection;
 195         GdkRegion *selection_region;
 196         EvRectangle selection_points;
 197         EvSelectionStyle selection_style;
 198         GdkColor base;
 199         GdkColor text;
 200
 201         EvRenderFlags flags;
 202 };
 203
 204 struct _EvJobRenderClass
 205 {
 206         EvJobClass parent_class;
 207
 208         void    (* page_ready) (EvJobRender *job);
 209 };
 210
 211 struct _EvJobThumbnail
 212 {
 213         EvJob parent;
 214
 215         gint page;
 216         gint rotation;
 217         gdouble scale;
 218
 219         GdkPixbuf *thumbnail;
 220 };
 221
 222 struct _EvJobThumbnailClass
 223 {
 224         EvJobClass parent_class;
 225 };
 226
 227 struct _EvJobFonts
 228 {
 229         EvJob parent;
 230         gboolean scan_completed;
 231 };
 232
 233 struct _EvJobFontsClass
 234 {
 235         EvJobClass parent_class;
 236
 237         /* Signals */
 238         void (* updated)  (EvJobFonts *job);
 239 };
 240
 241 struct _EvJobLoad
 242 {
 243         EvJob parent;
 244
 245         EvLinkDest *dest;
 246         EvWindowRunMode mode;
 247         gchar *search_string;
 248         gchar *uri;
 249         gchar *password;
 250 };
 251
 252 struct _EvJobLoadClass
 253 {
 254         EvJobClass parent_class;
 255 };
 256
 257 struct _EvJobSave
 258 {
 259         EvJob parent;
 260
 261         gchar *uri;
 262         gchar *document_uri;
 263 };
 264
 265 struct _EvJobSaveClass
 266 {
 267         EvJobClass parent_class;
 268 };
 269
 270 struct _EvJobPrint
 271 {
 272         EvJob parent;
 273
 274         const gchar *format;
 275         gchar  *temp_file;
 276         EvPrintRange *ranges;
 277         gint n_ranges;
 278         EvPrintPageSet page_set;
 279         gint copies;
 280         gint pages_per_sheet;
 281         gboolean collate;
 282         gboolean reverse;
 283         gdouble width;
 284         gdouble height;
 285 };
 286
 287 struct _EvJobPrintClass
 288 {
 289         EvJobClass parent_class;
 290 };
 291
 292 /* Base job class */
 293 GType           ev_job_get_type           (void) G_GNUC_CONST;
 294 gboolean        ev_job_run                (EvJob          *job);
 295 void            ev_job_cancel             (EvJob          *job);
 296 void            ev_job_failed             (EvJob          *job,
 297                                            GQuark          domain,
 298                                            gint            code,
 299                                            const gchar    *format,
 300                                            ...);
 301 void            ev_job_failed_from_error  (EvJob          *job,
 302                                            GError         *error);
 303 void            ev_job_succeeded          (EvJob          *job);
 304 gboolean        ev_job_is_cancelled       (EvJob          *job);
 305 gboolean        ev_job_is_finished        (EvJob          *job);
 306 gboolean        ev_job_is_failed          (EvJob          *job);
 307 EvJobRunMode    ev_job_get_run_mode       (EvJob          *job);
 308 void            ev_job_set_run_mode       (EvJob          *job,
 309                                            EvJobRunMode    run_mode);
 310
 311 /* EvJobLinks */
 312 GType           ev_job_links_get_type     (void) G_GNUC_CONST;
 313 EvJob          *ev_job_links_new          (EvDocument     *document);
 314
 315 /* EvJobAttachments */
 316 GType           ev_job_attachments_get_type (void) G_GNUC_CONST;
 317 EvJob          *ev_job_attachments_new      (EvDocument     *document);
 318
 319 /* EvJobRender */
 320 GType           ev_job_render_get_type    (void) G_GNUC_CONST;
 321 EvJob          *ev_job_render_new         (EvDocument      *document,
 322                                            gint             page,
 323                                            gint             rotation,
 324                                            gdouble          scale,
 325                                            gint             width,
 326                                            gint             height,
 327                                            EvRenderFlags    flags);
 328 void     ev_job_render_set_selection_info (EvJobRender     *job,
 329                                            EvRectangle     *selection_points,
 330                                            EvSelectionStyle selection_style,
 331                                            GdkColor        *text,
 332                                            GdkColor        *base);
 333 /* EvJobThumbnail */
 334 GType           ev_job_thumbnail_get_type (void) G_GNUC_CONST;
 335 EvJob          *ev_job_thumbnail_new      (EvDocument      *document,
 336                                            gint             page,
 337                                            gint             rotation,
 338                                            gdouble          scale);
 339 /* EvJobFonts */
 340 GType           ev_job_fonts_get_type     (void) G_GNUC_CONST;
 341 EvJob          *ev_job_fonts_new          (EvDocument      *document);
 342
 343 /* EvJobLoad */
 344 GType           ev_job_load_get_type      (void) G_GNUC_CONST;
 345 EvJob          *ev_job_load_new           (const gchar     *uri,
 346                                            EvLinkDest      *dest,
 347                                            EvWindowRunMode  mode,
 348                                            const gchar     *search_string);
 349 void            ev_job_load_set_uri       (EvJobLoad       *load,
 350                                            const gchar     *uri);
 351 void            ev_job_load_set_password  (EvJobLoad       *job,
 352                                            const gchar     *password);
 353
 354 /* EvJobSave */
 355 GType           ev_job_save_get_type      (void) G_GNUC_CONST;
 356 EvJob          *ev_job_save_new           (EvDocument      *document,
 357                                            const gchar     *uri,
 358                                            const gchar     *document_uri);
 359
 360 /* EvJobPrint */
 361 GType           ev_job_print_get_type     (void) G_GNUC_CONST;
 362 EvJob          *ev_job_print_new          (EvDocument      *document,
 363                                            const gchar     *format,
 364                                            gdouble          width,
 365                                            gdouble          height,
 366                                            EvPrintRange    *ranges,
 367                                            gint             n_ranges,
 368                                            EvPrintPageSet   page_set,
 369                                            gint             pages_per_sheet,
 370                                            gint             copies,
 371                                            gdouble          collate,
 372                                            gdouble          reverse);
 373
 374 G_END_DECLS
 375
 376 #endif /* __EV_JOBS_H__ */