Differences

This shows you the differences between two versions of the page.

--- code:device:mouse [2011/01/26 20:46] – created jmgr
+++ code:device:mouse [2011/04/20 20:29] (current) – removed jmgr
@@ Line 1: / Line 1: @@
-====== Mouse ======
-This object allows you to simulate mouse actions.
-===== Functions =====
-==== Mouse ====
-Constructor function.
-=== Syntax ===
-<code javascript>
-var myObject = new Mouse();
-</code>
-===== Methods =====
-==== position ====
-Returns the current position of the cursor.
-=== Syntax ===
-<code javascript>
-myObject.position();
-</code>
-=== Returns ===
-  * ([[code:core:point|Point]]) the current position of the cursor
-==== move ====
-Moves the mouse cursor.
-=== Syntax ===
-<code javascript>
-myObject.move(position);
-</code>
-=== Arguments ===
-  - position - ([[code:core:point|Point]]) the position where to move the mouse cursor
-=== Returns ===
-  * (Mouse) this Mouse
-==== isButtonPressed ====
-Returns true if **button** is pressed.
-=== Syntax ===
-<code javascript>
-myObject.isButtonPressed(button);
-</code>
-=== Arguments ===
-  - button - ([[#button|Button]]) the button to check
-=== Returns ===
-  * (boolean) true if **button** is pressed
-==== press ====
-Presses a mouse button or the left button if no button is specified.
-=== Syntax ===
-<code javascript>
-myObject.press(button);
-</code>
-<code javascript>
-myObject.press();
-</code>
-=== Arguments ===
-  - button - ([[#button|Button]]) the button to press
-=== Returns ===
-  * (Mouse) this Mouse
-=== Exceptions ===
-  * (PressButtonError) unable to press the button
-==== release ====
-Releases a mouse button or the left button if no button is specified.
-=== Syntax ===
-<code javascript>
-myObject.release(button);
-</code>
-<code javascript>
-myObject.release();
-</code>
-=== Arguments ===
-  - button - ([[#button|Button]]) the button to release
-=== Returns ===
-  * (Mouse) this Mouse
-=== Exceptions ===
-  * (ReleaseButtonError) unable to release the button
-==== click ====
-Presses and releases a mouse button or the left button if no button is specified.
-=== Syntax ===
-<code javascript>
-myObject.click(button);
-</code>
-<code javascript>
-myObject.click();
-</code>
-=== Arguments ===
-  - button - ([[#button|Button]]) the button to press and release
-=== Returns ===
-  * (Mouse) this Mouse
-=== Exceptions ===
-  * (ClickError) unable to press and release the button
-==== wheel ====
-Emulates a mouse wheel movement.
-=== Syntax ===
-<code javascript>
-myObject.wheel(intensity);
-</code>
-<code javascript>
-myObject.wheel();
-</code>
-=== Arguments ===
-  - intensity - (integer) the wheel movement intensity, positive is forward, negative is backward (default: 1)
-=== Returns ===
-  * (Mouse) this Mouse
-=== Exceptions ===
-  * (WheelError) unable to emulate a mouse wheel
-===== Enumerations =====
-==== Button ====
-Mouse buttons.
-=== Values ===
-  - LeftButton: left button
-  - MiddleButton: middle button
-  - RightButton: right button