GI.Poppler.Objects.Page

No description available in the introspection data.

Exported types

newtype Page

Memory-managed wrapper type.

Constructors

Page (ManagedPtr Page)

Instances

Eq Page

Defined in GI.Poppler.Objects.Page

Methods

(==) :: Page -> Page -> Bool

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

GObject Page

Defined in GI.Poppler.Objects.Page

ManagedPtrNewtype Page

Defined in GI.Poppler.Objects.Page

Methods

toManagedPtr :: Page -> ManagedPtr Page

TypedObject Page

Defined in GI.Poppler.Objects.Page

Methods

glibType :: IO GType

HasParentTypes Page

Defined in GI.Poppler.Objects.Page

IsGValue (Maybe Page)

Convert Page to and from GValue. See toGValue and fromGValue.

Defined in GI.Poppler.Objects.Page

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Page -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Page)

type ParentTypes Page

Defined in GI.Poppler.Objects.Page

type ParentTypes Page = '[Object]

class (GObject o, IsDescendantOf Page o) => IsPage o

Type class for types which can be safely cast to Page, for instance with toPage.

Instances

(GObject o, IsDescendantOf Page o) => IsPage o

Defined in GI.Poppler.Objects.Page

toPage :: (MonadIO m, IsPage o) => o -> m Page

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

Methods

Click to display all available methods, including inherited ones

Methods

addAnnot, bindProperty, bindPropertyFull, findText, findTextWithOptions, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, removeAnnot, render, renderForPrinting, renderForPrintingWithOptions, renderSelection, renderToPs, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getAnnotMapping, getBoundingBox, getCropBox, getData, getDuration, getFormFieldMapping, getImage, getImageMapping, getIndex, getLabel, getLinkMapping, getProperty, getQdata, getSelectedRegion, getSelectedText, getSelectionRegion, getSize, getText, getTextAttributes, getTextAttributesForArea, getTextForArea, getTextLayout, getTextLayoutForArea, getThumbnail, getThumbnailSize, getTransition.

Setters

setData, setDataFull, setProperty.

addAnnot

pageAddAnnot

Arguments

:: (HasCallStack, MonadIO m, IsPage a, IsAnnot b)

=> a

page: a Page

-> b

annot: a Annot to add

-> m ()

Adds annotation annot to page.

Since: 0.16

findText

pageFindText

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: a Page

-> Text

text: the text to search for (UTF-8 encoded)

-> m [Rectangle]

Returns: a List of 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

pageFindTextWithOptions

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: a Page

-> Text

text: the text to search for (UTF-8 encoded)

-> [FindFlags]

options: find options

-> m [Rectangle]

Returns: a newly allocated list of newly allocated Rectangle. Free with g_list_free_full() using rectangleFree.

Finds text in page with the given FindFlags options and returns a List of rectangles for each occurrence of the text on the page. The coordinates are in PDF points.

When FindFlagsMultiline is passed in options, matches may span more than one line. In this case, the returned list will contain one Rectangle for each part of a match. The function rectangleFindGetMatchContinued will return True for all rectangles belonging to the same match, except for the last one. If a hyphen was ignored at the end of the part of the match, rectangleFindGetIgnoredHyphen will return True for that rectangle.

Note that currently matches spanning more than two lines are not found. (This limitation may be lifted in a future version.)

Note also that currently finding multi-line matches backwards is not implemented; if you pass FindFlagsBackwards and FindFlagsMultiline together, FindFlagsMultiline will be ignored.

Since: 0.22

freeAnnotMapping

pageFreeAnnotMapping

Arguments

:: (HasCallStack, MonadIO m)

=> [AnnotMapping]

list: A list of AnnotMappings

-> m ()

Frees a list of AnnotMappings allocated by pageGetAnnotMapping. It also unreferences the Annots that each mapping contains, so if you want to keep them around, you need to reference them with objectRef.

freeFormFieldMapping

pageFreeFormFieldMapping

Arguments

:: (HasCallStack, MonadIO m)

=> [FormFieldMapping]

list: A list of FormFieldMappings

-> m ()

Frees a list of FormFieldMappings allocated by pageGetFormFieldMapping.

freeImageMapping

pageFreeImageMapping

Arguments

:: (HasCallStack, MonadIO m)

=> [ImageMapping]

list: A list of ImageMappings

-> m ()

Frees a list of ImageMappings allocated by pageGetImageMapping.

freeLinkMapping

pageFreeLinkMapping

Arguments

:: (HasCallStack, MonadIO m)

=> [LinkMapping]

list: A list of LinkMappings

-> m ()

Frees a list of LinkMappings allocated by pageGetLinkMapping. It also frees the Actions that each mapping contains, so if you want to keep them around, you need to copy them with actionCopy.

freeTextAttributes

pageFreeTextAttributes

Arguments

:: (HasCallStack, MonadIO m)

=> [TextAttributes]

list: A list of TextAttributess

-> m ()

Frees a list of TextAttributess allocated by pageGetTextAttributes.

Since: 0.18

getAnnotMapping

pageGetAnnotMapping

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: A Page

-> m [AnnotMapping]

Returns: A List of AnnotMapping

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.

getBoundingBox

pageGetBoundingBox :: (HasCallStack, MonadIO m, IsPage a) => a -> Rectangle -> m Bool

No description available in the introspection data.

getCropBox

pageGetCropBox

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: a Page

-> m Rectangle

Retrurns the crop box of page

getDuration

pageGetDuration

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: a Page

-> m Double

Returns: duration in seconds of page or -1.

Returns the duration of page

getFormFieldMapping

pageGetFormFieldMapping

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: A Page

-> m [FormFieldMapping]

Returns: A List of FormFieldMapping

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

pageGetImage

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: A Page

-> Int32

imageId: The image identifier

-> m Surface

Returns: A cairo surface for the image

Returns a cairo surface for the image of the page

getImageMapping

pageGetImageMapping

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: A Page

-> m [ImageMapping]

Returns: A List of ImageMapping

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

pageGetIndex

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: a Page

-> m Int32

Returns: index value of page

Returns the index of page

getLabel

pageGetLabel

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: a Page

-> m Text

Returns: a new allocated string containing the label of page, or Nothing if page doesn't have a label

Returns the label of page. Note that page labels and page indices might not coincide.

Since: 0.16

getLinkMapping

pageGetLinkMapping

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: A Page

-> m [LinkMapping]

Returns: A List of LinkMapping

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

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: a Page

-> Double

scale: scale specified as pixels per point

-> SelectionStyle

style: a SelectionStyle

-> Rectangle

selection: start and end point of selection as a 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

pageGetSelectedText

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: a Page

-> SelectionStyle

style: a SelectionStyle

-> Rectangle

selection: the Rectangle including the text

-> m Text

Returns: a pointer to the contents of the selection as a string

Retrieves the contents of the specified selection as text.

Since: 0.16

getSelectionRegion

pageGetSelectionRegion

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: a Page

-> Double

scale: scale specified as pixels per point

-> SelectionStyle

style: a SelectionStyle

-> Rectangle

selection: start and end point of selection as a rectangle

-> m [Rectangle]

Returns: a List of 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

pageGetSize

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: A Page

-> m (Double, Double)

Gets the size of page at the current scale and rotation.

getText

pageGetText

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: a Page

-> m Text

Returns: a pointer to the text of the page as a string

Retrieves the text of page.

Since: 0.16

getTextAttributes

pageGetTextAttributes

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: A Page

-> m [TextAttributes]

Returns: A List of TextAttributes

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

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: A Page

-> Rectangle

area: a Rectangle

-> m [TextAttributes]

Returns: A List of TextAttributes

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

pageGetTextForArea

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: a Page

-> Rectangle

area: 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

pageGetTextLayout

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: A Page

-> m (Bool, [Rectangle])

Returns: True if the page contains text, False otherwise

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

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: A Page

-> Rectangle

area: a Rectangle

-> m (Bool, [Rectangle])

Returns: True if the page contains text, False otherwise

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

pageGetThumbnail

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: the Page to get the thumbnail for

-> m Surface

Returns: the tumbnail as a cairo_surface_t or Nothing if the document doesn't have a thumbnail for this page.

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

pageGetThumbnailSize

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: A Page

-> m (Bool, Int32, Int32)

Returns: True, if page has a thumbnail associated with it.

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

pageGetTransition

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: a Page

-> m PageTransition

Returns: a PageTransition or Nothing.

Returns the transition effect of page

removeAnnot

pageRemoveAnnot

Arguments

:: (HasCallStack, MonadIO m, IsPage a, IsAnnot b)

=> a

page: a Page

-> b

annot: a Annot to remove

-> m ()

Removes annotation annot from page

Since: 0.22

render

pageRender

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: the page to render from

-> Context

cairo: cairo context to render to

-> 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. Please see the documentation for that function for the differences between rendering to the screen and rendering to a printer.

renderForPrinting

pageRenderForPrinting

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: the page to render from

-> Context

cairo: cairo context to render to

-> m ()

Render the page to the given cairo context for printing with POPPLER_PRINT_ALL flags selected. If you want a different set of flags, use pageRenderForPrintingWithOptions.

The difference between pageRender and this function is that some things get rendered differently between screens and printers:

<itemizedlist> <listitem> PDF annotations get rendered according to their AnnotFlag value. For example, POPPLER_ANNOT_FLAG_PRINT refers to whether an annotation is printed or not, whereas POPPLER_ANNOT_FLAG_NO_VIEW refers to whether an annotation is invisible when displaying to the screen. </listitem> <listitem> PDF supports "hairlines" of width 0.0, which often get rendered as having a width of 1 device pixel. When displaying on a screen, Cairo may render such lines wide so that they are hard to see, and Poppler makes use of PDF's Stroke Adjust graphics parameter to make the lines easier to see. However, when printing, Poppler is able to directly use a printer's pixel size instead. </listitem> <listitem> Some advanced features in PDF may require an image to be rasterized before sending off to a printer. This may produce raster images which exceed Cairo's limits. The "printing" functions will detect this condition and try to down-scale the intermediate surfaces as appropriate. </listitem> </itemizedlist>

renderForPrintingWithOptions

pageRenderForPrintingWithOptions

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: the page to render from

-> Context

cairo: cairo context to render to

-> [PrintFlags]

options: print options

-> m ()

Render the page to the given cairo context for printing with the specified options

See the documentation for pageRenderForPrinting for the differences between rendering to the screen and rendering to a printer.

Since: 0.16

renderSelection

pageRenderSelection

Arguments

:: (HasCallStack, MonadIO m, IsPage a)

=> a

page: the Page for which to render selection

-> Context

cairo: cairo context to render to

-> Rectangle

selection: start and end point of selection as a rectangle

-> Rectangle

oldSelection: previous selection

-> SelectionStyle

style: a SelectionStyle

-> Color

glyphColor: color to use for drawing glyphs

-> Color

backgroundColor: color to use for the selection background

-> 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

pageRenderToPs

Arguments

:: (HasCallStack, MonadIO m, IsPage a, IsPSFile b)

=> a

page: a Page

-> b

psFile: the PopplerPSFile to render to

-> m ()

Render the page on a postscript file

selectionRegionFree

pageSelectionRegionFree

Arguments

:: (HasCallStack, MonadIO m)

=> [Rectangle]

region: a List of Rectangle

-> m ()

Deprecated: (Since version 0.16)Use only to free deprecated regions created bypageGetSelectionRegion. Regions created bypageGetSelectedRegion should be freed withcairo_region_destroy() instead.

Frees region

Properties

label

The label of the page or Nothing. See also pageGetLabel

getPageLabel :: (MonadIO m, IsPage o) => o -> m (Maybe Text)

Get the value of the “label” property. When overloading is enabled, this is equivalent to

get page #label