ECB - the Emacs Code Browser: Elisp programming

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

# 9. Entry points for elisp programmers

This chapter describes how ECB can be used/programmed/driven by an elisp-program. This contains:

> 9.1 Variables for elisp-programs |  | Which variables an elisp-program can use
> 9.2 Available hooks of ECB |  | All available hooks
> 9.3 The library tree-buffer.el |  | Some words to the tree-buffer-library
> 9.4 How to deal with the adviced window-functions |  | How to deal with the adviced functions
> 9.5 How to program new layouts |  |

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

## 9.1 Variables for elisp-programs

Variables an elisp-program can use:

- `ecb-source-path-functions`

Look at the documentation of these variables to get a description.

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

## 9.2 Available hooks of ECB

The following hooks are available:

- `ecb-activate-before-new-frame-created-hook`
- `ecb-activate-before-layout-draw-hook`
- `ecb-activate-hook`
- `ecb-deactivate-hook`
- `ecb-show-ecb-windows-hook`
- `ecb-hide-ecb-windows-hook`
- `ecb-current-buffer-sync-hook`

Look at the documentation of these hooks to get a description.

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

## 9.3 The library tree-buffer.el

The library tree-buffer.el is ECB independent and can be used for other applications too. But such an application is not allowed to use any of the variables of tree-buffer.el especially not the variable tree-buffers!

`tree-buffers`: Only for internal use. It contains all tree-buffers of current Emacs-instance, means all tree-buffers of all applications which uses currently tree-buffers. Every application must store its own collection of tree-buffers in an own variable! For example: ECB stores its tree-buffer set in `ecb-tree-buffers`!

An application may only use the methods tree-buffer.el provides but no internal variables!

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

## 9.4 How to deal with the adviced window-functions

ECB offers for packages which work during activated ECB three macros for easy temporally(6) using all original-functions, all adviced functions or only some adviced functions:

- `ecb-with-original-functions`
- `ecb-with-adviced-functions`
- `ecb-with-some-adviced-functions`

For a detailed explanation of each macro read the documentation with `describe-function`!

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

## 9.5 How to program new layouts

Documentation will be added in future!

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

This document was generated on December, 6 2002 using texi2html