| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gdk.Structs.Rectangle
Description
Defines the position and size of a rectangle. It is identical to
RectangleInt.
- newtype Rectangle = Rectangle (ManagedPtr Rectangle)
- newZeroRectangle :: MonadIO m => m Rectangle
- noRectangle :: Maybe 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
Constructors
| Rectangle (ManagedPtr Rectangle) |
Instances
| BoxedObject Rectangle Source # | |
| (~) AttrOpTag tag AttrSet => Constructible Rectangle tag Source # | |
newZeroRectangle :: MonadIO m => m Rectangle Source #
Construct a Rectangle struct initialized to zero.
Methods
equal
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Rectangle |
|
| -> Rectangle |
|
| -> m Bool | Returns: |
Checks if the two given rectangles are equal.
Since: 3.20
intersect
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Rectangle |
|
| -> Rectangle |
|
| -> m (Bool, Rectangle) | Returns: |
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
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Rectangle |
|
| -> 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).