[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

D. Commands

The following documentation is meant for programmers who want to modify the OO-Browser. It is included here since some users of the OO-Browser may find it useful. All commands that are bound to keys and that are specific to the OO-Browser are listed here, plus a few other commands. Within each command description, identifiers shown in all capitals are the names of the command's formal arguments; all formal arguments are presented in the order in which they are required by the command. If a command takes optional arguments, the first optional argument is labeled optional; all following arguments are assumed to be optional.

br-ancestors {a}
Display ancestor tree whose root is the current class. With optional prefix ARG, display all ancestor trees whose roots are in the current listing. With no ARG or if ARG = -1 or br-invert-ancestors is `t', the current class ancestry tree is inverted. That is, it shows branches going down towards the root class, so that parents appear above children. If ARG < -1 or br-invert-ancestors is `t' and ARG > 1, then the ancestry trees of all classes in the current listing are inverted.

br-at {@}
Display the current class location in the inheritance graph. The class is displayed among both its ancestors and descendants. With optional prefix ARG, display the locations for all classes in the current listing.

br-attributes
Display attributes of the current class (prefix ARG = 1) or of the current listing if ARG is other than 0 or 1.

With ARG = 0, the value of the variable, br-inherited-features-flag, is toggled and no other action is taken.

If br-inherited-features-flag is `t', all attributes of each class are shown. If `nil', only lexically included attributes are shown and if the attributes of a single class are requested and none are defined, the class definition is displayed so that its attribute declarations may be browsed.

br-buffer-menu {b}
Display in the viewer window a selection list of buffers for the current browser language.

br-categories {C}
Display categories directly associated with the current class. This does not include any categories which the class inherits. With optional prefix ARG, display categories of all classes in the current listing.

br-children {c}
Display the children of the current class. With optional prefix ARG, display the children of all the classes in the current listing.

br-class-stats {M-c}
Display a statistics summary for the current class. Optional prefix arg PROMPT means prompt for a class name.

br-copyright
Display the OO-Browser copyright information in the viewer window.

br-count {#}
Count the number of entries visible in current listing buffer. Print the text result in the minibuffer when called interactively.

br-delete {C-c C-d}
Delete a class from the current Environment. Does not alter descendency relations. Optional prefix arg PROMPT means prompt for the class name.

br-descendants {d}
Display the descendant tree whose root is the current class. With optional prefix ARG, display all descendant trees whose roots are the classes in the current listing.

br-edit-entry {e}
Edit the source code for any browser listing entry, such as a class or a feature. Optional prefix arg PROMPT means prompt for the entry name; automatically prompt if called interactively outside of a listing window, e.g. within a source code buffer when the browser user interface is not displayed.

br-entry-info {i}
Display attributes of the current entry in the viewer window.

br-env-load {C-c C-l}
Load an OO-Browser Environment or specification from optional ENV-FILE, ENV-NAME or br-env-file. Non-nil PROMPT means prompt the user before building the Environment. Non-nil NO-BUILD means skip the build of the Environment entirely. Return `t' if the load is successful, else `nil'.

br-env-rebuild {C-c C-e}
Rescan System and Library sources associated with the current Environment. When given a prefix arg, DEBUG-FLAG, it will output a debugging backtrace if any error occurs during scanning (InfoDock and XEmacs only).

br-env-save {C-c C-s}
Save the modified Environment to a file given by optional SAVE-FILE or br-env-file.

br-env-stats {M-e}
Display a summary for the current Environment in the viewer window. With optional prefix ARG, display class totals in the minibuffer.

br-exit-level {x}
Return to prefix ARGth previous inheritance level listing. The command is ignored with ARG < 1.

br-feature-edit-declaration {C-c M-j}
Prompt with completion for a CLASS::FEATURE argument and then edit the associated declaration. If point is on a feature definition signature in a code buffer (prior to any of its arguments), the default is to edit that feature's declaration. An error is signaled if the declaration is not found. Presently, this command works in C++ buffers exclusively.

br-feature-signature {F}
Show the full feature signature in the view window. With optional prefix ARG, display signatures of all features from the current listing buffer.

br-features {f}
Display features/elements of the current class (prefix ARG = 1) or of the current listing if ARG is other than 0 or 1.

With ARG = 0, the value of the variable, br-inherited-features-flag, is toggled and no other action is taken.

If br-inherited-features-flag is `t', all features of each class are shown. If `nil', only lexically included features are shown and if the features of a single class are requested and none are defined, the class definition is displayed so that its feature declarations may be browsed.

br-find {C-c M-f}
Prompt with completion for a class or element name from the current Environment and display its definition for editing. (This command is available within source code buffers.)

br-help {h} or {?}
Display OO-Browser operation help information in the viewer window.

br-help-ms {H}
Display OO-browser mouse usage help information in the viewer window.

br-implementors {I}
Display a list of classes which contain definitions for the current element name. Ignore classes which inherit such definitions. With optional prefix ARG, display implementors of all elements within the current listing.

br-kill {C-c C-k}
Kill the buffer in the viewer window and redisplay help text.

br-lib-rebuild {L}
Rescan Library components of the current Environment.

br-lib-top-classes {l}
Display a list of the top-level Library classes. With prefix ARG, display all Library classes.

br-match {m}
Show all class names in the current Environment that contain optional EXPR. A `nil' value of EXPR means prompt for a value. With optional prefix ARG, EXPR is treated as a string. By default, it is treated as a regular expression. AGAIN non-nil shows the number of classes MATCHED from the last search, allowing repeated narrowing of the search set. An empty EXPR when AGAIN is `nil' matches to all classes in the Environment.

br-match-entries {M}
Show all entries in the current listing that contain optional EXPR. A `nil' value of EXPR means prompt for a value. With optional prefix ARG, EXPR is treated as a string. By default, it is treated as a regular expression. AGAIN non-nil means show the number of entries MATCHED from the last search, allowing repeated narrowing of the search set. An empty EXPR when AGAIN is `nil' matches to all entries in the listing.

br-next-entry {C-n}
Move point vertically down prefix ARG number of lines in a listing buffer.

br-order {o}
Order current browser listing window entries. With prefix ARG other than 1 (the default), don't remove leading space from entry lines before ordering. Negative ARG means order in descending Ascii sequence, otherwise order in ascending sequence.

br-parents {p}
Display the parents of the current class. With optional prefix ARG, display parents of all the classes in the current listing.

br-prev-entry {C-p}
Move point vertically up prefix ARG number of lines in a listing buffer.

br-protocols {P}
Display the protocols to which the current class or protocol conforms, including inherited ones. With optional prefix ARG, display protocols of all classes and protocols in the current listing.

br-quit {q}
Quit the OO-Browser. With optional prefix ARG, delete window configurations and listing buffers associated with the browser.

br-refresh {C-c C-r}
Restore the OO-Browser to its state upon startup.

br-report-bug {C-c C-b}
Report a bug or send some other kind of message to the OO-Browser maintainers.

br-resize-narrow {C-x -}
Narrow listing windows by 10 characters.

br-resize-widen {C-x +}
Widen listing windows by 10 characters.

br-routines
Display routines of the current class (prefix ARG = 1) or of the current listing if ARG is other than 0 or 1.

With ARG = 0, the value of the variable, br-inherited-features-flag, is toggled and no other action is taken.

If br-inherited-features-flag is `t', all routines of each class are shown. If `nil', only lexically included routines are shown and if the routines of a single class are requested and none are defined, the class definition is displayed so that its routine declarations may be browsed.

br-sys-rebuild {S}
Rescan System components of the current Environment.

br-sys-top-classes {s}
Display a list of top-level System classes. With prefix ARG, display all System classes.

br-to-from-viewer {C-c C-v}
Move point to the viewer window or back to the last recorded listing window.

br-toggle-keep-viewed
Toggle the value of the br-keep-viewed-classes flag.

br-show-all-classes {A}
Display a list of all Environment classes.

br-show-top-classes {t} or {T}
Display a list of top-level classes. With prefix ARG, display all Environment classes.

br-tree {M-d}
Start the appropriate tree application with a descendency tree of the current class. With optional prefix ARG, include a descendency tree for each class in the current listing buffer.

br-tree-features-toggle {M-f}
Toggle between showing and hiding features when br-tree is invoked to display descendants graphically.

br-tree-graph {M-g}
Start the appropriate tree application with the tree from the current listing buffer.

br-tree-kill {M-k}
Kill all current xoobr sub-processes.

br-unique {u}
Eliminate adjacent duplicate entry names from the current listing window. If two adjacent entries look the same, one is eliminated, even if they refer to different class elements.

br-version {C-c #}
Display the OO-Browser version number and credits.

br-view-entry {v}
Display source for any browser listing entry. Optional prefix arg PROMPT means prompt for an entry name; automatically prompt if called interactively outside of a listing window, e.g. within a source code buffer when the browser user interface is not displayed.

br-view-friend {V}
With point on a friend listing entry, view its source code definition. With optional OTHER-WIN non-nil, display in another window. With optional SIG-AT-POINT-FLAG non-nil, assume point is within a friend signature in a source buffer. (C++ only).

br-view-full-frame {1}
Delete all windows in the selected frame except for the viewer window.

br-viewer-beginning-of-buffer {<}
Scroll to the beginning of the viewer window buffer from within a listing window.

br-viewer-end-of-buffer {>}
Scroll to the end of the viewer window buffer from within a listing window.

br-viewer-scroll-down {DEL}
Scroll the viewer window downward ARG lines or a windowful if no ARG.

br-viewer-scroll-down-by-line {,}
Scroll the viewer window from within a listing window to show prefix ARG more prior lines (default is 1).

br-viewer-scroll-up {SPC}
Scroll the viewer window upward ARG lines or a windowful if no ARG.

br-viewer-scroll-up-by-line {.}
Scroll the viewer window from within a listing window to show prefix ARG more following lines (default is 1).

br-where {w} (in a listing window) {C-c M-w} (elsewhere)
Display in the viewer window and return the full path of the defining file for a browser listing entry. Optional prefix arg PROMPT means prompt for the entry name; automatically prompts if called interactively outside of a listing window, e.g. within a source code buffer when the browser user interface is not displayed.

br-write-buffer {C-c C-w}
Write the narrowed portion of the current browser buffer to a file.


[ << ] [ >> ]           [Top] [Contents] [Index] [ ? ]

This document was generated by XEmacs shared group account on December, 19 2009 using texi2html 1.65.