Core Function HotKeySet - Revision history

UberFoX: 1 revision

2015-06-14T12:38:15Z

1 revision

← Older revision

Revision as of 12:38, 14 June 2015

UberFoX: 1 revision

2014-08-11T21:40:33Z

1 revision

← Older revision

Revision as of 21:40, 11 August 2014

UberFoX at 23:02, 5 October 2013

2013-10-05T23:02:10Z

← Older revision		Revision as of 23:02, 5 October 2013
Line 1:		Line 1:
	<pre>		<pre>
−	HotKeySet( <keydef>, <function> )	+	HotKeySet( <keydef>, <function>, <param var> )
	</pre>		</pre>

Line 16:		Line 16:

	Optional; The name of the code to execute or the function to call when the key is pressed. Leave blank to unset a previous hotkey.		Optional; The name of the code to execute or the function to call when the key is pressed. Leave blank to unset a previous hotkey.
		+
		+	==== param var ====
		+
		+	Optional; A variable to pass inside the hotkey this variable will become $Param this is most useful for attaching a class to the hotkey so you can access its variables, functions natively.

	=== Return Value ===		=== Return Value ===

−	Success: Returns 1.	+	Success: Returns true.

−	Failure: Returns 0.	+	Failure: Returns false.

	=== Remarks ===		=== Remarks ===
Line 145:		Line 149:
	// Keep the GUI running as long as long as the window is open		// Keep the GUI running as long as long as the window is open
	While ( GUIStatus( $GUI ) ) DoEvents( );		While ( GUIStatus( $GUI ) ) DoEvents( );
		+	</syntaxhighlight>
		+
		+	Using the param var
		+
		+	<syntaxhighlight lang="sputnik">
		+	Class Test
		+	{
		+	Function __Construct()
		+	{
		+	HotKeySet("a", '$param->foo();', $this);
		+	}
		+	Function foo()
		+	{
		+	say "foo";
		+	}
		+	};
		+
		+	new Test();
		+
		+	while()
		+	doEvents();
	</syntaxhighlight>		</syntaxhighlight>

	[[Category:Core Function]]		[[Category:Core Function]]

UberFoX: /* Example */

2012-03-28T09:37:33Z

Example

← Older revision		Revision as of 09:37, 28 March 2012
Line 111:		Line 111:

	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">
−	$GUI = GUICreate("~~mooooo~~", ~~200~~, ~~200~~);	+	// Create the MDI GUI
−	~~GUISetState~~($GUI~~, @Show~~);	+	$GUI = GUICreate("Window", "GUI", 800, 600);
−	$B1 = ~~GUICreateButton~~($GUI~~, "mybutton"~~, "PRESS ME!!!", 8, 8);	+	// Show the MDI GUI
−	GUILink($B1, ~~@lClick~~, 'msgbox("Hello World!");');	+	GUILoad( $GUI );
		+
		+	$B1 = GUICreate("Button", $GUI, "PRESS ME!!!", 8, 8);
		+	GUILink($B1, "Click", 'msgbox("Hello World!");');

	HotKeySet("+!d", "myfunction();"); //Shift-Alt-d		HotKeySet("+!d", "myfunction();"); //Shift-Alt-d

−	~~Until~~ ( ~~GUIState~~( $GUI ) ~~== @sClosed~~ ) DoEvents();	+	// Keep the GUI running as long as long as the window is open
		+	While ( GUIStatus( $GUI ) ) DoEvents( );

	Function myfunction()		Function myfunction()
Line 129:		Line 133:

	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">
−	$GUI = GUICreate("~~mooooo~~", ~~200~~, ~~200~~);	+	// Create the MDI GUI
−	~~GUISetState~~($GUI~~, @Show~~);	+	$GUI = GUICreate("Window", "GUI", 800, 600);
−	$B1 = ~~GUICreateButton~~($GUI~~, "mybutton"~~, "PRESS ME!!!", 8, 8);	+	// Show the MDI GUI
−	GUILink($B1, ~~@lClick~~, 'msgbox("Hello World!");');	+	GUILoad( $GUI );
		+
		+	$B1 = GUICreate("Button", $GUI, "PRESS ME!!!", 8, 8);
		+	GUILink($B1, "Click", 'msgbox("Hello World!");');

	HotKeySet("+!d", 'println("Hello from the HOTKEY\n");'); //Shift-Alt-d		HotKeySet("+!d", 'println("Hello from the HOTKEY\n");'); //Shift-Alt-d

−	~~Until~~ ( ~~GUIState~~( $GUI ) ~~== @sClosed~~ ) DoEvents();	+	// Keep the GUI running as long as long as the window is open
		+	While ( GUIStatus( $GUI ) ) DoEvents( );
	</syntaxhighlight>		</syntaxhighlight>

	[[Category:Core Function]]		[[Category:Core Function]]

UberFoX: /* Remarks */

2012-03-28T09:36:09Z

Remarks

← Older revision		Revision as of 09:36, 28 March 2012
Line 59:		Line 59:

	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">
−	$GUI = GUICreate("~~mooooo~~", ~~200~~, ~~200~~);	+	// Create the MDI GUI
−	~~GUISetState~~($GUI~~, @Show~~);	+	$GUI = GUICreate("Window", "GUI", 800, 600);
−	$B1 = ~~GUICreateButton~~($GUI~~, "mybutton"~~, "PRESS ME!!!", 8, 8);	+	// Show the MDI GUI
−	GUILink($B1, ~~@lClick~~, 'msgbox("Hello World!");');	+	GUILoad( $GUI );
		+
		+	$B1 = GUICreate("Button", $GUI, "PRESS ME!!!", 8, 8);
		+	GUILink($B1, "Click", 'msgbox("Hello World!");');

	HotKeySet("a", "lol();");		HotKeySet("a", "lol();");
	HotKeySet("b", "lol2();");		HotKeySet("b", "lol2();");

−	~~Until~~ ( ~~GUIState~~( $GUI ) ~~== @sClosed~~ ) DoEvents();	+	// Keep the GUI running as long as long as the window is open
		+	While ( GUIStatus( $GUI ) ) DoEvents( );

	Function lol()		Function lol()
Line 76:		Line 80:
	HotKeySet("a", "lol();");		HotKeySet("a", "lol();");
	}		}
−		+
	Function lol2()		Function lol2()
	{		{

UberFoX: /* Remarks */

2012-03-28T09:34:42Z

Remarks

← Older revision		Revision as of 09:34, 28 March 2012
Line 25:		Line 25:
	=== Remarks ===		=== Remarks ===

−	Up to 64 simultaneous hotkeys per script may be registered.	+	There is no limit to simultaneous hotkeys per script that may be registered.

−	If two ~~AutoIt~~ scripts set the same HotKeys, you should avoid running those scripts simultaneously. (The second script cannot capture the hotkey unless the first script terminates or unregisters the key prior to the second script setting the hotkey.)	+	If two Sputnik scripts set the same HotKeys, you should avoid running those scripts simultaneously. (The second script cannot capture the hotkey unless the first script terminates or unregisters the key prior to the second script setting the hotkey.)

	Hotkeys can run at the same time as other hotkeys and even other functions.		Hotkeys can run at the same time as other hotkeys and even other functions.

UberFoX: /* Example */

2011-12-02T20:42:54Z

Example

← Older revision		Revision as of 20:42, 2 December 2011
Line 87:		Line 87:

	=== Example ===		=== Example ===
		+
		+	WARNING: To use hotkeys without a GUI you must still have a DoEvents() loop in your script somewhere example
		+
		+	<syntaxhighlight lang="sputnik">
		+	// Make some hotkeys
		+	HotKeySet("a", "Println('You pressed A');");
		+	HotKeySet("b", "Println('You pressed B');");
		+	HotKeySet("c", "Println('You pressed C');");
		+
		+	// A loop to keep your script running AND to check for hotkeys
		+	While ( true )
		+	{
		+	DoEvents(); //Without DoEvents() Sputnik wont know if a hotkey was pressed or not
		+	}
		+	// In GUI programs you dont really need to think about this problem
		+	// Since you use the DoEvents() to keep your GUI working anyway
		+	</syntaxhighlight>
		+

	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">

UberFoX: /* Example */

2011-11-29T20:33:28Z

Example

← Older revision		Revision as of 20:33, 29 November 2011
Line 102:		Line 102:
	println("Hello from the HOTKEY\n");		println("Hello from the HOTKEY\n");
	}		}
		+	</syntaxhighlight>
		+
		+	Of course you can make a hotkey execute code directly example:
		+
		+	<syntaxhighlight lang="sputnik">
		+	$GUI = GUICreate("mooooo", 200, 200);
		+	GUISetState($GUI, @Show);
		+	$B1 = GUICreateButton($GUI, "mybutton", "PRESS ME!!!", 8, 8);
		+	GUILink($B1, @lClick, 'msgbox("Hello World!");');
		+
		+	HotKeySet("+!d", 'println("Hello from the HOTKEY\n");'); //Shift-Alt-d
		+
		+	Until ( GUIState( $GUI ) == @sClosed ) DoEvents();
	</syntaxhighlight>		</syntaxhighlight>

	[[Category:Core Function]]		[[Category:Core Function]]

UberFoX at 12:14, 26 November 2011

2011-11-26T12:14:27Z

← Older revision		Revision as of 12:14, 26 November 2011
Line 6:		Line 6:

	Create a custom hotkey to run custom code or execute a function		Create a custom hotkey to run custom code or execute a function
		+
		+	=== Parameters ===

	==== keydef ====		==== keydef ====

UberFoX: /* Remarks */

2011-11-26T10:23:34Z

Remarks

← Older revision		Revision as of 10:23, 26 November 2011
Line 51:		Line 51:
	SendKeys("{Esc}");		SendKeys("{Esc}");
	HotKeySet("{Esc}", "captureEsc();");		HotKeySet("{Esc}", "captureEsc();");
		+	}
		+	</syntaxhighlight>
		+
		+	This example shows how to get a and b to still type despite being hotkeyed :
		+
		+	<syntaxhighlight lang="sputnik">
		+	$GUI = GUICreate("mooooo", 200, 200);
		+	GUISetState($GUI, @Show);
		+	$B1 = GUICreateButton($GUI, "mybutton", "PRESS ME!!!", 8, 8);
		+	GUILink($B1, @lClick, 'msgbox("Hello World!");');
		+
		+	HotKeySet("a", "lol();");
		+	HotKeySet("b", "lol2();");
		+
		+	Until ( GUIState( $GUI ) == @sClosed ) DoEvents();
		+
		+	Function lol()
		+	{
		+	println("moo");
		+	HotKeySet("a");
		+	SendKeys("a");
		+	HotKeySet("a", "lol();");
		+	}
		+
		+	Function lol2()
		+	{
		+	println("moo");
		+	HotKeySet("b");
		+	SendKeys("b");
		+	HotKeySet("b", "lol2();");
	}		}
	</syntaxhighlight>		</syntaxhighlight>