Previous: ECB-window synchronizing, Up: Usage of ECB


4.13 Interactive ECB commands

ECB offers a lot of interactive commands. Some of these commands prompt the user in the minibuffer if called with a prefix argument.

Example: If ecb-clear-history is called with a prefix argument then you will be prompted in the minibuffer with: 

   Clear from history: [all, not-existing-buffers, existing-buffers]

You can choose one of the options enclosed in brackets with TAB-completion; hitting RET direct after the prompt chooses auto. the first offered option (in the example above “all”).

Please note: The following interactive commands of ECB are listed without the prefix “ecb-” (e.g. the command ecb-activate is listed with name “activate”). This has been done for a better readable command index. See Command Index.

— Command: activate

Activates ECB and creates the special buffers for the choosen layout. For the layout see ecb-layout-name. This function raises always the ECB-frame if called from another frame. This is the same as calling ecb-minor-mode with a positive argument.

— Command: add-all-buffers-to-history

Add all current file-buffers to the history-buffer of ECB. Dependend on the value of ecb-history-sort-method afterwards the history is sorted either by name or by extension. If ecb-history-sort-method is nil the most recently used buffers are on the top of the history and the seldom used buffers at the bottom.

— Command: change-layout &optional preselect-type

Select a layout-name from all current available layouts (TAB-completion is offered) and change the layout to the selected layout-name. If optional argument PRESELECT-TYPE is not nil then you can preselect a layout-type \(TAB-completion is offered too) and then you will be asked only for layouts of that preselected type. Note: This function works by changing the option ecb-layout-name but only for current Emacs-session.

— Command: clear-history

Clears the history-buffer.

— Command: customize

Open a customize-buffer for all customize-groups of ECB.

— Command: customize-most-important

Open a customize-buffer for the most important

Next: , Previous: Top, Up: Top


1 Installation and first steps of ECB

This chapter describes how to install ECB and setup (X)Emacs correctly and what are the first steps after activation of ECB.

./usr/share/doc/ecb/html/Installation.html0000644000000000000000000000402210115427723020655 0ustar rootroot00000000000000 Installation - ECB - the Emacs Code Browser

Next: , Previous: Install and first steps, Up: Install and first steps


1.1 Installation of ECB

This section describes how to install ECB.

./usr/share/doc/ecb/html/Integrating-speedbar.html0000644000000000000000000001345510115427723022264 0ustar rootroot00000000000000 Integrating speedbar - ECB - the Emacs Code Browser

Next: , Previous: Simulating speedbar, Up: Tips and tricks


8.5 Integrating speedbar in the ECB-frame

It is very easy to integrate speedbar into ECB. There are two different ways to do this:

  1. You can either use speedbar in the directories-, sources- or methods-window of ECB instead of the built-in directory-, sources- or methods-browser of ECB. This can be done via the option ecb-use-speedbar-instead-native-tree-buffer.
  2. Or you can integrate an extra speedbar-window into a layout independent of the existence of a directory-, sources- or methods-window. For this you can either use the built-in layout “left-dir-plus-speedbar” or you have to create your own layout interactively with the command ecb-create-new-layout. This way is not described in more details because there is nothing more to describe - just create your layout.

In general integrating speedbar into the ECB-frame makes sense for people...

Note: It is not necessary to integrate speedbar if you only want parsing sources not supported by semantic. From version 1.94 on ECB supports native parsing and displaying of such sources (see Non-semantic sources)!

Regardless the group you belong, with the speedbar-integration feature of ECB you can combine both worlds, the speedbar- and the ECB-world:

  1. Choose a layout which either contains a directories- or a sources-window but not both of them1.

    Because speedbar has also display-modes for buffers and info-nodes and some other useful things (which can be changed by the speedbar-command speedbar-change-initial-expansion-list we recommend layouts like “left15” or “leftright3” for using with speedbar.

  2. Set the option ecb-use-speedbar-instead-native-tree-buffer to not nil. After this the chosen window of ECB will contain a full featured speedbar (the only difference to standard speedbar is not residing in an extra frame).

Note: If you belong to the first group of people (s.a.) a similar effect and usability is available by setting ecb-use-speedbar-instead-native-tree-buffer to nil and setting ecb-show-sources-in-directories-buffer to not nil, because this combination displays also directories and sources in one window.

So with the option ecb-use-speedbar-instead-native-tree-buffer you have the choice which way of displaying and handling “things” (directories, sources, methods...) you want (the speedbar- or the ECB-way).

During speedbar is running within ECB (i.e. ecb-use-speedbar-instead-native-tree-buffer is not nil) the speedbar-command speedbar is disabled and the speedbar-command speedbar-get-focus switches between the speedbar-window and the edit-window2.

IMPORTANT: ECB can only integrate speedbar-versions >= 0.14beta1! If you use lower versions of speedbar ecb-use-speedbar-instead-native-tree-buffer has no effect.

Footnotes

[1] Only one of them is needed if you use speedbar because speedbar displays directories and sources in one window. But if you like wasting space then you can also use a layout with both windows...

[2] The standard behavior is switching between the speedbar-frame and the attached frame, but this make obviously no sense during running speedbar with ECB.

./usr/share/doc/ecb/html/Interactive-ECB-commands.html0000644000000000000000000012027110115427723022664 0ustar rootroot00000000000000 Interactive ECB commands - ECB - the Emacs Code Browser

Previous: ECB-window synchronizing, Up: Usage of ECB


4.13 Interactive ECB commands

ECB offers a lot of interactive commands. Some of these commands prompt the user in the minibuffer if called with a prefix argument.

Example: If ecb-clear-history is called with a prefix argument then you will be prompted in the minibuffer with: 

   Clear from history: [all, not-existing-buffers, existing-buffers]

You can choose one of the options enclosed in brackets with TAB-completion; hitting RET direct after the prompt chooses auto. the first offered option (in the example above “all”).

Please note: The following interactive commands of ECB are listed without the prefix “ecb-” (e.g. the command ecb-activate is listed with name “activate”). This has been done for a better readable command index. See Command Index.

— Command: activate

Activates ECB and creates the special buffers for the choosen layout. For the layout see ecb-layout-name. This function raises always the ECB-frame if called from another frame. This is the same as calling ecb-minor-mode with a positive argument.

— Command: add-all-buffers-to-history

Add all current file-buffers to the history-buffer of ECB. Dependend on the value of ecb-history-sort-method afterwards the history is sorted either by name or by extension. If ecb-history-sort-method is nil the most recently used buffers are on the top of the history and the seldom used buffers at the bottom.

— Command: change-layout &optional preselect-type

Select a layout-name from all current available layouts (TAB-completion is offered) and change the layout to the selected layout-name. If optional argument PRESELECT-TYPE is not nil then you can preselect a layout-type \(TAB-completion is offered too) and then you will be asked only for layouts of that preselected type. Note: This function works by changing the option ecb-layout-name but only for current Emacs-session.

— Command: clear-history

Clears the history-buffer.

— Command: customize

Open a customize-buffer for all customize-groups of ECB.

— Command: customize-most-important

Open a customize-buffer for the most important

Next: , Previous: Top, Up: Top


1 Installation and first steps of ECB

This chapter describes how to install ECB and setup (X)Emacs correctly and what are the first steps after activation of ECB.

./usr/share/doc/ecb/html/Installation.html0000644000000000000000000000402210115427723020655 0ustar rootroot00000000000000 Installation - ECB - the Emacs Code Browser

Next: , Previous: Install and first steps, Up: Install and first steps


1.1 Installation of ECB

This section describes how to install ECB.

./usr/share/doc/ecb/html/Integrating-speedbar.html0000644000000000000000000001345510115427723022264 0ustar rootroot00000000000000 Integrating speedbar - ECB - the Emacs Code Browser

Next: , Previous: Simulating speedbar, Up: Tips and tricks


8.5 Integrating speedbar in the ECB-frame

It is very easy to integrate speedbar into ECB. There are two different ways to do this:

  1. You can either use speedbar in the directories-, sources- or methods-window of ECB instead of the built-in directory-, sources- or methods-browser of ECB. This can be done via the option ecb-use-speedbar-instead-native-tree-buffer.
  2. Or you can integrate an extra speedbar-window into a layout independent of the existence of a directory-, sources- or methods-window. For this you can either use the built-in layout “left-dir-plus-speedbar” or you have to create your own layout interactively with the command ecb-create-new-layout. This way is not described in more details because there is nothing more to describe - just create your layout.

In general integrating speedbar into the ECB-frame makes sense for people...

  • ...who like the speedbar way of handling directories and source-files but also like the ECB-way of displaying the buffer-contents (like methods and variables in a source-file). This people should use the option ecb-use-speedbar-instead-native-tree-buffer and set it to dir.
  • ...who like the speedbar way of browsing things like directories, files, file-contents etc. but who dislike the extra speedbar-frame.

Note: It is not necessary to integrate speedbar if you only want parsing sources not supported by semantic. From version 1.94 on ECB supports native parsing and displaying of such sources (see Non-semantic sources)!

Regardless the group you belong, with the speedbar-integration feature of ECB you can combine both worlds, the speedbar- and the ECB-world:

  1. Choose a layout which either contains a directories- or a sources-window but not both of them1.

    Because speedbar has also display-modes for buffers and info-nodes and some other useful things (which can be changed by the speedbar-command speedbar-change-initial-expansion-list we recommend layouts like “left15” or “leftright3” for using with speedbar.

  2. Set the option ecb-use-speedbar-instead-native-tree-buffer to not nil. After this the chosen window of ECB will contain a full featured speedbar (the only difference to standard speedbar is not residing in an extra frame).

Note: If you belong to the first group of people (s.a.) a similar effect and usability is available by setting ecb-use-speedbar-instead-native-tree-buffer to nil and setting ecb-show-sources-in-directories-buffer to not nil, because this combination displays also directories and sources in one window.

So with the option ecb-use-speedbar-instead-native-tree-buffer you have the choice which way of displaying and handling “things” (directories, sources, methods...) you want (the speedbar- or the ECB-way).

During speedbar is running within ECB (i.e. ecb-use-speedbar-instead-native-tree-buffer is not nil) the speedbar-command speedbar is disabled and the speedbar-command speedbar-get-focus switches between the speedbar-window and the edit-window2.

IMPORTANT: ECB can only integrate speedbar-versions >= 0.14beta1! If you use lower versions of speedbar ecb-use-speedbar-instead-native-tree-buffer has no effect.

Footnotes

[1] Only one of them is needed if you use speedbar because speedbar displays directories and sources in one window. But if you like wasting space then you can also use a layout with both windows...

[2] The standard behavior is switching between the speedbar-frame and the attached frame, but this make obviously no sense during running speedbar with ECB.

./usr/share/doc/ecb/html/Interactive-ECB-commands.html0000644000000000000000000012027110115427723022664 0ustar rootroot00000000000000 Interactive ECB commands - ECB - the Emacs Code Browser

Previous: ECB-window synchronizing, Up: Usage of ECB


4.13 Interactive ECB commands

ECB offers a lot of interactive commands. Some of these commands prompt the user in the minibuffer if called with a prefix argument.

Example: If ecb-clear-history is called with a prefix argument then you will be prompted in the minibuffer with: 

   Clear from history: [all, not-existing-buffers, existing-buffers]

You can choose one of the options enclosed in brackets with TAB-completion; hitting RET direct after the prompt chooses auto. the first offered option (in the example above “all”).

Please note: The following interactive commands of ECB are listed without the prefix “ecb-” (e.g. the command ecb-activate is listed with name “activate”). This has been done for a better readable command index. See Command Index.

— Command: activate

Activates ECB and creates the special buffers for the choosen layout. For the layout see ecb-layout-name. This function raises always the ECB-frame if called from another frame. This is the same as calling ecb-minor-mode with a positive argument.

— Command: add-all-buffers-to-history

Add all current file-buffers to the history-buffer of ECB. Dependend on the value of ecb-history-sort-method afterwards the history is sorted either by name or by extension. If ecb-history-sort-method is nil the most recently used buffers are on the top of the history and the seldom used buffers at the bottom.

— Command: change-layout &optional preselect-type

Select a layout-name from all current available layouts (TAB-completion is offered) and change the layout to the selected layout-name. If optional argument PRESELECT-TYPE is not nil then you can preselect a layout-type \(TAB-completion is offered too) and then you will be asked only for layouts of that preselected type. Note: This function works by changing the option ecb-layout-name but only for current Emacs-session.

— Command: clear-history

Clears the history-buffer.

— Command: customize

Open a customize-buffer for all customize-groups of ECB.

— Command: customize-most-important

Open a customize-buffer for the most important

Next: , Previous: Top, Up: Top


1 Installation and first steps of ECB

This chapter describes how to install ECB and setup (X)Emacs correctly and what are the first steps after activation of ECB.

./usr/share/doc/ecb/html/Installation.html0000644000000000000000000000402210115427723020655 0ustar rootroot00000000000000 Installation - ECB - the Emacs Code Browser

Next: , Previous: Install and first steps, Up: Install and first steps


1.1 Installation of ECB

This section describes how to install