gi-poppler-0.18.23: Poppler bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Poppler.Structs.Rectangle

Description

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

Synopsis

Exported types

newtype Rectangle Source #

Memory-managed wrapper type.

Constructors

Rectangle (ManagedPtr Rectangle) 

Instances

Instances details
Eq Rectangle Source # 
Instance details

Defined in GI.Poppler.Structs.Rectangle

Methods

(==) :: Rectangle -> Rectangle -> Bool

(/=) :: Rectangle -> Rectangle -> Bool

GBoxed Rectangle Source # 
Instance details

Defined in GI.Poppler.Structs.Rectangle

ManagedPtrNewtype Rectangle Source # 
Instance details

Defined in GI.Poppler.Structs.Rectangle

Methods

toManagedPtr :: Rectangle -> ManagedPtr Rectangle

TypedObject Rectangle Source # 
Instance details

Defined in GI.Poppler.Structs.Rectangle

Methods

glibType :: IO GType

IsGValue Rectangle Source #

Convert Rectangle to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Poppler.Structs.Rectangle

Methods

toGValue :: Rectangle -> IO GValue

fromGValue :: GValue -> IO Rectangle

HasParentTypes Rectangle Source # 
Instance details

Defined in GI.Poppler.Structs.Rectangle

tag ~ 'AttrSet => Constructible Rectangle tag Source # 
Instance details

Defined in GI.Poppler.Structs.Rectangle

Methods

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

type ParentTypes Rectangle Source # 
Instance details

Defined in GI.Poppler.Structs.Rectangle

type ParentTypes Rectangle = '[] :: [Type]

newZeroRectangle :: MonadIO m => m Rectangle Source #

Construct a Rectangle struct initialized to zero.

Methods

Overloaded methods

copy

rectangleCopy Source #

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 Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Rectangle

rectangle: a Rectangle

-> m () 

Frees the given Rectangle

new

rectangleNew Source #

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 Source #

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

get rectangle #x1

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

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 Source #

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

get rectangle #x2

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

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 Source #

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

get rectangle #y1

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

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 Source #

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

get rectangle #y2

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

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

set rectangle [ #y2 := value ]