Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
Safe Haskell | None |
Language | Haskell2010 |
- Exported types
- Methods
- findDest
- getAttachments
- getAuthor
- getCreationDate
- getCreator
- getFormField
- getId
- getKeywords
- getMetadata
- getModificationDate
- getNAttachments
- getNPages
- getPage
- getPageByLabel
- getPageLayout
- getPageMode
- getPdfConformance
- getPdfPart
- getPdfSubtype
- getPdfSubtypeString
- getPdfVersion
- getPdfVersionString
- getPermissions
- getPrintScaling
- getProducer
- getSubject
- getTitle
- hasAttachments
- isLinearized
- newFromData
- newFromFile
- newFromGfile
- newFromStream
- save
- saveACopy
- setAuthor
- setCreationDate
- setCreator
- setKeywords
- setModificationDate
- setProducer
- setSubject
- setTitle
- Properties
No description available in the introspection data.
Synopsis
- newtype Document = Document (ManagedPtr Document)
- class (GObject o, IsDescendantOf Document o) => IsDocument o
- toDocument :: (MonadIO m, IsDocument o) => o -> m Document
- noDocument :: Maybe Document
- documentFindDest :: (HasCallStack, MonadIO m, IsDocument a) => a -> Text -> m Dest
- documentGetAttachments :: (HasCallStack, MonadIO m, IsDocument a) => a -> m [Attachment]
- documentGetAuthor :: (HasCallStack, MonadIO m, IsDocument a) => a -> m Text
- documentGetCreationDate :: (HasCallStack, MonadIO m, IsDocument a) => a -> m CLong
- documentGetCreator :: (HasCallStack, MonadIO m, IsDocument a) => a -> m Text
- documentGetFormField :: (HasCallStack, MonadIO m, IsDocument a) => a -> Int32 -> m FormField
- documentGetId :: (HasCallStack, MonadIO m, IsDocument a) => a -> m (Bool, Text, Text)
- documentGetKeywords :: (HasCallStack, MonadIO m, IsDocument a) => a -> m Text
- documentGetMetadata :: (HasCallStack, MonadIO m, IsDocument a) => a -> m Text
- documentGetModificationDate :: (HasCallStack, MonadIO m, IsDocument a) => a -> m CLong
- documentGetNAttachments :: (HasCallStack, MonadIO m, IsDocument a) => a -> m Word32
- documentGetNPages :: (HasCallStack, MonadIO m, IsDocument a) => a -> m Int32
- documentGetPage :: (HasCallStack, MonadIO m, IsDocument a) => a -> Int32 -> m Page
- documentGetPageByLabel :: (HasCallStack, MonadIO m, IsDocument a) => a -> Text -> m Page
- documentGetPageLayout :: (HasCallStack, MonadIO m, IsDocument a) => a -> m PageLayout
- documentGetPageMode :: (HasCallStack, MonadIO m, IsDocument a) => a -> m PageMode
- documentGetPdfConformance :: (HasCallStack, MonadIO m, IsDocument a) => a -> m PDFConformance
- documentGetPdfPart :: (HasCallStack, MonadIO m, IsDocument a) => a -> m PDFPart
- documentGetPdfSubtype :: (HasCallStack, MonadIO m, IsDocument a) => a -> m PDFSubtype
- documentGetPdfSubtypeString :: (HasCallStack, MonadIO m, IsDocument a) => a -> m (Maybe Text)
- documentGetPdfVersion :: (HasCallStack, MonadIO m, IsDocument a) => a -> m (Word32, Word32)
- documentGetPdfVersionString :: (HasCallStack, MonadIO m, IsDocument a) => a -> m Text
- documentGetPermissions :: (HasCallStack, MonadIO m, IsDocument a) => a -> m [Permissions]
- documentGetPrintScaling :: (HasCallStack, MonadIO m, IsDocument a) => a -> m PrintScaling
- documentGetProducer :: (HasCallStack, MonadIO m, IsDocument a) => a -> m Text
- documentGetSubject :: (HasCallStack, MonadIO m, IsDocument a) => a -> m Text
- documentGetTitle :: (HasCallStack, MonadIO m, IsDocument a) => a -> m Text
- documentHasAttachments :: (HasCallStack, MonadIO m, IsDocument a) => a -> m Bool
- documentIsLinearized :: (HasCallStack, MonadIO m, IsDocument a) => a -> m Bool
- documentNewFromData :: (HasCallStack, MonadIO m) => Text -> Int32 -> Maybe Text -> m Document
- documentNewFromFile :: (HasCallStack, MonadIO m) => Text -> Maybe Text -> m Document
- documentNewFromGfile :: (HasCallStack, MonadIO m, IsFile a, IsCancellable b) => a -> Maybe Text -> Maybe b -> m Document
- documentNewFromStream :: (HasCallStack, MonadIO m, IsInputStream a, IsCancellable b) => a -> Int64 -> Maybe Text -> Maybe b -> m Document
- documentSave :: (HasCallStack, MonadIO m, IsDocument a) => a -> Text -> m ()
- documentSaveACopy :: (HasCallStack, MonadIO m, IsDocument a) => a -> Text -> m ()
- documentSetAuthor :: (HasCallStack, MonadIO m, IsDocument a) => a -> Text -> m ()
- documentSetCreationDate :: (HasCallStack, MonadIO m, IsDocument a) => a -> CLong -> m ()
- documentSetCreator :: (HasCallStack, MonadIO m, IsDocument a) => a -> Text -> m ()
- documentSetKeywords :: (HasCallStack, MonadIO m, IsDocument a) => a -> Text -> m ()
- documentSetModificationDate :: (HasCallStack, MonadIO m, IsDocument a) => a -> CLong -> m ()
- documentSetProducer :: (HasCallStack, MonadIO m, IsDocument a) => a -> Text -> m ()
- documentSetSubject :: (HasCallStack, MonadIO m, IsDocument a) => a -> Text -> m ()
- documentSetTitle :: (HasCallStack, MonadIO m, IsDocument a) => a -> Text -> m ()
- constructDocumentAuthor :: IsDocument o => Text -> IO (GValueConstruct o)
- getDocumentAuthor :: (MonadIO m, IsDocument o) => o -> m (Maybe Text)
- setDocumentAuthor :: (MonadIO m, IsDocument o) => o -> Text -> m ()
- constructDocumentCreationDate :: IsDocument o => Int32 -> IO (GValueConstruct o)
- getDocumentCreationDate :: (MonadIO m, IsDocument o) => o -> m Int32
- setDocumentCreationDate :: (MonadIO m, IsDocument o) => o -> Int32 -> m ()
- constructDocumentCreator :: IsDocument o => Text -> IO (GValueConstruct o)
- getDocumentCreator :: (MonadIO m, IsDocument o) => o -> m (Maybe Text)
- setDocumentCreator :: (MonadIO m, IsDocument o) => o -> Text -> m ()
- getDocumentFormat :: (MonadIO m, IsDocument o) => o -> m (Maybe Text)
- getDocumentFormatMajor :: (MonadIO m, IsDocument o) => o -> m Word32
- getDocumentFormatMinor :: (MonadIO m, IsDocument o) => o -> m Word32
- constructDocumentKeywords :: IsDocument o => Text -> IO (GValueConstruct o)
- getDocumentKeywords :: (MonadIO m, IsDocument o) => o -> m (Maybe Text)
- setDocumentKeywords :: (MonadIO m, IsDocument o) => o -> Text -> m ()
- getDocumentLinearized :: (MonadIO m, IsDocument o) => o -> m Bool
- getDocumentMetadata :: (MonadIO m, IsDocument o) => o -> m (Maybe Text)
- constructDocumentModDate :: IsDocument o => Int32 -> IO (GValueConstruct o)
- getDocumentModDate :: (MonadIO m, IsDocument o) => o -> m Int32
- setDocumentModDate :: (MonadIO m, IsDocument o) => o -> Int32 -> m ()
- getDocumentPageLayout :: (MonadIO m, IsDocument o) => o -> m PageLayout
- getDocumentPageMode :: (MonadIO m, IsDocument o) => o -> m PageMode
- getDocumentPermissions :: (MonadIO m, IsDocument o) => o -> m [Permissions]
- getDocumentPrintScaling :: (MonadIO m, IsDocument o) => o -> m PrintScaling
- constructDocumentProducer :: IsDocument o => Text -> IO (GValueConstruct o)
- getDocumentProducer :: (MonadIO m, IsDocument o) => o -> m (Maybe Text)
- setDocumentProducer :: (MonadIO m, IsDocument o) => o -> Text -> m ()
- constructDocumentSubject :: IsDocument o => Text -> IO (GValueConstruct o)
- getDocumentSubject :: (MonadIO m, IsDocument o) => o -> m (Maybe Text)
- setDocumentSubject :: (MonadIO m, IsDocument o) => o -> Text -> m ()
- getDocumentSubtype :: (MonadIO m, IsDocument o) => o -> m PDFSubtype
- getDocumentSubtypeConformance :: (MonadIO m, IsDocument o) => o -> m PDFConformance
- getDocumentSubtypePart :: (MonadIO m, IsDocument o) => o -> m PDFPart
- getDocumentSubtypeString :: (MonadIO m, IsDocument o) => o -> m (Maybe Text)
- constructDocumentTitle :: IsDocument o => Text -> IO (GValueConstruct o)
- getDocumentTitle :: (MonadIO m, IsDocument o) => o -> m (Maybe Text)
- setDocumentTitle :: (MonadIO m, IsDocument o) => o -> Text -> m ()
- getDocumentViewerPreferences :: (MonadIO m, IsDocument o) => o -> m [ViewerPreferences]
Exported types
Memory-managed wrapper type.
Instances
GObject Document Source # | |
Defined in GI.Poppler.Objects.Document gobjectType :: IO GType # | |
HasParentTypes Document Source # | |
Defined in GI.Poppler.Objects.Document | |
type ParentTypes Document Source # | |
Defined in GI.Poppler.Objects.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
(GObject o, IsDescendantOf Document o) => IsDocument o Source # | |
Defined in GI.Poppler.Objects.Document |
toDocument :: (MonadIO m, IsDocument o) => o -> m Document Source #
Methods
findDest
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> Text |
|
-> m Dest | Returns: a new |
Creates a Dest
for the named destination linkName
in document
.
Note that named destinations are bytestrings, not string. That means that
unless linkName
was returned by a poppler function (e.g. is
Dest
.named_dest
), it needs to be converted to string
using namedDestFromBytestring
before being passed to this
function.
The returned value must be freed with destFree
.
getAttachments
documentGetAttachments Source #
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m [Attachment] | Returns: a list of available attachments. |
Returns a List
containing Attachment
<!-- -->s. These attachments
are unowned, and must be unreffed, and the list must be freed with
g_list_free()
.
getAuthor
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m Text | Returns: a new allocated string containing the author
of |
Returns the author of the document
Since: 0.16
getCreationDate
documentGetCreationDate Source #
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m CLong | Returns: the date the document was created, or -1 |
Returns the date the document was created as seconds since the Epoch
Since: 0.16
getCreator
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m Text | Returns: a new allocated string containing the creator
of |
Returns the creator of the document. If the document was converted from another format, the creator is the name of the product that created the original document from which it was converted.
Since: 0.16
getFormField
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> Int32 |
|
-> m FormField |
Returns the FormField
for the given id
. It must be freed with
objectUnref
getId
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m (Bool, Text, Text) | Returns: |
Returns the PDF file identifier represented as two byte string arrays of size 32.
permanentId
is the permanent identifier that is built based on the file
contents at the time it was originally created, so that this identifer
never changes. updateId
is the update identifier that is built based on
the file contents at the time it was last updated.
Note that returned strings are not null-terminated, they have a fixed size of 32 bytes.
Since: 0.16
getKeywords
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m Text | Returns: a new allocated string containing keywords associated
to |
Returns the keywords associated to the document
Since: 0.16
getMetadata
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m Text | Returns: a new allocated string containing the XML
metadata, or |
Returns the XML metadata string of the document
Since: 0.16
getModificationDate
documentGetModificationDate Source #
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m CLong | Returns: the date the document was most recently modified, or -1 |
Returns the date the document was most recently modified as seconds since the Epoch
Since: 0.16
getNAttachments
documentGetNAttachments Source #
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m Word32 | Returns: Number of attachments |
Returns the number of attachments in a loaded document.
See also documentGetAttachments
Since: 0.18
getNPages
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m Int32 | Returns: Number of pages |
Returns the number of pages in a loaded document.
getPage
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> Int32 |
|
-> m Page | Returns: The |
Returns the Page
indexed at index
. This object is owned by the
caller.
getPageByLabel
documentGetPageByLabel Source #
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> Text |
|
-> m Page | Returns: The |
Returns the Page
reference by label
. This object is owned by the
caller. label
is a human-readable string representation of the page number,
and can be document specific. Typically, it is a value such as "iii" or "3".
By default, "1" refers to the first page.
getPageLayout
documentGetPageLayout Source #
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m PageLayout | Returns: a |
Returns the page layout that should be used when the document is opened
Since: 0.16
getPageMode
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m PageMode | Returns: a |
Returns a PageMode
representing how the document should
be initially displayed when opened.
Since: 0.16
getPdfConformance
documentGetPdfConformance Source #
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m PDFConformance | Returns: the document's subtype conformance level |
Returns the conformance level of the document
as PDFConformance
.
Since: 0.70
getPdfPart
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m PDFPart | Returns: the document's subtype part |
Returns the part of the conforming standard that the document
adheres to
as a PDFSubtype
.
Since: 0.70
getPdfSubtype
documentGetPdfSubtype Source #
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m PDFSubtype | Returns: the document's subtype |
Returns the subtype of document
as a PDFSubtype
.
Since: 0.70
getPdfSubtypeString
documentGetPdfSubtypeString Source #
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m (Maybe Text) | Returns: a newly allocated string containing
the PDF subtype version of |
Returns the PDF subtype version of document
as a string.
Since: 0.70
getPdfVersion
documentGetPdfVersion Source #
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m (Word32, Word32) |
No description available in the introspection data.
Since: 0.16
getPdfVersionString
documentGetPdfVersionString Source #
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m Text | Returns: a new allocated string containing the PDF version
of |
Returns the PDF version of document
as a string (e.g. PDF-1.6)
Since: 0.16
getPermissions
documentGetPermissions Source #
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m [Permissions] | Returns: a set of flags from |
Returns the flags specifying which operations are permitted when the document is opened.
Since: 0.16
getPrintScaling
documentGetPrintScaling Source #
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m PrintScaling | Returns: a |
Returns the print scaling value suggested by author of the document.
Since: 0.73
getProducer
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m Text | Returns: a new allocated string containing the producer
of |
Returns the producer of the document. If the document was converted from another format, the producer is the name of the product that converted it to PDF
Since: 0.16
getSubject
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m Text | Returns: a new allocated string containing the subject
of |
Returns the subject of the document
Since: 0.16
getTitle
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m Text | Returns: a new allocated string containing the title
of |
Returns the document's title
Since: 0.16
hasAttachments
documentHasAttachments Source #
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m Bool | Returns: |
Returns True
of document
has any attachments.
isLinearized
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m Bool |
Returns whether document
is linearized or not. Linearization of PDF
enables efficient incremental access of the PDF file in a network environment.
Since: 0.16
newFromData
newFromFile
newFromGfile
:: (HasCallStack, MonadIO m, IsFile a, IsCancellable b) | |
=> a |
|
-> Maybe Text |
|
-> Maybe b |
|
-> m Document |
Creates a new Document
reading the PDF contents from file
.
Possible errors include those in the POPPLER_ERROR
and G_FILE_ERROR
domains.
Since: 0.22
newFromStream
documentNewFromStream Source #
:: (HasCallStack, MonadIO m, IsInputStream a, IsCancellable b) | |
=> a |
|
-> Int64 |
|
-> Maybe Text |
|
-> Maybe b |
|
-> m Document |
Creates a new Document
reading the PDF contents from stream
.
Note that the given InputStream
must be seekable or IOErrorEnumNotSupported
will be returned.
Possible errors include those in the POPPLER_ERROR
and G_FILE_ERROR
domains.
Since: 0.22
save
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> Text |
|
-> m () | (Can throw |
Saves document
. Any change made in the document such as
form fields filled, annotations added or modified
will be saved.
If error
is set, False
will be returned. Possible errors
include those in the G_FILE_ERROR
domain.
saveACopy
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> Text |
|
-> m () | (Can throw |
Saves a copy of the original document
.
Any change made in the document such as
form fields filled by the user will not be saved.
If error
is set, False
will be returned. Possible errors
include those in the G_FILE_ERROR
domain.
setAuthor
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the document's author. If author
is Nothing
, Author
entry is removed from the document's Info dictionary.
Since: 0.46
setCreationDate
documentSetCreationDate Source #
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> CLong |
|
-> m () |
Sets the document's creation date. If creationDate
is -1, CreationDate
entry is removed from the document's Info dictionary.
Since: 0.46
setCreator
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the document's creator. If creator
is Nothing
, Creator
entry is removed from the document's Info dictionary.
Since: 0.46
setKeywords
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the document's keywords. If keywords
is Nothing
,
Keywords entry is removed from the document's Info dictionary.
Since: 0.46
setModificationDate
documentSetModificationDate Source #
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> CLong |
|
-> m () |
Sets the document's modification date. If modificationDate
is -1, ModDate
entry is removed from the document's Info dictionary.
Since: 0.46
setProducer
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the document's producer. If producer
is Nothing
,
Producer entry is removed from the document's Info dictionary.
Since: 0.46
setSubject
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the document's subject. If subject
is Nothing
, Subject
entry is removed from the document's Info dictionary.
Since: 0.46
setTitle
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the document's title. If title
is Nothing
, Title entry
is removed from the document's Info dictionary.
Since: 0.46
Properties
author
The author of the document
constructDocumentAuthor :: IsDocument o => Text -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “author
” property. This is rarely needed directly, but it is used by new
.
getDocumentAuthor :: (MonadIO m, IsDocument o) => o -> m (Maybe Text) Source #
Get the value of the “author
” property.
When overloading is enabled, this is equivalent to
get
document #author
setDocumentAuthor :: (MonadIO m, IsDocument o) => o -> Text -> m () Source #
Set the value of the “author
” property.
When overloading is enabled, this is equivalent to
set
document [ #author:=
value ]
creationDate
The date the document was created as seconds since the Epoch, or -1
constructDocumentCreationDate :: IsDocument o => Int32 -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “creation-date
” property. This is rarely needed directly, but it is used by new
.
getDocumentCreationDate :: (MonadIO m, IsDocument o) => o -> m Int32 Source #
Get the value of the “creation-date
” property.
When overloading is enabled, this is equivalent to
get
document #creationDate
setDocumentCreationDate :: (MonadIO m, IsDocument o) => o -> Int32 -> m () Source #
Set the value of the “creation-date
” property.
When overloading is enabled, this is equivalent to
set
document [ #creationDate:=
value ]
creator
The creator of the document. See also documentGetCreator
constructDocumentCreator :: IsDocument o => Text -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “creator
” property. This is rarely needed directly, but it is used by new
.
getDocumentCreator :: (MonadIO m, IsDocument o) => o -> m (Maybe Text) Source #
Get the value of the “creator
” property.
When overloading is enabled, this is equivalent to
get
document #creator
setDocumentCreator :: (MonadIO m, IsDocument o) => o -> Text -> m () Source #
Set the value of the “creator
” property.
When overloading is enabled, this is equivalent to
set
document [ #creator:=
value ]
format
The PDF version as string. See also documentGetPdfVersionString
getDocumentFormat :: (MonadIO m, IsDocument o) => o -> m (Maybe Text) Source #
Get the value of the “format
” property.
When overloading is enabled, this is equivalent to
get
document #format
formatMajor
The PDF major version number. See also documentGetPdfVersion
getDocumentFormatMajor :: (MonadIO m, IsDocument o) => o -> m Word32 Source #
Get the value of the “format-major
” property.
When overloading is enabled, this is equivalent to
get
document #formatMajor
formatMinor
The PDF minor version number. See also documentGetPdfVersion
getDocumentFormatMinor :: (MonadIO m, IsDocument o) => o -> m Word32 Source #
Get the value of the “format-minor
” property.
When overloading is enabled, this is equivalent to
get
document #formatMinor
keywords
The keywords associated to the document
constructDocumentKeywords :: IsDocument o => Text -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “keywords
” property. This is rarely needed directly, but it is used by new
.
getDocumentKeywords :: (MonadIO m, IsDocument o) => o -> m (Maybe Text) Source #
Get the value of the “keywords
” property.
When overloading is enabled, this is equivalent to
get
document #keywords
setDocumentKeywords :: (MonadIO m, IsDocument o) => o -> Text -> m () Source #
Set the value of the “keywords
” property.
When overloading is enabled, this is equivalent to
set
document [ #keywords:=
value ]
linearized
Whether document is linearized. See also documentIsLinearized
getDocumentLinearized :: (MonadIO m, IsDocument o) => o -> m Bool Source #
Get the value of the “linearized
” property.
When overloading is enabled, this is equivalent to
get
document #linearized
metadata
Document metadata in XML format, or Nothing
getDocumentMetadata :: (MonadIO m, IsDocument o) => o -> m (Maybe Text) Source #
Get the value of the “metadata
” property.
When overloading is enabled, this is equivalent to
get
document #metadata
modDate
The date the document was most recently modified as seconds since the Epoch, or -1
constructDocumentModDate :: IsDocument o => Int32 -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “mod-date
” property. This is rarely needed directly, but it is used by new
.
getDocumentModDate :: (MonadIO m, IsDocument o) => o -> m Int32 Source #
Get the value of the “mod-date
” property.
When overloading is enabled, this is equivalent to
get
document #modDate
setDocumentModDate :: (MonadIO m, IsDocument o) => o -> Int32 -> m () Source #
Set the value of the “mod-date
” property.
When overloading is enabled, this is equivalent to
set
document [ #modDate:=
value ]
pageLayout
The page layout that should be used when the document is opened
getDocumentPageLayout :: (MonadIO m, IsDocument o) => o -> m PageLayout Source #
Get the value of the “page-layout
” property.
When overloading is enabled, this is equivalent to
get
document #pageLayout
pageMode
The mode that should be used when the document is opened
getDocumentPageMode :: (MonadIO m, IsDocument o) => o -> m PageMode Source #
Get the value of the “page-mode
” property.
When overloading is enabled, this is equivalent to
get
document #pageMode
permissions
Flags specifying which operations are permitted when the document is opened
getDocumentPermissions :: (MonadIO m, IsDocument o) => o -> m [Permissions] Source #
Get the value of the “permissions
” property.
When overloading is enabled, this is equivalent to
get
document #permissions
printScaling
No description available in the introspection data.
Since: 0.73
getDocumentPrintScaling :: (MonadIO m, IsDocument o) => o -> m PrintScaling Source #
Get the value of the “print-scaling
” property.
When overloading is enabled, this is equivalent to
get
document #printScaling
producer
The producer of the document. See also documentGetProducer
constructDocumentProducer :: IsDocument o => Text -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “producer
” property. This is rarely needed directly, but it is used by new
.
getDocumentProducer :: (MonadIO m, IsDocument o) => o -> m (Maybe Text) Source #
Get the value of the “producer
” property.
When overloading is enabled, this is equivalent to
get
document #producer
setDocumentProducer :: (MonadIO m, IsDocument o) => o -> Text -> m () Source #
Set the value of the “producer
” property.
When overloading is enabled, this is equivalent to
set
document [ #producer:=
value ]
subject
The subject of the document
constructDocumentSubject :: IsDocument o => Text -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “subject
” property. This is rarely needed directly, but it is used by new
.
getDocumentSubject :: (MonadIO m, IsDocument o) => o -> m (Maybe Text) Source #
Get the value of the “subject
” property.
When overloading is enabled, this is equivalent to
get
document #subject
setDocumentSubject :: (MonadIO m, IsDocument o) => o -> Text -> m () Source #
Set the value of the “subject
” property.
When overloading is enabled, this is equivalent to
set
document [ #subject:=
value ]
subtype
Document PDF subtype type
getDocumentSubtype :: (MonadIO m, IsDocument o) => o -> m PDFSubtype Source #
Get the value of the “subtype
” property.
When overloading is enabled, this is equivalent to
get
document #subtype
subtypeConformance
Document PDF subtype conformance
getDocumentSubtypeConformance :: (MonadIO m, IsDocument o) => o -> m PDFConformance Source #
Get the value of the “subtype-conformance
” property.
When overloading is enabled, this is equivalent to
get
document #subtypeConformance
subtypePart
Document PDF subtype part
getDocumentSubtypePart :: (MonadIO m, IsDocument o) => o -> m PDFPart Source #
Get the value of the “subtype-part
” property.
When overloading is enabled, this is equivalent to
get
document #subtypePart
subtypeString
Document PDF subtype. See also documentGetPdfSubtypeString
getDocumentSubtypeString :: (MonadIO m, IsDocument o) => o -> m (Maybe Text) Source #
Get the value of the “subtype-string
” property.
When overloading is enabled, this is equivalent to
get
document #subtypeString
title
The document's title or Nothing
constructDocumentTitle :: IsDocument o => Text -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “title
” property. This is rarely needed directly, but it is used by new
.
getDocumentTitle :: (MonadIO m, IsDocument o) => o -> m (Maybe Text) Source #
Get the value of the “title
” property.
When overloading is enabled, this is equivalent to
get
document #title
setDocumentTitle :: (MonadIO m, IsDocument o) => o -> Text -> m () Source #
Set the value of the “title
” property.
When overloading is enabled, this is equivalent to
set
document [ #title:=
value ]
viewerPreferences
No description available in the introspection data.
getDocumentViewerPreferences :: (MonadIO m, IsDocument o) => o -> m [ViewerPreferences] Source #
Get the value of the “viewer-preferences
” property.
When overloading is enabled, this is equivalent to
get
document #viewerPreferences