IBM
Contents Index Previous Next



Index Viewer Window


All entities defined in the system are listed in alphabetical order in the Index Viewer window. The entities are sorted alphabetically according to either name, or type and name. For each entity, there may be a list of uses of the entity. The general characteristics of the window is described in User Interface and Basic Operations.

The Drawing Area

The window contains a list of all definitions of entities in the current SDL system or the current MSC diagram. The first line in the list gives the name of the current cross reference file.

For each entity, the following information is presented:

Figure 446 : The Index Viewer window

To double click on a defined entity in the window is the same operation as Show Definition in the Tools menu (see Show Definition). If there are several definitions associated with the entity, one of them is selected. If you double click again, another definition is selected. The list of definitions associated with the entity is traversed in a circular pattern.

To double click on a use in the window is the same operation as Show Use in the Tools menu (see Show Use). If there are several uses associated with the symbol, one of them is selected. If you double click again, another use is selected. The list of uses associated with the reference symbol is traversed in a circular pattern.

Fast Search

There is a fast search operation available when the Index Viewer drawing area has the input focus. Just start typing on the keyboard, and the list of entities will be searched from the top. The first matching entity will be selected.

Note that the fast search operation will only match if what you type matches the beginning of the text for an entity. For instance: If you type "Ga", you will find the entity Game_On if the entities are sorted with name first, while you will not find it if you type "On". The normal Search operation does not have this restriction.

The search string used by the fast search operation will be reset whenever any other operation than the fast search operation is performed. For instance, if you have typed "Ga" and the index viewer has found the entity Game_On, and you select another entity and start typing again, then the search string used for the search operation will not contain the initial "Ga" characters (and the fast search operation will start searching from the top of the list).

It is possible to use the delete character to correct any spelling mistakes. You can see what you have typed in the message area. Matched characters are shown in non-capital letters, while unmatched are shown in capital letters.

The Menu Bar

File Menu

The File menu contains the following menu choices:

View Menu

The View menu contains the following menu choices:

Window Options

Sets options for which parts of the Main window to show. The dialog controls whether to show the tool bar and the status bar.

Index Options

Determines the appearance of each entity in the window.

Figure 447 : The Index Options dialog

The following alternatives are available:

Filter Types

Determines which entity types to show/hide in the entity list. A dialog is opened with a sorted list of all entity types found in the current cross reference file:

Figure 448 : The Filter Types dialog

The figure shows some entity types for an SDL system. See MSC Icons for a list of MSC entities.

An SDT preference, FilterTypes can be set to an initial list of entities to show or hide whenever the Index Viewer is opened. Another SDT preference, ShowSelectedTypes, determines if the mentioned types should be shown or hidden. See FilterTypes.

Filter Uses

Determines which uses to show/hide. The dialog works in the same way as the dialog for Filter Types. The associated SDT preferences are named FilterUses and ShowSelectedUses.

Figure 449 : The Filter Uses dialog

Filter Diagrams

Hide/show entities based on which diagram they are defined in. The dialog works in the same way as the dialog for Filter Types. The most common use of this operation is to hide definitions from the SDL predefined package. The associated SDT preferences are named FilterDiagrams and ShowSelectedDiagrams.

Figure 450 : The Filter Diagrams dialog

Set Scale

Issues a dialog where the scale for the Tree window may be set.

Tools Menu

The Tools menu contains the following menu choices:

Search

Searches for a visible text in the entity list shown in the Main window.

Figure 451 : The Search dialog

If the search reaches the end of the trees, you are asked whether to continue the search from the first tree.

If the text cannot be found among the visible information, you are informed in a confirmation dialog.

Search Again

Searches again for the same text as in the latest search. The behavior is the same as described in Search.

Show Definition

Opens an editor containing the specified definition of the entity selected in the entity list. The diagram symbol containing the definition becomes selected in the editor.

The name and behavior of this menu choice depends on the number of existing definitions for the selected entity:

Show Use

Opens an editor, showing the selected use of an entity. The Show Use operation works in the same way as the Show Definition operation.

Popup Menus

The following tables lists the menu choices in the window's popup menus and a reference to the corresponding menu choice in the menu bar.

On the Window Background

Search

Search.

Search Again

Search Again.

On an Entity in the Window

Search

Search.

Search Again

Search Again.

Show Definition

Show Definition. The same menu choice variations apply.

Keyboard Accelerators

Apart from the general keyboard accelerators, the following accelerator can be used in the main window:

Accelerator Reference to corresponding command
Ctrl+E

Show Definition

Quick Buttons

The following quick button is special to the Index Viewer window. The general quick buttons are described in General Quick-Buttons.

Toggle Order

Switches the entity sort order between name and type and name.


http://www.ibm.com/rational
Contents Index Previous Next