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

Constructors

Document (ManagedPtr Document)

Instances

WrappedPtr Document

Methods

wrappedPtrCalloc :: IO (Ptr Document)

wrappedPtrCopy :: Document -> IO Document

wrappedPtrFree :: Maybe (FunPtr (Ptr Document -> IO ()))

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

type SignalList Document

type SignalList Document

noDocument :: Maybe Document

class ManagedPtrNewtype a => IsDocument a

Instances

IsDocument Document

IsDocument NoOpObject

Methods

getAttributeValue

data DocumentGetAttributeValueMethodInfo

Instances

((~) * signature (Text -> m (Maybe Text)), MonadIO m, IsDocument a) => MethodInfo * DocumentGetAttributeValueMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DocumentGetAttributeValueMethodInfo a -> signature -> s

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

Methods

overloadedMethod :: MethodProxy DocumentGetAttributesMethodInfo a -> signature -> s

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

data DocumentGetCurrentPageNumberMethodInfo

Instances

((~) * signature (m Int32), MonadIO m, IsDocument a) => MethodInfo * DocumentGetCurrentPageNumberMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DocumentGetCurrentPageNumberMethodInfo a -> signature -> s

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

Methods

overloadedMethod :: MethodProxy DocumentGetDocumentMethodInfo a -> signature -> s

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

data DocumentGetDocumentTypeMethodInfo

Instances

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

Methods

overloadedMethod :: MethodProxy DocumentGetDocumentTypeMethodInfo a -> signature -> s

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

Methods

overloadedMethod :: MethodProxy DocumentGetLocaleMethodInfo a -> signature -> s

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

data DocumentGetPageCountMethodInfo

Instances

((~) * signature (m Int32), MonadIO m, IsDocument a) => MethodInfo * DocumentGetPageCountMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DocumentGetPageCountMethodInfo a -> signature -> s

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

data DocumentSetAttributeValueMethodInfo

Instances

((~) * signature (Text -> Text -> m Bool), MonadIO m, IsDocument a) => MethodInfo * DocumentSetAttributeValueMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DocumentSetAttributeValueMethodInfo a -> signature -> s

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

type DocumentLoadCompleteCallback = IO ()

data DocumentLoadCompleteSignalInfo

Instances

SignalInfo DocumentLoadCompleteSignalInfo

Associated Types

type HaskellCallbackType DocumentLoadCompleteSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o DocumentLoadCompleteSignalInfo -> o -> HaskellCallbackType DocumentLoadCompleteSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType DocumentLoadCompleteSignalInfo

type HaskellCallbackType DocumentLoadCompleteSignalInfo = DocumentLoadCompleteCallback

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

genClosure_DocumentLoadComplete :: DocumentLoadCompleteCallback -> IO Closure

mk_DocumentLoadCompleteCallback :: C_DocumentLoadCompleteCallback -> IO (FunPtr C_DocumentLoadCompleteCallback)

noDocumentLoadCompleteCallback :: Maybe DocumentLoadCompleteCallback

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

wrap_DocumentLoadCompleteCallback :: DocumentLoadCompleteCallback -> Ptr () -> Ptr () -> IO ()

loadStopped

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

type DocumentLoadStoppedCallback = IO ()

data DocumentLoadStoppedSignalInfo

Instances

SignalInfo DocumentLoadStoppedSignalInfo

Associated Types

type HaskellCallbackType DocumentLoadStoppedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o DocumentLoadStoppedSignalInfo -> o -> HaskellCallbackType DocumentLoadStoppedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType DocumentLoadStoppedSignalInfo

type HaskellCallbackType DocumentLoadStoppedSignalInfo = DocumentLoadStoppedCallback

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

genClosure_DocumentLoadStopped :: DocumentLoadStoppedCallback -> IO Closure

mk_DocumentLoadStoppedCallback :: C_DocumentLoadStoppedCallback -> IO (FunPtr C_DocumentLoadStoppedCallback)

noDocumentLoadStoppedCallback :: Maybe DocumentLoadStoppedCallback

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

wrap_DocumentLoadStoppedCallback :: DocumentLoadStoppedCallback -> Ptr () -> Ptr () -> IO ()

pageChanged

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

type DocumentPageChangedCallback = Int32 -> IO ()

data DocumentPageChangedSignalInfo

Instances

SignalInfo DocumentPageChangedSignalInfo

Associated Types

type HaskellCallbackType DocumentPageChangedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o DocumentPageChangedSignalInfo -> o -> HaskellCallbackType DocumentPageChangedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType DocumentPageChangedSignalInfo

type HaskellCallbackType DocumentPageChangedSignalInfo = DocumentPageChangedCallback

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

genClosure_DocumentPageChanged :: DocumentPageChangedCallback -> IO Closure

mk_DocumentPageChangedCallback :: C_DocumentPageChangedCallback -> IO (FunPtr C_DocumentPageChangedCallback)

noDocumentPageChangedCallback :: Maybe DocumentPageChangedCallback

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

wrap_DocumentPageChangedCallback :: DocumentPageChangedCallback -> Ptr () -> Int32 -> Ptr () -> IO ()

reload

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

type DocumentReloadCallback = IO ()

data DocumentReloadSignalInfo

Instances

SignalInfo DocumentReloadSignalInfo

Associated Types

type HaskellCallbackType DocumentReloadSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o DocumentReloadSignalInfo -> o -> HaskellCallbackType DocumentReloadSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType DocumentReloadSignalInfo

type HaskellCallbackType DocumentReloadSignalInfo = DocumentReloadCallback

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

genClosure_DocumentReload :: DocumentReloadCallback -> IO Closure

mk_DocumentReloadCallback :: C_DocumentReloadCallback -> IO (FunPtr C_DocumentReloadCallback)

noDocumentReloadCallback :: Maybe DocumentReloadCallback

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

wrap_DocumentReloadCallback :: DocumentReloadCallback -> Ptr () -> Ptr () -> IO ()