GI.Gdk.Structs.Rectangle

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

Exported types

newtype Rectangle

Memory-managed wrapper type.

Constructors

Rectangle (ManagedPtr Rectangle)

Instances

Eq Rectangle

Defined in GI.Gdk.Structs.Rectangle

Methods

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

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

BoxedObject Rectangle

Defined in GI.Gdk.Structs.Rectangle

Methods

boxedType :: Rectangle -> IO GType

IsGValue Rectangle

Convert Rectangle to and from GValue with toGValue and fromGValue.

Defined in GI.Gdk.Structs.Rectangle

Methods

toGValue :: Rectangle -> IO GValue

fromGValue :: GValue -> IO Rectangle

tag ~ 'AttrSet => Constructible Rectangle tag

Defined in GI.Gdk.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

Overloaded methods

containsPoint

rectangleContainsPoint

Arguments

:: (HasCallStack, MonadIO m)

=> Rectangle

rect: a Rectangle

-> Int32

x: X coordinate

-> Int32

y: Y coordinate

-> m Bool

Returns: TRUE if rect contains the point

Returns TRUE if rect contains the point described by x and y.

equal

rectangleEqual

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.

intersect

rectangleIntersect

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

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

the height of the rectangle

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

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

get rectangle #height

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

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

set rectangle [ #height := value ]

width

the width of the rectangle

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

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

get rectangle #width

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

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

set rectangle [ #width := value ]

x

the x coordinate of the top left corner

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

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

get rectangle #x

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

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

set rectangle [ #x := value ]

y

the y coordinate of the top left corner

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

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

get rectangle #y

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

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

set rectangle [ #y := value ]