$mouse - Revision history

Cail: Added .cx/.cy

2014-07-08T11:32:07Z

Added .cx/.cy

← Older revision		Revision as of 11:32, 8 July 2014
Line 10:		Line 10:
	.mx/.my returns mouse x- and y-coordinates relative to mirc window.		.mx/.my returns mouse x- and y-coordinates relative to mirc window.
	.dx/.dy returns mouse x- and y-coordinates relative to desktop.		.dx/.dy returns mouse x- and y-coordinates relative to desktop.
			.cx/.cy returns mouse x- and y-coordinates relative to primary monitor. (Use for multi-monitor purposes rather than .dx/.dy.)
	.lb property returns $true if a mouse event occurred over a listbox, or $false if it didn't.		.lb property returns $true if a mouse event occurred over a listbox, or $false if it didn't.
	.key returns a bitwise value of the key(s) being pressed.		.key returns a bitwise value of the key(s) being pressed.

Albie: Reordered and made that page comply with Guidelines

2011-03-11T12:56:44Z

Reordered and made that page comply with Guidelines

← Older revision		Revision as of 12:56, 11 March 2011
Line 1:		Line 1:
	[[image:Mouse.png\|right\|thumb\|200px\|Differences between $mouse.x/y .mx/my and .dx/dy]]		[[image:Mouse.png\|right\|thumb\|200px\|Differences between $mouse.x/y .mx/my and .dx/dy]]
	~~'''$mouse'''<br />~~
	~~Properties: win, x, y, mx, my, dx, dy, key, lb~~

	Returns the x, y position of the current mouse event, and whether the left mouse button, shift key, and/or control key are pressed.		Returns the x, y position of the current mouse event, and whether the left mouse button, shift key, and/or control key are pressed.
	The $mouse identifier can be used in the mouse/click events.		The $mouse identifier can be used in the mouse/click events.

			$mouse

			Properties:
			.win property returns the name of the active window.
			.x/.y returns mouse x- and y-coordinates relative to active window.
			.mx/.my returns mouse x- and y-coordinates relative to mirc window.
			.dx/.dy returns mouse x- and y-coordinates relative to desktop.
			.lb property returns $true if a mouse event occurred over a listbox, or $false if it didn't.
			.key returns a bitwise value of the key(s) being pressed.

	For $mouse.key you can use the & bitwise operator to check if the left button, shift key, and/or control key are pressed:		For $mouse.key you can use the & bitwise operator to check if the left button, shift key, and/or control key are pressed:
Line 12:		Line 19:
	if ($mouse.key & 8) echo alt key is pressed.		if ($mouse.key & 8) echo alt key is pressed.
	if ($mouse.key & 16) echo right mouse button is pressed.		if ($mouse.key & 16) echo right mouse button is pressed.

	~~Properties:~~
	~~.win property returns the name of the active window.~~
	~~.x/.y returns mouse x- and y-coordinates relative to active window~~
	~~.mx/.my returns mouse x- and y-coordinates relative to mirc window~~
	~~.dx/.dy returns mouse x- and y-coordinates relative to desktop~~
	~~.lb property returns $true if a mouse event occurred over a listbox, or $false if it didn't.~~

	The following menu commands are available for mouse actions:		The following menu commands are available for mouse actions:
Line 30:		Line 30:
	drop: triggers when button is released inside the window (mouse1; left button)		drop: triggers when button is released inside the window (mouse1; left button)

	Example:		== Example ==
	; First we'll need to create a picture window from editbox:		; First we'll need to create a picture window from editbox:
	; -p means it's a picture window, first @test is the name of the window, the second @test is the name of the popupfile		; -p means it's a picture window, first @test is the name of the window, the second @test is the name of the popupfile
Line 56:		Line 56:
	}		}

			== See Also ==
			* [[$click]] Stores a history of x/y clicks in a window.
			* [[Popup_Menus#MENU_prefix\|Menu Prefix]] Various mouse events inside the custom menus.

	[[Category:Mouse and Menu Identifiers]]		[[Category:Mouse and Menu Identifiers]]

Cail: changing category back

2007-06-29T11:55:12Z

changing category back

← Older revision		Revision as of 11:55, 29 June 2007
Line 57:		Line 57:


	[[Category:Mouse and Menu ~~Identifier~~]]		[[Category:Mouse and Menu Identifiers]]

Cail: the same as the last one

2007-06-29T11:53:31Z

the same as the last one

← Older revision		Revision as of 11:53, 29 June 2007
Line 57:		Line 57:


	[[Category:Mouse and Menu ~~Identifiers\|Mouse and Menu Identifiers~~]]		[[Category:Mouse and Menu Identifier]]

Cail at 16:18, 3 February 2007

2007-02-03T16:18:23Z

← Older revision		Revision as of 16:18, 3 February 2007
Line 57:		Line 57:


	[[Category:Mouse and Menu Identifiers]]		[[Category:Mouse and Menu Identifiers\|Mouse and Menu Identifiers]]

Cail at 16:11, 3 February 2007

2007-02-03T16:11:14Z

← Older revision		Revision as of 16:11, 3 February 2007
Line 57:		Line 57:


	[[Category:Mouse Identifiers]]		[[Category:Mouse and Menu Identifiers]]

Cail: added stuff about mouse actions in menu

2007-01-31T11:22:07Z

added stuff about mouse actions in menu

@@ Line 19: / Line 19: @@
   .dx/.dy  returns mouse x- and y-coordinates relative to desktop
   .lb      property returns $true if a mouse event occurred over a listbox, or $false if it didn't.
 Example:

Cail: added image

2007-01-31T08:10:31Z

added image

← Older revision		Revision as of 08:10, 31 January 2007
Line 1:		Line 1:
			[[image:Mouse.png\|right\|thumb\|200px\|Differences between $mouse.x/y .mx/my and .dx/dy]]
	'''$mouse'''<br />		'''$mouse'''<br />
	Properties: win, x, y, mx, my, dx, dy, key, lb		Properties: win, x, y, mx, my, dx, dy, key, lb
Line 45:		Line 46:
	}		}


	[[Category:Mouse Identifiers]]		[[Category:Mouse Identifiers]]

Cail: added category

2007-01-31T07:55:59Z

added category

← Older revision		Revision as of 07:55, 31 January 2007
Line 44:		Line 44:
	elseif ($mouse.key & 16) { drawdot @test $color(background) 6 $mouse.x $mouse.y }		elseif ($mouse.key & 16) { drawdot @test $color(background) 6 $mouse.x $mouse.y }
	}		}

			[[Category:Mouse Identifiers]]

Cail: added $mouse

2007-01-31T07:52:32Z

added $mouse

New page

'''$mouse'''<br />
Properties: win, x, y, mx, my, dx, dy, key, lb

Returns the x, y position of the current mouse event, and whether the left mouse button, shift key, and/or control key are pressed.
The $mouse identifier can be used in the mouse/click events.

For $mouse.key you can use the & bitwise operator to check if the left button, shift key, and/or control key are pressed:
if ($mouse.key & 1) echo left button is pressed.
if ($mouse.key & 2) echo control key is pressed.
if ($mouse.key & 4) echo shift key is pressed.
if ($mouse.key & 8) echo alt key is pressed.
if ($mouse.key & 16) echo right mouse button is pressed.

Properties:
.win property returns the name of the active window.
.x/.y returns mouse x- and y-coordinates relative to active window
.mx/.my returns mouse x- and y-coordinates relative to mirc window
.dx/.dy returns mouse x- and y-coordinates relative to desktop
.lb property returns $true if a mouse event occurred over a listbox, or $false if it didn't.

Example:
; First we'll need to create a picture window from editbox:
; -p means it's a picture window, first @test is the name of the window, the second @test is the name of the popupfile
; (we'll use the window's name so we can use the menu prefix in remote script)
/window -p @test @test

; the menu for our @test window
menu @test {
; "mouse" triggers whenever mouse moves in the window, and executes draw alias
mouse:draw

; "dclick" triggers whenever user doubleclicks in the window, we'll use this to clear the window
dclick:clear @test
}

; this is the alias that is executed everytime mouse moves in @test window
alias draw {
; an if to check if left mouse button is pressed, if so draw a dot into the window with colorcode 4, size 2px,
; and read the X and Y location for the dot from $mouse.x and $mouse.y
if ($mouse.key & 1) { drawdot @test 4 2 $mouse.x $mouse.y }

; else if left mouse button wasn't pressed, see if right mouse button was
; we'll do the drawdot like earlier, but use background color as the color (erase) and make it a bit bigger
elseif ($mouse.key & 16) { drawdot @test $color(background) 6 $mouse.x $mouse.y }
}