Auto arg - Revision history

Pyadmin: 2 revisions

2014-03-28T01:48:53Z

2 revisions

Speleo3: More Examples

2012-10-18T07:16:29Z

More Examples

TakanoriNakane: Created page with "cmd.auto_arg controls auto-completion of command arguments in PyMOL's command line. It is an array of dictionaries.When Pymol's console attempts to auto-complete the ''n''-th..."

2012-08-21T15:04:58Z

Created page with "cmd.auto_arg controls auto-completion of command arguments in PyMOL's command line. It is an array of dictionaries.When Pymol's console attempts to auto-complete the ''n''-th..."

New page

cmd.[[auto_arg]] controls auto-completion of command arguments in PyMOL's command line. It is an array of dictionaries.When Pymol's console attempts to auto-complete the ''n''-th argument of command ''abc'', it will look at cmd.auto_arg[n]['abc'] (''n'' starts from 0). This is a list with three elements.

# The first element is a lambda function which returns an Shortcut object. Shortcut object wraps the list of candidate strings, given to its constructor.
# The second element is a string, which describs the argument.
# The third element is a string, which will be added after autocompletion (postfix).

===PYTHON EXAMPLE===

<source lang="python">
cmd.auto_arg[0]['test']=[lambda: cmd.Shortcut(['abc','bcd']), '1st argument', ', ']
</source>

This code defines the auto-completion list for the first argument of command
''test''. When you type 'test ' and press TAB, PyMOL will show you two candidates as:

<nowiki>parser: matching 1st argument:
abc bcd </nowiki>

If you type 'a' and press TAB again, PyMOL will complete it to "test abc, ". Note that ', ' is added.

===Pre-defined lambdas===

In most cases, you just want to complete from object names or setting lists. Then you don't have to write your own lambda function. Just use '''cmd.object_sc''' for choosing from objects.

<source lang="python">cmd.auto_arg[0]['test'] = [ cmd.object_sc, 'object', '']</source>

Use '''cmd.selection_sc''' for setting names (like 'line_width'), '''cmd.map_sc''' for maps and '''cmd.repres_sc''' for representations ('sticks', 'lines', etc).

===SEE ALSO===
*[[extend]]
*parser.py, cmd.py, shortcut.py

[[Category:Scripting]]

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

@@ Line 1: / Line 1: @@
-cmd.[[auto_arg]] controls auto-completion of command arguments in PyMOL's command line. It is an array of dictionaries.When Pymol's console attempts to auto-complete the ''n''-th argument of command ''abc'', it will look at cmd.auto_arg[n]['abc'] (''n'' starts from 0). This is a list with three elements.
+cmd.[[auto_arg]] controls auto-completion of command arguments in PyMOL's command line. It is an array of dictionaries. When Pymol's console attempts to auto-complete the ''n''-th argument of command ''abc'', it will look at <code>cmd.auto_arg[n]['abc']</code> (''n'' starts from 0). This is a list with three elements. For arguments which do not have an entry in cmd.auto_arg, the default is to auto-complete file names.
 # The first element is a lambda function which returns an Shortcut object. Shortcut object wraps the list of candidate strings, given to its constructor.
@@ Line 5: / Line 5: @@
 # The third element is a string, which will be added after autocompletion (postfix).
-===PYTHON EXAMPLE===
+== PYTHON EXAMPLE ==
 <source lang="python">
@@ Line 19: / Line 19: @@
 If you type 'a' and press TAB again, PyMOL will complete it to "test abc, ". Note that ', ' is added.
-===Pre-defined lambdas===
+== Pre-defined lambdas ==
 In most cases, you just want to complete from object names or setting lists. Then you don't have to write your own lambda function. Just use '''cmd.object_sc''' for choosing from objects.
 <source lang="python">cmd.auto_arg[0]['test'] = [ cmd.object_sc, 'object', '']</source>
 Use '''cmd.selection_sc''' for setting names (like 'line_width'), '''cmd.map_sc''' for maps and '''cmd.repres_sc''' for representations ('sticks', 'lines', etc).
-===SEE ALSO===
+== More Examples ==
 *[[extend]]
-*parser.py, cmd.py, shortcut.py
+*parser.py, cmd.py, shortcut.py, completing.py
 [[Category:Scripting]]