DocumentT

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 (

TStruct

) {

AtkDocument* getDocumentStruct();

string getAttributeValue(string attributeName);

AtkAttributeSet* getAttributes();

int getCurrentPageNumber();

void* getDocument();

string getDocumentType();

string getLocale();

int getPageCount();

bool setAttributeValue(string attributeName, string attributeValue);

int[string] connectedSignals;

void delegate(DocumentIF)[] _onLoadCompleteListeners;

void delegate(DocumentIF)[] onLoadCompleteListeners [@property getter];

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

static void callBackLoadComplete(AtkDocument* documentStruct, DocumentIF _document);

void delegate(DocumentIF)[] _onLoadStoppedListeners;

void delegate(DocumentIF)[] onLoadStoppedListeners [@property getter];

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

static void callBackLoadStopped(AtkDocument* documentStruct, DocumentIF _document);

void delegate(int, DocumentIF)[] _onPageChangedListeners;

void delegate(int, DocumentIF)[] onPageChangedListeners [@property getter];

void addOnPageChanged(void delegate(int, DocumentIF) dlg, ConnectFlags connectFlags);

static void callBackPageChanged(AtkDocument* documentStruct, int pageNumber, DocumentIF _document);

void delegate(DocumentIF)[] _onReloadListeners;

void delegate(DocumentIF)[] onReloadListeners [@property getter];

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

static void callBackReload(AtkDocument* documentStruct, DocumentIF _document);

}

Members

Functions

addOnLoadComplete void addOnLoadComplete(void delegate(DocumentIF) 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(DocumentIF) 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.
addOnPageChanged void addOnPageChanged(void delegate(int, DocumentIF) dlg, ConnectFlags connectFlags): The 'page-changed' signal is emitted when the current page of a document changes, e.g. pressing page up/down in a document viewer.
addOnReload void addOnReload(void delegate(DocumentIF) 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)
getAttributes AtkAttributeSet* getAttributes(): Gets an AtkAttributeSet which describes document-wide attributes as name-value pairs.
getCurrentPageNumber int getCurrentPageNumber(): Return: current page number inside @document. -1 if not implemented, not know by the implementor or irrelevant.
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(): Get the main Gtk struct
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(): Return: total page count of @document. -1 if not implemented, not know by the implementor or irrelevant.
setAttributeValue bool setAttributeValue(string attributeName, string attributeValue)

Properties

onLoadCompleteListeners void delegate(DocumentIF)[] onLoadCompleteListeners [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
onLoadStoppedListeners void delegate(DocumentIF)[] onLoadStoppedListeners [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
onPageChangedListeners void delegate(int, DocumentIF)[] onPageChangedListeners [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
onReloadListeners void delegate(DocumentIF)[] onReloadListeners [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

callBackLoadComplete void callBackLoadComplete(AtkDocument* documentStruct, DocumentIF _document): Undocumented in source. Be warned that the author may not have intended to support it.
callBackLoadStopped void callBackLoadStopped(AtkDocument* documentStruct, DocumentIF _document): Undocumented in source. Be warned that the author may not have intended to support it.
callBackPageChanged void callBackPageChanged(AtkDocument* documentStruct, int pageNumber, DocumentIF _document): Undocumented in source. Be warned that the author may not have intended to support it.
callBackReload void callBackReload(AtkDocument* documentStruct, DocumentIF _document): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

_onLoadCompleteListeners void delegate(DocumentIF)[] _onLoadCompleteListeners;: Undocumented in source.
_onLoadStoppedListeners void delegate(DocumentIF)[] _onLoadStoppedListeners;: Undocumented in source.
_onPageChangedListeners void delegate(int, DocumentIF)[] _onPageChangedListeners;: Undocumented in source.
_onReloadListeners void delegate(DocumentIF)[] _onReloadListeners;: Undocumented in source.
connectedSignals int[string] connectedSignals;: Undocumented in source.