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

GI.Poppler.Objects.AnnotTextMarkup

Contents

Exported types
Methods

Description

No description available in the introspection data.

Synopsis

newtype AnnotTextMarkup = AnnotTextMarkup (ManagedPtr AnnotTextMarkup)
class (GObject o, IsDescendantOf AnnotTextMarkup o) => IsAnnotTextMarkup o
toAnnotTextMarkup :: (MonadIO m, IsAnnotTextMarkup o) => o -> m AnnotTextMarkup
noAnnotTextMarkup :: Maybe AnnotTextMarkup
annotTextMarkupGetQuadrilaterals :: (HasCallStack, MonadIO m, IsAnnotTextMarkup a) => a -> m [Quadrilateral]
annotTextMarkupNewHighlight :: (HasCallStack, MonadIO m, IsDocument a) => a -> Rectangle -> [Quadrilateral] -> m AnnotTextMarkup
annotTextMarkupNewSquiggly :: (HasCallStack, MonadIO m, IsDocument a) => a -> Rectangle -> [Quadrilateral] -> m AnnotTextMarkup
annotTextMarkupNewStrikeout :: (HasCallStack, MonadIO m, IsDocument a) => a -> Rectangle -> [Quadrilateral] -> m AnnotTextMarkup
annotTextMarkupNewUnderline :: (HasCallStack, MonadIO m, IsDocument a) => a -> Rectangle -> [Quadrilateral] -> m AnnotTextMarkup
annotTextMarkupSetQuadrilaterals :: (HasCallStack, MonadIO m, IsAnnotTextMarkup a) => a -> [Quadrilateral] -> m ()

Exported types

newtype AnnotTextMarkup Source #

Memory-managed wrapper type.

Constructors

AnnotTextMarkup (ManagedPtr AnnotTextMarkup)

Instances

GObject AnnotTextMarkup Source #
Instance details Defined in GI.Poppler.Objects.AnnotTextMarkup Methods gobjectType :: IO GType #
HasParentTypes AnnotTextMarkup Source #
Instance details Defined in GI.Poppler.Objects.AnnotTextMarkup
type ParentTypes AnnotTextMarkup Source #
Instance details Defined in GI.Poppler.Objects.AnnotTextMarkup type ParentTypes AnnotTextMarkup = AnnotMarkup ': (Annot ': (Object ': ([] :: [Type])))

class (GObject o, IsDescendantOf AnnotTextMarkup o) => IsAnnotTextMarkup o Source #

Type class for types which can be safely cast to AnnotTextMarkup, for instance with toAnnotTextMarkup.

Instances

(GObject o, IsDescendantOf AnnotTextMarkup o) => IsAnnotTextMarkup o Source #
Instance details Defined in GI.Poppler.Objects.AnnotTextMarkup

toAnnotTextMarkup :: (MonadIO m, IsAnnotTextMarkup o) => o -> m AnnotTextMarkup Source #

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

noAnnotTextMarkup :: Maybe AnnotTextMarkup Source #

A convenience alias for Nothing :: Maybe AnnotTextMarkup.

Methods

getQuadrilaterals

annotTextMarkupGetQuadrilaterals Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnnotTextMarkup a)
=> a	`popplerAnnot`: A `AnnotTextMarkup`
-> m [Quadrilateral]	Returns: A `Array` of `Quadrilateral`

Returns a Array of Quadrilateral items that map from a location on page to a AnnotTextMarkup. This array must be freed when done.

Since: 0.26

newHighlight

annotTextMarkupNewHighlight Source #

Arguments

:: (HasCallStack, MonadIO m, IsDocument a)
=> a	`doc`: a `Document`
-> Rectangle	`rect`: a `Rectangle`
-> [Quadrilateral]	`quadrilaterals`: A `Array` of `Quadrilateral`<!-- -->s
-> m AnnotTextMarkup	Returns: A newly created `AnnotTextMarkup` annotation

Creates a new Highlight Text annotation that will be located on rect when added to a page. See pageAddAnnot

Since: 0.26

newSquiggly

annotTextMarkupNewSquiggly Source #

Arguments

:: (HasCallStack, MonadIO m, IsDocument a)
=> a	`doc`: a `Document`
-> Rectangle	`rect`: a `Rectangle`
-> [Quadrilateral]	`quadrilaterals`: A `Array` of `Quadrilateral`<!-- -->s
-> m AnnotTextMarkup	Returns: A newly created `AnnotTextMarkup` annotation

Creates a new Squiggly Text annotation that will be located on rect when added to a page. See pageAddAnnot

Since: 0.26

newStrikeout

annotTextMarkupNewStrikeout Source #

Arguments

:: (HasCallStack, MonadIO m, IsDocument a)
=> a	`doc`: a `Document`
-> Rectangle	`rect`: a `Rectangle`
-> [Quadrilateral]	`quadrilaterals`: A `Array` of `Quadrilateral`<!-- -->s
-> m AnnotTextMarkup	Returns: A newly created `AnnotTextMarkup` annotation

Creates a new Strike Out Text annotation that will be located on rect when added to a page. See pageAddAnnot

Since: 0.26

newUnderline

annotTextMarkupNewUnderline Source #

Arguments

:: (HasCallStack, MonadIO m, IsDocument a)
=> a	`doc`: a `Document`
-> Rectangle	`rect`: a `Rectangle`
-> [Quadrilateral]	`quadrilaterals`: A `Array` of `Quadrilateral`<!-- -->s
-> m AnnotTextMarkup	Returns: A newly created `AnnotTextMarkup` annotation

Creates a new Underline Text annotation that will be located on rect when added to a page. See pageAddAnnot

Since: 0.26

setQuadrilaterals

annotTextMarkupSetQuadrilaterals Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnnotTextMarkup a)
=> a	`popplerAnnot`: A `AnnotTextMarkup`
-> [Quadrilateral]	`quadrilaterals`: A `Array` of `Quadrilateral`<!-- -->s
-> m ()

Set the regions (Quadrilaterals) to apply the text markup in popplerAnnot.

Since: 0.26