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 typedef struct _EvJobFind EvJobFind;
  61 typedef struct _EvJobFindClass EvJobFindClass;
  62
  63 #define EV_TYPE_JOB                          (ev_job_get_type())
  64 #define EV_JOB(object)                       (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB, EvJob))
  65 #define EV_JOB_CLASS(klass)                  (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB, EvJobClass))
  66 #define EV_IS_JOB(object)                    (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB))
  67 #define EV_JOB_GET_CLASS(object)             (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_JOB, EvJobClass))
  68
  69 #define EV_TYPE_JOB_LINKS                    (ev_job_links_get_type())
  70 #define EV_JOB_LINKS(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LINKS, EvJobLinks))
  71 #define EV_JOB_LINKS_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LINKS, EvJobLinksClass))
  72 #define EV_IS_JOB_LINKS(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LINKS))
  73
  74 #define EV_TYPE_JOB_ATTACHMENTS              (ev_job_attachments_get_type())
  75 #define EV_JOB_ATTACHMENTS(object)           (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_ATTACHMENTS, EvJobAttachments))
  76 #define EV_JOB_ATTACHMENTS_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_ATTACHMENTS, EvJobAttachmentsClass))
  77 #define EV_IS_JOB_ATTACHMENTS(object)        (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_ATTACHMENTS))
  78
  79 #define EV_TYPE_JOB_RENDER                   (ev_job_render_get_type())
  80 #define EV_JOB_RENDER(object)                (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_RENDER, EvJobRender))
  81 #define EV_JOB_RENDER_CLASS(klass)           (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_RENDER, EvJobRenderClass))
  82 #define EV_IS_JOB_RENDER(object)             (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_RENDER))
  83
  84 #define EV_TYPE_JOB_THUMBNAIL                (ev_job_thumbnail_get_type())
  85 #define EV_JOB_THUMBNAIL(object)             (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnail))
  86 #define EV_JOB_THUMBNAIL_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnailClass))
  87 #define EV_IS_JOB_THUMBNAIL(object)          (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_THUMBNAIL))
  88
  89 #define EV_TYPE_JOB_FONTS                    (ev_job_fonts_get_type())
  90 #define EV_JOB_FONTS(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_FONTS, EvJobFonts))
  91 #define EV_JOB_FONTS_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_FONTS, EvJobFontsClass))
  92 #define EV_IS_JOB_FONTS(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_FONTS))
  93
  94 #define EV_TYPE_JOB_LOAD                     (ev_job_load_get_type())
  95 #define EV_JOB_LOAD(object)                  (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LOAD, EvJobLoad))
  96 #define EV_JOB_LOAD_CLASS(klass)             (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LOAD, EvJobLoadClass))
  97 #define EV_IS_JOB_LOAD(object)               (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LOAD))
  98
  99 #define EV_TYPE_JOB_SAVE                     (ev_job_save_get_type())
 100 #define EV_JOB_SAVE(object)                  (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_SAVE, EvJobSave))
 101 #define EV_JOB_SAVE_CLASS(klass)             (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_SAVE, EvJobSaveClass))
 102 #define EV_IS_JOB_SAVE(object)               (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_SAVE))
 103
 104 #define EV_TYPE_JOB_PRINT                    (ev_job_print_get_type())
 105 #define EV_JOB_PRINT(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_PRINT, EvJobPrint))
 106 #define EV_JOB_PRINT_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_PRINT, EvJobPrintClass))
 107 #define EV_IS_JOB_PRINT(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_PRINT))
 108
 109 #define EV_TYPE_JOB_FIND                    (ev_job_find_get_type())
 110 #define EV_JOB_FIND(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_FIND, EvJobFind))
 111 #define EV_JOB_FIND_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_FIND, EvJobFindClass))
 112 #define EV_IS_JOB_FIND(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_FIND))
 113
 114 typedef enum {
 115         EV_JOB_RUN_THREAD,
 116         EV_JOB_RUN_MAIN_LOOP
 117 } EvJobRunMode;
 118
 119 struct _EvJob
 120 {
 121         GObject parent;
 122
 123         EvDocument *document;
 124
 125         EvJobRunMode run_mode;
 126
 127         guint cancelled : 1;
 128         guint finished : 1;
 129         guint failed : 1;
 130
 131         GError *error;
 132         GCancellable *cancellable;
 133
 134         guint idle_finished_id;
 135         guint idle_cancelled_id;
 136 };
 137
 138 struct _EvJobClass
 139 {
 140         GObjectClass parent_class;
 141
 142         gboolean (*run)         (EvJob *job);
 143
 144         /* Signals */
 145         void     (* cancelled)  (EvJob *job);
 146         void     (* finished)   (EvJob *job);
 147 };
 148
 149 struct _EvJobLinks
 150 {
 151         EvJob parent;
 152
 153         GtkTreeModel *model;
 154 };
 155
 156 struct _EvJobLinksClass
 157 {
 158         EvJobClass parent_class;
 159 };
 160
 161 struct _EvJobAttachments
 162 {
 163         EvJob parent;
 164
 165         GList *attachments;
 166 };
 167
 168 struct _EvJobAttachmentsClass
 169 {
 170         EvJobClass parent_class;
 171 };
 172
 173 typedef enum {
 174         EV_RENDER_INCLUDE_NONE      = 0,
 175         EV_RENDER_INCLUDE_LINKS     = 1 << 0,
 176         EV_RENDER_INCLUDE_TEXT      = 1 << 1,
 177         EV_RENDER_INCLUDE_SELECTION = 1 << 2,
 178         EV_RENDER_INCLUDE_IMAGES    = 1 << 3,
 179         EV_RENDER_INCLUDE_FORMS     = 1 << 4,
 180         EV_RENDER_INCLUDE_ALL       = (1 << 5) - 1
 181 } EvRenderFlags;
 182
 183 struct _EvJobRender
 184 {
 185         EvJob parent;
 186
 187         gint page;
 188         gint rotation;
 189         gdouble scale;
 190
 191         EvPage *ev_page;
 192         gboolean page_ready;
 193         gint target_width;
 194         gint target_height;
 195         cairo_surface_t *surface;
 196
 197         GList *link_mapping;
 198         GdkRegion *text_mapping;
 199         GList *image_mapping;
 200         GList *form_field_mapping;
 201
 202         cairo_surface_t *selection;
 203         GdkRegion *selection_region;
 204         EvRectangle selection_points;
 205         EvSelectionStyle selection_style;
 206         GdkColor base;
 207         GdkColor text;
 208
 209         EvRenderFlags flags;
 210 };
 211
 212 struct _EvJobRenderClass
 213 {
 214         EvJobClass parent_class;
 215
 216         void    (* page_ready) (EvJobRender *job);
 217 };
 218
 219 struct _EvJobThumbnail
 220 {
 221         EvJob parent;
 222
 223         gint page;
 224         gint rotation;
 225         gdouble scale;
 226
 227         GdkPixbuf *thumbnail;
 228 };
 229
 230 struct _EvJobThumbnailClass
 231 {
 232         EvJobClass parent_class;
 233 };
 234
 235 struct _EvJobFonts
 236 {
 237         EvJob parent;
 238         gboolean scan_completed;
 239 };
 240
 241 struct _EvJobFontsClass
 242 {
 243         EvJobClass parent_class;
 244
 245         /* Signals */
 246         void (* updated)  (EvJobFonts *job,
 247                            gdouble     progress);
 248 };
 249
 250 struct _EvJobLoad
 251 {
 252         EvJob parent;
 253
 254         EvLinkDest *dest;
 255         EvWindowRunMode mode;
 256         gchar *search_string;
 257         gchar *uri;
 258         gchar *password;
 259 };
 260
 261 struct _EvJobLoadClass
 262 {
 263         EvJobClass parent_class;
 264 };
 265
 266 struct _EvJobSave
 267 {
 268         EvJob parent;
 269
 270         gchar *uri;
 271         gchar *document_uri;
 272 };
 273
 274 struct _EvJobSaveClass
 275 {
 276         EvJobClass parent_class;
 277 };
 278
 279 struct _EvJobPrint
 280 {
 281         EvJob parent;
 282
 283         const gchar *format;
 284         gchar  *temp_file;
 285         EvPrintRange *ranges;
 286         gint n_ranges;
 287         EvPrintPageSet page_set;
 288         gint copies;
 289         gint pages_per_sheet;
 290         gboolean collate;
 291         gboolean reverse;
 292         gdouble width;
 293         gdouble height;
 294 };
 295
 296 struct _EvJobPrintClass
 297 {
 298         EvJobClass parent_class;
 299 };
 300
 301 struct _EvJobFind
 302 {
 303         EvJob parent;
 304
 305         gint start_page;
 306         gint current_page;
 307         gint n_pages;
 308         GList **pages;
 309         gchar *text;
 310         gboolean case_sensitive;
 311         gboolean has_results;
 312 };
 313
 314 struct _EvJobFindClass
 315 {
 316         EvJobClass parent_class;
 317
 318         /* Signals */
 319         void (* updated)  (EvJobFind *job,
 320                            gint       page);
 321 };
 322
 323 /* Base job class */
 324 GType           ev_job_get_type           (void) G_GNUC_CONST;
 325 gboolean        ev_job_run                (EvJob          *job);
 326 void            ev_job_cancel             (EvJob          *job);
 327 void            ev_job_failed             (EvJob          *job,
 328                                            GQuark          domain,
 329                                            gint            code,
 330                                            const gchar    *format,
 331                                            ...);
 332 void            ev_job_failed_from_error  (EvJob          *job,
 333                                            GError         *error);
 334 void            ev_job_succeeded          (EvJob          *job);
 335 gboolean        ev_job_is_cancelled       (EvJob          *job);
 336 gboolean        ev_job_is_finished        (EvJob          *job);
 337 gboolean        ev_job_is_failed          (EvJob          *job);
 338 EvJobRunMode    ev_job_get_run_mode       (EvJob          *job);
 339 void            ev_job_set_run_mode       (EvJob          *job,
 340                                            EvJobRunMode    run_mode);
 341
 342 /* EvJobLinks */
 343 GType           ev_job_links_get_type     (void) G_GNUC_CONST;
 344 EvJob          *ev_job_links_new          (EvDocument     *document);
 345
 346 /* EvJobAttachments */
 347 GType           ev_job_attachments_get_type (void) G_GNUC_CONST;
 348 EvJob          *ev_job_attachments_new      (EvDocument     *document);
 349
 350 /* EvJobRender */
 351 GType           ev_job_render_get_type    (void) G_GNUC_CONST;
 352 EvJob          *ev_job_render_new         (EvDocument      *document,
 353                                            gint             page,
 354                                            gint             rotation,
 355                                            gdouble          scale,
 356                                            gint             width,
 357                                            gint             height,
 358                                            EvRenderFlags    flags);
 359 void     ev_job_render_set_selection_info (EvJobRender     *job,
 360                                            EvRectangle     *selection_points,
 361                                            EvSelectionStyle selection_style,
 362                                            GdkColor        *text,
 363                                            GdkColor        *base);
 364 /* EvJobThumbnail */
 365 GType           ev_job_thumbnail_get_type (void) G_GNUC_CONST;
 366 EvJob          *ev_job_thumbnail_new      (EvDocument      *document,
 367                                            gint             page,
 368                                            gint             rotation,
 369                                            gdouble          scale);
 370 /* EvJobFonts */
 371 GType           ev_job_fonts_get_type     (void) G_GNUC_CONST;
 372 EvJob          *ev_job_fonts_new          (EvDocument      *document);
 373
 374 /* EvJobLoad */
 375 GType           ev_job_load_get_type      (void) G_GNUC_CONST;
 376 EvJob          *ev_job_load_new           (const gchar     *uri,
 377                                            EvLinkDest      *dest,
 378                                            EvWindowRunMode  mode,
 379                                            const gchar     *search_string);
 380 void            ev_job_load_set_uri       (EvJobLoad       *load,
 381                                            const gchar     *uri);
 382 void            ev_job_load_set_password  (EvJobLoad       *job,
 383                                            const gchar     *password);
 384
 385 /* EvJobSave */
 386 GType           ev_job_save_get_type      (void) G_GNUC_CONST;
 387 EvJob          *ev_job_save_new           (EvDocument      *document,
 388                                            const gchar     *uri,
 389                                            const gchar     *document_uri);
 390
 391 /* EvJobPrint */
 392 GType           ev_job_print_get_type     (void) G_GNUC_CONST;
 393 EvJob          *ev_job_print_new          (EvDocument      *document,
 394                                            const gchar     *format,
 395                                            gdouble          width,
 396                                            gdouble          height,
 397                                            EvPrintRange    *ranges,
 398                                            gint             n_ranges,
 399                                            EvPrintPageSet   page_set,
 400                                            gint             pages_per_sheet,
 401                                            gint             copies,
 402                                            gdouble          collate,
 403                                            gdouble          reverse);
 404 /* EvJobFind */
 405 GType           ev_job_find_get_type      (void) G_GNUC_CONST;
 406 EvJob          *ev_job_find_new           (EvDocument      *document,
 407                                            gint             start_page,
 408                                            gint             n_pages,
 409                                            const gchar     *text,
 410                                            gboolean         case_sensitive);
 411 gint            ev_job_find_get_n_results (EvJobFind       *job,
 412                                            gint             pages);
 413 gdouble         ev_job_find_get_progress  (EvJobFind       *job);
 414 gboolean        ev_job_find_has_results   (EvJobFind       *job);
 415 GList         **ev_job_find_get_results   (EvJobFind       *job);
 416
 417 G_END_DECLS
 418
 419 #endif /* __EV_JOBS_H__ */