atk.document

Module for [Document] interface

Types 2

interfaceDocument

The ATK interface which represents the toplevel container for document content.

The AtkDocument interface should be supported by any object whose content is a representation or view of a document. The AtkDocument interface should appear on the toplevel container for the document content; however AtkDocument instances may be nested (i.e. an AtkDocument may be a descendant of another AtkDocument) in those cases where one document contains "embedded content" which can reasonably be considered a document in its own right.

Methods
string getAttributeValue(string attributeName)Retrieves the value of the given attribute_name inside document.
int getCurrentPageNumber()Retrieves the current page number inside document. Returns: the current page number inside document, or -1 if not implemented, not know by the implementor, or irrelevant.
void * getDocument()Gets a [xlib.types.void] that points to an instance of the DOM. It is up to the caller to check atkdocumentget_type to determine how to cast this pointer. Returns: a [xlib.types.void] that points ...
string getDocumentType()Gets a string indicating the document type. Returns: a string indicating the document type
string getLocale()Gets a UTF-8 string indicating the POSIX-style LCMESSAGES locale of the content of this document instance. Individual text substrings or images within this document may have a different locale, se...
int getPageCount()Retrieves the total number of pages inside document. Returns: total page count of document, or -1 if not implemented, not know by the implementor or irrelevant.
bool setAttributeValue(string attributeName, string attributeValue)Sets the value for the given attribute_name inside document.
gulong connectDocumentAttributeChanged(T)(T callback, Flag!"After" after = No.After)Connect to `DocumentAttributeChanged` signal.
gulong connectLoadComplete(T)(T callback, Flag!"After" after = No.After)Connect to `LoadComplete` signal.
gulong connectLoadStopped(T)(T callback, Flag!"After" after = No.After)Connect to `LoadStopped` signal.
gulong connectPageChanged(T)(T callback, Flag!"After" after = No.After)Connect to `PageChanged` signal.
gulong connectReload(T)(T callback, Flag!"After" after = No.After)Connect to `Reload` signal.