Check Key - Revision history

Pyadmin: 7 revisions

2014-03-28T01:49:14Z

7 revisions

Slaw at 13:54, 19 March 2013

2013-03-19T13:54:58Z

Slaw at 04:16, 25 May 2010

2010-05-25T04:16:31Z

Slaw at 04:06, 25 May 2010

2010-05-25T04:06:52Z

Slaw at 04:05, 25 May 2010

2010-05-25T04:05:42Z

Slaw: moved Check key to Check Key: Case sensitive title

2010-05-25T03:51:19Z

moved Check key to Check Key: Case sensitive title

Slaw at 03:50, 25 May 2010

2010-05-25T03:50:46Z

Slaw: Created page with '===DESCRIPTION=== A simple script used to check if a given key is valid for for the set_key command. This is useful when the user would like to use a keyboard key as short…'

2010-05-25T03:49:27Z

Created page with '===DESCRIPTION=== A simple script used to check if a given key is valid for for the set_key command. This is useful when the user would like to use a keyboard key as short…'

New page

===DESCRIPTION===

A simple script used to check if a given key is valid for for the [[set_key]] command. This is useful when the user would like to use a keyboard key as shortcut/hotkey in their script but need to check if the key is a valid one.

===USAGE===

load the script using the [[run]] command

<source lang="python">
check_key (keystroke)
</source>

If the key specified is a valid one as defined in [[set_key]] then it returns the value of the keystroke. Otherwise, it returns None.

For an example that calls this script, see [[jump]].

===PyMOL API===

<source lang="python">
from pymol import cmd
import re

allowed_keys=re.compile('(F1|F2|left|right|pgup|pgdn|home|insert|(CTRL-[A-Z])|ALT-[A-Z0-9])')

def check_key (keystroke):
keystroke=keystroke.strip('\"\'')
out=allowed_keys.search(keystroke)

if (out != None):
return keystroke
else:
print "Error: Invalid key \""+keystroke+"\""
print "Valid Keys: F1, F2, left, right, pdup, pgdn, home, insert"
print " CTRL-A to CTRL-Z"
print " ALT-0 to ALT-9, ALT-A to ALT-Z"
return
cmd.extend("check_key", check_key)
</source>

===SEE ALSO===
[[Button]] [[Set Key]]

@@ Line 1: / Line 1: @@
 ===DESCRIPTION===
@@ Line 26: / Line 33: @@
      """
-     Author Sean Law
+     Author Sean M. Law
-     Michigan State University
+     University of Michigan
-     slaw_(at)_msu_dot_edu
+     seanlaw_(at)_umich_dot_edu
      """

@@ Line 25: / Line 25: @@
 def check_key (keystroke):
-     #Author Sean Law
+     """
-     #Michigan State University
+    Author Sean Law
-     #slaw_(at)_msu_dot_edu
+     Michigan State University
      keystroke=keystroke.strip('\"\'')

← Older revision		Revision as of 04:06, 25 May 2010
Line 45:		Line 45:
	===SEE ALSO===		===SEE ALSO===
	[[Button]] [[Set Key]]		[[Button]] [[Set Key]]
		+
		+	[[Category:Script_Library]]

← Older revision	Revision as of 01:49, 28 March 2014
(No difference)

← Older revision	Revision as of 03:51, 25 May 2010
(No difference)

@@ Line 1: / Line 1: @@
 ===DESCRIPTION===
-A simple script used to check if a given key is valid for for the [[set_key]] command.  This is useful when the user would like to use a keyboard key as shortcut/hotkey in their script but need to check if the key is a valid one.
+A simple script used to check if a given key is valid for for the [[Set Key]] command.  This is useful when the user would like to use a keyboard key as shortcut/hotkey in their script but need to check if the key is a valid one.
 ===USAGE===
@@ Line 11: / Line 11: @@
 </source>
-If the key specified is a valid one as defined in [[set_key]] then it returns the value of the keystroke.  Otherwise, it returns None.
+If the key specified is a valid one as defined in [[Set Key]] then it returns the value of the keystroke.  Otherwise, it returns None.
-For an example that calls this script, see [[jump]].
+For an example that calls this script, see [[Jump]].
 ===PyMOL API===