Document package:gi-atk
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.
Memory-managed wrapper type.
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.)
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.
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.
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
Deprecated: Since 2.12. document is already a
representation ofthe document. Use it directly, or one of its
children, as aninstance of the DOM.
Retrieves the total number of pages inside document.
Since: 2.12
Returns an array of AtkTextSelections within this document.
Since: 2.52
Sets the value for the given attributeName inside
document.
Since: 1.12
Makes 1 or more selections within this document denoted by the given
array of AtkTextSelections. Any existing physical selection (inside or
outside this document) is replaced by the new selections. All objects
within the given selection ranges must be descendants of this
document. Otherwise FALSE will be returned.
Since: 2.52
A document frame which contains email content to be displayed or
composed either in plain text or HTML. (Since: 2.1.0)
The object is a visual frame or container which contains a view of
document content. Document frames may occur within another Document
instance, in which case the second document may be said to be embedded
in the containing instance. HTML frames are often ROLE_DOCUMENT_FRAME.
Either this object, or a singleton descendant, should implement the
Document interface. (Since: 1.11)
A document frame which contains a presentation or slide content.
(Since: 2.1.0)
A document frame which contains a spreadsheet. (Since: 2.1.0)
A document frame which contains textual content, such as found in a
word processing application. (Since: 2.1.0)
A document frame which contains HTML or other markup suitable for
display in a web browser. (Since: 2.1.0)
Connect a signal handler for the
documentAttributeChanged
signal, to be run after the default handler. When
overloading
is enabled, this is equivalent to
after document #documentAttributeChanged callback
By default the object invoking the signal is not passed to the
callback. If you need to access it, you can use the implit
?self parameter. Note that this requires activating the
ImplicitParams GHC extension.
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
By default the object invoking the signal is not passed to the
callback. If you need to access it, you can use the implit
?self parameter. Note that this requires activating the
ImplicitParams GHC extension.