Graphics.UI.Gtk.Poppler.Document

Details

The Document is an object used to refer to a main document.

Types

data Document

Instances

Eq Document

Ord Document

GObjectClass Document

DocumentClass Document

class GObjectClass o => DocumentClass o

Instances

DocumentClass Document

data Page

Instances

Eq Page

Ord Page

GObjectClass Page

PageClass Page

class GObjectClass o => PageClass o

Instances

PageClass Page

data IndexIter

data FontsIter

Instances

Eq FontsIter

Ord FontsIter

GObjectClass FontsIter

FontsIterClass FontsIter

class GObjectClass o => FontsIterClass o

Instances

FontsIterClass FontsIter

data FontInfo

Instances

Eq FontInfo

Ord FontInfo

GObjectClass FontInfo

FontInfoClass FontInfo

class GObjectClass o => FontInfoClass o

Instances

FontInfoClass FontInfo

data Dest

data FormField

Instances

Eq FormField

Ord FormField

GObjectClass FormField

FormFieldClass FormField

data Action

data PSFile

Instances

Eq PSFile

Ord PSFile

GObjectClass PSFile

PSFileClass PSFile

class GObjectClass o => PSFileClass o

Instances

PSFileClass PSFile

Enums

data FontType

Constructors

FontTypeUnknown

FontTypeType1

FontTypeType1c

FontTypeType1cot

FontTypeType3

FontTypeTruetype

FontTypeTruetypeot

FontTypeCidType0

FontTypeCidType0c

FontTypeCidType0cot

FontTypeCidType2

FontTypeCidType2ot

Instances

Bounded FontType

Enum FontType

Eq FontType

Ord FontType

Show FontType

Typeable FontType

data PageLayout

Constructors

PageLayoutUnset

PageLayoutSinglePage

PageLayoutOneColumn

PageLayoutTwoColumnLeft

PageLayoutTwoColumnRight

PageLayoutTwoPageLeft

PageLayoutTwoPageRight

Instances

Bounded PageLayout

Enum PageLayout

Eq PageLayout

Ord PageLayout

Show PageLayout

Typeable PageLayout

data PageMode

Constructors

PageModeUnset

PageModeNone

PageModeUseOutlines

PageModeUseThumbs

PageModeFullScreen

PageModeUseOc

PageModeUseAttachments

Instances

Bounded PageMode

Enum PageMode

Eq PageMode

Ord PageMode

Show PageMode

Typeable PageMode

data Permissions

Constructors

PermissionsOkToPrint

PermissionsOkToModify

PermissionsOkToCopy

PermissionsOkToAddNotes

PermissionsOkToFillForm

PermissionsOkToExtractContents

PermissionsOkToAssemble

PermissionsOkToPrintHighResolution

PermissionsFull

Instances

Bounded Permissions

Enum Permissions

Eq Permissions

Ord Permissions

Show Permissions

Typeable Permissions

data ViewerPreferences

Constructors

ViewerPreferencesUnset

ViewerPreferencesHideToolbar

ViewerPreferencesHideMenubar

ViewerPreferencesHideWindowui

ViewerPreferencesFitWindow

ViewerPreferencesCenterWindow

ViewerPreferencesDisplayDocTitle

ViewerPreferencesDirectionRtl

Instances

Bounded ViewerPreferences

Enum ViewerPreferences

Eq ViewerPreferences

Ord ViewerPreferences

Show ViewerPreferences

Typeable ViewerPreferences

Methods

documentNewFromFile

Arguments

:: String

uri uri of the file to load

-> Maybe String

password password to unlock the file with, or Nothing

-> IO (Maybe Document)

returns A newly created Document, or Nothing

Creates a new Document. If Nothing is returned, then error will be set. Possible errors include those in the Error and GFileError domains.

documentNewFromData

Arguments

:: String

data the pdf data contained in a char array

-> Maybe String

password password to unlock the file with, or Nothing

-> IO (Maybe Document)

returns A newly created Document, or Nothing

Creates a new Document. If Nothing is returned, then error will be set. Possible errors include those in the Error and GFileError domains.

documentSave

Arguments

:: DocumentClass doc

=> doc

-> String

uri uri of file to save

-> IO Bool

returns True, if the document was successfully saved

Saves document. Any change made in the document such as form fields filled by the user will be saved. If error is set, False will be returned. Possible errors include those in the GFileError domain.

documentGetNPages

Arguments

:: DocumentClass doc

=> doc

-> IO Int

returns Number of pages

Returns the number of pages in a loaded document.

documentGetPage

Arguments

:: DocumentClass doc

=> doc

-> Int

index a page index

-> IO Page

returns The Page at index

Returns the Page indexed at index. This object is owned by the caller. | Pages are indexed starting at 0.

documentGetPageByLabel

Arguments

:: DocumentClass doc

=> doc

-> String

label a page label

-> IO Page

returns The Page referenced by label

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.

documentFindDest

Arguments

:: DocumentClass doc

=> doc

-> String

linkName a named destination

-> IO (Maybe Dest)

returns The Dest destination or Nothing if linkName is not a destination.

Finds named destination linkName in document

documentHasAttachments

Arguments

:: DocumentClass doc

=> doc

-> IO Bool

returns True, if document has attachments.

Returns True of document has any attachments.

documentGetAttachments :: DocumentClass doc => doc -> IO [Attachment]

Returns a GList containing Attachments.

documentGetFormField

Arguments

:: DocumentClass doc

=> doc

-> Int

id an id of a FormField

-> IO (Maybe FormField)

Returns the FormField for the given id.

indexIterNew :: DocumentClass doc => doc -> IO (Maybe IndexIter)

Returns the root IndexIter for document, or Nothing.

indexIterCopy :: IndexIter -> IO IndexIter

Creates a new IndexIter as a copy of iter.

indexIterGetChild :: IndexIter -> IO (Maybe IndexIter)

Returns a newly created child of parent, or Nothing if the iter has no child. See indexIterNew for more information on this function.

indexIterIsOpen

Arguments

:: IndexIter

-> IO Bool

returns True, if the document wants iter to be expanded

Returns whether this node should be expanded by default to the user. The document can provide a hint as to how the document's index should be expanded initially.

indexIterNext

Arguments

:: IndexIter

-> IO Bool

returns True, if iter was set to the next action

Sets iter to point to the next action at the current level, if valid. See indexIterNew for more information.

indexIterGetAction :: IndexIter -> IO Action

Returns the Action associated with iter.

fontInfoNew :: DocumentClass doc => doc -> IO FontInfo

fontsIterCopy :: FontsIterClass iter => iter -> IO FontsIter

fontsIterGetName :: FontsIterClass iter => iter -> IO String

fontsIterGetFullName :: FontsIterClass iter => iter -> IO String

fontsIterGetFontType :: FontsIterClass iter => iter -> IO FontType

fontsIterIsEmbedded :: FontsIterClass iter => iter -> IO Bool

fontsIterIsSubset :: FontsIterClass iter => iter -> IO Bool

fontsIterNext

Arguments

:: FontsIterClass iter

=> iter

-> IO Bool

returns True, if iter was set to the next action

psFileNew

Arguments

:: DocumentClass doc

=> doc

-> String

filename the path of the output filename

-> Int

firstPage the first page to print

-> Int

nPages the number of pages to print

-> IO PSFile

Create a new postscript file to render to

psFileSetPaperSize

Arguments

:: PSFileClass file

=> file

psFile a PSFile which was not yet printed to.

-> Double

width the paper width in 1/72 inch

-> Double

height the paper height in 1/72 inch

-> IO ()

Set the output paper size. These values will end up in the DocumentMedia, the BoundingBox DSC comments and other places in the generated PostScript.

psFileSetDuplex

Arguments

:: PSFileClass file

=> file

psFile a PSFile which was not yet printed to

-> Bool

duplex whether to force duplex printing (on printers which support this)

-> IO ()

Enable or disable Duplex printing.

Attributes

documentAuthor :: DocumentClass doc => ReadAttr doc String

The author of the document.

Default value: ""

documentCreationDate :: DocumentClass doc => ReadAttr doc Int

The date and time the document was created.

Allowed values: >= 0

Default value: 0

documentCreator :: DocumentClass doc => ReadAttr doc String

The software that created the document.

Default value: ""

documentFormat :: DocumentClass doc => ReadAttr doc String

The PDF version of the document.

Default value: ""

documentFormatMajor :: DocumentClass doc => ReadAttr doc String

The PDF major version number of the document.

Default value: 1

documentFormatMinor :: DocumentClass doc => ReadAttr doc String

The PDF minor version number of the document.

Default value: 0

documentKeywords :: DocumentClass doc => ReadAttr doc String

Keywords.

Default value: ""

documentLinearized :: DocumentClass doc => ReadAttr doc String

Is the document optimized for web viewing?.

Default value: ""

documentMetadata :: DocumentClass doc => ReadAttr doc String

Embedded XML metadata.

Default value: ""

documentModDate :: DocumentClass doc => ReadAttr doc Int

The date and time the document was modified.

Allowed values: >= 0

Default value: 0

documentPageLayout :: DocumentClass doc => ReadAttr doc PageLayout

Initial Page Layout.

Default value: PageLayoutUnset

documentPageMode :: DocumentClass doc => ReadAttr doc PageMode

Page Mode.

Default value: PageModeUnset

documentPermissions :: DocumentClass doc => ReadAttr doc Permissions

Permissions.

Default value: PermissionsFull

documentProducer :: DocumentClass doc => ReadAttr doc String

The software that converted the document.

Default value: ""

documentSubject :: DocumentClass doc => ReadAttr doc String

Subjects the document touches.

Default value: ""

documentTitle :: DocumentClass doc => ReadAttr doc String

The title of the document.

Default value: ""

documentViewerPreferences :: DocumentClass doc => ReadAttr doc ViewerPreferences

Viewer Preferences.

documentLabel :: DocumentClass doc => ReadAttr doc String

The label of the page.

Default value: ""