lyx_mirror/src/box.h

/**
 * \file box.h
 * Copyright 2001 the LyX Team
 * Read the file COPYING
 *
 * \author John Levon <moz@compsoc.man.ac.uk>
 */

#ifndef BOX_H
#define BOX_H

#include "support/LOstream.h"

/**
 * A simple class representing rectangular regions.
 * It is expected that the box be constructed in
 * normalised form, that is to say : x1,y1 is top-left,
 * x2,y2 is bottom-right.
 *
 * Negative values are allowed.
 */
struct Box {
	int x1;
	int x2;
	int y1;
	int y2;

	Box(int x1_, int x2_,
		int y1_, int y2_) :
		x1(x1_), x2(x2_), y1(y1_), y2(y2_) {}

	/**
	 * Returns true if the given co-ordinates are within
	 * the box. Check is exclusive (point on a border
	 * returns false).
	 */
	bool contained(int x, int y) {
		return (x1 < x && x2 > x &&
			y1 < y && y2 > y);
	}

	 
};
 
inline std::ostream & operator<<(std::ostream & o, Box & b)
{
	return o << "x1,y1: " << b.x1 << "," << b.y1
		<< " x2,y2: " << b.x2 << "," << b.y2 << std::endl;
}
 
#endif // BOX_H