GI.Poppler.Structs.Rectangle

A Rectangle is used to describe locations on a page and bounding boxes

Exported types

newtype Rectangle

Memory-managed wrapper type.

Constructors

Rectangle (ManagedPtr Rectangle)

Instances

BoxedObject Rectangle

Defined in GI.Poppler.Structs.Rectangle

Methods

boxedType :: Rectangle -> IO GType

tag ~ AttrSet => Constructible Rectangle tag

Defined in GI.Poppler.Structs.Rectangle

Methods

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

newZeroRectangle :: MonadIO m => m Rectangle

Construct a Rectangle struct initialized to zero.

noRectangle :: Maybe Rectangle

A convenience alias for Nothing :: Maybe Rectangle.

Methods

copy

rectangleCopy

Arguments

:: (HasCallStack, MonadIO m)

=> Rectangle

rectangle: a Rectangle to copy

-> m Rectangle

Returns: a new allocated copy of rectangle

Creates a copy of rectangle

free

rectangleFree

Arguments

:: (HasCallStack, MonadIO m)

=> Rectangle

rectangle: a Rectangle

-> m ()

Frees the given Rectangle

new

rectangleNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Rectangle

Returns: a new Rectangle, use rectangleFree to free it

Creates a new Rectangle

Properties

x1

x coordinate of lower left corner

getRectangleX1 :: MonadIO m => Rectangle -> m Double

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

get rectangle #x1

setRectangleX1 :: MonadIO m => Rectangle -> Double -> m ()

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

set rectangle [ #x1 := value ]

x2

x coordinate of upper right corner

getRectangleX2 :: MonadIO m => Rectangle -> m Double

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

get rectangle #x2

setRectangleX2 :: MonadIO m => Rectangle -> Double -> m ()

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

set rectangle [ #x2 := value ]

y1

y coordinate of lower left corner

getRectangleY1 :: MonadIO m => Rectangle -> m Double

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

get rectangle #y1

setRectangleY1 :: MonadIO m => Rectangle -> Double -> m ()

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

set rectangle [ #y1 := value ]

y2

y coordinate of upper right corner

getRectangleY2 :: MonadIO m => Rectangle -> m Double

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

get rectangle #y2

setRectangleY2 :: MonadIO m => Rectangle -> Double -> m ()

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

set rectangle [ #y2 := value ]