Interface

Atk-1.0 ▶ Atk ▶ Document ▶ SignalSignatures

interface SignalSignatures {
    "document-attribute-changed": (arg1: string, arg2: string) => void;
    "load-complete": () => void;
    "load-stopped": () => void;
    "page-changed": (page_number: number) => void;
    reload: () => void;
}

Hierarchy (View Summary)

Index
document-attribute-changed load-complete load-stopped page-changed reload
"document-attribute-changed": (arg1: string, arg2: string) => void

The "document-attribute-changed" signal should be emitted when there is a change to one of the document attributes returned by atk_document_get_attributes.

2.52

"load-complete": () => void

The 'load-complete' signal is emitted when a pending load of a static document has completed. This signal is to be expected by ATK clients if and when AtkDocument implementors expose ATK_STATE_BUSY. If the state of an AtkObject which implements AtkDocument does not include ATK_STATE_BUSY, it should be safe for clients to assume that the AtkDocument's static contents are fully loaded into the container. (Dynamic document contents should be exposed via other signals.)

"load-stopped": () => void

The 'load-stopped' signal is emitted when a pending load of document contents is cancelled, paused, or otherwise interrupted by the user or application logic. It should not however be emitted while waiting for a resource (for instance while blocking on a file or network read) unless a user-significant timeout has occurred.

SignalRun Lastpage-changed

"page-changed": (page_number: number) => void

The 'page-changed' signal is emitted when the current page of a document changes, e.g. pressing page up/down in a document viewer.

2.12

reload: () => void

The 'reload' signal is emitted when the contents of a document is refreshed from its source. Once 'reload' has been emitted, a matching 'load-complete' or 'load-stopped' signal should follow, which clients may await before interrogating ATK for the latest document content.