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-file-exporter.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 _EvJobPrint EvJobPrint;
  50 typedef struct _EvJobPrintClass EvJobPrintClass;
  51
  52 #define EV_TYPE_JOB                          (ev_job_get_type())
  53 #define EV_JOB(object)                       (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB, EvJob))
  54 #define EV_JOB_CLASS(klass)                  (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB, EvJobClass))
  55 #define EV_IS_JOB(object)                    (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB))
  56
  57 #define EV_TYPE_JOB_LINKS                    (ev_job_links_get_type())
  58 #define EV_JOB_LINKS(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LINKS, EvJobLinks))
  59 #define EV_JOB_LINKS_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LINKS, EvJobLinksClass))
  60 #define EV_IS_JOB_LINKS(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LINKS))
  61
  62 #define EV_TYPE_JOB_RENDER                   (ev_job_render_get_type())
  63 #define EV_JOB_RENDER(object)                (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_RENDER, EvJobRender))
  64 #define EV_JOB_RENDER_CLASS(klass)           (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_RENDER, EvJobRenderClass))
  65 #define EV_IS_JOB_RENDER(object)             (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_RENDER))
  66
  67 #define EV_TYPE_JOB_THUMBNAIL                (ev_job_thumbnail_get_type())
  68 #define EV_JOB_THUMBNAIL(object)             (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnail))
  69 #define EV_JOB_THUMBNAIL_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnailClass))
  70 #define EV_IS_JOB_THUMBNAIL(object)          (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_THUMBNAIL))
  71
  72 #define EV_TYPE_JOB_FONTS                    (ev_job_fonts_get_type())
  73 #define EV_JOB_FONTS(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_FONTS, EvJobFonts))
  74 #define EV_JOB_FONTS_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_FONTS, EvJobFontsClass))
  75 #define EV_IS_JOB_FONTS(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_FONTS))
  76
  77 #define EV_TYPE_JOB_LOAD                     (ev_job_load_get_type())
  78 #define EV_JOB_LOAD(object)                  (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LOAD, EvJobLoad))
  79 #define EV_JOB_LOAD_CLASS(klass)             (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LOAD, EvJobLoadClass))
  80 #define EV_IS_JOB_LOAD(object)               (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LOAD))
  81
  82 #define EV_TYPE_JOB_PRINT                     (ev_job_print_get_type())
  83 #define EV_JOB_PRINT(object)                  (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_PRINT, EvJobPrint))
  84 #define EV_JOB_PRINT_CLASS(klass)             (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_PRINT, EvJobPrintClass))
  85 #define EV_IS_JOB_PRINT(object)               (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_PRINT))
  86
  87 typedef enum {
  88         EV_JOB_PRIORITY_LOW,
  89         EV_JOB_PRIORITY_HIGH,
  90 } EvJobPriority;
  91
  92 struct _EvJob
  93 {
  94         GObject parent;
  95         EvDocument *document;
  96         gboolean finished;
  97         gboolean async;
  98 };
  99
 100 struct _EvJobClass
 101 {
 102         GObjectClass parent_class;
 103
 104         void    (* finished) (EvJob *job);
 105 };
 106
 107 struct _EvJobLinks
 108 {
 109         EvJob parent;
 110
 111         GtkTreeModel *model;
 112 };
 113
 114 struct _EvJobLinksClass
 115 {
 116         EvJobClass parent_class;
 117 };
 118
 119 struct _EvJobRender
 120 {
 121         EvJob parent;
 122
 123         EvRenderContext *rc;
 124         gboolean page_ready;
 125         gint target_width;
 126         gint target_height;
 127         cairo_surface_t *surface;
 128
 129         GList *link_mapping;
 130         GdkRegion *text_mapping;
 131         GList *image_mapping;
 132         GList *form_field_mapping;
 133
 134         cairo_surface_t *selection;
 135         GdkRegion *selection_region;
 136         EvRectangle selection_points;
 137         EvSelectionStyle selection_style;
 138         GdkColor base;
 139         GdkColor text;
 140
 141         gint include_forms : 1;
 142         gint include_links : 1;
 143         gint include_text : 1;
 144         gint include_selection : 1;
 145         gint include_images : 1;
 146 };
 147
 148 struct _EvJobRenderClass
 149 {
 150         EvJobClass parent_class;
 151
 152         void    (* page_ready) (EvJobRender *job);
 153 };
 154
 155 struct _EvJobThumbnail
 156 {
 157         EvJob parent;
 158
 159         EvRenderContext *rc;
 160         GdkPixbuf *thumbnail;
 161 };
 162
 163 struct _EvJobThumbnailClass
 164 {
 165         EvJobClass parent_class;
 166 };
 167
 168 struct _EvJobFonts
 169 {
 170         EvJob parent;
 171         gboolean scan_completed;
 172 };
 173
 174 struct _EvJobFontsClass
 175 {
 176         EvJobClass parent_class;
 177 };
 178
 179 struct _EvJobLoad
 180 {
 181         EvJob parent;
 182
 183         EvLinkDest *dest;
 184         EvWindowRunMode mode;
 185         GError *error;
 186         gchar *uri;
 187 };
 188
 189 struct _EvJobLoadClass
 190 {
 191         EvJobClass parent_class;
 192 };
 193
 194 struct _EvJobPrint
 195 {
 196         EvJob parent;
 197
 198         GError *error;
 199         const gchar *format;
 200         gchar  *temp_file;
 201         EvPrintRange *ranges;
 202         gint n_ranges;
 203         EvPrintPageSet page_set;
 204         gint copies;
 205         gint pages_per_sheet;
 206         gboolean collate;
 207         gboolean reverse;
 208         gdouble width;
 209         gdouble height;
 210         EvFileExporterOrientation orientation;
 211 };
 212
 213 struct _EvJobPrintClass
 214 {
 215         EvJobClass parent_class;
 216 };
 217
 218 /* Base job class */
 219 GType           ev_job_get_type           (void) G_GNUC_CONST;
 220 void            ev_job_finished           (EvJob          *job);
 221
 222 /* EvJobLinks */
 223 GType           ev_job_links_get_type     (void) G_GNUC_CONST;
 224 EvJob          *ev_job_links_new          (EvDocument     *document);
 225 void            ev_job_links_run          (EvJobLinks     *thumbnail);
 226
 227 /* EvJobRender */
 228 GType           ev_job_render_get_type    (void) G_GNUC_CONST;
 229 EvJob          *ev_job_render_new         (EvDocument      *document,
 230                                            EvRenderContext *rc,
 231                                            gint             width,
 232                                            gint             height,
 233                                            EvRectangle     *selection_points,
 234                                            EvSelectionStyle selection_style,
 235                                            GdkColor        *text,
 236                                            GdkColor        *base,
 237                                            gboolean         include_forms,
 238                                            gboolean         include_links,
 239                                            gboolean         include_images,
 240                                            gboolean         include_text,
 241                                            gboolean         include_selection);
 242 void            ev_job_render_run         (EvJobRender     *thumbnail);
 243
 244 /* EvJobThumbnail */
 245 GType           ev_job_thumbnail_get_type (void) G_GNUC_CONST;
 246 EvJob          *ev_job_thumbnail_new      (EvDocument      *document,
 247                                            EvRenderContext *rc);
 248 void            ev_job_thumbnail_run      (EvJobThumbnail  *thumbnail);
 249
 250 /* EvJobFonts */
 251 GType           ev_job_fonts_get_type     (void) G_GNUC_CONST;
 252 EvJob          *ev_job_fonts_new          (EvDocument      *document);
 253 void            ev_job_fonts_run          (EvJobFonts      *fonts);
 254
 255 /* EvJobLoad */
 256 GType           ev_job_load_get_type      (void) G_GNUC_CONST;
 257 EvJob          *ev_job_load_new           (const gchar     *uri,
 258                                            EvLinkDest      *dest,
 259                                            EvWindowRunMode  mode);
 260 void            ev_job_load_set_uri       (EvJobLoad       *load,
 261                                            const gchar     *uri);
 262 void            ev_job_load_run           (EvJobLoad       *load);
 263
 264 /* EvJobPrint */
 265 GType           ev_job_print_get_type     (void) G_GNUC_CONST;
 266 EvJob          *ev_job_print_new          (EvDocument      *document,
 267                                            const gchar     *format,
 268                                            gdouble          width,
 269                                            gdouble          height,
 270                                            EvFileExporterOrientation orientation,
 271                                            EvPrintRange    *ranges,
 272                                            gint             n_ranges,
 273                                            EvPrintPageSet   page_set,
 274                                            gint             pages_per_sheet,
 275                                            gint             copies,
 276                                            gdouble          collate,
 277                                            gdouble          reverse);
 278 void            ev_job_print_run          (EvJobPrint      *print);
 279
 280 G_END_DECLS
 281
 282 #endif /* __EV_JOBS_H__ */