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."
31 #include <evince-document.h>
35 typedef struct _EvJob EvJob;
36 typedef struct _EvJobClass EvJobClass;
38 typedef struct _EvJobRender EvJobRender;
39 typedef struct _EvJobRenderClass EvJobRenderClass;
41 typedef struct _EvJobThumbnail EvJobThumbnail;
42 typedef struct _EvJobThumbnailClass EvJobThumbnailClass;
44 typedef struct _EvJobLinks EvJobLinks;
45 typedef struct _EvJobLinksClass EvJobLinksClass;
47 typedef struct _EvJobAttachments EvJobAttachments;
48 typedef struct _EvJobAttachmentsClass EvJobAttachmentsClass;
50 typedef struct _EvJobFonts EvJobFonts;
51 typedef struct _EvJobFontsClass EvJobFontsClass;
53 typedef struct _EvJobLoad EvJobLoad;
54 typedef struct _EvJobLoadClass EvJobLoadClass;
56 typedef struct _EvJobSave EvJobSave;
57 typedef struct _EvJobSaveClass EvJobSaveClass;
59 typedef struct _EvJobFind EvJobFind;
60 typedef struct _EvJobFindClass EvJobFindClass;
62 typedef struct _EvJobLayers EvJobLayers;
63 typedef struct _EvJobLayersClass EvJobLayersClass;
65 typedef struct _EvJobExport EvJobExport;
66 typedef struct _EvJobExportClass EvJobExportClass;
68 #define EV_TYPE_JOB (ev_job_get_type())
69 #define EV_JOB(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB, EvJob))
70 #define EV_JOB_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB, EvJobClass))
71 #define EV_IS_JOB(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB))
72 #define EV_JOB_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_JOB, EvJobClass))
74 #define EV_TYPE_JOB_LINKS (ev_job_links_get_type())
75 #define EV_JOB_LINKS(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LINKS, EvJobLinks))
76 #define EV_JOB_LINKS_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LINKS, EvJobLinksClass))
77 #define EV_IS_JOB_LINKS(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LINKS))
79 #define EV_TYPE_JOB_ATTACHMENTS (ev_job_attachments_get_type())
80 #define EV_JOB_ATTACHMENTS(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_ATTACHMENTS, EvJobAttachments))
81 #define EV_JOB_ATTACHMENTS_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_ATTACHMENTS, EvJobAttachmentsClass))
82 #define EV_IS_JOB_ATTACHMENTS(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_ATTACHMENTS))
84 #define EV_TYPE_JOB_RENDER (ev_job_render_get_type())
85 #define EV_JOB_RENDER(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_RENDER, EvJobRender))
86 #define EV_JOB_RENDER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_RENDER, EvJobRenderClass))
87 #define EV_IS_JOB_RENDER(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_RENDER))
89 #define EV_TYPE_JOB_THUMBNAIL (ev_job_thumbnail_get_type())
90 #define EV_JOB_THUMBNAIL(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnail))
91 #define EV_JOB_THUMBNAIL_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnailClass))
92 #define EV_IS_JOB_THUMBNAIL(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_THUMBNAIL))
94 #define EV_TYPE_JOB_FONTS (ev_job_fonts_get_type())
95 #define EV_JOB_FONTS(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_FONTS, EvJobFonts))
96 #define EV_JOB_FONTS_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_FONTS, EvJobFontsClass))
97 #define EV_IS_JOB_FONTS(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_FONTS))
99 #define EV_TYPE_JOB_LOAD (ev_job_load_get_type())
100 #define EV_JOB_LOAD(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LOAD, EvJobLoad))
101 #define EV_JOB_LOAD_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LOAD, EvJobLoadClass))
102 #define EV_IS_JOB_LOAD(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LOAD))
104 #define EV_TYPE_JOB_SAVE (ev_job_save_get_type())
105 #define EV_JOB_SAVE(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_SAVE, EvJobSave))
106 #define EV_JOB_SAVE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_SAVE, EvJobSaveClass))
107 #define EV_IS_JOB_SAVE(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_SAVE))
109 #define EV_TYPE_JOB_FIND (ev_job_find_get_type())
110 #define EV_JOB_FIND(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_FIND, EvJobFind))
111 #define EV_JOB_FIND_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_FIND, EvJobFindClass))
112 #define EV_IS_JOB_FIND(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_FIND))
114 #define EV_TYPE_JOB_LAYERS (ev_job_layers_get_type())
115 #define EV_JOB_LAYERS(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LAYERS, EvJobLayers))
116 #define EV_JOB_LAYERS_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LAYERS, EvJobLayersClass))
117 #define EV_IS_JOB_LAYERS(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LAYERS))
119 #define EV_TYPE_JOB_EXPORT (ev_job_export_get_type())
120 #define EV_JOB_EXPORT(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_EXPORT, EvJobExport))
121 #define EV_JOB_EXPORT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_EXPORT, EvJobExportClass))
122 #define EV_IS_JOB_EXPORT(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_EXPORT))
133 EvDocument *document;
135 EvJobRunMode run_mode;
142 GCancellable *cancellable;
144 guint idle_finished_id;
145 guint idle_cancelled_id;
150 GObjectClass parent_class;
152 gboolean (*run) (EvJob *job);
155 void (* cancelled) (EvJob *job);
156 void (* finished) (EvJob *job);
166 struct _EvJobLinksClass
168 EvJobClass parent_class;
171 struct _EvJobAttachments
178 struct _EvJobAttachmentsClass
180 EvJobClass parent_class;
184 EV_RENDER_INCLUDE_NONE = 0,
185 EV_RENDER_INCLUDE_LINKS = 1 << 0,
186 EV_RENDER_INCLUDE_TEXT = 1 << 1,
187 EV_RENDER_INCLUDE_SELECTION = 1 << 2,
188 EV_RENDER_INCLUDE_IMAGES = 1 << 3,
189 EV_RENDER_INCLUDE_FORMS = 1 << 4,
190 EV_RENDER_INCLUDE_ALL = (1 << 5) - 1
205 cairo_surface_t *surface;
208 GdkRegion *text_mapping;
209 GList *image_mapping;
210 GList *form_field_mapping;
212 cairo_surface_t *selection;
213 GdkRegion *selection_region;
214 EvRectangle selection_points;
215 EvSelectionStyle selection_style;
222 struct _EvJobRenderClass
224 EvJobClass parent_class;
226 void (* page_ready) (EvJobRender *job);
229 struct _EvJobThumbnail
237 GdkPixbuf *thumbnail;
240 struct _EvJobThumbnailClass
242 EvJobClass parent_class;
248 gboolean scan_completed;
251 struct _EvJobFontsClass
253 EvJobClass parent_class;
256 void (* updated) (EvJobFonts *job,
268 struct _EvJobLoadClass
270 EvJobClass parent_class;
281 struct _EvJobSaveClass
283 EvJobClass parent_class;
295 gboolean case_sensitive;
296 gboolean has_results;
299 struct _EvJobFindClass
301 EvJobClass parent_class;
304 void (* updated) (EvJobFind *job,
315 struct _EvJobLayersClass
317 EvJobClass parent_class;
328 struct _EvJobExportClass
330 EvJobClass parent_class;
334 GType ev_job_get_type (void) G_GNUC_CONST;
335 gboolean ev_job_run (EvJob *job);
336 void ev_job_cancel (EvJob *job);
337 void ev_job_failed (EvJob *job,
342 void ev_job_failed_from_error (EvJob *job,
344 void ev_job_succeeded (EvJob *job);
345 gboolean ev_job_is_cancelled (EvJob *job);
346 gboolean ev_job_is_finished (EvJob *job);
347 gboolean ev_job_is_failed (EvJob *job);
348 EvJobRunMode ev_job_get_run_mode (EvJob *job);
349 void ev_job_set_run_mode (EvJob *job,
350 EvJobRunMode run_mode);
353 GType ev_job_links_get_type (void) G_GNUC_CONST;
354 EvJob *ev_job_links_new (EvDocument *document);
356 /* EvJobAttachments */
357 GType ev_job_attachments_get_type (void) G_GNUC_CONST;
358 EvJob *ev_job_attachments_new (EvDocument *document);
361 GType ev_job_render_get_type (void) G_GNUC_CONST;
362 EvJob *ev_job_render_new (EvDocument *document,
368 EvRenderFlags flags);
369 void ev_job_render_set_selection_info (EvJobRender *job,
370 EvRectangle *selection_points,
371 EvSelectionStyle selection_style,
375 GType ev_job_thumbnail_get_type (void) G_GNUC_CONST;
376 EvJob *ev_job_thumbnail_new (EvDocument *document,
381 GType ev_job_fonts_get_type (void) G_GNUC_CONST;
382 EvJob *ev_job_fonts_new (EvDocument *document);
385 GType ev_job_load_get_type (void) G_GNUC_CONST;
386 EvJob *ev_job_load_new (const gchar *uri);
387 void ev_job_load_set_uri (EvJobLoad *load,
389 void ev_job_load_set_password (EvJobLoad *job,
390 const gchar *password);
393 GType ev_job_save_get_type (void) G_GNUC_CONST;
394 EvJob *ev_job_save_new (EvDocument *document,
396 const gchar *document_uri);
398 GType ev_job_find_get_type (void) G_GNUC_CONST;
399 EvJob *ev_job_find_new (EvDocument *document,
403 gboolean case_sensitive);
404 gint ev_job_find_get_n_results (EvJobFind *job,
406 gdouble ev_job_find_get_progress (EvJobFind *job);
407 gboolean ev_job_find_has_results (EvJobFind *job);
408 GList **ev_job_find_get_results (EvJobFind *job);
411 GType ev_job_layers_get_type (void) G_GNUC_CONST;
412 EvJob *ev_job_layers_new (EvDocument *document);
415 GType ev_job_export_get_type (void) G_GNUC_CONST;
416 EvJob *ev_job_export_new (EvDocument *document);
417 void ev_job_export_set_page (EvJobExport *job,
422 #endif /* __EV_JOBS_H__ */