File: The-layout-engine-API.html

package info (click to toggle)
ecb 2.32-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k, lenny, squeeze
  • size: 5,236 kB
  • ctags: 1,790
  • sloc: lisp: 24,391; makefile: 143; sh: 57
file content (98 lines) | stat: -rw-r--r-- 3,326 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
<html lang="en">
<head>
<title>ECB - the Emacs Code Browser</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name=description content="ECB - the Emacs Code Browser">
<meta name=generator content="makeinfo 4.2">
<link href="http://www.gnu.org/software/texinfo/" rel=generator-home>
</head>
<body>
<p>
Node:<a name="The%20layout-engine%20API">The layout-engine API</a>,
Previous:<a rel=previous accesskey=p href="Possible-layout-outlines.html#Possible%20layout-outlines">Possible layout-outlines</a>,
Up:<a rel=up accesskey=u href="The-layout-engine.html#The%20layout-engine">The layout-engine</a>
<hr><br>

<h4>The complete layout-engine API of ECB</h4>

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

<p>Functions and macros for programming with layouts and special
ecb-windows:
<ul>
<li><code>defecb-window-dedicator</code>
<li><code>ecb-available-layouts-member-p</code>
<li><code>ecb-canonical-ecb-windows-list</code>
<li><code>ecb-canonical-edit-windows-list</code>
<li><code>ecb-compile-window-live-p</code>
<li><code>ecb-compile-window-state</code>
<li><code>ecb-do-if-buffer-visible-in-ecb-frame</code>
<li><code>ecb-exec-in-window</code>
<li><code>ecb-get-current-visible-ecb-buffers</code>
<li><code>ecb-layout-define</code>
<li><code>ecb-layout-switch</code>
<li><code>ecb-layout-undefine</code>
<li><code>ecb-point-in-compile-window</code>
<li><code>ecb-point-in-ecb-window</code>
<li><code>ecb-point-in-edit-window</code>
<li><code>ecb-select-edit-window</code>
<li><code>ecb-split-hor</code>
<li><code>ecb-split-ver</code>
<li><code>ecb-where-is-point</code>
<li><code>ecb-with-dedicated-window</code><a rel=footnote href="#fn-1"><sup>1</sup></a>
</ul>

<p>Utility functions/macros:
<ul>
<li><code>ecb-display-one-ecb-buffer</code>
<li><code>ecb-enlarge-window</code>
<li><code>ecb-fix-filename</code>
<li><code>ecb-goto-ecb-window</code>
<li><code>ecb-window-live-p</code>
<li><code>ecb-with-readonly-buffer</code>
</ul>

<p>Some other maybe useful functions/macros:
<ul>
<li><code>ecb-with-adviced-functions</code>
<li><code>ecb-with-original-functions</code>
<li><code>ecb-with-some-adviced-functions</code>
</ul>

<p>Some useful <strong>READONLY</strong> variables:
<ul>
<li><code>ecb-compile-window</code>
<li><code>ecb-last-edit-window-with-point</code>
<li><code>ecb-last-source-buffer</code>
</ul>

<p><strong>Caution</strong>: DO NOT USE THE VARIABLE <code>ecb-edit-window</code> IN
YOUR PROGRAMS!

<p>User-options and hooks related to the layout-engine API:
<ul>
<li><code>ecb-current-buffer-sync-hook</code>
<li><code>ecb-hide-ecb-windows-after-hook</code>
<li><code>ecb-hide-ecb-windows-before-hook</code>
<li><code>ecb-redraw-layout-after-hook</code>
<li><code>ecb-redraw-layout-before-hook</code>
<li><code>ecb-show-ecb-windows-after-hook</code>
<li><code>ecb-show-ecb-windows-before-hook</code>
<li><code>ecb-windows-height</code>
<li><code>ecb-windows-width</code>
<li><code>ecb-compile-window-height</code>
</ul>

<hr><h4>Footnotes</h4>
<ol type="1">
<li><a name="fn-1"></a>
<p>Normally not needed because
<code>defecb-window-dedicator</code> does all necessary.</p>

</ol><hr>

</body></html>