Ctags Function Index
Menu: Tools > Ctags Function Index
Default Shortcut Key: none
Macro function: CtagsFunctionIndex()
The Ctags Function Index command displays a dialog containing a list of functions, procedures and global variables for the files currently being edited. The list can be used as a handy reference to function names and their calling parameters, or as a navigation aid: double-clicking on an entry will jump to the file and line that corresponds to the highlighted entry. The dialog is non-modal, so it can remain open alongside Boxer as you're doing other work.
In order to index the edited files, Boxer runs an external program and then reads the output file it creates. Exuberant Ctags is a fast, multi-language implementation of the original ctags and etags programs that are available on Unix. Exuberant Ctags is distributed under the GNU General Public License. The program ctags.exe and a zip file containing the program's source code have been installed in a directory named 'Ctags' beneath the Boxer installation directory.
Exuberant Ctags supports indexing of the following languages:
The list can be sorted on any of its columns by clicking on the associated column title in the header at the top of the listing. Clicking on the same header a second time will reverse the order of the sort.
The function prototype information contained in the Ctags Function Index dialog is also available for display when the mouse hovers over a function that has been indexed:
The display of these popup tool tips can be configured by clicking the Settings button, which leads to the Configure Ctags Function Index dialog.
Popup tool tips can also be displayed for global variables, structure and class members, typedefs, macros and other language-dependent identifiers:
Use the Refresh button to re-index all open files, and any other 'extra files' that may have been designated in the Configure Ctags Function Index dialog. You might want to use the Refresh button when changes have been made to an edited file that would invalidate the information that was previously gathered. For example, if a function's calling parameters are changed, or a function is added or deleted, use Refresh.
The Settings button will display the Configure Ctags Function Index dialog, which provides options that control how and when files will be indexed, the appearance of the function list, and whether popup tool tips will be displayed.
Use the Display combobox to filter the listing of indexed functions and variables. The available choices are:
all indexed files
all open files
files in active project
Extra files to be indexed can be designated in the Configure Ctags Function Index dialog.