Portability | portable (depends on GHC) |
---|---|
Stability | alpha |
Maintainer | gtk2hs-devel@lists.sourceforge.net |
- data Cairo
- data PopplerRectangle = PopplerRectangle Double Double Double Double
- data PopplerColor = PopplerColor Word16 Word16 Word16
- data ImageMapping
- data PageTransition
- data LinkMapping
- data FormFieldMapping
- data SelectionStyle
- pageRender :: PageClass page => page -> Render ()
- pageRenderToPixbuf :: PageClass page => page -> Rectangle -> Double -> Int -> Pixbuf -> IO ()
- pageGetSize :: PageClass page => page -> IO (Double, Double)
- pageGetIndex :: PageClass page => page -> IO Int
- pageGetThumbnail :: PageClass page => page -> IO (Maybe Surface)
- pageGetThumbnailSize :: PageClass page => page -> IO (Maybe (Int, Int))
- pageRenderToPs :: (PageClass page, PSFileClass psFile) => page -> psFile -> IO ()
- pageFindText :: PageClass page => page -> String -> IO [PopplerRectangle]
- pageGetText :: PageClass page => page -> SelectionStyle -> PopplerRectangle -> IO String
- pageGetDuration :: PageClass page => page -> IO Double
- pageGetTransition :: PageClass page => page -> IO (Maybe PageTransition)
- pageGetLinkMapping :: PageClass page => page -> IO [LinkMapping]
- pageGetImageMapping :: PageClass page => page -> IO [ImageMapping]
- pageGetFormFieldMapping :: PageClass page => page -> IO [FormFieldMapping]
- pageGetSelectionRegion :: PageClass page => page -> Double -> SelectionStyle -> PopplerRectangle -> IO [PopplerRectangle]
- pageRenderSelection :: PageClass page => page -> PopplerRectangle -> PopplerRectangle -> SelectionStyle -> PopplerColor -> PopplerColor -> Render ()
- pageRenderSelectionToPixbuf :: PageClass page => page -> Double -> Int -> Pixbuf -> PopplerRectangle -> PopplerRectangle -> SelectionStyle -> Color -> Color -> IO ()
Types
data Cairo
data PopplerRectangle Source
Rectangles describing an area in Double
s.
- Specifies x, y, width and height
data PopplerColor Source
data ImageMapping Source
data PageTransition Source
data LinkMapping Source
data FormFieldMapping Source
Enums
data SelectionStyle Source
Methods
pageRender :: PageClass page => page -> Render ()Source
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
:: PageClass page | |
=> page | |
-> Rectangle |
|
-> Double |
|
-> Int |
|
-> Pixbuf |
|
-> IO () |
First scale the document to match the specified pixels per point, then render the rectangle given by
the upper left corner at (srcX
, srcY
) and srcWidth
and srcHeight
. This function is for rendering
a page that will be displayed. If you want to render a page that will be printed use
pageRenderToPixbufForPrinting
instead
pageGetSize :: PageClass page => page -> IO (Double, Double)Source
Gets the size of page at the current scale and rotation.
Returns the index of page
:: PageClass page | |
=> page | |
-> IO (Maybe Surface) | returns the tumbnail as a |
Get the embedded thumbnail for the specified page. If the document doesn't have an embedded
thumbnail for the page, this function returns Nothing
.
pageGetThumbnailSize :: PageClass page => page -> IO (Maybe (Int, Int))Source
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.
pageRenderToPs :: (PageClass page, PSFileClass psFile) => page -> psFile -> IO ()Source
Render the page on a postscript file
:: PageClass page | |
=> page | |
-> String |
|
-> IO [PopplerRectangle] |
A GList of rectangles for each occurance of the text on the page. The coordinates are in PDF points.
:: PageClass page | |
=> page | |
-> SelectionStyle | |
-> PopplerRectangle | |
-> IO String | returns selection string |
Retrieves the contents of the specified selection as text.
Returns the duration of page
:: PageClass page | |
=> page | |
-> IO (Maybe PageTransition) | returns a |
Returns the transition effect of page
pageGetLinkMapping :: PageClass page => page -> IO [LinkMapping]Source
Returns a list of LinkMapping
items that map from a location on page to a Action
.
pageGetImageMapping :: PageClass page => page -> IO [ImageMapping]Source
Returns a list of ImageMapping
items that map from a location on page to a Action
.
pageGetFormFieldMapping :: PageClass page => page -> IO [FormFieldMapping]Source
Returns a list of FormFieldMapping
items that map from a location on page to a Action
.
:: PageClass page | |
=> page | |
-> Double |
|
-> SelectionStyle |
|
-> PopplerRectangle |
|
-> IO [PopplerRectangle] |
Returns a region containing the area that would be rendered by pageRenderSelection
or
pageRenderSelectionToPixbuf
as a GList of PopplerRectangle.
:: PageClass page | |
=> page | |
-> PopplerRectangle |
|
-> PopplerRectangle |
|
-> SelectionStyle |
|
-> PopplerColor |
|
-> PopplerColor |
|
-> Render () |
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-Nothing
, 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.
pageRenderSelectionToPixbufSource
:: PageClass page | |
=> page | |
-> Double |
|
-> Int |
|
-> Pixbuf |
|
-> PopplerRectangle |
|
-> PopplerRectangle |
|
-> SelectionStyle |
|
-> Color |
|
-> Color |
|
-> IO () |
Render the selection specified by selection for page into pixbuf. The selection will be rendered at
scale, using glyphColor
for the glyphs and backgroundColor
for the selection background.
If non-Nothing
, oldSelection
specifies the selection that is already rendered in pixbuf, in which case
this function will (some day) only render the changed part of the selection.