Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.Gdk.Structs.Rectangle

Contents

Exported types
Methods
Properties
- height
- width
- x
- y

Description

Defines the position and size of a rectangle. It is identical to RectangleInt.

Synopsis

newtype Rectangle = Rectangle (ManagedPtr Rectangle)
newZeroRectangle :: MonadIO m => m Rectangle
rectangleEqual :: (HasCallStack, MonadIO m) => Rectangle -> Rectangle -> m Bool
rectangleIntersect :: (HasCallStack, MonadIO m) => Rectangle -> Rectangle -> m (Bool, Rectangle)
rectangleUnion :: (HasCallStack, MonadIO m) => Rectangle -> Rectangle -> m Rectangle
getRectangleHeight :: MonadIO m => Rectangle -> m Int32
setRectangleHeight :: MonadIO m => Rectangle -> Int32 -> m ()
getRectangleWidth :: MonadIO m => Rectangle -> m Int32
setRectangleWidth :: MonadIO m => Rectangle -> Int32 -> m ()
getRectangleX :: MonadIO m => Rectangle -> m Int32
setRectangleX :: MonadIO m => Rectangle -> Int32 -> m ()
getRectangleY :: MonadIO m => Rectangle -> m Int32
setRectangleY :: MonadIO m => Rectangle -> Int32 -> m ()

Exported types

newtype Rectangle Source #

Memory-managed wrapper type.

Constructors

Rectangle (ManagedPtr Rectangle)

Instances

Instances details

Eq Rectangle Source #
Instance details Defined in GI.Gdk.Structs.Rectangle Methods (==) :: Rectangle -> Rectangle -> Bool # (/=) :: Rectangle -> Rectangle -> Bool #
GBoxed Rectangle Source #
Instance details Defined in GI.Gdk.Structs.Rectangle
ManagedPtrNewtype Rectangle Source #
Instance details Defined in GI.Gdk.Structs.Rectangle Methods toManagedPtr :: Rectangle -> ManagedPtr Rectangle #
TypedObject Rectangle Source #
Instance details Defined in GI.Gdk.Structs.Rectangle Methods glibType :: IO GType #
HasParentTypes Rectangle Source #
Instance details Defined in GI.Gdk.Structs.Rectangle
tag ~ 'AttrSet => Constructible Rectangle tag Source #
Instance details Defined in GI.Gdk.Structs.Rectangle Methods new :: MonadIO m => (ManagedPtr Rectangle -> Rectangle) -> [AttrOp Rectangle tag] -> m Rectangle #
IsGValue (Maybe Rectangle) Source #	Convert `Rectangle` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gdk.Structs.Rectangle Methods gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe Rectangle -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe Rectangle) #
type ParentTypes Rectangle Source #
Instance details Defined in GI.Gdk.Structs.Rectangle type ParentTypes Rectangle = '[] :: [Type]

newZeroRectangle :: MonadIO m => m Rectangle Source #

Construct a Rectangle struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

equal, intersect, union.

Getters

None.

Setters

None.

equal

rectangleEqual Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Rectangle	`rect1`: a `Rectangle`
-> Rectangle	`rect2`: a `Rectangle`
-> m Bool	Returns: `True` if the rectangles are equal.

Checks if the two given rectangles are equal.

Since: 3.20

intersect

rectangleIntersect Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Rectangle	`src1`: a `Rectangle`
-> Rectangle	`src2`: a `Rectangle`
-> m (Bool, Rectangle)	Returns: `True` if the rectangles intersect.

Calculates the intersection of two rectangles. It is allowed for dest to be the same as either src1 or src2. If the rectangles do not intersect, dest’s width and height is set to 0 and its x and y values are undefined. If you are only interested in whether the rectangles intersect, but not in the intersecting area itself, pass Nothing for dest.

union

rectangleUnion Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Rectangle	`src1`: a `Rectangle`
-> Rectangle	`src2`: a `Rectangle`
-> m Rectangle

Calculates the union of two rectangles. The union of rectangles src1 and src2 is the smallest rectangle which includes both src1 and src2 within it. It is allowed for dest to be the same as either src1 or src2.

Note that this function does not ignore 'empty' rectangles (ie. with zero width or height).

Properties

height

No description available in the introspection data.

getRectangleHeight :: MonadIO m => Rectangle -> m Int32 Source #

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

get rectangle #height

setRectangleHeight :: MonadIO m => Rectangle -> Int32 -> m () Source #

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

set rectangle [ #height := value ]

width

No description available in the introspection data.

getRectangleWidth :: MonadIO m => Rectangle -> m Int32 Source #

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

get rectangle #width

setRectangleWidth :: MonadIO m => Rectangle -> Int32 -> m () Source #

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

set rectangle [ #width := value ]

x

No description available in the introspection data.

getRectangleX :: MonadIO m => Rectangle -> m Int32 Source #

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

get rectangle #x

setRectangleX :: MonadIO m => Rectangle -> Int32 -> m () Source #

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

set rectangle [ #x := value ]

y

No description available in the introspection data.

getRectangleY :: MonadIO m => Rectangle -> m Int32 Source #

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

get rectangle #y

setRectangleY :: MonadIO m => Rectangle -> Int32 -> m () Source #

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

set rectangle [ #y := value ]