EvJob: Evince View Library Reference Manual

## EvJob EvJob |

## Functions

gboolean | ev_job_run ()
void | ev_job_cancel ()
void | ev_job_failed ()
void | ev_job_failed_from_error ()
void | ev_job_succeeded ()
gboolean | ev_job_is_finished ()
gboolean | ev_job_is_failed ()
EvJobRunMode | ev_job_get_run_mode ()
void | ev_job_set_run_mode ()
EvJob * | ev_job_links_new ()
GtkTreeModel * | ev_job_links_get_model ()
EvJob * | ev_job_attachments_new ()
EvJob * | ev_job_export_new ()
void | ev_job_export_set_page ()
EvJob * | ev_job_render_new ()
void | ev_job_render_set_selection_info ()
EvJob * | ev_job_page_data_new ()
EvJob * | ev_job_thumbnail_new ()
EvJob * | ev_job_thumbnail_new_with_target_size ()
void | ev_job_thumbnail_set_has_frame ()
void | ev_job_thumbnail_set_output_format ()
EvJob * | ev_job_fonts_new ()
EvJob * | ev_job_load_new ()
void | ev_job_load_set_uri ()
void | ev_job_load_set_password ()
EvJob * | ev_job_load_stream_new ()
void | ev_job_load_stream_set_stream ()
void | ev_job_load_stream_set_load_flags ()
void | ev_job_load_stream_set_password ()
EvJob * | ev_job_load_gfile_new ()
void | ev_job_load_gfile_set_gfile ()
void | ev_job_load_gfile_set_load_flags ()
void | ev_job_load_gfile_set_password ()
EvJob * | ev_job_save_new ()
EvJob * | ev_job_find_new ()
gint | ev_job_find_get_n_results ()
gdouble | ev_job_find_get_progress ()
gboolean | ev_job_find_has_results ()
GList ** | ev_job_find_get_results ()
void | ev_job_find_set_options ()
EvFindOptions | ev_job_find_get_options ()
EvJob * | ev_job_layers_new ()
EvJob * | ev_job_print_new ()
void | ev_job_print_set_page ()
void | ev_job_print_set_cairo ()
EvJob * | ev_job_annots_new ()

## Signals

void | cancelled | Run Last
void | finished | Run First
void | updated | Run Last
void | updated | Run Last

## Types and Values

struct | EvJob
struct | EvJobClass
struct | EvJobRender
struct | EvJobRenderClass
struct | EvJobPageData
struct | EvJobPageDataClass
struct | EvJobThumbnail
struct | EvJobThumbnailClass
struct | EvJobLinks
struct | EvJobLinksClass
struct | EvJobAttachments
struct | EvJobAttachmentsClass
struct | EvJobFonts
struct | EvJobFontsClass
struct | EvJobLoad
struct | EvJobLoadClass
struct | EvJobLoadStream
struct | EvJobLoadStreamClass
struct | EvJobLoadGFile
struct | EvJobLoadGFileClass
struct | EvJobSave
struct | EvJobSaveClass
struct | EvJobFind
struct | EvJobFindClass
struct | EvJobLayers
struct | EvJobLayersClass
struct | EvJobExport
struct | EvJobExportClass
struct | EvJobPrint
struct | EvJobPrintClass
struct | EvJobAnnots
struct | EvJobAnnotsClass
enum | EvJobRunMode
enum | EvJobPageDataFlags
enum | EvJobThumbnailFormat

## Object Hierarchy

        GEnum
        ╰── EvJobRunMode
        GFlags
        ╰── EvJobPageDataFlags
        GObject
        ╰── EvJob
            ├── EvJobAttachments
            ├── EvJobExport
            ├── EvJobFind
            ├── EvJobFonts
            ├── EvJobLayers
            ├── EvJobLinks
            ├── EvJobLoad
            ├── EvJobPageData
            ├── EvJobPrint
            ├── EvJobRender
            ├── EvJobSave
            ╰── EvJobThumbnail

## Description

## Functions

### ev_job_run ()

    gboolean
    ev_job_run (EvJob *job);

### ev_job_cancel ()

    void
    ev_job_cancel (EvJob *job);

### ev_job_failed ()

    void
    ev_job_failed (EvJob *job,
                   GQuark domain,
                   gint code,
                   const gchar *format,
                   ...);

### ev_job_failed_from_error ()

    void
    ev_job_failed_from_error (EvJob *job,
                              GError *error);

Rename to: ev_job_failed

#### Parameters

job | an EvJob |
error | a GError |

### ev_job_succeeded ()

    void
    ev_job_succeeded (EvJob *job);

### ev_job_is_finished ()

    gboolean
    ev_job_is_finished (EvJob *job);

### ev_job_is_failed ()

    gboolean
    ev_job_is_failed (EvJob *job);

### ev_job_get_run_mode ()

    EvJobRunMode
    ev_job_get_run_mode (EvJob *job);

### ev_job_set_run_mode ()

    void
    ev_job_set_run_mode (EvJob *job,
                         EvJobRunMode run_mode);

### ev_job_links_new ()

    EvJob *
    ev_job_links_new (EvDocument *document);

### ev_job_links_get_model ()

    GtkTreeModel *
    ev_job_links_get_model (EvJobLinks *job);

Get a GtkTreeModel loaded with the links

#### Parameters

job | EvJobLinks |

#### Returns

The GtkTreeModel loaded.

[transfer none]

Since: 3.6

### ev_job_attachments_new ()

    EvJob *
    ev_job_attachments_new (EvDocument *document);

### ev_job_export_new ()

    EvJob *
    ev_job_export_new (EvDocument *document);

### ev_job_export_set_page ()

    void
    ev_job_export_set_page (EvJobExport *job,
                            gint page);

### ev_job_render_new ()

    EvJob *
    ev_job_render_new (EvDocument *document,
                       gint page,
                       gint rotation,
                       gdouble scale,
                       gint width,
                       gint height);

### ev_job_render_set_selection_info ()

    void
    ev_job_render_set_selection_info (EvJobRender *job,
                                      EvRectangle *selection_points,
                                      EvSelectionStyle selection_style,
                                      GdkColor *text,
                                      GdkColor *base);

### ev_job_page_data_new ()

    EvJob *
    ev_job_page_data_new (EvDocument *document,
                          gint page,
                          EvJobPageDataFlags flags);

### ev_job_thumbnail_new ()

    EvJob *
    ev_job_thumbnail_new (EvDocument *document,
                          gint page,
                          gint rotation,
                          gdouble scale);

### ev_job_thumbnail_new_with_target_size ()

    EvJob *
    ev_job_thumbnail_new_with_target_size (EvDocument *document,
                                           gint page,
                                           gint rotation,
                                           gint target_width,
                                           gint target_height);

### ev_job_thumbnail_set_has_frame ()

    void
    ev_job_thumbnail_set_has_frame (EvJobThumbnail *job,
                                    gboolean has_frame);

Since: 3.8

### ev_job_thumbnail_set_output_format ()

    void
    ev_job_thumbnail_set_output_format (EvJobThumbnail *job,
                                        EvJobThumbnailFormat format);

Set the desired output format for the generated thumbnail

#### Parameters

job | a EvJobThumbnail |
format | a EvJobThumbnailFormat |

Since: 3.14

### ev_job_fonts_new ()

    EvJob *
    ev_job_fonts_new (EvDocument *document);

### ev_job_load_new ()

    EvJob *
    ev_job_load_new (const gchar *uri);

### ev_job_load_set_uri ()

    void
    ev_job_load_set_uri (EvJobLoad *load,
                         const gchar *uri);

### ev_job_load_set_password ()

    void
    ev_job_load_set_password (EvJobLoad *job,
                              const gchar *password);

### ev_job_load_stream_new ()

    EvJob *
    ev_job_load_stream_new (GInputStream *stream,
                            EvDocumentLoadFlags flags);

### ev_job_load_stream_set_stream ()

    void
    ev_job_load_stream_set_stream (EvJobLoadStream *job,
                                   GInputStream *stream);

### ev_job_load_stream_set_load_flags ()

    void
    ev_job_load_stream_set_load_flags (EvJobLoadStream *job,
                                       EvDocumentLoadFlags flags);

### ev_job_load_stream_set_password ()

    void
    ev_job_load_stream_set_password (EvJobLoadStream *job,
                                     const gchar *password);

### ev_job_load_gfile_new ()

    EvJob *
    ev_job_load_gfile_new (GFile *gfile,
                           EvDocumentLoadFlags flags);

### ev_job_load_gfile_set_gfile ()

    void
    ev_job_load_gfile_set_gfile (EvJobLoadGFile *job,
                                 GFile *gfile);

### ev_job_load_gfile_set_load_flags ()

    void
    ev_job_load_gfile_set_load_flags (EvJobLoadGFile *job,
                                      EvDocumentLoadFlags flags);

### ev_job_load_gfile_set_password ()

    void
    ev_job_load_gfile_set_password (EvJobLoadGFile *job,
                                    const gchar *password);

### ev_job_save_new ()

    EvJob *
    ev_job_save_new (EvDocument *document,
                     const gchar *uri,
                     const gchar *document_uri);

### ev_job_find_new ()

    EvJob *
    ev_job_find_new (EvDocument *document,
                     gint start_page,
                     gint n_pages,
                     const gchar *text,
                     gboolean case_sensitive);

### ev_job_find_get_n_results ()

    gint
    ev_job_find_get_n_results (EvJobFind *job,
                               gint pages);

### ev_job_find_get_progress ()

    gdouble
    ev_job_find_get_progress (EvJobFind *job);

### ev_job_find_has_results ()

    gboolean
    ev_job_find_has_results (EvJobFind *job);

### ev_job_find_get_results ()

    GList **
    ev_job_find_get_results (EvJobFind *job);

[skip]

#### Parameters

job | an EvJobFind |

#### Returns

a GList of GLists containing EvRectangles

### ev_job_find_set_options ()

    void
    ev_job_find_set_options (EvJobFind *job,
                             EvFindOptions options);

Since: 3.6

### ev_job_find_get_options ()

    EvFindOptions
    ev_job_find_get_options (EvJobFind *job);

#### Returns

the job's find options

Since: 3.6

### ev_job_layers_new ()

    EvJob *
    ev_job_layers_new (EvDocument *document);

### ev_job_print_new ()

    EvJob *
    ev_job_print_new (EvDocument *document);

### ev_job_print_set_page ()

    void
    ev_job_print_set_page (EvJobPrint *job,
                           gint page);

### ev_job_print_set_cairo ()

    void
    ev_job_print_set_cairo (EvJobPrint *job,
                            cairo_t *cr);

### ev_job_annots_new ()

    EvJob *
    ev_job_annots_new (EvDocument *document);

## Types and Values

### struct EvJob

    struct EvJob;

### struct EvJobClass

    struct EvJobClass {
    	GObjectClass parent_class;

    	gboolean (*run)         (EvJob *job);

    	/* Signals */
    	void     (* cancelled)  (EvJob *job);
    	void     (* finished)   (EvJob *job);
    };

### struct EvJobRender

    struct EvJobRender;

### struct EvJobRenderClass

    struct EvJobRenderClass {
    	EvJobClass parent_class;
    };

### struct EvJobPageData

    struct EvJobPageData;

### struct EvJobPageDataClass

    struct EvJobPageDataClass {
    	EvJobClass parent_class;
    };

### struct EvJobThumbnail

    struct EvJobThumbnail;

### struct EvJobThumbnailClass

    struct EvJobThumbnailClass {
    	EvJobClass parent_class;
    };

### struct EvJobLinks

    struct EvJobLinks;

### struct EvJobLinksClass

    struct EvJobLinksClass {
    	EvJobClass parent_class;
    };

### struct EvJobAttachments

    struct EvJobAttachments;

### struct EvJobAttachmentsClass

    struct EvJobAttachmentsClass {
    	EvJobClass parent_class;
    };

### struct EvJobFonts

    struct EvJobFonts;

### struct EvJobFontsClass

    struct EvJobFontsClass {
            EvJobClass parent_class;

    	/* Signals */
    	void (* updated)  (EvJobFonts *job,
    			   gdouble     progress);
    };

### struct EvJobLoad

    struct EvJobLoad;

### struct EvJobLoadClass

    struct EvJobLoadClass {
    	EvJobClass parent_class;
    };

### struct EvJobLoadStream

    struct EvJobLoadStream {
            EvJob parent;

            char *password;
            GInputStream *stream;
            EvDocumentLoadFlags flags;
    };

A job class to load a EvDocument from a GInputStream.

Since: 3.6

### struct EvJobLoadStreamClass

    struct EvJobLoadStreamClass {
            EvJobClass parent_class;
    };

### struct EvJobLoadGFile

    struct EvJobLoadGFile {
            EvJob parent;

            char *password;
            GFile *gfile;
            EvDocumentLoadFlags flags;
    };

A job class to load a EvDocument from a GFile.

Since: 3.6

### struct EvJobLoadGFileClass

    struct EvJobLoadGFileClass {
            EvJobClass parent_class;
    };

### struct EvJobSave

    struct EvJobSave;

### struct EvJobSaveClass

    struct EvJobSaveClass {
    	EvJobClass parent_class;
    };

### struct EvJobFind

    struct EvJobFind;

### struct EvJobFindClass

    struct EvJobFindClass {
    	EvJobClass parent_class;

    	/* Signals */
    	void (* updated)  (EvJobFind *job,
    			   gint       page);
    };

### struct EvJobLayers

    struct EvJobLayers;

### struct EvJobLayersClass

    struct EvJobLayersClass {
    	EvJobClass parent_class;
    };

### struct EvJobExport

    struct EvJobExport;

### struct EvJobExportClass

    struct EvJobExportClass {
    	EvJobClass parent_class;
    };

### struct EvJobPrint

    struct EvJobPrint;

### struct EvJobPrintClass

    struct EvJobPrintClass {
    	EvJobClass parent_class;
    };

### struct EvJobAnnots

    struct EvJobAnnots {
    	EvJob parent;

    	GList *annots;
    };

### struct EvJobAnnotsClass

    struct EvJobAnnotsClass {
    	EvJobClass parent_class;
    };

### enum EvJobRunMode

#### Members

EV_JOB_RUN_THREAD |  |
EV_JOB_RUN_MAIN_LOOP |  |

### enum EvJobPageDataFlags

#### Members

EV_PAGE_DATA_INCLUDE_NONE |  |
EV_PAGE_DATA_INCLUDE_LINKS |  |
EV_PAGE_DATA_INCLUDE_TEXT |  |
EV_PAGE_DATA_INCLUDE_TEXT_MAPPING |  |
EV_PAGE_DATA_INCLUDE_TEXT_LAYOUT |  |
EV_PAGE_DATA_INCLUDE_TEXT_ATTRS |  |
EV_PAGE_DATA_INCLUDE_TEXT_LOG_ATTRS |  |
EV_PAGE_DATA_INCLUDE_IMAGES |  |
EV_PAGE_DATA_INCLUDE_FORMS |  |
EV_PAGE_DATA_INCLUDE_ANNOTS |  |
EV_PAGE_DATA_INCLUDE_MEDIA |  |
EV_PAGE_DATA_INCLUDE_ALL |  |

### enum EvJobThumbnailFormat

#### Members

EV_JOB_THUMBNAIL_PIXBUF |  |
EV_JOB_THUMBNAIL_SURFACE |  |

## Signal Details

### The `“cancelled”` signal

    void
    user_function (EvJob   *evjob,
                   gpointer user_data)

Flags: Run Last

### The `“finished”` signal

    void
    user_function (EvJob   *evjob,
                   gpointer user_data)

Flags: Run First

### The `“updated”` signal

    void
    user_function (EvJobFonts *evjobfonts,
                   double      arg1,
                   gpointer    user_data)

Flags: Run Last

### The `“updated”` signal

    void
    user_function (EvJobFind *evjobfind,
                   int        arg1,
                   gpointer   user_data)

Flags: Run Last