GI.Atk.Interfaces.Document

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.

Exported types

newtype Document

Memory-managed wrapper type.

Constructors

Document (ManagedPtr Document)

Instances

Eq Document

Defined in GI.Atk.Interfaces.Document

Methods

(==) :: Document -> Document -> Bool

(/=) :: Document -> Document -> Bool

IsGValue Document

Convert Document to and from GValue with toGValue and fromGValue.

Defined in GI.Atk.Interfaces.Document

Methods

toGValue :: Document -> IO GValue

fromGValue :: GValue -> IO Document

ManagedPtrNewtype Document

Defined in GI.Atk.Interfaces.Document

Methods

toManagedPtr :: Document -> ManagedPtr Document

TypedObject Document

Defined in GI.Atk.Interfaces.Document

Methods

glibType :: IO GType

GObject Document

Defined in GI.Atk.Interfaces.Document

HasParentTypes Document

Defined in GI.Atk.Interfaces.Document

type ParentTypes Document

Defined in GI.Atk.Interfaces.Document

type ParentTypes Document = '[Object]

class (GObject o, IsDescendantOf Document o) => IsDocument o

Type class for types which can be safely cast to Document, for instance with toDocument.

Instances

(GObject o, IsDescendantOf Document o) => IsDocument o

Defined in GI.Atk.Interfaces.Document

toDocument :: (MonadIO m, IsDocument o) => o -> m Document

Cast to Document, for types for which this is known to be safe. For general casts, use castTo.

Methods

Overloaded methods

getAttributeValue

documentGetAttributeValue

Arguments

:: (HasCallStack, MonadIO m, IsDocument a)

=> a

document: a Object instance that implements AtkDocumentIface

-> Text

attributeName: a character string representing the name of the attribute whose value is being queried.

-> m (Maybe Text)

Returns: a string value associated with the named attribute for this document, or Nothing if a value for attributeName has not been specified for this document.

Retrieves the value of the given attributeName inside document.

Since: 1.12

getAttributes

documentGetAttributes

Arguments

:: (HasCallStack, MonadIO m, IsDocument a)

=> a

document: a Object instance that implements AtkDocumentIface

-> m [Ptr ()]

Returns: An AtkAttributeSet containing the explicitly set name-value-pair attributes associated with this document as a whole.

Gets an AtkAttributeSet which describes document-wide attributes as name-value pairs.

Since: 1.12

getCurrentPageNumber

documentGetCurrentPageNumber

Arguments

:: (HasCallStack, MonadIO m, IsDocument a)

=> a

document: the Document

-> m Int32

Returns: the current page number inside document, or -1 if not implemented, not know by the implementor, or irrelevant.

Retrieves the current page number inside document.

Since: 2.12

getDocument

documentGetDocument

Arguments

:: (HasCallStack, MonadIO m, IsDocument a)

=> a

document: a Object instance that implements AtkDocumentIface

-> m (Ptr ())

Returns: a gpointer that points to an instance of the DOM.

Deprecated: Since 2.12. document is already a representation ofthe document. Use it directly, or one of its children, as aninstance of the DOM.

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.

getDocumentType

documentGetDocumentType

Arguments

:: (HasCallStack, MonadIO m, IsDocument a)

=> a

document: a Object instance that implements AtkDocumentIface

-> m Text

Returns: a string indicating the document type

Deprecated: Since 2.12. Please use documentGetAttributes toask for the document type if it applies.

Gets a string indicating the document type.

getLocale

documentGetLocale

Arguments

:: (HasCallStack, MonadIO m, IsDocument a)

=> a

document: a Object instance that implements AtkDocumentIface

-> m Text

Returns: a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of the document content as a whole, or NULL if the document content does not specify a locale.

Deprecated: (Since version 2.7.90)Please use objectGetObjectLocale instead.

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

documentGetPageCount

Arguments

:: (HasCallStack, MonadIO m, IsDocument a)

=> a

document: the Document

-> m Int32

Returns: total page count of document, or -1 if not implemented, not know by the implementor or irrelevant.

Retrieves the total number of pages inside document.

Since: 2.12

setAttributeValue

documentSetAttributeValue

Arguments

:: (HasCallStack, MonadIO m, IsDocument a)

=> a

document: a Object instance that implements DocumentIface

-> Text

attributeName: a character string representing the name of the attribute whose value is being set.

-> Text

attributeValue: a string value to be associated with attributeName.

-> m Bool

Returns: True if attributeValue is successfully associated with attributeName for this document, and False if if the document does not allow the attribute to be modified

Sets the value for the given attributeName inside document.

Since: 1.12

Signals

loadComplete

type C_DocumentLoadCompleteCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DocumentLoadCompleteCallback = IO ()

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

afterDocumentLoadComplete :: (IsDocument a, MonadIO m) => a -> DocumentLoadCompleteCallback -> m SignalHandlerId

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

genClosure_DocumentLoadComplete :: MonadIO m => DocumentLoadCompleteCallback -> m (GClosure C_DocumentLoadCompleteCallback)

Wrap the callback into a GClosure.

mk_DocumentLoadCompleteCallback :: C_DocumentLoadCompleteCallback -> IO (FunPtr C_DocumentLoadCompleteCallback)

Generate a function pointer callable from C code, from a C_DocumentLoadCompleteCallback.

noDocumentLoadCompleteCallback :: Maybe DocumentLoadCompleteCallback

A convenience synonym for Nothing :: Maybe DocumentLoadCompleteCallback.

onDocumentLoadComplete :: (IsDocument a, MonadIO m) => a -> DocumentLoadCompleteCallback -> m SignalHandlerId

Connect a signal handler for the loadComplete signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on document #loadComplete callback

wrap_DocumentLoadCompleteCallback :: DocumentLoadCompleteCallback -> C_DocumentLoadCompleteCallback

Wrap a DocumentLoadCompleteCallback into a C_DocumentLoadCompleteCallback.

loadStopped

type C_DocumentLoadStoppedCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DocumentLoadStoppedCallback = IO ()

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.

afterDocumentLoadStopped :: (IsDocument a, MonadIO m) => a -> DocumentLoadStoppedCallback -> m SignalHandlerId

Connect a signal handler for the loadStopped signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after document #loadStopped callback

genClosure_DocumentLoadStopped :: MonadIO m => DocumentLoadStoppedCallback -> m (GClosure C_DocumentLoadStoppedCallback)

Wrap the callback into a GClosure.

mk_DocumentLoadStoppedCallback :: C_DocumentLoadStoppedCallback -> IO (FunPtr C_DocumentLoadStoppedCallback)

Generate a function pointer callable from C code, from a C_DocumentLoadStoppedCallback.

noDocumentLoadStoppedCallback :: Maybe DocumentLoadStoppedCallback

A convenience synonym for Nothing :: Maybe DocumentLoadStoppedCallback.

onDocumentLoadStopped :: (IsDocument a, MonadIO m) => a -> DocumentLoadStoppedCallback -> m SignalHandlerId

Connect a signal handler for the loadStopped signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on document #loadStopped callback

wrap_DocumentLoadStoppedCallback :: DocumentLoadStoppedCallback -> C_DocumentLoadStoppedCallback

Wrap a DocumentLoadStoppedCallback into a C_DocumentLoadStoppedCallback.

pageChanged

type C_DocumentPageChangedCallback = Ptr () -> Int32 -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DocumentPageChangedCallback

Arguments

 = Int32

pageNumber: the new page number. If this value is unknown or not applicable, -1 should be provided.

-> IO ()

The 'page-changed' signal is emitted when the current page of a document changes, e.g. pressing page up/down in a document viewer.

Since: 2.12

afterDocumentPageChanged :: (IsDocument a, MonadIO m) => a -> DocumentPageChangedCallback -> m SignalHandlerId

Connect a signal handler for the pageChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after document #pageChanged callback

genClosure_DocumentPageChanged :: MonadIO m => DocumentPageChangedCallback -> m (GClosure C_DocumentPageChangedCallback)

Wrap the callback into a GClosure.

mk_DocumentPageChangedCallback :: C_DocumentPageChangedCallback -> IO (FunPtr C_DocumentPageChangedCallback)

Generate a function pointer callable from C code, from a C_DocumentPageChangedCallback.

noDocumentPageChangedCallback :: Maybe DocumentPageChangedCallback

A convenience synonym for Nothing :: Maybe DocumentPageChangedCallback.

onDocumentPageChanged :: (IsDocument a, MonadIO m) => a -> DocumentPageChangedCallback -> m SignalHandlerId

Connect a signal handler for the pageChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on document #pageChanged callback

wrap_DocumentPageChangedCallback :: DocumentPageChangedCallback -> C_DocumentPageChangedCallback

Wrap a DocumentPageChangedCallback into a C_DocumentPageChangedCallback.

reload

type C_DocumentReloadCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DocumentReloadCallback = IO ()

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.

afterDocumentReload :: (IsDocument a, MonadIO m) => a -> DocumentReloadCallback -> m SignalHandlerId

Connect a signal handler for the reload signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after document #reload callback

genClosure_DocumentReload :: MonadIO m => DocumentReloadCallback -> m (GClosure C_DocumentReloadCallback)

Wrap the callback into a GClosure.

mk_DocumentReloadCallback :: C_DocumentReloadCallback -> IO (FunPtr C_DocumentReloadCallback)

Generate a function pointer callable from C code, from a C_DocumentReloadCallback.

noDocumentReloadCallback :: Maybe DocumentReloadCallback

A convenience synonym for Nothing :: Maybe DocumentReloadCallback.

onDocumentReload :: (IsDocument a, MonadIO m) => a -> DocumentReloadCallback -> m SignalHandlerId

Connect a signal handler for the reload signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on document #reload callback

wrap_DocumentReloadCallback :: DocumentReloadCallback -> C_DocumentReloadCallback

Wrap a DocumentReloadCallback into a C_DocumentReloadCallback.