Home » Support » Index of All Documentation » Wing IDE Reference Manual »

17. Command Reference

This chapter describes the entire top-level command set of Wing IDE. Use this reference to look up command names for use in modified keyboard bindings.

Top Level Commands

These are the top-level application commands.

abandon-changes (confirm=True)

Abandon any changes in the current document and reload it from disk. Prompts for user to confirm the operation unless either there are no local changes being abandoned or confirm is set to False.

about-application ()

Show the application-wide about box

begin-visited-document-cycle (move_back=True)

Start moving between documents in the order they were visited. Starts modal key interation that ends when a key other than tab is seen or ctrl is released.

check-for-updates ()

Check for updates to Wing IDE and offer to install any that are available

close (ignore_changes=False, close_window=False)

Close active document. Abandon any changes when ignore_changes is True. Close empty windows and quit if all document windows closed when close_window is True.

close-all (omit_current=False, ignore_changes=False, close_window=False)

Close all documents in the current window, or in all windows if in one-window-per-editor windowing policy. Leave currently visible documents (or active window in one-window-per-editor-mode) if omit_current is True. Abandons changes rather than saving them when ignore_changes is True. Close empty window and quit if all document windows closed when close_window is True.

close-window ()

Close the current window and all documents and panels in it

command-by-name (command_name)

Execute given command by name, collecting any args as needed

copy-tutorial ()

Prompt user and copy the tutorial directory from the Wing IDE installation to the directory selected by the user

edit-file-sets ()

Show the File Sets preference editor

edit-preferences-file ()

Edit the preferences as a text file

execute-cmd (cmd)

Execute the given command line silently in the background (this is legacy code; use run_process instead)

execute-file (loc=None)

Execute the file at the given location or use the active view if loc is None.

execute-os-command (title)

Execute one of the stored commands in the OS Commands tool, selecting it by its title

execute-os-command-by-id (id)

Execute one of the stored commands in the OS Commands tool, selecting it by its internal ID

execute-process (cmd_line)

Execute the given command line in the OS Commands tool using default run directory and environment as defined in project properties, or the values set in an existing command with the same command line in the OS Commands tool.

goto-bookmark (mark)

Goto named bookmark

hide-line-numbers ()

Hide line numbers in editors

initiate-numeric-modifier (digit)

VI style repeat/numeric modifier for following command

initiate-repeat ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke.

initiate-repeat-0 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke.

initiate-repeat-1 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke.

initiate-repeat-2 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke.

initiate-repeat-3 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke.

initiate-repeat-4 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke.

initiate-repeat-5 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke.

initiate-repeat-6 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke.

initiate-repeat-7 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke.

initiate-repeat-8 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke.

initiate-repeat-9 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke.

internal-profile-start ()

Start internal profiling.

internal-profile-stop ()

Stop internal profiling.

new-blank-file (filename)

Create a new blank file on disk, open it in an editor, and add it to the current project.

new-document-window ()

Create a new document window with same documents and panels as in the current document window (if any; otherwise empty with default panels)

new-file (ext='.py')

Create a new file

new-panel-window (panel_type=None)

Create a new panel window of given type

next-document ()

Move to the next document alphabetically in the list of documents open in the current window

next-window ()

Switch to the next window alphabetically by title

nth-document (n=<command.commandmgr.kArgNumericModifier instance at 0xb6a0b40c>)

Move to the nth document alphabetically in the list of documents open in the current window

open (filename)

Open a file from disk using keyboard-driven selection of the file

open-by-fragment (document_name)

Open a document from the project by typing a fragment of its name

open-from-keyboard (filename)

Open a file from disk using keyboard-driven selection of the file

open-gui (filename=None)

Open a file from disk, prompting with file selection dialog if necessary

previous-document ()

Move to the previous document alphabetically in the list of documents open in the current window

previous-window ()

None

query-end-session ()

Process query-end-session message on win32

quit ()

Quit the application.

recent-document ()

Switches to previous document most recently visited in the current window or window set if in one-window-per-editor windowing mode.

reload-scripts ()

Force reload of all scripts, from all configured script directories. This is usually only needed when adding a new script file. Existing scripts are automatically reloaded when they change on disk.

remove-bookmark (mark)

Remove the given named bookmark

restore-default-tools ()

Hide/remove all tools and restore to original default state

save (close=False, force=False)

Save active document. Also close it if close is True.

save-all (close_window=False)

Save all unsaved items. Will prompt the user only for choosing names for new items that don't have a set filename

save-as ()

Save active document to a new file

scratch-document (title='Scratch', mime_type='text/plain')

Create a new scratch buffer with given title and mime type. The buffer is never marked as changed but can be saved w/ save-as.

set-bookmark (mark)

Set a bookmark at current location on the editor. Mark is the project-wide textual name of the bookmark.

show-bookmarks ()

Show a list of all currently defined bookmarks

show-bug-report-dialog ()

Show the bug reporting dialog

show-document (section='manual')

Show the given documentation section

show-feedback-dialog ()

Show the feedback submission dialog

show-howtos ()

Show the How-Tos index

show-html-document (section='manual')

Show the given document section in HTML format.

show-line-numbers (show=1)

Show the line numbers in editors

show-manual-html ()

Show the HTML version of the Wing IDE users manual

show-manual-pdf ()

Show the PDF version of the Wing IDE users manual for either US Letter or A4, depending on user's print locale

show-panel (panel_type, flash=True)

Show most recently visited panel instance of given type If no such panel exists, add one to the primary window and show it. Returns the panel view object or None if not shown.

show-pdf-document (doc='manual')

Show the given document in PDF format. One of 'manual', 'intro', or 'howtos'.

show-preferences-gui (prefname=None)

Edit the preferences file using the preferences GUI, optionally opening to the section that contains the given preference by name

show-python-for-beginners-html ()

Show the Python for Beginners web page

show-python-introductions-html ()

Show the Python Introductions web page

show-python-manual-html ()

Show the HTML version of the Python users manual

show-python-org-html ()

Show the python.org site home page

show-python-org-search-html ()

Show the python.org site search page

show-quickstart ()

Show the quick start guide

show-success-stories-html ()

Show the Python Success Stories page

show-support-html ()

Show the Wing IDE support site home page

show-text-registers ()

Show the contents of all non-empty text registers in a temporary editor

show-tutorial ()

Show the tutorial

show-wingtip (section='/')

Show the Wing Tips window

show-wingware-website ()

Show the Wingware home page

switch-document (document_name)

Switches to named document. Name may either be the complete name or the last path component of a path name.

toolbar-search (text, next=False, set_anchor=True)

Search using text entered in toolbar search area from the current cursor or selection position

toolbar-search-next (text, set_anchor=True)

Move to next match of text entered in the toolbar search area

vi-goto-bookmark ()

Goto bookmark using single character name defined by the next pressed key

vi-set-bookmark ()

Set a bookmark at current location on the editor using the next key press as the name of the bookmark.

wing-tips ()

Display interactive tip manager

write-changed-file-and-close (filename)

Write current document to given location only if it contains any changes and close it. Writes to current file name if given filename is None.

write-file (filename)

Write current file to a new location.

write-file-and-close (filename)

Write current document to given location and close it. Saves to current file name if the given filename is None.

Dock Window Commands

Commands for windows that contain dockable tool areas. These are available for the currently active window, if any.

enter-fullscreen ()

Hide both the vertical and horizontal tool areas and toolbar, saving previous state so it can be restored later with exit_fullscreen

exit-fullscreen ()

Restore previous non-fullscreen state of all tools and tool bar

hide-horizontal-tools ()

Hide the horizontal tool area

hide-vertical-tools ()

Hide the vertical tool area

minimize-horizontal-tools ()

Minimize the horizontal tool area

minimize-vertical-tools ()

Minimize the vertical tool area

show-horizontal-tools ()

Show the horizontal tool area

show-vertical-tools ()

Show the vertical tool area

toggle-horizontal-tools ()

Show or minimize the horizontal tool area

toggle-vertical-tools ()

Show or minimize the vertical tool area

Document Viewer Commands

Commands for the documentation viewer. These are available when the documentation viewer has the keyboard focus.

document-back ()

Go back to prior document page in history of pages that have been viewed

document-contents ()

Go to the document contents page

document-forward ()

Go forward to next document page in history of pages that have been viewed

document-next ()

Go to the next page in the current document

document-previous ()

Go to the previous page in the current document

isearch-backward (search_string=None, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb6abe56c>)

Initiate incremental mini-search backward from the cursor position, optionally entering the given search string.

isearch-backward-regex (search_string=None, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb6abe8ac>)

Initiate incremental regular expression mini-search backward from the cursor position, optionally entering the given search string.

isearch-forward (search_string=None, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb6a95a8c>)

Initiate incremental mini-search forward from the cursor position, optionally entering the given search string.

isearch-forward-regex (search_string=None, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb6abe88c>)

Initiate incremental regular expression mini-search forward from the cursor position, optionally entering the given search string.

isearch-repeat (reverse=False, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb6abe86c>)

Repeat the most recent isearch, using same string and regex/text. Reverse direction when reverse is True.

isearch-sel-backward (persist=True, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb6abe5ac>)

Initiate incremental mini-search backward from the cursor position, using current selection as the search string. Set persist=False to do the search but end the interactive search session immediately.

isearch-sel-forward (persist=True, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb6abe4cc>)

Initiate incremental mini-search forward from the cursor position, using current selection as the search string. Set persist=False to do the search but end the interactive search session immediately.

repeat-search-char (opposite=0, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb6abe16c>)

Repeat the last search_char operation, optionally in the opposite direction.

search-char (dir=1, pos=0, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb6abe14c>, single_line=0)

Search for the given character. Searches to right if dir > 0 and to left if dir < 0. Optionally place cursor pos characters to left or right of the target (e.g., use -1 to place one to left). If repeat > 1, the Nth match is found. Set single_line=1 to search only within the current line.

Editor Browse Mode Commands

Commands available only when the editor is in browse mode (used for VI bindings and possibly others)

enter-insert-mode (pos='before')

Enter editor insert mode

enter-replace-mode ()

Enter editor replace mode

enter-visual-mode (unit='char')

Enter editor visual mode. Unit should be one of 'char', 'line', or 'block'.

start-select-block ()

Turn on auto-select block mode

start-select-char ()

Turn on auto-select mode character by character

start-select-line ()

Turn on auto-select mode line by line

vi-command-by-name ()

Execute a VI command (implements ":" commands from VI)

vi-ctrl-c ()

Perform vi mode ctrl-c action which either does a copy or nothing if ctrl-x/v/c are not being used for clipboard actions. The default is to map ctrl-c to clipboard on Windows and OS X. This can be overridden by the VI Mode Ctrl-X/C/V preference.

vi-ctrl-v ()

Perform vi mode ctrl-v action which either does a paste or does start-select-block. The default is to map ctrl-v to clipboard on Windows and OS X. This can be overridden by the VI Mode Ctrl-X/C/V preference.

vi-ctrl-x ()

Perform vi mode ctrl-x action which either does a cut or does initiate-numeric-modified with the following digit key press. The default is to map ctrl-x to clipboard on Windows and OS X. This can be overridden by the VI Mode Ctrl-X/C/V preference.

Editor Insert Mode Commands

Commands available only when editor is in insert mode (used for VI bindings and possibly others)

enter-browse-mode (provisional=False)

Enter editor browse mode

vi-ctrl-c ()

Perform vi mode ctrl-c action which either does a copy or enters browse mode if ctrl-x/v/c are not being used for clipboard actions. The default is to map ctrl-c to clipboard on Windows and OS X. This can be overridden by the VI Mode Ctrl-X/C/V preference.

vi-ctrl-v ()

Perform vi mode ctrl-v action which either does a paste or does start-select-block. The default is to map ctrl-v to clipboard on Windows and OS X. This can be overridden by the VI Mode Ctrl-X/C/V preference.

vi-ctrl-x ()

Perform vi mode ctrl-x action which either does a cut or nothing depending on whether ctrl-x/v/c are mapped to clipboard actions. The default is to map ctrl-x to clipboard on Windows and OS X. This can be overridden by the VI Mode Ctrl-X/C/V preference.

Editor Non Modal Commands

Commands available only when the editor is in non-modal editing mode

exit-visual-mode ()

None

start-select-block ()

Turn on auto-select block mode

start-select-char ()

Turn on auto-select mode character by character

start-select-line ()

Turn on auto-select mode line by line

Editor Panel Commands

Commands that control splitting up an editor panel. These are available when one split in the editor panel has the keyboard focus.

split-horizontally (new=0)

Split current view horizontally.

split-horizontally-open-file (filename)

Split current view horizontally and open selected file

split-vertically (new=0)

Split current view vertically. Create new editor in new view when new==1.

split-vertically-open-file (filename)

Split current view vertically and open selected file

unsplit (action='current')

Unsplit all editors so there's only one. Action specifies how to choose the remaining displayed editor. One of:

current -- Show current editor
close   -- Close current editor before unsplitting
recent  -- Change to recent buffer before unsplitting
recent-or-close -- Change to recent buffer before closing
split, or close the current buffer if there is only
one split left.

NOTE: The parameters for this command are subject to change in the future.

Editor Replace Mode Commands

Commands available only when editor is in replace mode (used for VI bindings and possibly others)

enter-browse-mode (provisional=False)

Enter editor browse mode

Editor Split Commands

Commands for a particular editor split, available when the editor in that split has the keyboard focus. Additional commands affecting the editor's content are defined separately.

activate-file-option-menu ()

Activate the file menu for the editor.

grow-split-horizontally ()

Increase width of this split

grow-split-vertically ()

Increase height of this split

next-bookmark ()

Move forward to next auto-bookmarked editor position

previous-bookmark ()

Move back to previous auto-bookmarked editor position

shrink-split-horizontally ()

Decrease width of this split

shrink-split-vertically ()

Decrease height of this split

Editor Visual Mode Commands

Commands available only when the editor is in visual mode (used for VI bindings and some others)

enter-browse-mode ()

Enter editor browse mode

enter-insert-mode (pos='delete-sel')

Enter editor insert mode

enter-visual-mode (unit='char')

Alter type of editor visual mode or exit back to browse mode. Unit should be one of 'char', 'line', or 'block'.

exit-visual-mode ()

Exit visual mode and return back to default mode

vi-command-by-name ()

Execute a VI command (implements ":" commands from VI)

Global Documentation Commands

Commands for the documentation viewer. These are available when the documentation viewer has the keyboard focus.

document-search (txt=None)

Search all documentation.

Toolbar Search Commands

Commands available when the tool bar search entry area has the keyboard focus.

backward-char ()

Move backward one character

backward-char-extend ()

Move backward one character, extending the selection

backward-delete-char ()

Delete character behind the cursor

backward-delete-word ()

Delete word behind the cursor

backward-word ()

Move backward one word

backward-word-extend ()

Move backward one word, extending the selection

beginning-of-line ()

Move to the beginning of the toolbar search entry

beginning-of-line-extend ()

Move to the beginning of the toolbar search entry, extending the selection

copy ()

Cut selection

cut ()

Cut selection

end-of-line ()

Move to the end of the toolbar search entry

end-of-line-extend ()

Move to the end of the toolbar search entry, extendning the selection

forward-char ()

Move forward one character

forward-char-extend ()

Move forward one character, extending the selection

forward-delete-char ()

Delete character in front of the cursor

forward-delete-word ()

Delete word in front of the cursor

forward-word ()

Move forward one word

forward-word-extend ()

Move forward one word, extending the selection

paste ()

Paste from clipboard

Window Commands

Commands for windows in general. These are available for the currently active window, if any.

move-editor-focus (dir=1, wrap=True)

Move focus to next or previous editor split, optionally wrapping when the end is reached.

move-editor-focus-first ()

Move focus to first editor split

move-editor-focus-last ()

Move focus to last editor split

move-editor-focus-previous ()

Move focus to last editor split

move-focus ()

None

Wing Tips Commands

Commands for the Wing Tips tool. These are only available when the tool is visible and has focus

wingtips-close ()

Close the Wing Tips window

wingtips-contents ()

Got to the Wing Tips contents page

wingtips-next ()

Got to the next page in Wing Tips

wingtips-next-unseen ()

Got to a next unseen Wing Tips page

wingtips-previous ()

Got to the previous page in Wing Tips

Active Editor Commands

Commands that only apply to editors when they have the keyboard focus. These commands are also available for the Python Shell, Debug Probe, and Debug I/O tools, which subclass the source editor, although some of the commands are modified or disabled as appropriate in those contexts.

activate-symbol-option-menu-1 ()

Activate the 1st symbol menu for the editor.

activate-symbol-option-menu-2 ()

Activate the 2nd symbol menu for the editor.

activate-symbol-option-menu-3 ()

Activate the 3rd symbol menu for the editor.

activate-symbol-option-menu-4 ()

Activate the 4th symbol menu for the editor.

backward-char (wrap=1, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642986c>)

Move cursor backward one character

backward-char-extend (wrap=1, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb69ade4c>)

Move cursor backward one character, adjusting the selection range to new position

backward-char-extend-rect (wrap=1, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642dbac>)

Move cursor backward one character, adjusting the rectangular selection range to new position

backward-delete-char (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642de6c>)

Delete one character behind the cursor, or the current selection if not empty.

backward-delete-word (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d04c>)

Delete one word behind of the cursor

backward-page (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d5ac>)

Move cursor backward one page

backward-page-extend (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642da0c>)

Move cursor backward one page, adjusting the selection range to new position

backward-paragraph (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d38c>)

Move cursor backward one paragraph (to next all-whitespace line).

backward-paragraph-extend (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d36c>)

Move cursor backward one paragraph (to next all-whitespace line), adjusting the selection range to new position.

backward-tab ()

Outdent line at current position

backward-word (delimiters=None, gravity='start', repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d4ac>)

Move cursor backward one word. Optionally, provide a string that contains the delimiters to define which characters are part of a word. Gravity may be "start" or "end" to indicate whether cursor is placed at start or end of the word.

backward-word-extend (delimiters=None, gravity='start', repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d48c>)

Move cursor backward one word, adjusting the selection range to new position. Optionally, provide a string that contains the delimiters to define which characters are part of a word. Gravity may be "start" or "end" to indicate whether cursor is placed at start or end of the word.

beginning-of-line ()

Move to beginning of current line, or to the end of the leading white space if already at the beginning of the line.

beginning-of-line-extend ()

Move to beginning of current line, or to the end of the leading white space if already at the beginning of the line, adjusting the selection range to the new position.

beginning-of-line-text ()

Move to end of the leading white space, if any, on the current line, or to the beginning of the line if already at the end of the leading white space.

beginning-of-line-text-extend ()

Move to end of the leading white space, if any, on the current line, or to the beginning of the line if already at the end of the leading white space. The selection range is adjusted to the new position.

beginning-of-screen-line ()

Move to beginning of current wrapped line

beginning-of-screen-line-extend ()

Move to beginning of current wrapped line, extending selection

beginning-of-screen-line-text ()

Move to first non-blank character at beginning of current wrapped line

beginning-of-screen-line-text-extend ()

Move to first non-blank character at beginning of current wrapped line, extending selection

brace-match ()

Match brace at current cursor position, selecting all text between the two and hilighting the braces

cancel ()

Cancel current editor command

cancel-autocompletion ()

Cancel any active autocompletion.

case-lower (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d78c>)

Change case of the current selection, or character ahead of the cursor if there is no selection, to lower case

case-lower-next-move (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d96c>)

Change case of text spanned by next cursor movement to lower case

case-swap (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d88c>)

Change case of the current selection, or character ahead of the cursor if there is no selection, so each letter is the opposite of its current case

case-swap-next-move (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642dacc>)

Change case of text spanned by next cursor movement so each letter is the opposite of its current case

case-title (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d84c>)

Change case of the current selection, or character ahead of the cursor if there is no selection, to title case (first letter of each word capitalized)

case-title-next-move (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d9ac>)

Change case of text spanned by next cursor movement to title case (first letter of each word capitalized)

case-upper (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d6ac>)

Change case of the current selection, or character ahead of the cursor if there is no selection, to upper case

case-upper-next-move (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d92c>)

Change case of text spanned by next cursor movement to upper case

center-cursor ()

Scroll so cursor is centered on display

clear ()

Clear selected text

complete-autocompletion (append='')

Complete the current active autocompletion.

copy ()

Copy selected text

cursor-move-to-bottom (offset=<command.commandmgr.kArgNumericModifier instance at 0xb642de4c>)

Move cursor to bottom of display (without scrolling), optionally at an offset of given number of lines before bottom

cursor-move-to-center ()

Move cursor to center of display (without scrolling)

cursor-move-to-top (offset=<command.commandmgr.kArgNumericModifier instance at 0xb642dd0c>)

Move cursor to top of display (without scrolling), optionally at an offset of given number of lines below top

cursor-to-bottom ()

Scroll so cursor is centered at bottom of display

cursor-to-top ()

Scroll so cursor is centered at top of display

cut ()

Cut selected text

cut-line ()

Cut the current line(s) to clipboard.

delete-line (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d0ec>)

Delete the current line or lines when the selection spans multiple lines or given repeat is > 1

delete-line-insert (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d1ec>)

Delete the current line or lines when the selection spans multiple lines or given repeat is > 1. Enters insert mode (when working with modal key bindings).

delete-next-move (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d52c>)

Delete the text covered by the next cursor move command.

delete-next-move-insert (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d60c>)

Delete the text covered by the next cursor move command and then enter insert mode (when working in a modal editor key binding)

delete-range (start_line, end_line, register=None)

Delete given range of lines, copying them into given register (or currently selected default register if register is None

delete-to-end-of-line (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d30c>, post_offset=0)

Delete everything between the cursor and end of line

delete-to-end-of-line-insert (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d3ec>)

Delete everything between the cursor and end of line and enter insert move (when working in a modal editor key binding)

delete-to-start-of-line ()

Delete everything between the cursor and start of line

end-of-document ()

Move cursor to end of document

end-of-document-extend ()

Move cursor to end of document, adjusting the selection range to new position

end-of-line (count=<command.commandmgr.kArgNumericModifier instance at 0xb642948c>)

Move to end of current line

end-of-line-extend (count=<command.commandmgr.kArgNumericModifier instance at 0xb6429eec>)

Move to end of current line, adjusting the selection range to new position

end-of-screen-line (count=<command.commandmgr.kArgNumericModifier instance at 0xb6429ecc>)

Move to end of current wrapped line

end-of-screen-line-extend (count=<command.commandmgr.kArgNumericModifier instance at 0xb642958c>)

Move to end of current wrapped line, extending selection

exchange-point-and-mark ()

When currently marking text, this exchanges the current position and mark ends of the current selection

filter-next-move (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d64c>)

Filter the lines covered by the next cursor move command through an external command and replace the lines with the result

filter-range (cmd, start_line=0, end_line=-1)

Filter a range of lines in the editor through an external command and replace the lines with the result. Filters the whole file by default.

filter-selection (cmd)

Filter the current selection through an external command and replace the lines with the result

form-feed ()

Place a form feed character at the current cursor position

forward-char (wrap=1, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb64295ac>)

Move cursor forward one character

forward-char-extend (wrap=1, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642962c>)

Move cursor forward one character, adjusting the selection range to new position

forward-char-extend-rect (wrap=1, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb64295ec>)

Move cursor forward one character, adjusting the rectangular selection range to new position

forward-delete-char (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d56c>)

Delete one character in front of the cursor

forward-delete-char-insert (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d6ec>)

Delete one char in front of the cursor and enter insert mode (when working in modal key bindings)

forward-delete-char-within-line (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d44c>)

Delete one character in front of the cursor unless at end of line, in which case delete backward. Do nothing if the line is empty. This is VI style 'x' in browser mode.

forward-delete-word (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d4ec>)

Delete one word in front of the cursor

forward-delete-word-insert (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642dd4c>)

Delete one word in front of the cursor and enter insert mode (when working in modal key bindings)

forward-page (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d74c>)

Move cursor forward one page

forward-page-extend (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d18c>)

Move cursor forward one page, adjusting the selection range to new position

forward-paragraph (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d90c>)

Move cursor forward one paragraph (to next all-whitespace line).

forward-paragraph-extend (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642d8ec>)

Move cursor forward one paragraph (to next all-whitespace line), adjusting the selection range to new position.

forward-tab ()

Place a tab character at the current cursor position

forward-word (delimiters=None, gravity='start', repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642ddac>)

Move cursor forward one word. Optionally, provide a string that contains the delimiters to define which characters are part of a word. Gravity may be "start" or "end" to indicate whether cursor is placed at start or end of the word.

forward-word-extend (delimiters=None, gravity='start', repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642ddec>)

Move cursor forward one word, adjusting the selection range to new position. Optionally, rovide a string that contains the delimiters to define which characters are part of a word. Gravity may be "start" or "end" to indicate whether cursor is placed at start or end of the word.

hide-selection ()

Turn off display of the current text selection

indent-to-match ()

Indent the current line or selected region to match indentation of preceding non-blank line

indent-to-next-indent-stop ()

Indent to next indent stop from the current position. Acts like indent command if selection covers multiple lines.

isearch-backward (search_string=None, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb64298ac>)

Initiate incremental mini-search backward from the cursor position, optionally entering the given search string

isearch-backward-regex (search_string=None, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb6429c2c>)

Initiate incremental regular expression mini-search backward from the cursor position, optionally entering the given search string

isearch-forward (search_string=None, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642918c>)

Initiate incremental mini-search forward from the cursor position, optionally entering the given search string

isearch-forward-regex (search_string=None, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642982c>)

Initiate incremental regular expression mini-search forward from the cursor position, optionally entering the given search string

isearch-repeat (reverse=False, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb64291ac>)

Repeat the most recent isearch, using same string and regex/text. Reverse direction when reverse is True.

isearch-sel-backward (persist=True, whole_word=False, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb64296ec>)

Initiate incremental mini-search backward from the cursor position, using current selection as the search string. Set persist=False to do the search but end the interactive search session immediately.

isearch-sel-forward (persist=True, whole_word=False, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642930c>)

Initiate incremental mini-search forward from the cursor position, using current selection as the search string. Set persist=False to do the search but end the interactive search session immediately.

kill-line ()

Kill rest of line from cursor to end of line, and place it into the clipboard with any other contiguously removed lines. End-of-line is removed only if there is nothing between the cursor and the end of the line.

middle-of-screen-line ()

Move to middle of current wrapped line

middle-of-screen-line-extend ()

Move to middle of current wrapped line, extending selection

move-to-register (unit='char', cut=0, num=<command.commandmgr.kArgNumericModifier instance at 0xb640dd2c>)

Cut or copy a specified number of characters or lines, or the current selection. Set cut=1 to remove the range of text from the editor after moving to register (otherwise it is just copied). Unit should be one of 'char' or 'line' or 'sel' for current selection.

move-to-register-next-move (cut=0, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb6429dac>)

Move the text spanned by the next cursor motion to a register

new-line ()

Place a new line at the current cursor position

next-line (cursor='same', repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642952c>)

Move to screen next line, optionally repositioning character within line: 'same' to leave in same horizontal position, 'start' at start, 'end' at end, or 'fnb' for first non-blank char.

next-line-extend (cursor='same', repeat=<command.commandmgr.kArgNumericModifier instance at 0xb6429c4c>)

Move to next screen line, adjusting the selection range to new position, optionally repositioning character within line: same' to leave in same horizontal position, 'start' at start, 'end' at end, or 'fnb' for first non-blank char.

next-line-extend-rect (cursor='same', repeat=<command.commandmgr.kArgNumericModifier instance at 0xb6429fec>)

Move to next screen line, adjusting the rectangular selection range to new position, optionally repositioning character within line: same' to leave in same horizontal position, 'start' at start, 'end' at end, or 'fnb' for first non-blank char.

next-line-in-file (cursor='start', repeat=<command.commandmgr.kArgNumericModifier instance at 0xb64294cc>)

Move to next line in file, repositioning character within line: 'start' at start, 'end' at end, or 'fnb' for first non-blank char.

paste ()

Paste text from clipboard

paste-register (pos=1, indent=0, cursor=-1)

Paste text from register as before or after the current position. If the register contains only lines, then the lines are pasted before or after current line (rather than at cursor). If the register contains fragments of lines, the text is pasted over the current selection or either before or after the cursor. Set pos = 1 to paste after, or -1 to paste before. Set indent=1 to indent the pasted text to match current line. Set cursor=-1 to place cursor before lines or cursor=1 to place it after lines after paste completes.

previous-line (cursor='same', repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642946c>)

Move to previous screen line, optionally repositioning character within line: same' to leave in same horizontal position, 'start' at start, 'end' at end, or 'fnb' for first non-blank char.

previous-line-extend (cursor='same', repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642940c>)

Move to previous screen line, adjusting the selection range to new position, optionally repositioning character within line: same' to leave in same horizontal position, 'start' at start, 'end' at end, or 'fnb' for first non-blank char.

previous-line-extend-rect (cursor='same', repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642950c>)

Move to previous screen line, adjusting the rectangular selection range to new position, optionally repositioning character within line: same' to leave in same horizontal position, 'start' at start, 'end' at end, or 'fnb' for first non-blank char.

previous-line-in-file (cursor='start', repeat=<command.commandmgr.kArgNumericModifier instance at 0xb64295cc>)

Move to previous line in file, repositioning character within line: 'start' at start, 'end' at end, or 'fnb' for first non-blank char.

profile-editor-start ()

Turn on profiling for the current source editor

profile-editor-stop ()

Stop profiling and print stats to stdout

reanalyze-file ()

Rescan file for code analysis.

redo ()

Redo last action

repeat-command (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb64294ac>)

Repeat the last editor command

repeat-search-char (opposite=0, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb6429b8c>)

Repeat the last search_char operation, optionally in the opposite direction.

rstrip-each-line ()

Strip trailing whitespace from each line.

scroll-text-down (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642dc6c>, move_cursor=True)

Scroll text down a line w/o moving cursor's relative position on screen. Repeat is number of lines or if >0 and <1.0 then percent of screen. Set move_cursor to False to leave cursor in current position within the source, otherwise it is moved so the cursor remains on same screen line.

scroll-text-left (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642dc4c>)

Scroll text left a column w/o moving cursor's relative position on screen. Repeat is number of columns or if >0 and <1.0 then percent of screen.

scroll-text-page-down (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642dbcc>, move_cursor=True)

Scroll text down a page w/o moving cursor's relative position on screen. Repeat is number of pages or if >0 and <1.0 then percent of screen. Set move_cursor to False to leave cursor in current position within the source, otherwise it is moved so the cursor remains on same screen line.

scroll-text-page-up (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642db0c>, move_cursor=True)

Scroll text up a page w/o moving cursor's relative position on screen. Repeat is number of pages or if >0 and <1.0 then percent of screen. Set move_cursor to False to leave cursor in current position within the source, otherwise it is moved so the cursor remains on same screen line.

scroll-text-right (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642dccc>)

Scroll text right a column w/o moving cursor's relative position on screen. Repeat is number of columns or if >0 and <1.0 then percent of screen.

scroll-text-up (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642dc0c>, move_cursor=True)

Scroll text up a line w/o moving cursor's relative position on screen. Repeat is number of lines or if >0 and <1.0 then percent of screen. Set move_cursor to False to leave cursor in current position within the source, otherwise it is moved so the cursor remains on same screen line.

scroll-to-cursor ()

Scroll to current cursor position, if not already visible

search-char (dir=1, pos=0, repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642968c>, single_line=0)

Search for the given character. Searches to right if dir > 0 and to left if dir < 0. Optionally place cursor pos characters to left or right of the target (e.g., use -1 to place one to left). If repeat > 1, the Nth match is found. Set single_line=1 to search only within the current line.

select-all ()

Select all text in the editor

set-mark-command (unit='char')

Set start of text marking for selection at current cursor position. Subsequently, all cursor move operations will automatically extend the text selection until stop-mark-command is issued. Unit defines what is selected: can be one of char, line, or block (rectangle).

set-register ()

Set the register to use for subsequent cut/copy/paste operations

show-autocompleter ()

Show the auto-completer for current cursor position

show-selection ()

Turn on display of the current text selection

start-of-document ()

Move cursor to start of document

start-of-document-extend ()

Move cursor to start of document, adjusting the selection range to new position

stop-mark-command (deselect=True)

Stop text marking for selection at current cursor position, leaving the selection set as is. Subsequent cursor move operations will deselect the range and set selection to cursor position. Deselect immediately when deselect is True.

tab-key ()

Implement the tab key, the action of which is configurable by preference

undo ()

Undo last action

yank-line ()

Yank contents of kill buffer created with kill-line into the edit buffer

General Editor Commands

Editor commands that act on the current (most recently active) source editor, whether or not it currently has the keyboard focus.

check-indent-consistency ()

Check whether indents consistently use spaces or tabs throughout the file.

comment-out-region ()

Comment out the selected region

convert-indents-to-mixed (indent_size)

Convert all lines with leading spaces to mixed tabs and spaces.

convert-indents-to-spaces-only (indent_size)

Convert all lines containing leading tabs to spaces only.

convert-indents-to-tabs-only ()

Convert all indentation to use tab characters only and no spaces

evaluate-file-in-shell (restart_shell=None)

Run the contents of the editor within the Python Shell

evaluate-sel-in-shell (restart_shell=False, whole_lines=None)

Evaluate the current selection from the editor within the Python Shell tool, optionally restarting the shell first. When whole_lines is set, the selection is rounded to whole lines before evaluation. When unspecified (set to None), the setting from the Shell's Option menu is used instead.

execute-kbd-macro (register='a', repeat=<command.commandmgr.kArgNumericModifier instance at 0xb6d0b18c>)

Execute most recently recorded keyboard macro. If register is None then the user is asked to enter a letter a-z for the register where the macro is filed. Otherwise, register 'a' is used by default.

fill-paragraph ()

Attempt to auto-justify the paragraph around the current start of selection

fold-collapse-all ()

Collapse all fold points in the current file

fold-collapse-all-clicked ()

Collapse the clicked fold point completely

fold-collapse-all-current ()

Collapse the current fold point completely

fold-collapse-more-clicked ()

Collapse the clicked fold point one more level

fold-collapse-more-current ()

Collapse the current fold point one more level

fold-expand-all ()

Expand all fold points in the current file

fold-expand-all-clicked ()

Expand the clicked fold point completely

fold-expand-all-current ()

Expand the current fold point completely

fold-expand-more-clicked ()

Expand the clicked fold point one more level

fold-expand-more-current ()

Expand the current fold point one more level

fold-toggle ()

Toggle the current fold point

fold-toggle-clicked ()

Toggle the clicked fold point

force-indent-style-to-match-file ()

Force the indent style of the editor to match the indent style found in the majority of the file

force-indent-style-to-mixed ()

Force the indent style of the editor to mixed use of tabs and spaces, regardless of the file contents

force-indent-style-to-spaces-only ()

Force the indent style of the editor to use spaces only, regardless of file contents

force-indent-style-to-tabs-only ()

Force the indent style of the editor to use tabs only, regardless of file contents

goto-clicked-symbol-defn ()

Goto the definition of the source symbol that was last clicked on

goto-column (column=<command.commandmgr.kArgNumericModifier instance at 0xb6d0ba6c>)

Move cursor to given column

goto-line (lineno=<command.commandmgr.kArgNumericModifier instance at 0xb642df4c>)

Position cursor at start of given line number

goto-nth-line (lineno=<command.commandmgr.kArgNumericModifier instance at 0xb6d0bacc>, cursor='start')

Position cursor at start of given line number (1=first, -1 = last). This differs from goto-line in that it never prompts for a line number but instead uses the previously entered numeric modifier or defaults to going to line one. The cursor can be positioned at 'start', 'end', or 'fnb' for first non-blank character.

goto-nth-line-default-end (lineno=<command.commandmgr.kArgNumericModifier instance at 0xb6d0baac>, cursor='start')

Same as goto_nth_line but defaults to end of file if no lineno is given

goto-percent-line (percent=<command.commandmgr.kArgNumericModifier instance at 0xb6d0ba8c>, cursor='start')

Position cursor at start of line at given percent in file. This uses the previously entered numeric modifier or defaults to going to line one. The cursor can be positioned at 'start', 'end', or 'fnb' for first non-blank character, or in VI mode it will do brace matching operation to reflect how VI overrides this command.

goto-selected-symbol-defn ()

Goto the definition of the selected source symbol

hide-all-whitespace ()

Turn off all special marks for displaying white space and end-of-line

hide-eol ()

Turn off special marks for displaying end-of-line chars

hide-indent-guides ()

Turn off special marks for displaying indent level

hide-whitespace ()

Turn off special marks for displaying white space

indent-lines (num=<command.commandmgr.kArgNumericModifier instance at 0xb6d0b14c>)

Indent selected number of lines from cursor position

indent-next-move (num=<command.commandmgr.kArgNumericModifier instance at 0xb6d0b0ac>)

Indent lines spanned by next cursor move

indent-region (sel=None)

Indent the selected region one level of indentation. Set sel to None to use preference to determine selection behavior, or "never-select" to unselect after indent, "always-select" to always select after indent, or "retain-select" to retain current selection after indent.

indent-to-match-next-move (num=<command.commandmgr.kArgNumericModifier instance at 0xb6d0bc6c>)

Indent lines spanned by next cursor move to match, based on the preceding line

insert-command (cmd)

Insert the output for the given command at current cursor position. Some special characters in the command line (if not escaped with ) will be replaced as follows:

% -- Current file's full path name
# -- Previous file's full path name

insert-file (filename)

Insert a file at current cursor position, prompting user for file selection

join-lines (delim=' ', num=<command.commandmgr.kArgNumericModifier instance at 0xb6d0bbec>)

Join together specified number of lines after current line (replace newlines with the given delimiter (single space by default)

join-selection (delim=' ')

Join together all lines in given selection (replace newlines with the given delimiter (single space by default)

kill-buffer ()

Close the current text file

outdent-lines (num=<command.commandmgr.kArgNumericModifier instance at 0xb6d0b1ec>)

Outdent selected number of lines from cursor position

outdent-next-move (num=<command.commandmgr.kArgNumericModifier instance at 0xb6d0b9ec>)

Outdent lines spanned by next cursor move

outdent-region (sel=None)

Outdent the selected region one level of indentation. Set sel to None to use preference to determine selection behavior, or "never-select" to unselect after indent, "always-select" to always select after indent, or "retain-select" to retain current selection after indent.

page-setup ()

Show printing page setup dialog

print-view ()

Print active editor document

query-replace (search_string, replace_string)

Initiate incremental mini-search query/replace from the cursor position.

query-replace-regex (search_string, replace_string)

Initiate incremental mini-search query/replace from the cursor position. The search string is treated as a regular expression.

range-replace (search_string, replace_string, confirm, range_limit, match_limit, regex)

Initiate incremental mini-search query/replace within the given selection. This is similar to query_replace but allows some additional options:

confirm -- True to confirm each replace
range_limit -- None to replace between current selection start and end of document,
1 to limit operation to current selection or to current line of selection is empty,
(start, end) to limit operation to within given selection range, or "first|last"
to limit operating withing given range of lines.
match_limit -- None to replace any number of matches, or limit of number of replaces
regex -- Treat search string as a regular expression

repeat-replace (repeat=<command.commandmgr.kArgNumericModifier instance at 0xb642df2c>)

Repeat the last query replace or range replace operation on the current line. The first match is replaced without confirmation.

replace-char (line_mode='multiline', num=<command.commandmgr.kArgNumericModifier instance at 0xb642df8c>)

Replace num characters with given character. Set line_mode to multiline to allow replacing across lines, extend to replace on current line and then extend the line length, and restrict to replace only if enough characters exist on current line after cursor position.

replace-string (search_string, replace_string)

Replace all occurrences of a string from the cursor position to end of file.

replace-string-regex (search_string, replace_string)

Replace all occurrences of a string from the cursor position to end of file. The search string is treated as a regular expression.

save-buffer ()

Save the current text file to disk

set-readonly ()

Set editor to be readonly. This cannot be done if the editor contains any unsaved edits.

set-writable ()

Set editor to be writable. This can be used to override the read-only state used initially for editors displaying files that are read-only on disk.

show-all-whitespace ()

Turn on all special marks for displaying white space and end-of-line

show-eol ()

Turn on special marks for displaying end-of-line chars

show-indent-guides ()

Turn on special marks for displaying indent level

show-indent-manager ()

Display the indentation manager for this editor file

show-whitespace ()

Turn on special marks for displaying white space

start-kbd-macro (register='a')

Start definition of a keyboard macro. If register=None then the user is prompted to enter a letter a-z under which to file the macro. Otherwise, register 'a' is used by default.

stop-kbd-macro ()

Stop definition of a keyboard macro

toggle-line-wrapping ()

Toggles line wrapping preference for all editors

toggle-overtype ()

Toggle status of overtyping mode

uncomment-out-region ()

Uncomment out the selected region

use-lexer-ada ()

Force syntax highlighting Ada source

use-lexer-apache-conf ()

Force syntax highlighting for Apache configuration file format

use-lexer-asm ()

Force syntax highlighting for Masm assembly language

use-lexer-ave ()

Force syntax highlighting for Avenue GIS language

use-lexer-baan ()

Force syntax highlighting for Baan

use-lexer-bash ()

Force syntax highlighting for bash scripts

use-lexer-bullant ()

Force syntax highlighting for Bullant

use-lexer-by-doctype ()

Use syntax highlighting appropriate to the file type

use-lexer-cpp ()

Force syntax highlighting for C/C++ source

use-lexer-css2 ()

Force syntax highlighting for CSS2

use-lexer-diff ()

Force syntax highlighting for diff/cdiff files

use-lexer-dos-batch ()

Force syntax highlighting for DOS batch files

use-lexer-eiffel ()

Force syntax highlighting for Eiffel source

use-lexer-errlist ()

Force syntax highlighting for error list format

use-lexer-escript ()

Force syntax highlighting for EScript

use-lexer-fortran ()

Force syntax highlighting for Fortran

use-lexer-html ()

Force syntax highlighting for HTML

use-lexer-idl ()

Force syntax highlighting for XP IDL

use-lexer-java ()

Force syntax highlighting for Java source

use-lexer-javascript ()

Force syntax highlighting for Javascript

use-lexer-latex ()

Force syntax highlighting for LaTeX

use-lexer-lisp ()

Force syntax highlighting for Lisp source

use-lexer-lout ()

Force syntax highlighting for LOUT typesetting language

use-lexer-lua ()

Force syntax highlighting for Lua

use-lexer-makefile ()

Force syntax highlighting for make files

use-lexer-matlab ()

Force syntax highlighting for Matlab

use-lexer-mmixal ()

Force syntax highlighting for MMIX assembly language

use-lexer-msidl ()

Force syntax highlighting for MS IDL

use-lexer-nncrontab ()

Force syntax highlighting for NNCrontab files

use-lexer-none ()

Use no syntax highlighting

use-lexer-nsis ()

Force syntax highlighting for NSIS

use-lexer-pascal ()

Force syntax highlighting for Pascal source

use-lexer-perl ()

Force syntax highlighting for Perl source

use-lexer-php ()

Force syntax highlighting for PHP source

use-lexer-plsql ()

Force syntax highlighting for PL/SQL files

use-lexer-pov ()

Force syntax highlighting for POV ray tracer scene description language

use-lexer-properties ()

Force syntax highlighting for properties files

use-lexer-ps ()

Force syntax highlighting for Postscript

use-lexer-python ()

Force syntax highlighting for Python source

use-lexer-rc ()

Force syntax highlighting for RC file format

use-lexer-ruby ()

Force syntax highlighting for Ruby source

use-lexer-scriptol ()

Force syntax highlighting for Scriptol

use-lexer-sql ()

Force syntax highlighting for SQL

use-lexer-tcl ()

Force syntax highlighting for TCL

use-lexer-vb ()

Force syntax highlighting for Visual Basic

use-lexer-vxml ()

Force syntax highlighting for VXML

use-lexer-xcode ()

Force syntax highlighting for XCode files

use-lexer-xml ()

Force syntax highlighting for XML files

use-lexer-yaml ()

Force syntax highlighting for YAML

zoom-in ()

Zoom in, increasing the text display size temporarily by one font size

zoom-out ()

Zoom out, increasing the text display size temporarily by one font size

Project Manager Commands

These commands act on the project manager or on the current project, regardless of whether the project list has the keyboard focus.

add-current-file-to-project ()

Add the frontmost currently open file to project

add-directory-to-project (loc=None, recursive=True, filter='*', include_hidden=False, gui=True)

Add directory to project.

add-file-to-project ()

Add an existing file to the project.

browse-selected-from-project ()

Browse file currently selected in the project manager

clear-project-main-debug-file ()

Clear main debug file to nothing, so that debugging runs the frontmost window by default

close-project ()

Close currently open project file

compact-project ()

Compact currently open project file by pruning information about non-existent files and non-critical attribs for things like visual state.

debug-selected-from-project ()

Start debugging the file currently selected in the project manager

execute-selected-from-project ()

Execute the file currently selected in the project manager

new-project ()

Create a new project.

open-ext-selected-from-project ()

Open file currently selected in the project manager

open-project ()

Open a project file.

open-selected-from-project ()

Open files currently selected in the project manager

remove-directory-from-project (loc=None, gui=True)

Remove directory from project.

remove-selection-from-project ()

Remove currently selected file or package from the project

rescan-project-directories (dirs=None, recursive=True)

Scan project directories for changes. If list of directories is not specified, currently selected directories are used.

save-project ()

Save project file.

save-project-as ()

Save project file under another name.

set-current-as-main-debug-file ()

Set current frontmost file as the main debug file for this project

set-selected-as-main-debug-file ()

Set selected file as the main debug file for this project

show-analysis-stats ()

Show source code analysis statistics

show-project-window ()

Raise the project manager window

use-normal-project ()

Store project in normal format

use-shared-project ()

Store project in sharable format

view-directory-properties (loc=None)

None

view-file-properties (loc=None)

View project properties for a particular file (current file is none is given)

view-project-as-flat-tree ()

View project as flattened directory tree from project file

view-project-as-tree ()

View project as directory tree from project file

view-project-by-mime-type ()

View project as tree organized by file mime type

view-project-properties (highlighted_attrib=None)

View or change project-wide properties

Project View Commands

Commands that are available only when the project view has the keyboard focus.

browse-selected-from-project ()

Browse file currently selected in the project manager

debug-selected-from-project ()

Start debugging the file currently selected in the project manager

execute-selected-from-project ()

Execute the file currently selected in the project manager

open-ext-selected-from-project ()

Open file currently selected in the project manager

open-selected-from-project ()

Open files currently selected in the project manager

remove-selection-from-project ()

Remove currently selected file or package from the project

set-selected-as-main-debug-file ()

Set selected file as the main debug file for this project

view-project-as-flat-tree ()

View project as flattened directory tree from project file

view-project-as-tree ()

View project as directory tree from project file

view-project-by-mime-type ()

View project as tree organized by file mime type

Debugger Commands

Commands that control the debugger and current debug process, if any.

break-clear ()

Clear the breakpoint on the current line

break-clear-all ()

Clear all breakpoints

break-clear-clicked ()

Clear the breakpoint at current click location

break-disable ()

Disable the breakpoint on current line

break-disable-all ()

Disable all breakpoints

break-disable-clicked ()

Disable the breakpoint at current click location

break-edit-cond ()

Edit condition for the breakpoint on current line

break-edit-cond-clicked ()

Edit condition for the breakpoint at the current mouse click location

break-enable ()

Enable the breakpoint on the current line

break-enable-all ()

Enable all breakpoints

break-enable-clicked ()

Enable the breakpoint at current click location

break-enable-toggle ()

Toggle whether breakpoint on current line is enabled or disabled

break-ignore ()

Ignore the breakpoint on current line for N iterations

break-ignore-clicked ()

Ignore the breakpoint at the current mouse click location for N iterations

break-set ()

Set a new regular breakpoint on current line

break-set-clicked ()

Set a new regular breakpoint at the current mouse click location

break-set-cond ()

Set a new conditional breakpoint on current line

break-set-cond-clicked ()

Set a new conditionalbreakpoint at the current mouse click location

break-set-temp ()

Set a new temporary breakpoint on current line

break-set-temp-clicked ()

Set a new temporary breakpoint at the current mouse click location

break-toggle ()

Toggle breakpoint at current line (creates new regular bp when one is created)

clear-exception-ignores-list ()

Clear list of exceptions being ignored during debugging

clear-var-errors ()

Clear stored variable errors so they get refetched

collapse-tree-more ()

Collapse whole selected variables display subtree one more level

debug-attach ()

Attach to an already-running debug process

debug-continue ()

Continue (or start) running, to next breakpoint

debug-detach ()

Detach from the debug process and let it run

debug-file ()

Start debugging the current file (rather than the main entry point)

debug-kill ()

Stop debugging

debug-stop ()

Pause free-running execution at current program counter

exception-always-stop ()

Always stop on exceptions, even if they are handled by the code

exception-never-stop ()

Never stop on exceptions, even if they are unhandled in the code

exception-stop-when-printed ()

Stop only on exceptions when they are about to be printed

exception-unhandled-stop ()

Stop only on exceptions that are not handled by the code

expand-tree-more ()

Expand whole selected variables display subtree deeper

force-var-reload ()

Force refetch of a value from server

frame-down ()

Move down the current debug stack

frame-show ()

Show the position (thread and stack frame) where the debugger originally stopped

frame-up ()

Move up the current debug stack

hide-detail ()

Show the textual value detail area

run-build-command ()

Execute the build command defined in the project, if any

run-to-cursor ()

Run to current cursor position

show-detail ()

Show the textual value detail area

step-into ()

Step into current execution point, or start debugging at first line

step-out ()

Return from current function

step-over ()

Step over current execution point

watch (style='ref')

Watch selected variable using a direct object reference to track it

watch-expression (expr=None)

Add a new expression to the watch list

watch-module-ref ()

Watch selected value relative to a module looked up by name in sys.modules

watch-parent-ref ()

Watch selected variable using a reference to the value's parent and the key slot for the value

watch-ref ()

Watch selected variable using a direct object reference to track it

watch-symbolic ()

Watch selected value using the symbolic path to it

Debugger Watch Commands

Commands for the debugger's Watch tool (Wing IDE Professional only). These are available only when the watch tool has key board focus.

watch-clear-all ()

Clear all entries from the watch list

watch-clear-selected ()

Clear selected entry from the watch list

Search Manager Commands

Globally available commands defined for the search manager. These commands are available regardless of whether a search manager is visible or has keyboard focus.

batch-replace (look_in=None, use_selection=False)

Display search and replace in files tool.

batch-search (look_in=None, use_selection=True)

Display search in files tool. The look_in argument gets entered in the look in field if not None or ''. The current selection is put into the search field if it doesn't span mulitiple lines and either use_selection is true or there's nothing in the search field.

replace ()

Bring up the search manager in replace mode.

replace-again ()

Replace current selection with the search manager.

replace-and-search ()

Replace current selection and search again.

search ()

Bring up the search manager in search mode.

search-again (search_string='', direction=1)

Search again using the search manager's current settings.

search-backward (search_string=None)

Search again using the search manager's current settings in backward direction

search-forward (search_string='')

Search again using the search manager's current settings in forward direction

search-manager (search_string=None, replace_string=None, action=None, direction=None, auto_search=0, auto_replace=0, auto_replace_all=0, auto_show=0, scope=None, scope_location=None, style=None, match_case=None, whole_words=None, wrap=None, omit_binary=None, flash=False)

Deprecated search command; should not be used in new code.

search-sel ()

Search forward using current selection

search-sel-backward ()

Search backward using current selection

search-sel-forward ()

Search forward using current selection

Search Manager Instance Commands

Commands for a particular search manager instance. These are only available when the search manager has they keyboard focus.

clear ()

Clear selected text

copy ()

Copy selected text

cut ()

Cut selected text

forward-tab ()

Place a forward tab at the current cursor position in search or replace string

paste ()

Paste text from clipboard

« 16. Preferences ReferenceTable of Contents18. License Information »