Document

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

class Document {

protected

AtkDocument* atkDocument;

AtkDocument* getDocumentStruct();

void* getStruct();

this(AtkDocument* atkDocument);

int[string] connectedSignals;

void delegate(Document)[] onLoadCompleteListeners;

void addOnLoadComplete(void delegate(Document) dlg, ConnectFlags connectFlags);

static void callBackLoadComplete(AtkDocument* atkdocumentStruct, Document _document);

void delegate(Document)[] onLoadStoppedListeners;

void addOnLoadStopped(void delegate(Document) dlg, ConnectFlags connectFlags);

static void callBackLoadStopped(AtkDocument* atkdocumentStruct, Document _document);

void delegate(Document)[] onReloadListeners;

void addOnReload(void delegate(Document) dlg, ConnectFlags connectFlags);

static void callBackReload(AtkDocument* atkdocumentStruct, Document _document);

string getDocumentType();

void* getDocument();

string getAttributeValue(string attributeName);

int setAttributeValue(string attributeName, string attributeValue);

AtkAttributeSet* getAttributes();

string getLocale();

}

Constructors

this this(AtkDocument* atkDocument): Sets our main struct and passes it to the parent class

Members

Functions

addOnLoadComplete void addOnLoadComplete(void delegate(Document) dlg, ConnectFlags connectFlags): 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.)
addOnLoadStopped void addOnLoadStopped(void delegate(Document) dlg, ConnectFlags connectFlags): 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.
addOnReload void addOnReload(void delegate(Document) dlg, ConnectFlags connectFlags): 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.
getAttributeValue string getAttributeValue(string attributeName): Since 1.12
getAttributes AtkAttributeSet* getAttributes(): Gets an AtkAttributeSet which describes document-wide attributes as name-value pairs. Since 1.12
getDocument void* getDocument(): 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.
getDocumentStruct AtkDocument* getDocumentStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
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.
getStruct void* getStruct(): the main Gtk struct as a void*
setAttributeValue int setAttributeValue(string attributeName, string attributeValue): Since 1.12

Static functions

callBackLoadComplete void callBackLoadComplete(AtkDocument* atkdocumentStruct, Document _document): Undocumented in source. Be warned that the author may not have intended to support it.
callBackLoadStopped void callBackLoadStopped(AtkDocument* atkdocumentStruct, Document _document): Undocumented in source. Be warned that the author may not have intended to support it.
callBackReload void callBackReload(AtkDocument* atkdocumentStruct, Document _document): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

atkDocument AtkDocument* atkDocument;: the main Gtk struct
connectedSignals int[string] connectedSignals;
onLoadCompleteListeners void delegate(Document)[] onLoadCompleteListeners;: Undocumented in source.
onLoadStoppedListeners void delegate(Document)[] onLoadStoppedListeners;: Undocumented in source.
onReloadListeners void delegate(Document)[] onReloadListeners;: Undocumented in source.