DocumentT

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.

template DocumentT () {

string getAttributeValue(string attributeName);

int getCurrentPageNumber();

void* getDocument();

string getDocumentType();

string getLocale();

int getPageCount();

bool setAttributeValue(string attributeName, string attributeValue);

ulong connectDocumentAttributeChanged(T callback, Flag!"After" after);

ulong connectLoadComplete(T callback, Flag!"After" after);

ulong connectLoadStopped(T callback, Flag!"After" after);

ulong connectPageChanged(T callback, Flag!"After" after);

ulong connectReload(T callback, Flag!"After" after);

}

Members

Functions

connectDocumentAttributeChanged ulong connectDocumentAttributeChanged(T callback, Flag!"After" after): Connect to DocumentAttributeChanged signal.
connectLoadComplete ulong connectLoadComplete(T callback, Flag!"After" after): Connect to LoadComplete signal.
connectLoadStopped ulong connectLoadStopped(T callback, Flag!"After" after): Connect to LoadStopped signal.
connectPageChanged ulong connectPageChanged(T callback, Flag!"After" after): Connect to PageChanged signal.
connectReload ulong connectReload(T callback, Flag!"After" after): Connect to Reload signal.
getAttributeValue string getAttributeValue(string attributeName): Retrieves the value of the given attribute_name inside document.
getCurrentPageNumber int getCurrentPageNumber(): Retrieves the current page number inside document.
getDocument void* getDocument(): Gets a [xlib.types.void*] 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.
getDocumentType string getDocumentType(): Gets a string indicating the document type.
getLocale string getLocale(): 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.
getPageCount int getPageCount(): Retrieves the total number of pages inside document.
setAttributeValue bool setAttributeValue(string attributeName, string attributeValue): Sets the value for the given attribute_name inside document.

atk document_mixin templates

DocumentT