Node:The layout-engine API, Previous:Possible layout-outlines, Up:The layout-engine

The complete layout-engine API of ECB

This section lists all functions, macros, variables and user-options the layout-engine API of ECB offers foreign packages. Call describe-function rsp. describe-variable to get a detailed description.

Functions and macros for programming with layouts and special ecb-windows:

• defecb-window-dedicator
• ecb-available-layouts-member-p
• ecb-canonical-ecb-windows-list
• ecb-canonical-edit-windows-list
• ecb-compile-window-live-p
• ecb-compile-window-state
• ecb-do-if-buffer-visible-in-ecb-frame
• ecb-exec-in-window
• ecb-get-current-visible-ecb-buffers
• ecb-layout-define
• ecb-layout-switch
• ecb-layout-undefine
• ecb-point-in-compile-window
• ecb-point-in-ecb-window
• ecb-point-in-edit-window
• ecb-select-edit-window
• ecb-split-hor
• ecb-split-ver
• ecb-where-is-point
• ecb-with-dedicated-window¹

Utility functions/macros:

• ecb-display-one-ecb-buffer
• ecb-enlarge-window
• ecb-fix-filename
• ecb-goto-ecb-window
• ecb-window-live-p
• ecb-with-readonly-buffer

Some other maybe useful functions/macros:

• ecb-with-adviced-functions
• ecb-with-original-functions
• ecb-with-some-adviced-functions

Some useful READONLY variables:

• ecb-compile-window
• ecb-last-edit-window-with-point
• ecb-last-source-buffer

Caution: DO NOT USE THE VARIABLE ecb-edit-window IN YOUR PROGRAMS!

User-options and hooks related to the layout-engine API:

• ecb-current-buffer-sync-hook
• ecb-hide-ecb-windows-after-hook
• ecb-hide-ecb-windows-before-hook
• ecb-redraw-layout-after-hook
• ecb-redraw-layout-before-hook
• ecb-show-ecb-windows-after-hook
• ecb-show-ecb-windows-before-hook
• ecb-windows-height
• ecb-windows-width
• ecb-compile-window-height

Footnotes

1. Normally not needed because defecb-window-dedicator does all necessary.