gi-poppler-0.18.24: Poppler bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Poppler.Objects.Attachment

Description

No description available in the introspection data.

Synopsis

Exported types

newtype Attachment Source #

Memory-managed wrapper type.

Constructors

Attachment (ManagedPtr Attachment) 

Instances

Instances details
Eq Attachment Source # 
Instance details

Defined in GI.Poppler.Objects.Attachment

Methods

(==) :: Attachment -> Attachment -> Bool

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

GObject Attachment Source # 
Instance details

Defined in GI.Poppler.Objects.Attachment

ManagedPtrNewtype Attachment Source # 
Instance details

Defined in GI.Poppler.Objects.Attachment

Methods

toManagedPtr :: Attachment -> ManagedPtr Attachment

TypedObject Attachment Source # 
Instance details

Defined in GI.Poppler.Objects.Attachment

Methods

glibType :: IO GType

IsGValue Attachment Source #

Convert Attachment to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Poppler.Objects.Attachment

Methods

toGValue :: Attachment -> IO GValue

fromGValue :: GValue -> IO Attachment

HasParentTypes Attachment Source # 
Instance details

Defined in GI.Poppler.Objects.Attachment

type ParentTypes Attachment Source # 
Instance details

Defined in GI.Poppler.Objects.Attachment

type ParentTypes Attachment = '[Object]

class (GObject o, IsDescendantOf Attachment o) => IsAttachment o Source #

Type class for types which can be safely cast to Attachment, for instance with toAttachment.

Instances

Instances details
(GObject o, IsDescendantOf Attachment o) => IsAttachment o Source # 
Instance details

Defined in GI.Poppler.Objects.Attachment

toAttachment :: (MonadIO m, IsAttachment o) => o -> m Attachment Source #

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

Methods

Overloaded methods

save

attachmentSave Source #

Arguments

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

attachment: A Attachment.

-> Text

filename: name of file to save

-> m ()

(Can throw GError)

Saves attachment to a file indicated by filename. If error is set, False will be returned. Possible errors include those in the G_FILE_ERROR domain and whatever the save function generates.

saveToCallback

attachmentSaveToCallback Source #

Arguments

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

attachment: A Attachment.

-> FunPtr C_AttachmentSaveFunc

saveFunc: a function that is called to save each block of data that the save routine generates.

-> m ()

(Can throw GError)

Saves attachment by feeding the produced data to saveFunc. Can be used when you want to store the attachment to something other than a file, such as an in-memory buffer or a socket. If error is set, False will be returned. Possible errors include those in the G_FILE_ERROR domain and whatever the save function generates.