This group contains general settings for the Emacs code browser:
activate-before-layout-draw-hook | User Option |
Normal hook run at the end of activating the ecb-package by running
ecb-activate . This hooks are run after all the internal setup
process but directly before(!) drawing the layout specified in
ecb-layout (means before dividing the frame into several
windows).
A senseful using of this hook can be maximizing the Emacs-frame for
example, because this should be done before the layout is drawn
because ECB computes the size of the ECB-windows with the current
frame size! If you need a hook-option for the real end of the
activating process (i.e. after the layout-drawing) look at
IMPORTANT: The difference between this hook and
|
activate-hook | User Option |
Hook run at the end of activating ECB by ecb-activate . This
hooks are run at the real end of the activating process, means after
the layout has been drawn!. If you need hooks which are run direct
before the layout-drawing look at
ecb-activate-before-layout-draw-hook .
|
auto-activate | User Option |
Automatically startup ECB when Emacs starts up. This should only be
true if you always want to run ecb-activate .
|
auto-compatibility-check | User Option |
Check at ECB-startup if all ECB-options have correct values. If not
nil then all ECB-options are checked if their current value have the
correct type. It the type is incorrect the option is either auto.
upgraded to the new type or reset to the default-value of current ECB
if no upgrade is possible. This feature can also upgrade options which
are renamed in current ECB and try to transform the old-value to the
new named option. After startup all upgraded or reset options are
displayed with their old (before upgrade/reset) and new values. See
also the commands ecb-upgrade-options and
ecb-display-upgraded-options . If this option is off then the
user can perform the check and reset manually with
ecb-upgrade-options .
See Auto. option-upgrading.
|
before-activate-hook | User Option |
Normal hook run at the beginning of activating the ecb-package by
running ecb-activate . These hooks run before any other tasks of
the activating process are performed. If any of these hooks returns
nil then ECB will not be activated!
This can be used to check some conditions and then only start ECB if
all conditions are true. For example a function could be added which
returns only nil if Gnus is running. Then calling |
before-deactivate-hook | User Option |
Normal hook run at the beginning of deactivating ECB by running
ecb-deactivate . These hooks run before any other tasks of the
deactivating process are performed. If any of these hooks returns nil
then ECB will not be deactivated! See also
ecb-before-activate-hook .
|
bucket-node-display | User Option |
How ECB displays bucket-nodes in a ECB tree-buffer. Bucket-nodes have
only one job: Nodes with similar properties will be dropped into one
bucket for such a common property and all these nodes will be added as
children to the bucket-node. Besides being expandable and collapsable
a bucket-node has no senseful action assigned. Examples for
bucket-nodes are "[+] Variables, "[+] Dependencies" etc. in the
Methods-buffer or buckets which combine filenames with same extension
under a bucket-node with name this extension.
This option defines how bucket-node should be displayed. The name of the bucket-node is computed by ECB but you can define a prefix, a suffix and a special face for the bucket-node The default are empty prefix/suffix-strings and
|
clear-caches-before-activate | User Option |
Clear all ECB internal caches before startup. If t then ECB clears all
its internal caches before starting up. Caches are used for files- and
subdirs (see ecb-cache-directory-contents and
ecb-cache-directory-contents-not ) for semantic-tags and for
the history-filter.
This caches are completely clean at load-time of the ECB-library! Default is nil, because is makes sense not to clear these caches at
start-time because ECB is often deacticated temporally (see
|
current-buffer-sync-hook | User Option |
Normal hook run at the end of ecb-current-buffer-sync .
See documentation of Precondition for such a hook: Current buffer is the buffer of the current selected edit-window. Postcondition for such a hook: Point must stay in the same edit-window as before evaluating the hook. Important note: If It is strongly recommended that each function added to this hook uses
the macro |
deactivate-hook | User Option |
Normal hook run at the end of deactivating (but before the ecb-layout
is cleared!) ECB by running ecb-deactivate .
|
debug-mode | User Option |
If not nil ECB displays debug-information in the Messages-buffer. This
is done for some critical situations concerning semantic-tags and
their overlays (or extends for XEmacs). Normally you should not need
this switched on! But if you get errors like "destroyed extend" for
XEmacs or "wrong-argument-type" concerning overlays for GNU Emacs then
you should switch on this option and submitting a bug-report to the
ecb-mailing-list (ecb-submit-problem-report ) after getting the
error again!
|
grep-function | User Option |
Function used for performing a grep. The popup-menu of the
tree-buffers "Directories", "Sources" and "History" offer to
grep the "current" directory:
|
grep-find-function | User Option |
Function used for performing a recursive grep. For more Details see option `ecb-grep-function' and replace "grep" with "recursive grep". |
key-map | User Option |
Specifies all keybindings for the ECB minor-mode key-map. The value is
a cons-cell where the car is a common-prefix key for all the
keybindings. The cdr is a list of keybindings each of them a list
again. A key-binding has the following form:
'(<common-prefix-flag> <keysequence> <function>) where
It is highly recommended to use one of the standard keys C-c or C-x as first key of your common-prefix-key! You MUST change this option via customize to take effect! All keysequences must be inserted as a string and must follow the
syntax needed by Text is divided into "words" separated by whitespace. Except for the words described below, the characters of each word go directly as characters of the keysequence. The whitespace that separates words is ignored. Whitespace in the macro must be written explicitly, as in C-c SPC.
|
major-modes-activate | User Option |
List of major-modes for which ECB should be activated or shown. Do not
mistake this option with ecb-auto-activate . The latter one is
for activating ECB after Emacs-startup (even without opening a buffer)
and this one is for defining for which major-modes ECB should be
activated if the mode goes active!
The behavior is like follows: If a mode is contained in this option ECB is activated after activating this mode (if ECB was deactivated before) or the ECB-windows are shown if ECB was already active but its windows were hidden. In every case ECB is activated with visible ECB-windows afterwards! For every major mode there can be specified an
There are two additional options:
Any auto. activation is only done if the current-frame is unsplitted to avoid changing unnecessarily or unintentionally the frame-layout if the user just jumps between different windows. |
major-modes-deactivate | User Option |
List of major-modes for which ECB should be deactivated or hidden.
Specify if ECB should be deactivated or at least hidden if a
major-mode is active. For each major-mode there must be added an
action what should be done:
There are two additional options:
If a major-mode is listed in Any auto. deactivation/hiding is only done if the edit-window of ECB is unsplitted and point is in the edit-window to avoid changing unnecessarily or unintentionally the frame-layout if the user just jumps between different edit-windows, the tree-windows and the compile-window of ECB. There is one exception from this rule: If the edit-window is splitted and one window contains a dired-buffer and a "ECB-deactivating"-file is opened via dired then opening this file deactivates ECB (rsp. hides the ECB-windows). |
minor-mode-text | User Option |
String to display in the mode line when ECB minor mode is active. (When the string is not empty, make sure that it has a leading space.) |
primary-mouse-jump-destination | User Option |
Jump-destination of a primary mouse-button click. Defines in which
edit-window (if splitted) ECB does the "right" action (opening the
source, jumping to a method/variable) after clicking with the primary
mouse-button (see ecb-primary-secondary-mouse-buttons ) onto a
node. There are two possible choices:
If the edit-window is not splitted this setting doesn't matter. Note: A click with the secondary mouse-button (see again
|
run-ediff-in-ecb-frame | User Option |
Run ediff-sessions in the same frame as ECB is running. If not nil then ECB ensures that ediff runs in the same frame as ECB and ECB restores exactly the "before-ediff"-window-layout after quiting ediff. If nil then ediff decides in which frame it will run - depending on the current window-layout (e.g. if the ecb-windows are currently hidden) this can be the ecb-frame but this can also be a newly created frame or any other frame. |
tip-of-the-day | User Option |
Show tip of the day at start time of ECB. |
tip-of-the-day-file | User Option |
File where tip-of-the-day cursor is stored. |
use-recursive-edit | User Option |
Tell ECB to use a recursive edit. If set then it can easily be deactivated by (keyboard-escape-quit). |
version-check | User Option |
Checks at start-time if the requirements are fulfilled.
It checks if the required versions of the libraries semantic, eieio and
speedbar are installed and loaded into Emacs.
It is strongly recommended to set this option to not |
window-sync | User Option |
Synchronize the ECB-windows automatically with current edit window. If
always then the synchronization takes place always a buffer
changes in the edit window, if nil then never. If a list of
major-modes then only if the major-mode of the new buffer
belongs NOT to this list.
But in every case the synchronization takes only place if the
current-buffer in the edit-window has a relation to files or
directories. Examples for the former one are all
programming-language-modes, It's recommended to exclude at least IMPORTANT NOTE: Every time the synchronization is done the hook
|
window-sync-delay | User Option |
Time Emacs must be idle before the ECB-windows are synchronized with current edit window. If nil then there is no delay, means synchronization takes place immediately. A small value of about 0.25 seconds saves CPU resources and you get even though almost the same effect as if you set no delay. |