GI.Poppler.Structs.Dest

Data structure for holding a destination

Exported types

newtype Dest

Memory-managed wrapper type.

Constructors

Dest (ManagedPtr Dest)

Instances

BoxedObject Dest

Defined in GI.Poppler.Structs.Dest

Methods

boxedType :: Dest -> IO GType

tag ~ AttrSet => Constructible Dest tag

Defined in GI.Poppler.Structs.Dest

Methods

new :: MonadIO m => (ManagedPtr Dest -> Dest) -> [AttrOp Dest tag] -> m Dest

newZeroDest :: MonadIO m => m Dest

Construct a Dest struct initialized to zero.

noDest :: Maybe Dest

A convenience alias for Nothing :: Maybe Dest.

Methods

copy

destCopy

Arguments

:: (HasCallStack, MonadIO m)

=> Dest

dest: a Dest

-> m Dest

Returns: a new destination identical to dest

Copies dest, creating an identical Dest.

free

destFree

Arguments

:: (HasCallStack, MonadIO m)

=> Dest

dest: a Dest

-> m ()

Frees dest

Properties

bottom

bottom coordinate

getDestBottom :: MonadIO m => Dest -> m Double

Get the value of the “bottom” field. When overloading is enabled, this is equivalent to

get dest #bottom

setDestBottom :: MonadIO m => Dest -> Double -> m ()

Set the value of the “bottom” field. When overloading is enabled, this is equivalent to

set dest [ #bottom := value ]

changeLeft

whether left coordinate should be changed

getDestChangeLeft :: MonadIO m => Dest -> m Word32

Get the value of the “change_left” field. When overloading is enabled, this is equivalent to

get dest #changeLeft

setDestChangeLeft :: MonadIO m => Dest -> Word32 -> m ()

Set the value of the “change_left” field. When overloading is enabled, this is equivalent to

set dest [ #changeLeft := value ]

changeTop

whether top coordinate should be changed

getDestChangeTop :: MonadIO m => Dest -> m Word32

Get the value of the “change_top” field. When overloading is enabled, this is equivalent to

get dest #changeTop

setDestChangeTop :: MonadIO m => Dest -> Word32 -> m ()

Set the value of the “change_top” field. When overloading is enabled, this is equivalent to

set dest [ #changeTop := value ]

changeZoom

whether scale factor should be changed

getDestChangeZoom :: MonadIO m => Dest -> m Word32

Get the value of the “change_zoom” field. When overloading is enabled, this is equivalent to

get dest #changeZoom

setDestChangeZoom :: MonadIO m => Dest -> Word32 -> m ()

Set the value of the “change_zoom” field. When overloading is enabled, this is equivalent to

set dest [ #changeZoom := value ]

left

left coordinate

getDestLeft :: MonadIO m => Dest -> m Double

Get the value of the “left” field. When overloading is enabled, this is equivalent to

get dest #left

setDestLeft :: MonadIO m => Dest -> Double -> m ()

Set the value of the “left” field. When overloading is enabled, this is equivalent to

set dest [ #left := value ]

namedDest

name of the destination (POPPLER_DEST_NAMED only)

clearDestNamedDest :: MonadIO m => Dest -> m ()

Set the value of the “named_dest” field to Nothing. When overloading is enabled, this is equivalent to

clear #namedDest

getDestNamedDest :: MonadIO m => Dest -> m (Maybe Text)

Get the value of the “named_dest” field. When overloading is enabled, this is equivalent to

get dest #namedDest

setDestNamedDest :: MonadIO m => Dest -> CString -> m ()

Set the value of the “named_dest” field. When overloading is enabled, this is equivalent to

set dest [ #namedDest := value ]

pageNum

page number

getDestPageNum :: MonadIO m => Dest -> m Int32

Get the value of the “page_num” field. When overloading is enabled, this is equivalent to

get dest #pageNum

setDestPageNum :: MonadIO m => Dest -> Int32 -> m ()

Set the value of the “page_num” field. When overloading is enabled, this is equivalent to

set dest [ #pageNum := value ]

right

right coordinate

getDestRight :: MonadIO m => Dest -> m Double

Get the value of the “right” field. When overloading is enabled, this is equivalent to

get dest #right

setDestRight :: MonadIO m => Dest -> Double -> m ()

Set the value of the “right” field. When overloading is enabled, this is equivalent to

set dest [ #right := value ]

top

top coordinate

getDestTop :: MonadIO m => Dest -> m Double

Get the value of the “top” field. When overloading is enabled, this is equivalent to

get dest #top

setDestTop :: MonadIO m => Dest -> Double -> m ()

Set the value of the “top” field. When overloading is enabled, this is equivalent to

set dest [ #top := value ]

type

type of destination

getDestType :: MonadIO m => Dest -> m DestType

Get the value of the “type” field. When overloading is enabled, this is equivalent to

get dest #type

setDestType :: MonadIO m => Dest -> DestType -> m ()

Set the value of the “type” field. When overloading is enabled, this is equivalent to

set dest [ #type := value ]

zoom

scale factor

getDestZoom :: MonadIO m => Dest -> m Double

Get the value of the “zoom” field. When overloading is enabled, this is equivalent to

get dest #zoom

setDestZoom :: MonadIO m => Dest -> Double -> m ()

Set the value of the “zoom” field. When overloading is enabled, this is equivalent to

set dest [ #zoom := value ]