Memory-managed wrapper type.

Type class for types which can be safely cast to Document, for instance with toDocument.

Cast to Document, for types for which this is known to be safe. For general casts, use castTo.

Retrieves the value of the given attributeName inside document.

Since: 1.12

Gets an AtkAttributeSet which describes document-wide attributes as name-value pairs.

Since: 1.12

Retrieves the current page number inside document.

Since: 2.12

Gets a gpointer that points to an instance of the DOM. It is up to the caller to check atk_document_get_type to determine how to cast this pointer.

Gets a string indicating the document type.

Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of the content of this document instance. Individual text substrings or images within this document may have a different locale, see atk_text_get_attributes and atk_image_get_image_locale.

Retrieves the total number of pages inside document.

Since: 2.12

Sets the value for the given attributeName inside document.

Since: 1.12

Type for the callback on the (unwrapped) C side.

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.)

Connect a signal handler for the loadComplete signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after document #loadComplete callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_DocumentLoadCompleteCallback.

A convenience synonym for Nothing :: Maybe DocumentLoadCompleteCallback.

Connect a signal handler for the loadComplete signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on document #loadComplete callback

Wrap a DocumentLoadCompleteCallback into a C_DocumentLoadCompleteCallback.

Type for the callback on the (unwrapped) C side.

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.

Connect a signal handler for the loadStopped signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after document #loadStopped callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_DocumentLoadStoppedCallback.

A convenience synonym for Nothing :: Maybe DocumentLoadStoppedCallback.

Connect a signal handler for the loadStopped signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on document #loadStopped callback

Wrap a DocumentLoadStoppedCallback into a C_DocumentLoadStoppedCallback.

Type for the callback on the (unwrapped) C side.

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

Since: 2.12

Connect a signal handler for the pageChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after document #pageChanged callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_DocumentPageChangedCallback.

A convenience synonym for Nothing :: Maybe DocumentPageChangedCallback.

Connect a signal handler for the pageChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on document #pageChanged callback

Wrap a DocumentPageChangedCallback into a C_DocumentPageChangedCallback.

Type for the callback on the (unwrapped) C side.

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.

Connect a signal handler for the reload signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after document #reload callback

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_DocumentReloadCallback.

A convenience synonym for Nothing :: Maybe DocumentReloadCallback.

Connect a signal handler for the reload signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on document #reload callback

Wrap a DocumentReloadCallback into a C_DocumentReloadCallback.