B. Menus
This appendix summarizes the commands available on the OO-Browser popup
and menubar menus that mirror the keyboard-based commands discussed
throughout the manual. See section D. Commands, for a summary of the OO-Browser
command names and the keys to which they are bound.
When running InfoDock, the Mode-Menubars
button on the menubar
will replace the menubar of global InfoDock commands with one specific
to the OO-Browser. (Under XEmacs and GNU Emacs, a single
OO-Browser
pulldown menu automatically appears on the menubar
when the point is within a listing window.)
B.1 OO-Browser Menu
The OO-Browser menu includes various help and browser exit commands.
This menu appears as a top-level list of items within the listing window
popup menu and the singular pulldown menu used under XEmacs and GNU Emacs.
Its items are:
About
- Displays the OO-Browser version number and credits.
Language-Manual
- Displays the OO-Browser manual section of specifics for the language of
the current Environment.
Program-Manual
- Displays the very beginning of the online version of the OO-Browser manual.
The entire manual can be browsed in section order by simply using the
{SPC} key. {DEL} moves backwards through the manual.
Menu-Manual
- Displays this section of the OO-Browser manual.
What-is-New?
- Displays a summary of user-visible changes in each OO-Browser release.
---
Load-Env-by-Name
- Menu which loads Environments based on user-given names.
---
Copyright
- Displays OO-Browser copyright information within the browser viewer
window.
Help-Commands
- Displays a menu of OO-Browser commands within the browser viewer window.
A press of the Action Key within any of the key bindings listed in this
command menu invokes the associated command.
Help-Mode
- Summarizes the key bindings available within OO-Browser listing windows.
Help-Mouse
- Displays a summary of how the Action and Assist Keys behave across the
contexts available throughout OO-Browser usage.
---
Discuss-via-Email
- Starts composing a new e-mail message to the OO-Browser discussion
mail list.
Get-Support-via-Email
- Starts composing a new e-mail message to Deepware's support
staff in which you can ask questions or make requests. This requires
that you have pre-paid for support credits with Deepware.
---
Reinitialize
- Restores the OO-Browser user interface to its state upon startup.
Exit-this-Listing
- Returns to the previous OO-Browser listing buffer and discards
the contents of the current window.
---
Exit-Temporarily
- Hides the OO-Browser's buffers and windows, for re-invocation later.
Quit
- Deletes all the OO-Browser listing buffers and all of its windows.
B.2 Class Menu
The Class menu contains operations that apply to individual class
entries or a set of classes extracted from the Environment. Use the
List-Window menu
for the parallel set of commands that operate on
all classes within a listing. Its items are:
Concept-Manual
- See section Displaying Top-Level Classes.
Menu-Manual
- Displays this section of the OO-Browser manual.
---
Edit-Definition
- Edits within the viewer window the source definition of the current
listing entry.
View-Definition
- Views the source definition of the current listing entry
(the source is made read-only and point is left in the listing window).
---
Edit-Named
- Prompts for a class name and then edits the class definition within
the viewer window.
View-Named
- Prompts for a class name and then views the class definition within
the viewer window.
---
Match-from-Listing
- Prompts for a regular expression used to match against the names of all
classes and features within the current Environment. The matches are
displayed in a listing buffer which may then be filtered further with
another match expression. {RET} ends the matching.
Where-is-Named?
- Prompts for a class or feature name and then displays in the viewer
window the full path of the source file where the name is defined.
Where-is-Entry?
- Displays in the viewer window the full path of the source file which
defines the present listing entry.
---
Ancestors
- Generates an ancestor tree listing for the current class. The ancestors
branch down and outward from the current class.
See section Browsing Descendants and Ancestors,
for information on how to invert the listing.
Attributes
- Lists the attributes of the current class. If
br-inherited-features-flag is `t', all attributes including
inherited attributes of the class are shown; otherwise, only the
attributes lexically defined within the class are shown.
Children
- Lists the children of the current class.
Descendants
- Generates the descendency tree for the current class.
Features
- Lists the features of the current class. If
br-inherited-features-flag is `t', all features including
inherited features of the class are shown; otherwise, only the features
lexically defined within the class are shown.
Implementors
- Displays a list of classes which contain definitions for the current
<protocol/interface> entry.
Info
- Displays language-specific summary information for the current class
entry.
Level
- Shows the current class location within its inheritance graph, that is,
among its ancestors and descendants.
Parents
- Lists the parents of the current class.
Protocols
- Displays the protocols to which the current class or protocol conforms,
including inherited ones.
Routines
- Lists the routines (methods) of the current class. If
br-inherited-features-flag is `t', all routines including
inherited routines of the class are shown; otherwise, only the routines
lexically defined within the class are shown.
---
Class-Statistics
- Displays within the minibuffer a statistics summary for the current class.
This generally shows the number of parents and children that the class has.
B.3 Environment Menu
The commands on the Environment menu manipulate entire
Environments. Its items are:
Concept-Manual
- See section Working with Environments.
Menu-Manual
- Displays this section of the OO-Browser manual.
---
Create-or-Load
- Invokes the OO-Browser on a new or existing Environment.
Display-Env-List
- List Environment names and associated Environment files.
Rebuild
- Rescans the System and Library code directories associated with the current
Environment to update the entire Environment.
Statistics
- Displays a summary for the current Environment in the viewer window.
---
Add-Name
- Associates a new name with an existing Environment.
Change-Name
- Renames an Environment.
Remove-Name
- Deletes an Environment name but not the Environment itself.
Replace-Env-of-Name
- Changes which Environment is associated with a particular name.
---
Delete-Class
- Deletes a class from the current Environment.
---
Save
- Prompts for a file to which to save the current Environment, with
a default of the current Environment file name.
B.4 Feature Menu
The Feature menu supplies commands that apply to feature
(attribute and method) entries. (More precisely, these commands work
with any kind of element entry.) Its items are:
Concept-Manual
- See section 2.8 Browsing Elements.
Menu-Manual
- Displays this section of the OO-Browser manual.
---
Edit-Definition
- Edits within the viewer window the source definition of the current
listing entry.
View-Definition
- Views the source definition of the current listing entry (the source is
made read-only and point is left in the listing window).
---
Edit-Declaration
- Edits within the viewer window the declaration (signature) of the
current listing entry.
View-Declaration
- Views the declaration (signature) of the current listing entry.
---
View-Friend-Def
- With point on a friend listing entry, views its source code definition.
---
Edit-Named
- Prompts for a feature name and then edits the feature definition
within the viewer window.
View-Named
- Prompts for a feature name and then views the feature definition.
---
Current-Attributes
- See
Class/Attributes
.
Current-Features
- See
Class/Features
.
Current-Routines
- See
Class/Routines
.
---
All-Attributes
- See
List-Window/All-Attributes
.
All-Features
- See
List-Window/All-Features
.
All-Routines
- See
List-Window/All-Routines
.
---
Implementors
- Displays a list of classes which contain definitions for the current element name.
Signature
- Shows within the viewer window the full feature signature for the
current listing entry.
B.5 Graphical Menu
The Graphical menu creates and deletes graphical, tree-oriented
views of Environment information related to listing entries. Its items
are:
Concept-Manual
- See section 2.22 Browsing Graphically.
Menu-Manual
- Displays this section of the OO-Browser manual.
---
Class-Descendants-View
- Displays within a graphical viewer the descendency tree for the current
class. If
Options/Graphical-Descendant-Features
is enabled, the
features of each descendant are added to the view.
Listing-Descendants-View
- Displays within a graphical viewer the descendency trees for all listing
entries within the current buffer. If
Options/Graphical-Descendant-Features
is enabled, the features of
each descendant are added to the view.
Listing-Graphical-View
- Displays within a graphical viewer the tree of listing entries from the
current buffer. Each entry node in this view may be selected with the
mouse and its corresponding source will be displayed within the editor
for either viewing or editing depending on which mouse key was used.
---
Kill-Graphical-Views
- Deletes all existing OO-Browser graphical views.
B.6 List-Window Menu
The List-Window menu offers commands that operate on all of the
entries within the current listing window at once. Its items are:
Concept-Manual
- See section Using the OO-Browser.
Menu-Manual
- Displays this section of the OO-Browser manual.
---
Write (Save as)
- Prompts for the name of a new or existing file and writes the narrowed
portion of the current listing buffer to the file. Any existing
contents of the file are overwritten.
---
Count-Entries
- Counts the number of entries visible in the current listing buffer and
displays the result within the minibuffer window.
Order-Entries
- Alphabetizes the current listing window entries. Ignores
any leading whitespace and removes any duplicates found.
---
All-Ancestors
- Displays ancestor trees for all entries within the current listing
window which have ancestors.
All-Attributes
- Displays attributes for all entries within the current listing
window which have attributes.
All-Children
- Displays the children for all entries within the current listing window
which have children.
All-Descendants
- Displays descendant trees for all entries within the current listing
window which have descendants.
All-Features
- Displays features for all entries within the current listing window
which have features.
All-Implementors
- For each element in the current listing, displays a list of classes
which contain definitions for it. Ignores classes which inherit such
definitions.
All-Levels
- Shows for each class within the current listing window its inheritance
graph, i.e. where it is located among its ancestors and descendants.
All-Parents
- Displays the parents for all entries within the current listing window
which have parents.
All-Protocols
- Display the protocols to which each class and protocol within the
current listing window conforms, including inherited ones.
All-Routines
- Displays routines (methods) for all entries within the current listing
window which have routines.
---
Show-All-Classes
- Displays the list of all classes.
Show-All-Lib-Classes
- Displays the list of all Library classes.
Show-All-Sys-Classes
- Displays the list of all System classes.
Show-Top-Classes
- Displays the list of all top-level classes, i.e. those without parents.
Show-Top-Lib-Classes
- Displays the list of all top-level Library classes.
Show-Top-Sys-Classes
- Displays the list of all top-level System classes.
---
Narrow-by-10
- Narrows the OO-Browser listing windows by 10 characters.
Widen-by-10
- Widens the OO-Browser listing windows by 10 characters.
---
Exit-this-Listing
- Returns to the previous OO-Browser listing buffer and discards
the contents of the current window.
B.7 Options Menu
The Options menu toggles major OO-Browser option settings.
Its items are:
Concept-Manual
- See section OO-Browser Options.
Menu-Manual
- Displays this section of the OO-Browser manual.
---
Keep-Viewed-Classes
- Toggles whether or not multiple class buffers are left around after
viewing. If off (the default), each viewed class buffer is deleted
after use. Classes displayed for editing are not affected; they are
always left around for further editing unless explicitly deleted.
Graphical-Descendant-Features
- Toggles whether or not features are added to any class listing displayed
in graphical form. The default is not to add features to graphical
displays.
List-Protocols-with-Classes
- Toggles whether or not protocols (interfaces) are included in listings
of all classes or top-level classes. The default is to include them
under languages that support protocols.
Show-Inherited-Features
- Toggles whether or not feature listings include inherited features.
The default is to include them. If off, only those features lexically
included within a class are shown.
Use-Vi-as-Editor
- Toggles whether or not the OO-Browser sends source code to Vi for
editing and viewing, instead of to the viewer window.
#cindex 2-button mouse
#cindex 3-button mouse
3-Button-Mouse
- Toggles which mouse key is used for displaying items from listing buffers.
With this enabled, the middle mouse buttons is used for this purpose.
Otherwise, the left mouse button is used.
B.8 View-Window Menu
The View-Window menu is used to manipulate the viewer window
display from within a listing window. Its items are:
Concept-Manual
- See section 2.7 Viewing and Editing.
Menu-Manual
- Displays this section of the OO-Browser manual.
---
Select-Code-Buffer
- Displays within the viewer window a list of all existing buffers of
source code for the current OO-Browser language. A press of the Action
Key, {SPC}, or {q} on an entry line displays the
associated buffer.
---
Full-Frame
- Deletes all browser windows except for the viewer window. This is used
to get a full-frame view of a source file.
Kill-Buffer
- Kills the current buffer within the viewer window and redisplays
the initial OO-Browser command help buffer.
Move-To-or-From
- Moves point back and forth between the viewer window and the last
recorded browser listing window.
---
Scroll-Backward
- Scrolls the viewer backward one windowful.
Scroll-Forward
- Scrolls the viewer forward one windowful.
---
Scroll-Backward-One-Line
- Scrolls the viewer window backward one line.
Scroll-Forward-One-Line
- Scrolls the viewer window forward one line.
---
To-Buffer-Beginning
- Scrolls to the beginning of the viewer buffer.
To-Buffer-End
- Scrolls to the end of the viewer buffer.
This document was generated by XEmacs shared group account on December, 19 2009
using texi2html 1.65.