Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Poppler.Objects.Document

Contents

Exported types
Methods
Properties

Description

Synopsis

Exported types

newtype Document Source

Constructors

Document (ForeignPtr Document)

Instances

GObject Document
type ParentTypes Document
type AttributeList Document
type SignalList Document

class GObject o => DocumentK o Source

Instances

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

toDocument :: DocumentK o => o -> IO Document Source

noDocument :: Maybe Document Source

Methods

documentFindDest

documentFindDest :: (MonadIO m, DocumentK a) => a -> Text -> m Dest Source

documentGetAttachments

documentGetAttachments :: (MonadIO m, DocumentK a) => a -> m [Attachment] Source

documentGetAuthor

documentGetAuthor :: (MonadIO m, DocumentK a) => a -> m Text Source

documentGetCreationDate

documentGetCreationDate :: (MonadIO m, DocumentK a) => a -> m Int64 Source

documentGetCreator

documentGetCreator :: (MonadIO m, DocumentK a) => a -> m Text Source

documentGetFormField

documentGetFormField :: (MonadIO m, DocumentK a) => a -> Int32 -> m FormField Source

documentGetId

documentGetId :: (MonadIO m, DocumentK a) => a -> m (Bool, Text, Text) Source

documentGetKeywords

documentGetKeywords :: (MonadIO m, DocumentK a) => a -> m Text Source

documentGetMetadata

documentGetMetadata :: (MonadIO m, DocumentK a) => a -> m Text Source

documentGetModificationDate

documentGetModificationDate :: (MonadIO m, DocumentK a) => a -> m Int64 Source

documentGetNAttachments

documentGetNAttachments :: (MonadIO m, DocumentK a) => a -> m Word32 Source

documentGetNPages

documentGetNPages :: (MonadIO m, DocumentK a) => a -> m Int32 Source

documentGetPage

documentGetPage :: (MonadIO m, DocumentK a) => a -> Int32 -> m Page Source

documentGetPageByLabel

documentGetPageByLabel :: (MonadIO m, DocumentK a) => a -> Text -> m Page Source

documentGetPageLayout

documentGetPageLayout :: (MonadIO m, DocumentK a) => a -> m PageLayout Source

documentGetPageMode

documentGetPageMode :: (MonadIO m, DocumentK a) => a -> m PageMode Source

documentGetPdfVersion

documentGetPdfVersion :: (MonadIO m, DocumentK a) => a -> m (Word32, Word32) Source

documentGetPdfVersionString

documentGetPdfVersionString :: (MonadIO m, DocumentK a) => a -> m Text Source

documentGetPermissions

documentGetPermissions :: (MonadIO m, DocumentK a) => a -> m [Permissions] Source

documentGetProducer

documentGetProducer :: (MonadIO m, DocumentK a) => a -> m Text Source

documentGetSubject

documentGetSubject :: (MonadIO m, DocumentK a) => a -> m Text Source

documentGetTitle

documentGetTitle :: (MonadIO m, DocumentK a) => a -> m Text Source

documentHasAttachments

documentHasAttachments :: (MonadIO m, DocumentK a) => a -> m Bool Source

documentIsLinearized

documentIsLinearized :: (MonadIO m, DocumentK a) => a -> m Bool Source

documentNewFromData

documentNewFromData :: MonadIO m => Text -> Int32 -> Maybe Text -> m Document Source

documentNewFromFile

documentNewFromFile :: MonadIO m => Text -> Maybe Text -> m Document Source

documentNewFromGfile

documentNewFromGfile :: (MonadIO m, FileK a, CancellableK b) => a -> Maybe Text -> Maybe b -> m Document Source

documentNewFromStream

documentNewFromStream :: (MonadIO m, InputStreamK a, CancellableK b) => a -> Int64 -> Maybe Text -> Maybe b -> m Document Source

documentSave

documentSave :: (MonadIO m, DocumentK a) => a -> Text -> m () Source

documentSaveACopy

documentSaveACopy :: (MonadIO m, DocumentK a) => a -> Text -> m () Source

Properties

Author

data DocumentAuthorPropertyInfo Source

Instances

AttrInfo DocumentAuthorPropertyInfo
type AttrLabel DocumentAuthorPropertyInfo = "Document::author"
type AttrGetType DocumentAuthorPropertyInfo = Text
type AttrBaseTypeConstraint DocumentAuthorPropertyInfo = DocumentK
type AttrSetTypeConstraint DocumentAuthorPropertyInfo = * ~ ()
type AttrAllowedOps DocumentAuthorPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getDocumentAuthor :: (MonadIO m, DocumentK o) => o -> m Text Source

CreationDate

data DocumentCreationDatePropertyInfo Source

Instances

AttrInfo DocumentCreationDatePropertyInfo
type AttrLabel DocumentCreationDatePropertyInfo = "Document::creation-date"
type AttrGetType DocumentCreationDatePropertyInfo = Int32
type AttrBaseTypeConstraint DocumentCreationDatePropertyInfo = DocumentK
type AttrSetTypeConstraint DocumentCreationDatePropertyInfo = * ~ ()
type AttrAllowedOps DocumentCreationDatePropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getDocumentCreationDate :: (MonadIO m, DocumentK o) => o -> m Int32 Source

Creator

data DocumentCreatorPropertyInfo Source

Instances

AttrInfo DocumentCreatorPropertyInfo
type AttrLabel DocumentCreatorPropertyInfo = "Document::creator"
type AttrGetType DocumentCreatorPropertyInfo = Text
type AttrBaseTypeConstraint DocumentCreatorPropertyInfo = DocumentK
type AttrSetTypeConstraint DocumentCreatorPropertyInfo = * ~ ()
type AttrAllowedOps DocumentCreatorPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getDocumentCreator :: (MonadIO m, DocumentK o) => o -> m Text Source

Format

data DocumentFormatPropertyInfo Source

Instances

AttrInfo DocumentFormatPropertyInfo
type AttrLabel DocumentFormatPropertyInfo = "Document::format"
type AttrGetType DocumentFormatPropertyInfo = Text
type AttrBaseTypeConstraint DocumentFormatPropertyInfo = DocumentK
type AttrSetTypeConstraint DocumentFormatPropertyInfo = * ~ ()
type AttrAllowedOps DocumentFormatPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getDocumentFormat :: (MonadIO m, DocumentK o) => o -> m Text Source

FormatMajor

data DocumentFormatMajorPropertyInfo Source

Instances

AttrInfo DocumentFormatMajorPropertyInfo
type AttrLabel DocumentFormatMajorPropertyInfo = "Document::format-major"
type AttrGetType DocumentFormatMajorPropertyInfo = Word32
type AttrBaseTypeConstraint DocumentFormatMajorPropertyInfo = DocumentK
type AttrSetTypeConstraint DocumentFormatMajorPropertyInfo = * ~ ()
type AttrAllowedOps DocumentFormatMajorPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getDocumentFormatMajor :: (MonadIO m, DocumentK o) => o -> m Word32 Source

FormatMinor

data DocumentFormatMinorPropertyInfo Source

Instances

AttrInfo DocumentFormatMinorPropertyInfo
type AttrLabel DocumentFormatMinorPropertyInfo = "Document::format-minor"
type AttrGetType DocumentFormatMinorPropertyInfo = Word32
type AttrBaseTypeConstraint DocumentFormatMinorPropertyInfo = DocumentK
type AttrSetTypeConstraint DocumentFormatMinorPropertyInfo = * ~ ()
type AttrAllowedOps DocumentFormatMinorPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getDocumentFormatMinor :: (MonadIO m, DocumentK o) => o -> m Word32 Source

Keywords

data DocumentKeywordsPropertyInfo Source

Instances

AttrInfo DocumentKeywordsPropertyInfo
type AttrLabel DocumentKeywordsPropertyInfo = "Document::keywords"
type AttrGetType DocumentKeywordsPropertyInfo = Text
type AttrBaseTypeConstraint DocumentKeywordsPropertyInfo = DocumentK
type AttrSetTypeConstraint DocumentKeywordsPropertyInfo = * ~ ()
type AttrAllowedOps DocumentKeywordsPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getDocumentKeywords :: (MonadIO m, DocumentK o) => o -> m Text Source

Linearized

data DocumentLinearizedPropertyInfo Source

Instances

AttrInfo DocumentLinearizedPropertyInfo
type AttrLabel DocumentLinearizedPropertyInfo = "Document::linearized"
type AttrGetType DocumentLinearizedPropertyInfo = Bool
type AttrBaseTypeConstraint DocumentLinearizedPropertyInfo = DocumentK
type AttrSetTypeConstraint DocumentLinearizedPropertyInfo = * ~ ()
type AttrAllowedOps DocumentLinearizedPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getDocumentLinearized :: (MonadIO m, DocumentK o) => o -> m Bool Source

Metadata

data DocumentMetadataPropertyInfo Source

Instances

AttrInfo DocumentMetadataPropertyInfo
type AttrLabel DocumentMetadataPropertyInfo = "Document::metadata"
type AttrGetType DocumentMetadataPropertyInfo = Text
type AttrBaseTypeConstraint DocumentMetadataPropertyInfo = DocumentK
type AttrSetTypeConstraint DocumentMetadataPropertyInfo = * ~ ()
type AttrAllowedOps DocumentMetadataPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getDocumentMetadata :: (MonadIO m, DocumentK o) => o -> m Text Source

ModDate

data DocumentModDatePropertyInfo Source

Instances

AttrInfo DocumentModDatePropertyInfo
type AttrLabel DocumentModDatePropertyInfo = "Document::mod-date"
type AttrGetType DocumentModDatePropertyInfo = Int32
type AttrBaseTypeConstraint DocumentModDatePropertyInfo = DocumentK
type AttrSetTypeConstraint DocumentModDatePropertyInfo = * ~ ()
type AttrAllowedOps DocumentModDatePropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getDocumentModDate :: (MonadIO m, DocumentK o) => o -> m Int32 Source

PageLayout

data DocumentPageLayoutPropertyInfo Source

Instances

AttrInfo DocumentPageLayoutPropertyInfo
type AttrLabel DocumentPageLayoutPropertyInfo = "Document::page-layout"
type AttrGetType DocumentPageLayoutPropertyInfo = PageLayout
type AttrBaseTypeConstraint DocumentPageLayoutPropertyInfo = DocumentK
type AttrSetTypeConstraint DocumentPageLayoutPropertyInfo = * ~ ()
type AttrAllowedOps DocumentPageLayoutPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getDocumentPageLayout :: (MonadIO m, DocumentK o) => o -> m PageLayout Source

PageMode

data DocumentPageModePropertyInfo Source

Instances

AttrInfo DocumentPageModePropertyInfo
type AttrLabel DocumentPageModePropertyInfo = "Document::page-mode"
type AttrGetType DocumentPageModePropertyInfo = PageMode
type AttrBaseTypeConstraint DocumentPageModePropertyInfo = DocumentK
type AttrSetTypeConstraint DocumentPageModePropertyInfo = * ~ ()
type AttrAllowedOps DocumentPageModePropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getDocumentPageMode :: (MonadIO m, DocumentK o) => o -> m PageMode Source

Permissions

data DocumentPermissionsPropertyInfo Source

Instances

AttrInfo DocumentPermissionsPropertyInfo
type AttrLabel DocumentPermissionsPropertyInfo = "Document::permissions"
type AttrGetType DocumentPermissionsPropertyInfo = [Permissions]
type AttrBaseTypeConstraint DocumentPermissionsPropertyInfo = DocumentK
type AttrSetTypeConstraint DocumentPermissionsPropertyInfo = * ~ ()
type AttrAllowedOps DocumentPermissionsPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getDocumentPermissions :: (MonadIO m, DocumentK o) => o -> m [Permissions] Source

Producer

data DocumentProducerPropertyInfo Source

Instances

AttrInfo DocumentProducerPropertyInfo
type AttrLabel DocumentProducerPropertyInfo = "Document::producer"
type AttrGetType DocumentProducerPropertyInfo = Text
type AttrBaseTypeConstraint DocumentProducerPropertyInfo = DocumentK
type AttrSetTypeConstraint DocumentProducerPropertyInfo = * ~ ()
type AttrAllowedOps DocumentProducerPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getDocumentProducer :: (MonadIO m, DocumentK o) => o -> m Text Source

Subject

data DocumentSubjectPropertyInfo Source

Instances

AttrInfo DocumentSubjectPropertyInfo
type AttrLabel DocumentSubjectPropertyInfo = "Document::subject"
type AttrGetType DocumentSubjectPropertyInfo = Text
type AttrBaseTypeConstraint DocumentSubjectPropertyInfo = DocumentK
type AttrSetTypeConstraint DocumentSubjectPropertyInfo = * ~ ()
type AttrAllowedOps DocumentSubjectPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getDocumentSubject :: (MonadIO m, DocumentK o) => o -> m Text Source

Title

data DocumentTitlePropertyInfo Source

Instances

AttrInfo DocumentTitlePropertyInfo
type AttrLabel DocumentTitlePropertyInfo = "Document::title"
type AttrGetType DocumentTitlePropertyInfo = Text
type AttrBaseTypeConstraint DocumentTitlePropertyInfo = DocumentK
type AttrSetTypeConstraint DocumentTitlePropertyInfo = * ~ ()
type AttrAllowedOps DocumentTitlePropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getDocumentTitle :: (MonadIO m, DocumentK o) => o -> m Text Source

ViewerPreferences

data DocumentViewerPreferencesPropertyInfo Source

Instances

AttrInfo DocumentViewerPreferencesPropertyInfo
type AttrLabel DocumentViewerPreferencesPropertyInfo = "Document::viewer-preferences"
type AttrGetType DocumentViewerPreferencesPropertyInfo = [ViewerPreferences]
type AttrBaseTypeConstraint DocumentViewerPreferencesPropertyInfo = DocumentK
type AttrSetTypeConstraint DocumentViewerPreferencesPropertyInfo = * ~ ()
type AttrAllowedOps DocumentViewerPreferencesPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getDocumentViewerPreferences :: (MonadIO m, DocumentK o) => o -> m [ViewerPreferences] Source