gi-atk-2.0.12: Atk bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Atk.Interfaces.Document

Contents

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 #

Constructors

Document (ManagedPtr Document) 

Instances

GObject Document # 
IsObject Document # 
IsDocument Document # 
((~) * info (ResolveDocumentMethod t Document), MethodInfo * info Document p) => IsLabel t (Document -> p) # 

Methods

fromLabel :: Proxy# Symbol t -> Document -> p #

((~) * info (ResolveDocumentMethod t Document), MethodInfo * info Document p) => IsLabelProxy t (Document -> p) # 

Methods

fromLabelProxy :: Proxy Symbol t -> Document -> p #

HasAttributeList * Document # 
type AttributeList Document # 
type SignalList Document # 

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

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

data DocumentGetAttributesMethodInfo #

Instances

((~) * signature (m [Ptr ()]), MonadIO m, IsDocument a) => MethodInfo * DocumentGetAttributesMethodInfo a signature # 

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: 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

data DocumentGetDocumentMethodInfo #

Instances

((~) * signature (m (Ptr ())), MonadIO m, IsDocument a) => MethodInfo * DocumentGetDocumentMethodInfo a signature # 

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

data DocumentGetLocaleMethodInfo #

Instances

((~) * signature (m Text), MonadIO m, IsDocument a) => MethodInfo * DocumentGetLocaleMethodInfo a signature # 

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. -1 if not implemented, not know by the implementor or irrelevant.

No description available in the introspection data.

Since: 2.12

setAttributeValue

documentSetAttributeValue #

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 () #

loadStopped

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

pageChanged

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

reload

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