/*This file is part of Silex - see http://projects.silexlabs.org/?/silex

Silex is Š 2010-2011 Silex Labs and is released under the GPL License:

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License (GPL) as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. 

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

To read the license please visit http://www.gnu.org/copyleft/gpl.html
*/
package cocktail.mouse;

import cocktail.domElement.DOMElement;
import cocktail.geom.GeomData;

/**
 * This file contains mouse related structures
 * and enums
 */

/**
 * Stored the data raised by a mouse event
 */ 
typedef MouseEventData = {
	var mousePosition:MousePosition;
	
	/**
	 * represents the keyboard state
	 * when the mouse event occurs
	 */
	var ctrlKey:Bool;
	var altKey:Bool;
	var shiftKey:Bool;
}

/**
 * Represents the position of the mouse, both
 * global (relative to the browser window top left
 * corner) and local (relative to the dom element
 * which triggered the mouse event top left corner)
 */
typedef MousePosition = {
	var localX:Float;
	var localY:Float;
	var globalX:Float;
	var globalY:Float;
}

/**
 * Lists the different cursors which can
 * be set for the mouse pointer
 */
enum MouseCursorValue {
	/**
	 * uses a custom bitmap cursor set with
	 * an image dom element. The hotSpot is the registration
	 * point of the cursor.
	 */
	custom(imageDOMElement:DOMElement, hotSpot:Point);
	
	/**
	 * Let the browser manage the mouse cursor
	 */
	auto;
	
	/**
	 * Hides the mouse cursor
	 */
	none;
	
	/**
	 * Use a native OS mouse cursor
	 */
	native(nativeOSMouseCursorValue:NativeOSMouseCursorValue);
}

/**
 * Lists all the available native
 * OS mouse cursor
 */
enum NativeOSMouseCursorValue {
	
	/**
	 * represents a pointed hand
	 */
	pointer;
	
	/**
	 * represents an i-beam
	 */
	text;
}