gi-atk-2.0.21: Atk bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Atk.Interfaces.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.

Synopsis

Exported types

newtype Document Source #

Memory-managed wrapper type.

Constructors

Document (ManagedPtr Document) 

Instances

Instances details
Eq Document Source # 
Instance details

Defined in GI.Atk.Interfaces.Document

GObject Document Source # 
Instance details

Defined in GI.Atk.Interfaces.Document

Methods

gobjectType :: IO GType #

IsGValue Document Source #

Convert Document to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Atk.Interfaces.Document

HasParentTypes Document Source # 
Instance details

Defined in GI.Atk.Interfaces.Document

type ParentTypes Document Source # 
Instance details

Defined in GI.Atk.Interfaces.Document

noDocument :: Maybe Document Source #

A convenience alias for Nothing :: Maybe Document.

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

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

Instances

Instances details
(GObject o, IsDescendantOf Document o) => IsDocument o Source # 
Instance details

Defined in GI.Atk.Interfaces.Document

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

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

Methods

Overloaded methods

getAttributeValue

documentGetAttributeValue Source #

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 NULL if a value for attribute_name has not been specified for this document.

No description available in the introspection data.

Since: 1.12

getAttributes

documentGetAttributes Source #

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 Source #

Arguments

:: (HasCallStack, MonadIO m, IsDocument a) 
=> a

document: the Document

-> m Int32

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

No description available in the introspection data.

Since: 2.12

getDocument

documentGetDocument Source #

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 Source #

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 Source #

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 Source #

Arguments

:: (HasCallStack, MonadIO m, IsDocument a) 
=> a

document: the Document

-> m Int32

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

No description available in the introspection data.

Since: 2.12

setAttributeValue

documentSetAttributeValue Source #

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

-> Text

attributeValue: a string value to be associated with attribute_name.

-> m Bool

Returns: TRUE if value is successfully associated with attribute_name for this document, FALSE otherwise (e.g. if the document does not allow the attribute to be modified).

No description available in the introspection data.

Since: 1.12

Signals

loadComplete

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

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

type DocumentLoadCompleteCallback = IO () Source #

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 Source #

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

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

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

loadStopped

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

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

type DocumentLoadStoppedCallback = IO () Source #

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 Source #

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

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

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

pageChanged

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

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

type DocumentPageChangedCallback Source #

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 Source #

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

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

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

reload

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

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

type DocumentReloadCallback = IO () Source #

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 Source #

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

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

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