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