gi-poppler-0.18.18: Poppler bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (inaki@blueleaf.cc)
Safe HaskellNone
LanguageHaskell2010

GI.Poppler.Structs.Point

Contents

Description

A Point is used to describe a location point on a page

Synopsis

Exported types

newtype Point Source #

Memory-managed wrapper type.

Constructors

Point (ManagedPtr Point) 
Instances
BoxedObject Point Source # 
Instance details

Defined in GI.Poppler.Structs.Point

Methods

boxedType :: Point -> IO GType #

tag ~ AttrSet => Constructible Point tag Source # 
Instance details

Defined in GI.Poppler.Structs.Point

Methods

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

newZeroPoint :: MonadIO m => m Point Source #

Construct a Point struct initialized to zero.

noPoint :: Maybe Point Source #

A convenience alias for Nothing :: Maybe Point.

Methods

copy

pointCopy Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Point

point: a Point to copy

-> m Point

Returns: a new allocated copy of point

Creates a copy of point. The copy must be freed with pointFree after use.

Since: 0.26

free

pointFree Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Point

point: a Point

-> m () 

Frees the memory used by point

Since: 0.26

new

pointNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m Point

Returns: a new Point

Creates a new Point. It must be freed with pointFree after use.

Since: 0.26

Properties

x

x coordinate

getPointX :: MonadIO m => Point -> m Double Source #

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

get point #x

setPointX :: MonadIO m => Point -> Double -> m () Source #

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

set point [ #x := value ]

y

y coordinate

getPointY :: MonadIO m => Point -> m Double Source #

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

get point #y

setPointY :: MonadIO m => Point -> Double -> m () Source #

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

set point [ #y := value ]