1 /* this file is part of evince, a gnome document viewer
3 * Copyright (C) 2008 Carlos Garcia Campos <carlosgc@gnome.org>
4 * Copyright (C) 2005 Red Hat, Inc
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.
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.
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.
21 #if !defined (__EV_EVINCE_VIEW_H_INSIDE__) && !defined (EVINCE_COMPILATION)
22 #error "Only <evince-view.h> can be included directly."
32 #include <evince-document.h>
36 typedef struct _EvJob EvJob;
37 typedef struct _EvJobClass EvJobClass;
39 typedef struct _EvJobRender EvJobRender;
40 typedef struct _EvJobRenderClass EvJobRenderClass;
42 typedef struct _EvJobThumbnail EvJobThumbnail;
43 typedef struct _EvJobThumbnailClass EvJobThumbnailClass;
45 typedef struct _EvJobLinks EvJobLinks;
46 typedef struct _EvJobLinksClass EvJobLinksClass;
48 typedef struct _EvJobAttachments EvJobAttachments;
49 typedef struct _EvJobAttachmentsClass EvJobAttachmentsClass;
51 typedef struct _EvJobFonts EvJobFonts;
52 typedef struct _EvJobFontsClass EvJobFontsClass;
54 typedef struct _EvJobLoad EvJobLoad;
55 typedef struct _EvJobLoadClass EvJobLoadClass;
57 typedef struct _EvJobSave EvJobSave;
58 typedef struct _EvJobSaveClass EvJobSaveClass;
60 typedef struct _EvJobFind EvJobFind;
61 typedef struct _EvJobFindClass EvJobFindClass;
63 typedef struct _EvJobLayers EvJobLayers;
64 typedef struct _EvJobLayersClass EvJobLayersClass;
66 typedef struct _EvJobExport EvJobExport;
67 typedef struct _EvJobExportClass EvJobExportClass;
69 typedef struct _EvJobPrint EvJobPrint;
70 typedef struct _EvJobPrintClass EvJobPrintClass;
72 #define EV_TYPE_JOB (ev_job_get_type())
73 #define EV_JOB(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB, EvJob))
74 #define EV_JOB_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB, EvJobClass))
75 #define EV_IS_JOB(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB))
76 #define EV_JOB_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_JOB, EvJobClass))
78 #define EV_TYPE_JOB_LINKS (ev_job_links_get_type())
79 #define EV_JOB_LINKS(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LINKS, EvJobLinks))
80 #define EV_JOB_LINKS_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LINKS, EvJobLinksClass))
81 #define EV_IS_JOB_LINKS(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LINKS))
83 #define EV_TYPE_JOB_ATTACHMENTS (ev_job_attachments_get_type())
84 #define EV_JOB_ATTACHMENTS(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_ATTACHMENTS, EvJobAttachments))
85 #define EV_JOB_ATTACHMENTS_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_ATTACHMENTS, EvJobAttachmentsClass))
86 #define EV_IS_JOB_ATTACHMENTS(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_ATTACHMENTS))
88 #define EV_TYPE_JOB_RENDER (ev_job_render_get_type())
89 #define EV_JOB_RENDER(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_RENDER, EvJobRender))
90 #define EV_JOB_RENDER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_RENDER, EvJobRenderClass))
91 #define EV_IS_JOB_RENDER(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_RENDER))
93 #define EV_TYPE_JOB_THUMBNAIL (ev_job_thumbnail_get_type())
94 #define EV_JOB_THUMBNAIL(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnail))
95 #define EV_JOB_THUMBNAIL_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnailClass))
96 #define EV_IS_JOB_THUMBNAIL(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_THUMBNAIL))
98 #define EV_TYPE_JOB_FONTS (ev_job_fonts_get_type())
99 #define EV_JOB_FONTS(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_FONTS, EvJobFonts))
100 #define EV_JOB_FONTS_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_FONTS, EvJobFontsClass))
101 #define EV_IS_JOB_FONTS(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_FONTS))
103 #define EV_TYPE_JOB_LOAD (ev_job_load_get_type())
104 #define EV_JOB_LOAD(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LOAD, EvJobLoad))
105 #define EV_JOB_LOAD_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LOAD, EvJobLoadClass))
106 #define EV_IS_JOB_LOAD(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LOAD))
108 #define EV_TYPE_JOB_SAVE (ev_job_save_get_type())
109 #define EV_JOB_SAVE(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_SAVE, EvJobSave))
110 #define EV_JOB_SAVE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_SAVE, EvJobSaveClass))
111 #define EV_IS_JOB_SAVE(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_SAVE))
113 #define EV_TYPE_JOB_FIND (ev_job_find_get_type())
114 #define EV_JOB_FIND(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_FIND, EvJobFind))
115 #define EV_JOB_FIND_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_FIND, EvJobFindClass))
116 #define EV_IS_JOB_FIND(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_FIND))
118 #define EV_TYPE_JOB_LAYERS (ev_job_layers_get_type())
119 #define EV_JOB_LAYERS(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LAYERS, EvJobLayers))
120 #define EV_JOB_LAYERS_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LAYERS, EvJobLayersClass))
121 #define EV_IS_JOB_LAYERS(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LAYERS))
123 #define EV_TYPE_JOB_EXPORT (ev_job_export_get_type())
124 #define EV_JOB_EXPORT(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_EXPORT, EvJobExport))
125 #define EV_JOB_EXPORT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_EXPORT, EvJobExportClass))
126 #define EV_IS_JOB_EXPORT(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_EXPORT))
128 #define EV_TYPE_JOB_PRINT (ev_job_print_get_type())
129 #define EV_JOB_PRINT(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_PRINT, EvJobPrint))
130 #define EV_JOB_PRINT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_PRINT, EvJobPrintClass))
131 #define EV_IS_JOB_PRINT(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_PRINT))
142 EvDocument *document;
144 EvJobRunMode run_mode;
151 GCancellable *cancellable;
153 guint idle_finished_id;
154 guint idle_cancelled_id;
159 GObjectClass parent_class;
161 gboolean (*run) (EvJob *job);
164 void (* cancelled) (EvJob *job);
165 void (* finished) (EvJob *job);
175 struct _EvJobLinksClass
177 EvJobClass parent_class;
180 struct _EvJobAttachments
187 struct _EvJobAttachmentsClass
189 EvJobClass parent_class;
193 EV_RENDER_INCLUDE_NONE = 0,
194 EV_RENDER_INCLUDE_LINKS = 1 << 0,
195 EV_RENDER_INCLUDE_TEXT = 1 << 1,
196 EV_RENDER_INCLUDE_SELECTION = 1 << 2,
197 EV_RENDER_INCLUDE_IMAGES = 1 << 3,
198 EV_RENDER_INCLUDE_FORMS = 1 << 4,
199 EV_RENDER_INCLUDE_ANNOTS = 1 << 5,
200 EV_RENDER_INCLUDE_ALL = (1 << 6) - 1
215 cairo_surface_t *surface;
218 GdkRegion *text_mapping;
219 GList *image_mapping;
220 GList *form_field_mapping;
221 GList *annots_mapping;
223 cairo_surface_t *selection;
224 GdkRegion *selection_region;
225 EvRectangle selection_points;
226 EvSelectionStyle selection_style;
233 struct _EvJobRenderClass
235 EvJobClass parent_class;
237 void (* page_ready) (EvJobRender *job);
240 struct _EvJobThumbnail
248 GdkPixbuf *thumbnail;
251 struct _EvJobThumbnailClass
253 EvJobClass parent_class;
259 gboolean scan_completed;
262 struct _EvJobFontsClass
264 EvJobClass parent_class;
267 void (* updated) (EvJobFonts *job,
279 struct _EvJobLoadClass
281 EvJobClass parent_class;
292 struct _EvJobSaveClass
294 EvJobClass parent_class;
306 gboolean case_sensitive;
307 gboolean has_results;
310 struct _EvJobFindClass
312 EvJobClass parent_class;
315 void (* updated) (EvJobFind *job,
326 struct _EvJobLayersClass
328 EvJobClass parent_class;
339 struct _EvJobExportClass
341 EvJobClass parent_class;
352 struct _EvJobPrintClass
354 EvJobClass parent_class;
358 GType ev_job_get_type (void) G_GNUC_CONST;
359 gboolean ev_job_run (EvJob *job);
360 void ev_job_cancel (EvJob *job);
361 void ev_job_failed (EvJob *job,
366 void ev_job_failed_from_error (EvJob *job,
368 void ev_job_succeeded (EvJob *job);
369 gboolean ev_job_is_cancelled (EvJob *job);
370 gboolean ev_job_is_finished (EvJob *job);
371 gboolean ev_job_is_failed (EvJob *job);
372 EvJobRunMode ev_job_get_run_mode (EvJob *job);
373 void ev_job_set_run_mode (EvJob *job,
374 EvJobRunMode run_mode);
377 GType ev_job_links_get_type (void) G_GNUC_CONST;
378 EvJob *ev_job_links_new (EvDocument *document);
380 /* EvJobAttachments */
381 GType ev_job_attachments_get_type (void) G_GNUC_CONST;
382 EvJob *ev_job_attachments_new (EvDocument *document);
385 GType ev_job_render_get_type (void) G_GNUC_CONST;
386 EvJob *ev_job_render_new (EvDocument *document,
392 EvRenderFlags flags);
393 void ev_job_render_set_selection_info (EvJobRender *job,
394 EvRectangle *selection_points,
395 EvSelectionStyle selection_style,
399 GType ev_job_thumbnail_get_type (void) G_GNUC_CONST;
400 EvJob *ev_job_thumbnail_new (EvDocument *document,
405 GType ev_job_fonts_get_type (void) G_GNUC_CONST;
406 EvJob *ev_job_fonts_new (EvDocument *document);
409 GType ev_job_load_get_type (void) G_GNUC_CONST;
410 EvJob *ev_job_load_new (const gchar *uri);
411 void ev_job_load_set_uri (EvJobLoad *load,
413 void ev_job_load_set_password (EvJobLoad *job,
414 const gchar *password);
417 GType ev_job_save_get_type (void) G_GNUC_CONST;
418 EvJob *ev_job_save_new (EvDocument *document,
420 const gchar *document_uri);
422 GType ev_job_find_get_type (void) G_GNUC_CONST;
423 EvJob *ev_job_find_new (EvDocument *document,
427 gboolean case_sensitive);
428 gint ev_job_find_get_n_results (EvJobFind *job,
430 gdouble ev_job_find_get_progress (EvJobFind *job);
431 gboolean ev_job_find_has_results (EvJobFind *job);
432 GList **ev_job_find_get_results (EvJobFind *job);
435 GType ev_job_layers_get_type (void) G_GNUC_CONST;
436 EvJob *ev_job_layers_new (EvDocument *document);
439 GType ev_job_export_get_type (void) G_GNUC_CONST;
440 EvJob *ev_job_export_new (EvDocument *document);
441 void ev_job_export_set_page (EvJobExport *job,
444 GType ev_job_print_get_type (void) G_GNUC_CONST;
445 EvJob *ev_job_print_new (EvDocument *document);
446 void ev_job_print_set_page (EvJobPrint *job,
448 void ev_job_print_set_cairo (EvJobPrint *job,
453 #endif /* __EV_JOBS_H__ */