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