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
- addAnnot
- findText
- findTextWithOptions
- freeAnnotMapping
- freeFormFieldMapping
- freeImageMapping
- freeLinkMapping
- freeTextAttributes
- getAnnotMapping
- getCropBox
- getDuration
- getFormFieldMapping
- getImage
- getImageMapping
- getIndex
- getLabel
- getLinkMapping
- getSelectedRegion
- getSelectedText
- getSelectionRegion
- getSize
- getText
- getTextAttributes
- getTextAttributesForArea
- getTextForArea
- getTextLayout
- getTextLayoutForArea
- getThumbnail
- getThumbnailSize
- getTransition
- removeAnnot
- render
- renderForPrinting
- renderForPrintingWithOptions
- renderSelection
- renderToPs
- selectionRegionFree
- Properties
No description available in the introspection data.
Synopsis
- newtype Page = Page (ManagedPtr Page)
- class (GObject o, IsDescendantOf Page o) => IsPage o
- toPage :: (MonadIO m, IsPage o) => o -> m Page
- noPage :: Maybe Page
- pageAddAnnot :: (HasCallStack, MonadIO m, IsPage a, IsAnnot b) => a -> b -> m ()
- pageFindText :: (HasCallStack, MonadIO m, IsPage a) => a -> Text -> m [Rectangle]
- pageFindTextWithOptions :: (HasCallStack, MonadIO m, IsPage a) => a -> Text -> [FindFlags] -> m [Rectangle]
- pageFreeAnnotMapping :: (HasCallStack, MonadIO m) => [AnnotMapping] -> m ()
- pageFreeFormFieldMapping :: (HasCallStack, MonadIO m) => [FormFieldMapping] -> m ()
- pageFreeImageMapping :: (HasCallStack, MonadIO m) => [ImageMapping] -> m ()
- pageFreeLinkMapping :: (HasCallStack, MonadIO m) => [LinkMapping] -> m ()
- pageFreeTextAttributes :: (HasCallStack, MonadIO m) => [TextAttributes] -> m ()
- pageGetAnnotMapping :: (HasCallStack, MonadIO m, IsPage a) => a -> m [AnnotMapping]
- pageGetCropBox :: (HasCallStack, MonadIO m, IsPage a) => a -> m Rectangle
- pageGetDuration :: (HasCallStack, MonadIO m, IsPage a) => a -> m Double
- pageGetFormFieldMapping :: (HasCallStack, MonadIO m, IsPage a) => a -> m [FormFieldMapping]
- pageGetImage :: (HasCallStack, MonadIO m, IsPage a) => a -> Int32 -> m Surface
- pageGetImageMapping :: (HasCallStack, MonadIO m, IsPage a) => a -> m [ImageMapping]
- pageGetIndex :: (HasCallStack, MonadIO m, IsPage a) => a -> m Int32
- pageGetLabel :: (HasCallStack, MonadIO m, IsPage a) => a -> m Text
- pageGetLinkMapping :: (HasCallStack, MonadIO m, IsPage a) => a -> m [LinkMapping]
- pageGetSelectedRegion :: (HasCallStack, MonadIO m, IsPage a) => a -> Double -> SelectionStyle -> Rectangle -> m Region
- pageGetSelectedText :: (HasCallStack, MonadIO m, IsPage a) => a -> SelectionStyle -> Rectangle -> m Text
- pageGetSelectionRegion :: (HasCallStack, MonadIO m, IsPage a) => a -> Double -> SelectionStyle -> Rectangle -> m [Rectangle]
- pageGetSize :: (HasCallStack, MonadIO m, IsPage a) => a -> m (Double, Double)
- pageGetText :: (HasCallStack, MonadIO m, IsPage a) => a -> m Text
- pageGetTextAttributes :: (HasCallStack, MonadIO m, IsPage a) => a -> m [TextAttributes]
- pageGetTextAttributesForArea :: (HasCallStack, MonadIO m, IsPage a) => a -> Rectangle -> m [TextAttributes]
- pageGetTextForArea :: (HasCallStack, MonadIO m, IsPage a) => a -> Rectangle -> m Text
- pageGetTextLayout :: (HasCallStack, MonadIO m, IsPage a) => a -> m (Bool, [Rectangle])
- pageGetTextLayoutForArea :: (HasCallStack, MonadIO m, IsPage a) => a -> Rectangle -> m (Bool, [Rectangle])
- pageGetThumbnail :: (HasCallStack, MonadIO m, IsPage a) => a -> m Surface
- pageGetThumbnailSize :: (HasCallStack, MonadIO m, IsPage a) => a -> m (Bool, Int32, Int32)
- pageGetTransition :: (HasCallStack, MonadIO m, IsPage a) => a -> m PageTransition
- pageRemoveAnnot :: (HasCallStack, MonadIO m, IsPage a, IsAnnot b) => a -> b -> m ()
- pageRender :: (HasCallStack, MonadIO m, IsPage a) => a -> Context -> m ()
- pageRenderForPrinting :: (HasCallStack, MonadIO m, IsPage a) => a -> Context -> m ()
- pageRenderForPrintingWithOptions :: (HasCallStack, MonadIO m, IsPage a) => a -> Context -> [PrintFlags] -> m ()
- pageRenderSelection :: (HasCallStack, MonadIO m, IsPage a) => a -> Context -> Rectangle -> Rectangle -> SelectionStyle -> Color -> Color -> m ()
- pageRenderToPs :: (HasCallStack, MonadIO m, IsPage a, IsPSFile b) => a -> b -> m ()
- pageSelectionRegionFree :: (HasCallStack, MonadIO m) => [Rectangle] -> m ()
- getPageLabel :: (MonadIO m, IsPage o) => o -> m (Maybe Text)
Exported types
Memory-managed wrapper type.
Instances
GObject Page Source # | |
Defined in GI.Poppler.Objects.Page gobjectType :: IO GType | |
HasParentTypes Page Source # | |
Defined in GI.Poppler.Objects.Page | |
type ParentTypes Page Source # | |
Defined in GI.Poppler.Objects.Page |
class (GObject o, IsDescendantOf Page o) => IsPage o Source #
Instances
(GObject o, IsDescendantOf Page o) => IsPage o Source # | |
Defined in GI.Poppler.Objects.Page |
Methods
addAnnot
:: (HasCallStack, MonadIO m, IsPage a, IsAnnot b) | |
=> a |
|
-> b |
|
-> m () |
Adds annotation annot
to page
.
Since: 0.16
findText
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> Text |
|
-> m [Rectangle] |
Finds text
in page
with the default options (FindFlagsDefault
) and
returns a List
of rectangles for each occurrence of the text on the page.
The coordinates are in PDF points.
findTextWithOptions
freeAnnotMapping
:: (HasCallStack, MonadIO m) | |
=> [AnnotMapping] |
|
-> m () |
Frees a list of AnnotMapping
<!-- -->s allocated by
pageGetAnnotMapping
. It also unreferences the Annot
<!-- -->s
that each mapping contains, so if you want to keep them around, you need to
reference them with objectRef
.
freeFormFieldMapping
pageFreeFormFieldMapping Source #
:: (HasCallStack, MonadIO m) | |
=> [FormFieldMapping] |
|
-> m () |
Frees a list of FormFieldMapping
<!-- -->s allocated by
pageGetFormFieldMapping
.
freeImageMapping
:: (HasCallStack, MonadIO m) | |
=> [ImageMapping] |
|
-> m () |
Frees a list of ImageMapping
<!-- -->s allocated by
pageGetImageMapping
.
freeLinkMapping
:: (HasCallStack, MonadIO m) | |
=> [LinkMapping] |
|
-> m () |
Frees a list of LinkMapping
<!-- -->s allocated by
pageGetLinkMapping
. It also frees the Action
<!-- -->s
that each mapping contains, so if you want to keep them around, you need to
copy them with actionCopy
.
freeTextAttributes
pageFreeTextAttributes Source #
:: (HasCallStack, MonadIO m) | |
=> [TextAttributes] |
|
-> m () |
Frees a list of TextAttributes
<!-- -->s allocated by
pageGetTextAttributes
.
Since: 0.18
getAnnotMapping
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> m [AnnotMapping] | Returns: A |
Returns a list of AnnotMapping
items that map from a location on
page
to a Annot
. This list must be freed with
pageFreeAnnotMapping
when done.
getCropBox
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> m Rectangle |
Retrurns the crop box of page
getDuration
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> m Double | Returns: duration in seconds of |
Returns the duration of page
getFormFieldMapping
pageGetFormFieldMapping Source #
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> m [FormFieldMapping] | Returns: A |
Returns a list of FormFieldMapping
items that map from a
location on page
to a form field. This list must be freed
with pageFreeFormFieldMapping
when done.
getImage
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> Int32 |
|
-> m Surface | Returns: A cairo surface for the image |
Returns a cairo surface for the image of the page
getImageMapping
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> m [ImageMapping] | Returns: A |
Returns a list of ImageMapping
items that map from a
location on page
to an image of the page. This list must be freed
with pageFreeImageMapping
when done.
getIndex
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> m Int32 | Returns: index value of |
Returns the index of page
getLabel
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> m Text | Returns: a new allocated string containing the label of |
Returns the label of page
. Note that page labels
and page indices might not coincide.
Since: 0.16
getLinkMapping
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> m [LinkMapping] | Returns: A |
Returns a list of LinkMapping
items that map from a
location on page
to a Action
. This list must be freed
with pageFreeLinkMapping
when done.
getSelectedRegion
pageGetSelectedRegion Source #
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> Double |
|
-> SelectionStyle |
|
-> Rectangle |
|
-> m Region | Returns: a cairo_region_t |
Returns a region containing the area that would be rendered by
pageRenderSelection
.
The returned region must be freed with cairo_region_destroy()
Since: 0.16
getSelectedText
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> SelectionStyle |
|
-> Rectangle |
|
-> m Text | Returns: a pointer to the contents of the |
Retrieves the contents of the specified selection
as text.
Since: 0.16
getSelectionRegion
pageGetSelectionRegion Source #
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> Double |
|
-> SelectionStyle |
|
-> Rectangle |
|
-> m [Rectangle] |
Deprecated: (Since version 0.16)Use pageGetSelectedRegion
instead.
Returns a region containing the area that would be rendered by
pageRenderSelection
as a List
of
Rectangle
. The returned list must be freed with
pageSelectionRegionFree
.
getSize
Gets the size of page
at the current scale and rotation.
getText
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> m Text | Returns: a pointer to the text of the |
Retrieves the text of page
.
Since: 0.16
getTextAttributes
pageGetTextAttributes Source #
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> m [TextAttributes] | Returns: A |
Obtains the attributes of the text as a List
of TextAttributes
.
This list must be freed with pageFreeTextAttributes
when done.
Each list element is a TextAttributes
struct where start_index and
end_index indicates the range of text (as returned by pageGetText
)
to which text attributes apply.
See also pageGetTextAttributesForArea
Since: 0.18
getTextAttributesForArea
pageGetTextAttributesForArea Source #
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> Rectangle |
|
-> m [TextAttributes] | Returns: A |
Obtains the attributes of the text in area
as a List
of TextAttributes
.
This list must be freed with pageFreeTextAttributes
when done.
Each list element is a TextAttributes
struct where start_index and
end_index indicates the range of text (as returned by pageGetTextForArea
)
to which text attributes apply.
Since: 0.26
getTextForArea
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> Rectangle |
|
-> m Text | Returns: a pointer to the text as a string |
Retrieves the text of page
contained in area
.
Since: 0.26
getTextLayout
Obtains the layout of the text as a list of Rectangle
This array must be freed with free
when done.
The position in the array represents an offset in the text returned by
pageGetText
See also pageGetTextLayoutForArea
.
Since: 0.16
getTextLayoutForArea
pageGetTextLayoutForArea Source #
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> Rectangle |
|
-> m (Bool, [Rectangle]) |
Obtains the layout of the text contained in area
as a list of Rectangle
This array must be freed with free
when done.
The position in the array represents an offset in the text returned by
pageGetTextForArea
Since: 0.26
getThumbnail
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> m Surface | Returns: the tumbnail as a cairo_surface_t or |
Get the embedded thumbnail for the specified page. If the document
doesn't have an embedded thumbnail for the page, this function
returns Nothing
.
getThumbnailSize
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> m (Bool, Int32, Int32) | Returns: |
Returns True
if page
has a thumbnail associated with it. It also
fills in width
and height
with the width and height of the
thumbnail. The values of width and height are not changed if no
appropriate thumbnail exists.
getTransition
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> m PageTransition | Returns: a |
Returns the transition effect of page
removeAnnot
:: (HasCallStack, MonadIO m, IsPage a, IsAnnot b) | |
=> a |
|
-> b |
|
-> m () |
Removes annotation annot
from page
Since: 0.22
render
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> Context |
|
-> m () |
Render the page to the given cairo context. This function
is for rendering a page that will be displayed. If you want
to render a page that will be printed use
pageRenderForPrinting
instead
renderForPrinting
pageRenderForPrinting Source #
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> Context |
|
-> m () |
Render the page to the given cairo context for printing.
renderForPrintingWithOptions
pageRenderForPrintingWithOptions Source #
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> Context |
|
-> [PrintFlags] |
|
-> m () |
Render the page to the given cairo context for printing with the specified options
Since: 0.16
renderSelection
:: (HasCallStack, MonadIO m, IsPage a) | |
=> a |
|
-> Context |
|
-> Rectangle |
|
-> Rectangle |
|
-> SelectionStyle |
|
-> Color |
|
-> Color |
|
-> m () |
Render the selection specified by selection
for page
to
the given cairo context. The selection will be rendered, using
glyphColor
for the glyphs and backgroundColor
for the selection
background.
If non-NULL, oldSelection
specifies the selection that is already
rendered to cairo
, in which case this function will (some day)
only render the changed part of the selection.
renderToPs
:: (HasCallStack, MonadIO m, IsPage a, IsPSFile b) | |
=> a |
|
-> b |
|
-> m () |
Render the page on a postscript file
selectionRegionFree
pageSelectionRegionFree Source #
:: (HasCallStack, MonadIO m) | |
=> [Rectangle] | |
-> m () |
Deprecated: (Since version 0.16)
Frees region
Properties
label
The label of the page or Nothing
. See also pageGetLabel
getPageLabel :: (MonadIO m, IsPage o) => o -> m (Maybe Text) Source #
Get the value of the “label
” property.
When overloading is enabled, this is equivalent to
get
page #label