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 typedef enum {
 127         EV_RENDER_INCLUDE_NONE      = 0,
 128         EV_RENDER_INCLUDE_LINKS     = 1 << 0,
 129         EV_RENDER_INCLUDE_TEXT      = 1 << 1,
 130         EV_RENDER_INCLUDE_SELECTION = 1 << 2,
 131         EV_RENDER_INCLUDE_IMAGES    = 1 << 3,
 132         EV_RENDER_INCLUDE_FORMS     = 1 << 4,
 133         EV_RENDER_INCLUDE_ALL       = (1 << 5) - 1
 134 } EvRenderFlags;
 135
 136 struct _EvJobRender
 137 {
 138         EvJob parent;
 139
 140         gint page;
 141         gint rotation;
 142         gdouble scale;
 143
 144         EvPage *ev_page;
 145         gboolean page_ready;
 146         gint target_width;
 147         gint target_height;
 148         cairo_surface_t *surface;
 149
 150         GList *link_mapping;
 151         GdkRegion *text_mapping;
 152         GList *image_mapping;
 153         GList *form_field_mapping;
 154
 155         cairo_surface_t *selection;
 156         GdkRegion *selection_region;
 157         EvRectangle selection_points;
 158         EvSelectionStyle selection_style;
 159         GdkColor base;
 160         GdkColor text;
 161
 162         EvRenderFlags flags;
 163 };
 164
 165 struct _EvJobRenderClass
 166 {
 167         EvJobClass parent_class;
 168
 169         void    (* page_ready) (EvJobRender *job);
 170 };
 171
 172 struct _EvJobThumbnail
 173 {
 174         EvJob parent;
 175
 176         gint page;
 177         gint rotation;
 178         gdouble scale;
 179
 180         GdkPixbuf *thumbnail;
 181 };
 182
 183 struct _EvJobThumbnailClass
 184 {
 185         EvJobClass parent_class;
 186 };
 187
 188 struct _EvJobFonts
 189 {
 190         EvJob parent;
 191         gboolean scan_completed;
 192 };
 193
 194 struct _EvJobFontsClass
 195 {
 196         EvJobClass parent_class;
 197 };
 198
 199 struct _EvJobLoad
 200 {
 201         EvJob parent;
 202
 203         EvLinkDest *dest;
 204         EvWindowRunMode mode;
 205         gchar *search_string;
 206         GError *error;
 207         gchar *uri;
 208 };
 209
 210 struct _EvJobLoadClass
 211 {
 212         EvJobClass parent_class;
 213 };
 214
 215 struct _EvJobSave
 216 {
 217         EvJob parent;
 218
 219         GError *error;
 220         gchar *uri;
 221         gchar *document_uri;
 222 };
 223
 224 struct _EvJobSaveClass
 225 {
 226         EvJobClass parent_class;
 227 };
 228
 229 struct _EvJobPrint
 230 {
 231         EvJob parent;
 232
 233         GError *error;
 234         const gchar *format;
 235         gchar  *temp_file;
 236         EvPrintRange *ranges;
 237         gint n_ranges;
 238         EvPrintPageSet page_set;
 239         gint copies;
 240         gint pages_per_sheet;
 241         gboolean collate;
 242         gboolean reverse;
 243         gdouble width;
 244         gdouble height;
 245 };
 246
 247 struct _EvJobPrintClass
 248 {
 249         EvJobClass parent_class;
 250 };
 251
 252 /* Base job class */
 253 GType           ev_job_get_type           (void) G_GNUC_CONST;
 254 void            ev_job_finished           (EvJob          *job);
 255
 256 /* EvJobLinks */
 257 GType           ev_job_links_get_type     (void) G_GNUC_CONST;
 258 EvJob          *ev_job_links_new          (EvDocument     *document);
 259 void            ev_job_links_run          (EvJobLinks     *thumbnail);
 260
 261 /* EvJobRender */
 262 GType           ev_job_render_get_type    (void) G_GNUC_CONST;
 263 EvJob          *ev_job_render_new         (EvDocument      *document,
 264                                            gint             page,
 265                                            gint             rotation,
 266                                            gdouble          scale,
 267                                            gint             width,
 268                                            gint             height,
 269                                            EvRenderFlags    flags);
 270 void     ev_job_render_set_selection_info (EvJobRender     *job,
 271                                            EvRectangle     *selection_points,
 272                                            EvSelectionStyle selection_style,
 273                                            GdkColor        *text,
 274                                            GdkColor        *base);
 275 void            ev_job_render_run         (EvJobRender     *thumbnail);
 276
 277 /* EvJobThumbnail */
 278 GType           ev_job_thumbnail_get_type (void) G_GNUC_CONST;
 279 EvJob          *ev_job_thumbnail_new      (EvDocument      *document,
 280                                            gint             page,
 281                                            gint             rotation,
 282                                            gdouble          scale);
 283 void            ev_job_thumbnail_run      (EvJobThumbnail  *thumbnail);
 284
 285 /* EvJobFonts */
 286 GType           ev_job_fonts_get_type     (void) G_GNUC_CONST;
 287 EvJob          *ev_job_fonts_new          (EvDocument      *document);
 288 void            ev_job_fonts_run          (EvJobFonts      *fonts);
 289
 290 /* EvJobLoad */
 291 GType           ev_job_load_get_type      (void) G_GNUC_CONST;
 292 EvJob          *ev_job_load_new           (const gchar     *uri,
 293                                            EvLinkDest      *dest,
 294                                            EvWindowRunMode  mode,
 295                                            const gchar     *search_string);
 296 void            ev_job_load_set_uri       (EvJobLoad       *load,
 297                                            const gchar     *uri);
 298 void            ev_job_load_run           (EvJobLoad       *load);
 299
 300 /* EvJobSave */
 301 GType           ev_job_save_get_type      (void) G_GNUC_CONST;
 302 EvJob          *ev_job_save_new           (EvDocument      *document,
 303                                            const gchar     *uri,
 304                                            const gchar     *document_uri);
 305 void            ev_job_save_run           (EvJobSave       *save);
 306
 307 /* EvJobPrint */
 308 GType           ev_job_print_get_type     (void) G_GNUC_CONST;
 309 EvJob          *ev_job_print_new          (EvDocument      *document,
 310                                            const gchar     *format,
 311                                            gdouble          width,
 312                                            gdouble          height,
 313                                            EvPrintRange    *ranges,
 314                                            gint             n_ranges,
 315                                            EvPrintPageSet   page_set,
 316                                            gint             pages_per_sheet,
 317                                            gint             copies,
 318                                            gdouble          collate,
 319                                            gdouble          reverse);
 320 void            ev_job_print_run          (EvJobPrint      *print);
 321
 322 G_END_DECLS
 323
 324 #endif /* __EV_JOBS_H__ */