#include <stdbool.h>
#include <stdlib.h>
#include <stdio.h>
#include "helpers/formatstring.h"
#include "HandlerChain_WindowRectangle.h"

Include dependency graph for HandlerChain_WindowRectangle.c:

Functions
void	WindowRectangle_Initialize (WindowRectangle *rectangle, int x, int y, int width, int height)
	Initialize the specified WindowRectangle based on the given position and size in some arbitrary space. Ensures a minimum size.

bool	WindowRectangle_PointInside (WindowRectangle rectangle, MessagePosition point)
	Determine if the given WindowRectangle object contains the given MessagePosition.

bool	WindowRectangle_ToString (WindowRectangle rectangle, DynamicString output)
	Convert the given WindowRectangle to a string representation.

Variables
const int	MINIMUM_WIDTH = 4
	Minimum width of a window (to accommodate a close box).

const int	MINIMUM_HEIGHT = 4
	Minimum height of a window (to accommodate a close box).

Detailed Description

Function Documentation

void WindowRectangle_Initialize	(	WindowRectangle *	rectangle,
		int	x,
		int	y,
		int	width,
		int	height
	)

Initialize the specified WindowRectangle based on the given position and size in some arbitrary space. Ensures a minimum size.

Parameters

rectangle	A WindowRectangle object to initialize.
x	Horizontal position of the upper left corner.
y	Vertical position of the upper left corner.
width	Width of the rectangle.
height	Height of the rectangle.

bool WindowRectangle_PointInside	(	WindowRectangle *	rectangle,
		MessagePosition *	point
	)

Determine if the given WindowRectangle object contains the given MessagePosition.

Parameters

rectangle	A WindowRectangle object to examine.
point	A MessagePosition object specifying a point in the same space as the `rectangle` value.

Returns: Returns true if the MessagePosition is in the WindowRectangle; otherwise, returns false.

bool WindowRectangle_ToString	(	WindowRectangle *	rectangle,
		DynamicString *	output
	)

Convert the given WindowRectangle to a string representation.

Parameters

rectangle	A WindowRectangle to convert.
output	A DynamicString that returns the string version of the rectangle. Call DynamicString_Initialize() on this object before passing as an argument.

Returns: Returns true if the rectangle was formatted as a string; otherwise, returns false, indicating an out of memory condition (or NULL argument).