PapersView.JobLoad¶

Subclasses:: None

Methods¶

Inherited:: PapersView.Job (12), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`get_loaded_document` ()
	`get_password` ()
	`get_password_save` ()
	`set_fd` (fd, mime_type)
	`set_load_flags` (flags)
	`set_password` (password)
	`set_password_save` (save)
	`set_uri` (uri)
	`take_fd` (fd, mime_type)

Virtual Methods¶

Inherited:: PapersView.Job (3), GObject.Object (7)

Properties¶

Inherited:: PapersView.Job (1)

Signals¶

Inherited:: PapersView.Job (2), GObject.Object (1)

Fields¶

Inherited:: PapersView.Job (2), GObject.Object (1)

Name	Type	Access	Description
parent	`PapersView.Job`	r

Class Details¶

class PapersView.JobLoad(**kwargs)¶

Bases:: PapersView.Job
Abstract:: No
Structure:: PapersView.JobLoadClass

A job class to load an PapersDocument.Document

Supports loading in different forms depending on the options being set.

classmethod new()¶

Return type:: PapersView.Job

get_loaded_document()¶

Returns:: The loaded document, if available
Return type:: PapersDocument.Document or None

New in version 46.0.

get_password()¶

Return type:: str

get_password_save()¶

Return type:: Gio.PasswordSave

set_fd(fd, mime_type)¶

Parameters:

fd (int) – a file descriptor
mime_type (str) – the mime type of the file descriptor

Raises:

GLib.Error

Returns:

True if the file descriptor could be set

Return type:

bool

Sets fd as the file descriptor in self. If duplicating fd fails, returns False with error filled in.

It is an error to call this function if uri is set for the job

New in version 46.0.

set_load_flags(flags)¶

Parameters:: flags (PapersDocument.DocumentLoadFlags) –

set_password(password)¶

Parameters:: password (str or None) – the password

set_password_save(save)¶

Parameters:: save (Gio.PasswordSave) –

set_uri(uri)¶

Parameters:: uri (str) – an uri representing a file

It is an error to call this function if the file descriptor is set for the job.

take_fd(fd, mime_type)¶

Parameters:

fd (int) – a file descriptor
mime_type (str) – the mime type of the file descriptor

Sets fd as the file descriptor in self. Note that self takes ownership of fd; you must not do anything with it afterwards.

It is an error to call this function if uri is set for the job

New in version 46.0.