Top-level Commands


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

Application Control Commands

These are the high level application control 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, back_key=None, forward_key=None)

Start moving between documents in the order they were visited. Starts modal key interaction that ends when a key other than tab is seen or ctrl is released. Key Binding: Ctrl-Tab invokes begin-visited-document-cycle(move_back=True)

bookmarks-menu-items ()

Returns list of menu items for selecting among defined bookmarks

check-for-updates ()

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

close (ignore_changes=False, close_window=True, can_quit=False)

Close active document. Abandon any changes when ignore_changes is True. Close empty windows when close_window is true and quit if all document windows closed when can_quit is true. Key Bindings: Wing IDE: Ctrl-F4; Brief: Ctrl-F4; VI/VIM: Ctrl-F4; Eclipse: Ctrl-F4; Emacs: Ctrl-F4; Visual Studio: Ctrl-F4; OS X: Command-F4

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. Key Bindings: Eclipse: Ctrl-Shift-F2

close-window ()

Close the current window and all documents and panels in it Key Bindings: Wing IDE: Alt-F4; Brief: Alt-F4; VI/VIM: Alt-F4; Eclipse: Alt-F4; Emacs: Alt-F4; Visual Studio: Alt-F4; OS X: Option-F4

command-by-name (command_name)

Execute given command by name, collecting any args as needed Key Bindings: Wing IDE: Ctrl-F12; Brief: Ctrl-F12; VI/VIM: Ctrl-F12; Eclipse: Ctrl-F12; Emacs: Ctrl-F12; Visual Studio: Ctrl-F12; OS X: Command-F12

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

enter-license ()

Enter a new license code, replacing any existing license activation

execute-file (loc=None)

Execute the file at the given location or use the active view if loc is None. Key Bindings: Eclipse: Ctrl-U

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, raise_panel=True)

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. Key Bindings: Emacs: Alt-!

fileset-load (name)

Load the given named file set

fileset-manage ()

Display the file set manager dialog

fileset-new-with-open-files (file_set_name)

Create a new named file set with the currently open files

fileset-new-with-selected-files (file_set_name)

Create a new named file set with the currently selected files

goto-bookmark (mark)

Goto named bookmark Key Bindings: Wing IDE: Ctrl-Alt-G; Eclipse: Ctrl-Alt-G; Emacs: Ctrl-X R B; Visual Studio: Ctrl-Alt-G; OS X: Command-Shift-D

goto-next-bookmark (current_file_only=False)

Go to the next bookmark, or the first one if no bookmark is selected. Stays within the file in the current editor when current_file_only is True. Key Bindings: Wing IDE: Ctrl-Alt-Right; Brief: Ctrl-Alt-Right; VI/VIM: Ctrl-Alt-Right; Eclipse: Ctrl-Alt-Right; Emacs: Ctrl-Alt-Right; Visual Studio: Ctrl-Alt-Right

goto-previous-bookmark (current_file_only=False)

Go to the previous bookmark in the bookmark list, or the last one if no bookmark is selected. Stays within the file in the current editor when current_file_only is True. Key Bindings: Wing IDE: Ctrl-Alt-Left; Brief: Ctrl-Alt-Left; VI/VIM: Ctrl-Alt-Left; Eclipse: Ctrl-Alt-Left; Emacs: Ctrl-Alt-Left; Visual Studio: Ctrl-Alt-Left

hide-line-numbers ()

Hide line numbers in editors

initiate-numeric-modifier (digit)

VI style repeat/numeric modifier for following command Key Bindings: VI/VIM: 1 invokes initiate-numeric-modifier(digit=1)

initiate-repeat ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke. Key Bindings: Emacs: Ctrl-U

initiate-repeat-0 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke. Key Bindings: Emacs: Alt-0

initiate-repeat-1 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke. Key Bindings: Emacs: Alt-1

initiate-repeat-2 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke. Key Bindings: Emacs: Alt-2

initiate-repeat-3 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke. Key Bindings: Emacs: Alt-3

initiate-repeat-4 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke. Key Bindings: Brief: Ctrl-R; Emacs: Alt-4

initiate-repeat-5 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke. Key Bindings: Emacs: Alt-5

initiate-repeat-6 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke. Key Bindings: Emacs: Alt-6

initiate-repeat-7 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke. Key Bindings: Emacs: Alt-7

initiate-repeat-8 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke. Key Bindings: Emacs: Alt-8

initiate-repeat-9 ()

Enter a sequence of digits indicating number of times to repeat the subsequent command or keystroke. Key Bindings: Emacs: Alt-9

internal-profile-start ()

Start internal profiling. Profile information is collected for Wing IDE's internals until internal_profile_stop is executed.

internal-profile-stop ()

Stop internal profiling after earlier internal_profile_start command. The profile can be found in the error-log file or submitted to Wingware as part of the error log included with a bug report from the Help menu.

new-blank-file (filename)

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

new-directory (filename)

Create a new directory on disk 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) Key Bindings: Emacs: Ctrl-X 5 2; OS X: Shift-F4

new-file (ext='.py')

Create a new file Key Bindings: Wing IDE: Ctrl-N; Eclipse: Ctrl-N; Visual Studio: Ctrl-N; OS X: Command-N

new-package (filename)

Create a new Python package directory on disk, add it to the current project, and open the new __init__.py in the editor.

new-panel-window (panel_type=None)

Create a new panel window of given type

next-document (repeat=<numeric modifier; default=1>)

Move to the next document alphabetically in the list of documents open in the current window Key Bindings: Wing IDE: Ctrl-Page_Down; Brief: Ctrl-Page_Down; VI/VIM: Ctrl-Page_Down; Eclipse: Ctrl-Page_Down; Emacs: Ctrl-Page_Down; Visual Studio: Ctrl-Page_Down; OS X: Command-0

next-window ()

Switch to the next window alphabetically by title Key Bindings: Wing IDE: Ctrl-Comma; Eclipse: Ctrl-Comma; Emacs: Ctrl-O; Visual Studio: Ctrl-Comma

nth-document (n=<numeric modifier; default=0>)

Move to the nth document alphabetically in the list of documents open in the current window Key Bindings: VI/VIM: Ctrl-^

open (filename)

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

open-from-keyboard (filename)

Open a file from disk using keyboard-driven selection of the file Key Bindings: Wing IDE: Ctrl-K; Eclipse: Ctrl-K; Emacs: Ctrl-X Ctrl-F; Visual Studio: Ctrl-K Ctrl-O

open-from-project (fragment='', skip_if_unique=False)

Open document from the project via the Open From Project dialog. The given fragment is used as the initial fragment filter and if it is None, the selected text or the symbol under the cursor is used. If skip_if_unique is true, the file is opened without the dialog being displayed if only one filename matches the fragment. Key Bindings: Wing IDE: Ctrl-Shift-O; VI/VIM: Ctrl-Shift-O; Eclipse: Ctrl-Shift-O; Emacs: Ctrl-X Ctrl-O; Visual Studio: Ctrl-Shift-O; OS X: Command-Shift-O

open-gui (filename=None)

Open a file from disk, prompting with file selection dialog if necessary Key Bindings: Wing IDE: Ctrl-O; Brief: Alt-E; Eclipse: Ctrl-O; Visual Studio: Ctrl-O; OS X: Command-O

perspective-disable-auto ()

Disable auto-perspectives

perspective-enable-auto ()

Enable auto-perspectives

perspective-manage ()

Display the perspectives manager dialog

perspective-restore (name)

Restore the given named perspective.

previous-document (repeat=<numeric modifier; default=1>)

Move to the previous document alphabetically in the list of documents open in the current window Key Bindings: Wing IDE: Ctrl-Page_Up; Brief: Ctrl-Page_Up; VI/VIM: Ctrl-Page_Up; Eclipse: Ctrl-Page_Up; Emacs: Ctrl-Page_Up; Visual Studio: Ctrl-Page_Up; OS X: Command-9

previous-window ()

Switch to the previous window alphabetically by title

query-end-session ()

Process query-end-session message on win32

quit ()

Quit the application. Key Bindings: Wing IDE: Ctrl-Q; Brief: Alt-X; Eclipse: Ctrl-Q; Emacs: Ctrl-X Ctrl-C; Visual Studio: Ctrl-Q; OS X: Command-Q

recent-document ()

Switches to previous document most recently visited in the current window or window set if in one-window-per-editor windowing mode. Key Bindings: Wing IDE: Ctrl-8; Eclipse: Ctrl-8; Emacs: Ctrl-X D; Visual Studio: Ctrl-8; OS X: Command-8

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

remove-bookmark-current ()

Remove bookmark at current line, if any. This command is only available if there is a bookmark on the line.

rename-current-file (filename)

Rename current file, moving the file on disk if it exists.

restart-wing ()

Restart the application

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. Key Bindings: Wing IDE: Ctrl-S; Brief: Alt-W; VI/VIM: Ctrl-S; Eclipse: Ctrl-S; Emacs: Ctrl-X Ctrl-S; Visual Studio: Ctrl-S; OS X: Command-S

save-all (close_window=False)

Save all unsaved items, prompting for names for any new items that don't have a filename already. Key Bindings: Eclipse: Ctrl-Shift-S; Visual Studio: Ctrl-Shift-S

save-as ()

Save active document to a new file Key Bindings: Wing IDE: Ctrl-Shift-S; Eclipse: Ctrl-Shift-S; OS X: Command-Shift-S

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. Key Bindings: Wing IDE: Ctrl-Alt-M; Brief: Alt-0 invokes set-bookmark(mark="0"); Eclipse: Ctrl-Alt-M; Emacs: Ctrl-X R M; Visual Studio: Ctrl-Alt-M; OS X: Command-D

set-bookmark-default ()

Set a bookmark at current line, using a default bookmark name for that context. This command is only available if there is not already a bookmark on the line.

show-bookmarks ()

Show a list of all currently defined bookmarks Key Bindings: Wing IDE: Ctrl-Alt-K; Brief: Alt-J; Eclipse: Ctrl-Alt-K; Emacs: Ctrl-X R Return; Visual Studio: Ctrl-Alt-K; OS X: Command-Shift-K

show-bug-report-dialog ()

Show the bug reporting dialog

show-document (section='manual')

Show the given documentation section Key Bindings: OS X: Command-?

show-feedback-dialog ()

Show the feedback submission dialog

show-file-in-editor (filename, lineno=None, col=-1, length=0)

Show the given file in the editor. Selects the code starting and given column (if >= 0) and of given length.

show-file-in-os-file-manager (filename=None)

Show the selected file in the Explorer, Finder, or other OS-provided file manager. Shows the given file, if any, or the current file selected in the GUI.

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, grab_focus=None)

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. Focus is shifted to panel if grab_focus is specified and is true; if grab_focus is not specified, it defaults to the value of flash.

The valid panel types are:

project (*) browser (**) batch-search (*) interactive-search source-assistant (**) debug-data debug-stack debug-io debug-exceptions debug-breakpoints (**) debug-probe (**) debug-watch (**) debug-modules (**) python-shell messages (*) help indent (**) bookmarks (**) testing (**) open-files (*) os-command (**) snippets (**) diff (**) uses (**) refactoring (**) versioncontrol.svn (**) versioncontrol.hg (**) versioncontrol.git (**) versioncontrol.bzr (**) versioncontrol.cvs (**) versioncontrol.perforce (**)

(*) Wing Personal and Pro only (**) Wing Pro only Key Bindings: Eclipse: Ctrl-E invokes show-panel(panel_type="open-files")

show-panel-debug-data (flash=True, grab_focus=None)

Not documented

show-panel-debug-exceptions (flash=True, grab_focus=None)

Not documented

show-panel-debug-io (flash=True, grab_focus=None)

Not documented

show-panel-debug-stack (flash=True, grab_focus=None)

Not documented

show-panel-help (flash=True, grab_focus=None)

Not documented

show-panel-interactive-search (flash=True, grab_focus=None)

Not documented

show-panel-python-shell (flash=True, grab_focus=None)

Not documented

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

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

show-plugins-gui ()

Show the plugins GUI for enabling and disabling plugins

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 Key Bindings: OS X: Command-Comma

show-python-donate-html ()

Show the Python donations web page

show-python-for-beginners-html ()

Show the Python for Beginners web page

show-python-manual-html ()

Show 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-store ()

Show the Wingware store for purchasing a license

show-wingware-website ()

Show the Wingware home page

show-wingware-wiki ()

Show the Wingware wiki for sharing scripts, tips, and tricks

switch-document (document_name)

Switches to named document. Name may either be the complete name or the last path component of a path name. Key Bindings: Emacs: Ctrl-X B; Visual Studio: Ctrl-K Ctrl-S

toggle-bookmark ()

Set or remove a bookmark at current location on the editor. When set, the name of the bookmark is set to an auto-generated default. Key Bindings: Wing IDE: Ctrl-Alt-T; Eclipse: Ctrl-Alt-T; Emacs: Ctrl-X R T; Visual Studio: Ctrl-Alt-T; OS X: Command-H

toggle-bookmark-at-click ()

Set or remove a bookmark at the position in the editor where the most recent mouse click occurred. When set, the name of the bookmark is set to an auto-generated default.

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

Search using given text and the toolbar search area. The search is always forward from the current cursor or selection position

toolbar-search-focus ()

Move focus to toolbar search entry. Key Bindings: Wing IDE: Ctrl-D; Eclipse: Ctrl-D; Visual Studio: Ctrl-D

toolbar-search-next (set_anchor=True)

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

toolbar-search-prev (set_anchor=True)

Move to previous match of text already entered in the toolbar search area

vi-delete-bookmark (marks)

Remove one or more bookmarks (pass in space separated list of names)

vi-goto-bookmark ()

Goto bookmark using single character name defined by the next pressed key Key Bindings: VI/VIM: Grave

vi-set-bookmark ()

Set a bookmark at current location on the editor using the next key press as the name of the bookmark. Key Bindings: VI/VIM: m

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, start_line=None, end_line=None, follow=True)

Write current file to a new location, optionally omitting all but the lines in the given range. The editor is changed to point to the new location when follow is True. If follow is 'untitled' then the editor is changed to point to the new location only if starting with an untitled buffer and saving the whole file. Note that the editor contents will be truncated to the given start/end lines when follow is True. Key Bindings: Emacs: Ctrl-X Ctrl-W

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. Key Bindings: VI/VIM: Shift-Z Shift-Z invokes write-file-and-close(filename=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 Key Binding: Shift-F2

exit-fullscreen ()

Restore previous non-fullscreen state of all tools and tool bar Key Binding: Shift-F2

hide-horizontal-tools ()

Hide the horizontal tool area

hide-toolbar ()

Hide toolbars in all document windows

hide-vertical-tools ()

Hide the vertical tool area

minimize-horizontal-tools ()

Minimize the horizontal tool area Key Binding: F1

minimize-vertical-tools ()

Minimize the vertical tool area Key Binding: F2

show-horizontal-tools ()

Show the horizontal tool area Key Binding: F1

show-toolbar ()

Show toolbars in all document windows

show-vertical-tools ()

Show the vertical tool area Key Binding: F2

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.

copy ()

Copy any selected text. Key Bindings: Wing IDE: Ctrl-Insert; Brief: Ctrl-Insert; VI/VIM: Ctrl-Insert; Eclipse: Ctrl-Insert; Emacs: Ctrl-Insert; Visual Studio: Ctrl-Insert; OS X: Command-C

document-back ()

Go back to prior page in the history of those that have been viewed

document-contents ()

Go to the document contents page

document-forward ()

Go forward to next page in the history of those 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=<numeric modifier; default=1>)

Initiate incremental mini-search backward from the cursor position, optionally entering the given search string. Key Bindings: Wing IDE: Ctrl-Shift-U; Eclipse: Ctrl-Shift-U; Emacs: Ctrl-R; Visual Studio: Ctrl-Shift-U; OS X: Command-Shift-U

isearch-backward-regex (search_string=None, repeat=<numeric modifier; default=1>)

Initiate incremental regular expression mini-search backward from the cursor position, optionally entering the given search string. Key Bindings: VI/VIM: ?; Emacs: Ctrl-Alt-R

isearch-forward (search_string=None, repeat=<numeric modifier; default=1>)

Initiate incremental mini-search forward from the cursor position, optionally entering the given search string. Key Bindings: Wing IDE: Ctrl-U; Eclipse: Ctrl-U; Emacs: Ctrl-S; Visual Studio: Ctrl-I; OS X: Command-U

isearch-forward-regex (search_string=None, repeat=<numeric modifier; default=1>)

Initiate incremental regular expression mini-search forward from the cursor position, optionally entering the given search string. Key Bindings: VI/VIM: /; Emacs: Ctrl-Alt-S

isearch-repeat (reverse=False, repeat=<numeric modifier; default=1>)

Repeat the most recent isearch, using same string and regex/text. Reverse direction when reverse is True. Key Bindings: VI/VIM: n

isearch-sel-backward (persist=True, repeat=<numeric modifier; default=1>)

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. Key Bindings: Wing IDE: Ctrl-Shift-B; VI/VIM: # invokes isearch-sel-backward(persist=0, whole_word=1); Eclipse: Ctrl-Shift-B; Emacs: Ctrl-C R; Visual Studio: Ctrl-Shift-B

isearch-sel-forward (persist=True, repeat=<numeric modifier; default=1>)

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. Key Bindings: Wing IDE: Ctrl-B; VI/VIM: * invokes isearch-sel-forward(persist=0, whole_word=1); Eclipse: Ctrl-B; Emacs: Ctrl-C S; Visual Studio: Ctrl-B

zoom-in ()

Increase documentation font size Key Binding: Ctrl-+

zoom-out ()

Decrease documentation font size Key Binding: Ctrl--

zoom-reset ()

Reset documentation font size to default

Global Documentation Commands

Commands for the documentation viewer that are available regardless of where the focus is.

document-search (txt=None)

Search all documentation.

Window Commands

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

focus-current-editor ()

Move focus back to the current editor, out of any tool, if there is an active editor. Key Bindings: Eclipse: F12

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

Move focus to next or previous editor split, optionally wrapping when the end is reached. Key Bindings: VI/VIM: Ctrl-W j invokes move-editor-focus(wrap=False); Emacs: Ctrl-X O

move-editor-focus-first ()

Move focus to first editor split Key Bindings: VI/VIM: Ctrl-W t

move-editor-focus-last ()

Move focus to last editor split Key Bindings: VI/VIM: Ctrl-W b

move-editor-focus-previous ()

Move focus to previous editor split Key Bindings: VI/VIM: Ctrl-W p

move-focus ()

Move the keyboard focus forward within the Window to the next editable area Key Binding: Shift-F1

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 ()

Go to the Wing Tips contents page

wingtips-next ()

Go to the next page in Wing Tips

wingtips-next-unseen ()

Go to a next unseen Wing Tips page

wingtips-previous ()

Go to the previous page in Wing Tips

« 20. Command ReferenceTable of Contents20.1. Project Manager Commands »