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