Interface¶

Main Window¶

Subwindows¶

NumbatUI's three views are organized into subwindows, which can be freely arranged within the Main Window or detached from it. Each subwindow has a title bar displaying its name and 2 buttons for closing the subwindow and for detaching it from the Main Window.

Tab Bar¶

The Tab Bar is located at the top of the Main Window and is used to open multiple symbols in parallel.

Status Bar¶

The Status Bar is located on the bottom of the Main Window and is used to convey information about NumbatUI's status and currently running processes to the user

It displays:

• The most recent status message.
• Error Count if the currently loaded project has errors.
• Indexing progress bar while indexing.

On-Screen Search Bar¶

The On-Screen Search Bar is used to search visible contents of the Graph View and Code View. It gets displayed at the bottom of the Main Window when using the Find On-Screen action.

Windows¶

Start Window¶

On every start of NumbatUI you are shown the start window. It allows for creating new projects or opening existing ones.

Path List Box¶

The Path List Box is a user interface element that is used within the Preferences Window and the Project Setup Wizard. It allows for entering a list of file and directory paths. If you want to use environment variables you can use either of the following notations. ${VARIABLE_NAME} or %VARIABLE_NAME%

Plain Text Editing¶

By pressing the pen icon in the bottom right corner you can open the plain text edition dialog. It allows you to edit the whole list within a text field. Each line will be one list item.

Preferences Window¶

The Preferences window lets you define settings for all projects. You can open the Preferences from the menu via Edit/Preferences.

Project Setup Wizard¶

The Project Setup Wizard lets you create a new NumbatUI project. It allows for defining name and location of your project NumbatUI and adding several Source Groups, that define which source files will be indexed. There are several ways to create Source Groups. It is sufficient to add only one Source Group for most projects.

For detailed information continue at PROJECT SETUP.

Indexing Dialogs¶

These dialogs will be used while NumbatUI indexes your project. The whole user interface will be frozen as long as these dialogs are visible.

Start Indexing Dialog¶

This dialog displays the number of files for indexing and clearing before indexing starts. There are different refresh modes:

• Updated files: Reindexes all files that were modified since the last indexing, all files depending on those and new files.
• Incomplete & updated files: Reindexes all files that had errors during last indexing, all files depending on those and all updated files.
• All files: Deletes the previous index and reindexes all files.

Shallow Python Indexing

For Python projects a checkbox Shallow Python Indexing is additionally displayed. When checked, references within your code base (calls, usages, etc.) are resolved by name, which is imprecise but much faster than in-depth indexing. Use this option for a quick first indexing pass and start browsing the code base while running a second pass for in-depth indexing.

Progress Dialog¶

This dialog shows that NumbatUI is currently doing processing that can't be interrupted.

Indexing Dialogs¶

This dialog shows the indexing progress of your project, by displaying the number of already indexed files, the last file that was started indexing, the number of errors and a progress estimate in percent.

Finished Indexing Dialog¶

This dialog is shown after indexing finished, giving you information about indexed files, duration and errors.

Interrupted Indexing Dialog¶

This dialog is shown after indexing was stopped, giving you information about indexed files, duration and errors. You can choose to either use the new index or continue using the old one.

Menu¶

Project¶

• New Project
  • Shortcut: New Project
  • Opens the New Project Dialog to define a new project and loads it after creation.
• Open Project
  • Shortcut: Open Project
  • Opens a file dialog to choose an existing NumbatUI project file from your system's hard drive.
• Recent Projects
  • Opens a submenu to choose recent opened NumbatUI projects.
• Edit Project
  • Opens the Edit Project Dialog prefilled with your project settings and allows for changing them.
• Exit
  • Quits NumbatUI.

Edit¶

• Refresh
  • Shortcut: Refresh
  • Refresh will check all indexed source files for updates and reindex the ones that changed and their depending ones.
• Full Refresh
  • Shortcut: Full Refresh
  • Full Refresh will reindex the whole project.
• Find Symbol
  • Shortcut: Find Symbol
  • This option will put the focus into the search field, so you can start typing your search query. Alternatively you can click the search field.
• Find Text
  • Shortcut: Find Text
  • This option will put the focus into the search field and start a new full text search query
• Find On-Screen
  • Shortcut: Find On-Screen
  • Display the On-Screen Search Bar to search visible contents of the Graph View and Code View
• Next Reference
  • Shortcut: Next Reference
  • Use this option to iterate to the next source location of the active symbol in the code view.
• Previous Reference
  • Shortcut: Previous Reference
  • Use this option to iterate to the previous source location of the active symbol in the code view.
• Next Local Reference
  • Shortcut: Next Local Reference
  • Use this option to iterate to the next source location of the active local symbol or edge in the code view.
• Previous Local Reference
  • Shortcut: Previous Local Reference
  • Use this option to iterate to the previous source location of the active local symbol or edge in the code view.
• To overview
  • Shortcut: To overview
  • This option will display the overview of the project.
• Preferences
  • Shortcut: Preferences
  • Opens the Preferences Window.

View¶

• New Tab
  • Opens a new tab.
• Close Tab
  • Closes the current tab.
• Select Next Tab
  • Switch to the tab to the right of the current tab.
• Select Previous Tab
  • Switch to the tab to the left of the current tab.
• Show Start Window
  • Shows the Start Window.
• Show Title Bars
  • Toggle the visibility of the bars above each Window Widget.
• Reset window layout
  • Resets all the dock widgets to their original layout.
• Search Window
  • Toggle the visibility of the Search Window. This can also be done by closing the Search Window on clicking the "x" icon in it's title bar. (See Window Widgets)
• Graph Window
  • Toggle the visibility of the Graph Window. This can also be done by closing the Graph Window on clicking the "x" icon in it's title bar. (See Window Widgets)
• Code Window
  • Toggle the visibility of the Code Window. This can also be done by closing the Code Window on clicking the "x" icon in it's title bar. (See Window Widgets)
• Status Window
  • Toggle the visibility of the Status Window. This can also be done by closing the Status Window on clicking the "x" icon in it's title bar. (See Window Widgets)
• Larger Font
  • Shortcut: Larger Font
  • Increase the font size within the Main Window's user interface.
• Smaller Font
  • Shortcut: Smaller Font
  • Decrease the font size within the Main Window's user interface.
• Reset font size
  • Shortcut: Reset font size
  • Resets the font size to the original size.

History¶

• Back
  • Shortcut: Back
  • Undoes the last navigation action.
• Forward
  • Shortcut: Forward
  • Redoes an undone navigation action.
• Recently Active Symbols
  • List the history of active symbols in chronologic order.

Bookmarks¶

• Bookmark Active Symbol
  • Shortcut: Bookmark Active Symbol](#shortcuts)
  • Opens the Bookmark Creator dialog create a new bookmark.
• Bookmark Manager
  • Shortcut: Bookmark Manager](#shortcuts)
  • Opens the Bookmark Manager dialog for viewing all bookmarks.
• Recent Bookmarks
  • List of recently added bookmarks for quick activation.

Help¶

• About
  • Shows copyright information about NumbatUI.
• Keyboard Shortcuts
  • Shows table of keyboard shortcuts for NumbatUI.
• Documentation
  • Opens this documentation of NumbatUI in your web browser by URL.
• Changelog
  • Opens the changelog of NumbatUI in your web browser by URL.
• Bug Tracker
  • Opens NumbatUI's bug tracker in your web browser by URL.
• License
  • Opens a window containing the NumbatUI license and all 3^rd party licenses.
• Show Data Folder
  • Opens the file explorer showing the data folder.
• Show Log Folder
  • Opens the file explorer in the directory data/logs where all log files are saved to. You can enable file logging in the Preferences Window.

Shortcuts¶

General¶

Graph View¶

Code View¶

Graph View¶

The graph view visualizes the currently selected symbol and all its relationships to other symbols as an interactive graph visualization. You can also display whole call graphs, inheritance chains or include trees by using the toolbar in the top left. Read more about that at Custom Trail.

Interactions:¶

Buttons:

• Use the trail navigation in the top left to create Custom Trails.
• Use the grouping buttons in the top left to enable Node Grouping by namespace/package or file.
• Press the + and - buttons in the lower left corner to change the zoom level.
• Press the ? button in the bottom right corner to show the Graph Legend.

Panning:

• Drag the background area with the mouse.
• Scroll left-right and up-down on the mouse pad.
• Use the keys W A S D.

Zooming:

• Hold Ctrl/Cmd and scroll with mouse wheel or mouse pad.
• Press Shift + W or Shift + S.
• Press 0 to reset zoom.

Context Menu:

• Open in New Tab: Opens a new Tab with the node under the mouse cursor as active symbol.
• Back: Go back in history.
• Forward: Go forward in history.
• Show Definition: Show the definition of the node under the mouse cursor in the Code View.
• Expand Node: Expand node under mouse cursor.
• Collapse Node: Collapse node under mouse cursor.
• Hide Node: Hide node under mouse cursor.
• Hide Edge: Hide edge under mouse cursor.
• Bookmark Node: Create a bookmark for node under mouse cursor.
• Save As Image: Export current graph as image file. Possible formats are PNG, JPEG, BMP and SVG.
• Save To Clipboard: Save current graph as PNG image to clipboard.
• Copy Name: Copy name for node under mouse cursor to clipboard.
• Copy Full Path: Copy file path for file node under mouse cursor to clipboard.
• Open Containing Folder: Show the file in your file explorer for file node under mouse cursor.

Nodes¶

Colors are corresponding to the default color scheme.

Node Type	Image
File: Non-indexed files are files that are not part of any source group and therefore have not been indexed by NumbatUI's indexer. Incomplete files produced errors during indexing or where part of an indexer run with errors.
Macro
Namespace, Package & Module
Class & Struct: Display their members nested, and separated by access type: public, protected, private. By default only members with edges are shown. The arrow icon allows to expand and collapse them. The number tells how many nodes are hidden.
Type
Typedef
Variable & Field
Function & Method
Enum & Enum Constant
Bundle: A bundle node combines multiple nodes to reduce the size of the graph visualization. The name describes what kind of nodes are bundled. The number tells how many nodes are bundled.
**Group: A group node shows that all contained nodes share something in common e.g. same file or namespace.

Edges¶

Colors are corresponding to the default color scheme.

Edge Type	Image
File Include
Type Use
Variable Use
Function Call
Inheritance
Method Override
Template Specialization & Template Argument Use
Template Member Specialization
Bundled Edges: Bundles multiple edges between the child nodes of the 2 nodes. The thickness gives an impression of how many edges are bundled. Hover the edge to get the number of bundled edges.

Custom Trail¶

Using the toolbar in the top left you can display whole call graphs, inheritance chains or include trees for the currently active symbol if the right symbol type is currently active. Or you can use the Custom Trail Dialog to display graphs based on custom criteria.

Custom Trail Dialog¶

The Custom Trail Dialog can be accessed within the trail controls in the top left of the graph view. It allows to display Custom Trails based on certain criteria.

Every Custom Trail has a specific Start Symbol, then 1 of 3 different modes can be chosen:

Additional options allow defining which information should be shown:

Node Grouping¶

Using grouping buttons in the top left you can specify if nodes in the graph shall be grouped by either namespace/package or defining file.

Namespace/Package Grouping¶

All nodes that belong to the same namespace or package are grouped together in a separate group node.

File Grouping¶

All nodes defined in the same source or header file are grouped together in a separate group node.

Graph Legend¶

Click the ? button in the bottom right corner of the graph view or enter the keyword legend in the search field to show the graph legend. It gives you an overview on the different node and edge types and provides examples of graph layouts.

Code View¶

The code view displays the corresponding source code of the currently selected symbols. The code view has two modes. In list mode it contains a list of one or more files. In single file mode it shows one full source file at a time.

If a viewed file had errors during indexing, its file icon will contain an x and there is a Show Errors-button visible in the files title bar. Clicking one Show Errors will show you only the errors that cause this specific file to be incomplete in the Errors Tab.

Snippet List Mode¶

In this mode the Code View will provide all references of the currently active symbol at once. The top most snippet will show the definition of the symbol if available.

Files¶

Each file has a title bar with the file's name. Clicking the title bar will change the display state. There are 2 different states:

• Minimized: The file does not show its content.

• Snippets: The file displays the snippets containing active locations separated by lines.

Snippets¶

A code snippet contains the lines of interest for the currently active symbol surrounded by some more lines to provide some context. Other symbols that were indexed by NumbatUI are framed by a box when hovered. Here NumbatUI distinguishes between local symbols and symbols that can be related to any other part of the code base. In case the snippet is part of a class, function or namespace, an additional line at the top of the snippet provides information about the snippet’s context (e.g. the surrounding scope).

Single File Mode¶

In single file mode you will only every have one file visible at a time. The first file shown is usually the file containing the definition of the active snippet if available. Other than that the user interface is the same as in Snippet List Mode.

Search View¶

The Search View contains the search field and some other related user interface elements.

Back, Forward and History¶

The left Backward button lets you undo your last navigation actions (see Back) and the right Forward button lets you redo your undone navigation actions again (see Forward). Both buttons are only enabled when the respective actions are available at the moment.

The middle button shows a list of the recently active symbol stack. Select a symbol to activate it.

Refresh¶

The refresh button allows you to refresh the current project and reindex all updated, added and removed files. To reindex the whole project choose the Force Refresh option from the Edit Menu.

Overview Button¶

Show the overview screen, which gives a summary of the loaded project. The overview screen is shown after the project was loaded. Alternatively use the shortcut To overview.

Search Bar¶

The search bar allows you to enter search requests to find one of NumbatUI's indexed symbols. It doesn't allow for full text searching across all files so far. The search field allows for most text editing interactions common to text fields. When typing your request the Autocompletion Popup will show you search results matching to your entered string.

Autocompletion Popup¶

The Autocompletion Popup displays all Nodes matching your search request within all indexed symbols. The match results are determined by a fuzzy matching algorithm, that allows you to skip characters. The popup shows which characters in the words are matching and displays their corresponding node color. The node type is displayed on the right.

Keywords¶

Additionally the search view provides specific keywords that select a certain group of symbols.

Full text search¶

Search for a certain string in all indexed files by putting ? at the front of your search query. The default full text search is case-insensitive, use ?? to search case-sensitive.

Bookmarking Buttons¶

The Bookmark Active Symbol button on the left opens the Bookmark Creator to create a new bookmark. The Bookmark Manager button on the right is used to display the Bookmark Manager for activating and editing your bookmarks.

Bookmark Creator¶

Use the Bookmark Creator to create or edit bookmarks.

Bookmark Manager¶

Use the Bookmark Manager to view and activate your bookmarks. Bookmarks are displayed as lines below their respective category. If a bookmark does not have a category it will be placed within the default category. The buttons for removing/editing categories or bookmarks are only visible when hovering the respective line. Bookmark information is stored within a separate .srctrlbm file next to your .srctrlprj project file.

Status View¶

This view provides different tabs with information about your project. This view is hidden by default.

Status Tab¶

This table gives some information about status updates while running NumbatUI. It can be helpful to figure out why something does not the way it's expected to.

Errors Tab¶

This list shows errors occurred during indexing.

The following information is provided:

• Type: ERROR or FATAL. A FATAL error causes lots of missing information since the indexer had to stop at this error.
• Error message
• File
• Line number
• Indexed: Whether the file is within the indexed files.
• Translation Unit: The source file that produced this error while being indexed.

Tooltips¶

Show information about hovered symbols in the Graph View and Code View

The following information is provided:

• Symbol type
• Visibility (e.g. public or private)
• Reference count
• Symbol name
• Clickable type name for global variables and fields.
• Full signatures with clickable return type name and parameter types names for functions and methods.