~ubuntu-branches/ubuntu/saucy/ecb/saucy

« back to all changes in this revision

Viewing changes to html-help/ecb-methods.html

  • Committer: Bazaar Package Importer
  • Author(s): Joerg Jaspert
  • Date: 2004-09-01 22:15:18 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20040901221518-0jfdt2apb2rj69ey
Tags: 2.27-1
And include latest Upstream too...

Show diffs side-by-side

added added

removed removed

Lines of Context:
53
53
<p>
54
54
<table width="100%">
55
55
<tr>
 
56
<td align="left"><b>auto-expand-tag-tree-collapse-other</b><i>
 
57
</i></td>
 
58
<td align="right">User Option</td>
 
59
</tr>
 
60
</table>
 
61
<table width="95%" align="center">
 
62
<tr><td>
 
63
Auto. expanding the tag-tree collapses all not related nodes. There
 
64
are several choices:
 
65
 
 
66
<ul>
 
67
<li>Only if on tag:
 
68
This means collapsing all nodes which have no relevance for the
 
69
currently highlighted node will be collapsed, because they are not
 
70
necessary to make the highlighted node visible. But do this only if
 
71
point stays onto a tag in the selected edit-window.
 
72
 
 
73
<li>Always:
 
74
Same as before but collapse also when point doesn't stays on a tag
 
75
(e.g. between two defuns in elisp) in the selected edit-window. This
 
76
means in such a situation a full collapsing of the methods-buffer.
 
77
 
 
78
<li>Never:
 
79
Do not automatically collapse the methods-buffer. 
 
80
</ul>
 
81
</td></tr>
 
82
</table>
 
83
 
 
84
<p>
 
85
<table width="100%">
 
86
<tr>
56
87
<td align="left"><b>auto-update-methods-after-save</b><i>
57
88
</i></td>
58
89
<td align="right">User Option</td>
67
98
<p>
68
99
<table width="100%">
69
100
<tr>
 
101
<td align="left"><b>default-tag-filter</b><i>
 
102
</i></td>
 
103
<td align="right">User Option</td>
 
104
</tr>
 
105
</table>
 
106
<table width="95%" align="center">
 
107
<tr><td>
 
108
Default tag-filters for certain files. This option allow to define
 
109
default tag-filters for certain files which are applied automatically
 
110
after loading such a file into a buffer. The possible filters are the
 
111
same as offered by the command <code>ecb-methods-filter</code> and they are
 
112
applied in the same manner - the only difference is they are applied
 
113
automatically. Please be aware that symbol-filters (e.g. 
 
114
protection-symbols like public or private) must not be inserted with
 
115
quotes whereas a filter-regexp has to be inserted with surrounding
 
116
double-quotes! In addition backslashes in a regexp have to be doubled!
 
117
 
 
118
<p>For each file-spec (a major-mode plus a file-regexp which both specify
 
119
a file for which filters should be applied) there can be as much
 
120
filters as needed - they are layered like with
 
121
<code>ecb-methods-filter</code> too.
 
122
 
 
123
<p>Tag-classes which are completely hidden or excluded by the option
 
124
<code>ecb-show-tags</code> will never being displayed in the Methods-buffer
 
125
regardless of the filters of this option! 
 
126
</td></tr>
 
127
</table>
 
128
 
 
129
<p>
 
130
<table width="100%">
 
131
<tr>
 
132
<td align="left"><b>display-image-icons-for-semantic-tags</b><i>
 
133
</i></td>
 
134
<td align="right">User Option</td>
 
135
</tr>
 
136
</table>
 
137
<table width="95%" align="center">
 
138
<tr><td>
 
139
Display nice and pretty icons for semantic-tags in the Methods-buffer. 
 
140
This option takes only effect if Emacs can display images and if
 
141
<code>ecb-tree-buffer-style</code> is set to <code>image</code>. 
 
142
</td></tr>
 
143
</table>
 
144
 
 
145
<p>
 
146
<table width="100%">
 
147
<tr>
70
148
<td align="left"><b>exclude-parents-regexp</b><i>
71
149
</i></td>
72
150
<td align="right">User Option</td>
74
152
</table>
75
153
<table width="95%" align="center">
76
154
<tr><td>
77
 
Regexp which parent classes should not be shown in the methods buffer
 
155
Regexps which parent classes should not be shown in the methods buffer
78
156
(see also <code>ecb-show-parents</code>). If nil then all parents will be
79
157
shown if <code>ecb-show-parents</code> is not nil.
80
158
 
226
304
<p>
227
305
<table width="100%">
228
306
<tr>
 
307
<td align="left"><b>methods-filter-replace-existing</b><i>
 
308
</i></td>
 
309
<td align="right">User Option</td>
 
310
</tr>
 
311
</table>
 
312
<table width="95%" align="center">
 
313
<tr><td>
 
314
How the methods-filter should be applied to existing filters. There
 
315
are three different choices:
 
316
 
 
317
<ul>
 
318
<li><code>never</code>:
 
319
This is the default and means that calling <code>ecb-methods-filter</code>
 
320
always adds the new filter on top of already existing filters. So you
 
321
can combine several filter to one combined like this example: 'Display
 
322
only all public methods having the string "test" in its name.' With
 
323
this setting the filters can only be cleared by calling
 
324
<code>ecb-methods-filter</code> and then choosing "nothing".
 
325
 
 
326
<li><code>always</code>:
 
327
This means that <code>ecb-methods-filter</code> always clears a previous
 
328
filter before applying the new one.
 
329
 
 
330
<li><code>ask</code>:
 
331
ECB asks if the new filter should replace the existing ones. 
 
332
</ul>
 
333
</td></tr>
 
334
</table>
 
335
 
 
336
<p>
 
337
<table width="100%">
 
338
<tr>
229
339
<td align="left"><b>methods-menu-sorter</b><i>
230
340
</i></td>
231
341
<td align="right">User Option</td>
347
457
<p>
348
458
<table width="100%">
349
459
<tr>
 
460
<td align="left"><b>methods-separate-prototypes</b><i>
 
461
</i></td>
 
462
<td align="right">User Option</td>
 
463
</tr>
 
464
</table>
 
465
<table width="95%" align="center">
 
466
<tr><td>
 
467
Separate function-prototypes from the real functions. This is for
 
468
example useful for C++ and C because these languages distinct between
 
469
a method-prototype (rsp. function-prototype for C) and the method
 
470
(rsp. function for C) itself. If this option is not nil then ECB
 
471
separates the prototypes from the real function/methods. Then with
 
472
<code>ecb-show-tags</code> the user can define different display-settings
 
473
for each of them. If this option is nil then the prototypes and the
 
474
real functions are filled in the same bucket and displayed plain and
 
475
there is no sorting between prototypes and functions possible. If this
 
476
option is switched on then it is senseful that <code>ecb-show-tags</code>
 
477
contains for all modes which distinct between prototypes and real
 
478
functions/methods two entries for the tag-type 'function - see the
 
479
documentation of this option. 
 
480
</td></tr>
 
481
</table>
 
482
 
 
483
<p>
 
484
<table width="100%">
 
485
<tr>
350
486
<td align="left"><b>post-process-semantic-taglist</b><i>
351
487
</i></td>
352
488
<td align="right">User Option</td>
414
550
<table width="95%" align="center">
415
551
<tr><td>
416
552
How to show tags in the methods buffer first time after find-file. 
417
 
This variable is a list where each element represents a type of
418
 
tags:
 
553
This functionality is set on a major-mode base, i.e. for every
 
554
major-mode a different setting can be used. The value of this option
 
555
is a list of cons-cells:
 
556
 
 
557
<p>The car is either a major-mode symbol or the special symbol 'default
 
558
which means if no setting for a certain major-mode is defined then the
 
559
cdr of the 'default cons-cell is used. This option should always
 
560
contain a default-setting!
 
561
 
 
562
<p>The cdr is a list where each element represents a type of tags:
419
563
 
420
564
<br><pre>(&lt;tag type&gt; &lt;display type&gt; &lt;sort method&gt;)
421
565
</pre>
422
566
 
 
567
<p>There can be more than 1 element for a certain &lt;tag type&gt;. This is for
 
568
example useful for C++ and C because these languages distinct between
 
569
a method-prototype (rsp. function-prototype for C) and the method
 
570
(rsp. function for C) itself. The default value of these option
 
571
contains two entries for &lt;tag type&gt; is <code>function</code> whereas the
 
572
first one is responsible for the "real" methods (rsp. functions) and
 
573
the second one for the prototypes. So if the methods should be
 
574
flattened and the prototypes collapsed the show-tags-list for C++ and
 
575
C must contain two entries for &lt;tag type&gt; <code>function</code>, the first
 
576
one defined as <code>flattened</code> and the second one defined as
 
577
<code>collapsed</code>.
 
578
 
423
579
<p>The tags in the methods buffer are displayed in the order as they appear in
424
580
this list.
425
581
 
597
753
function for details what they do.
598
754
 
599
755
<p>But you can add any arbitrary function if the following conditions are
600
 
fulfilled: The function gets the semantic tag as argument returns
601
 
the (new) point after finishing its job. 
 
756
fulfilled: The function gets the semantic tag as argument, returns the
 
757
(new) point after finishing its job and the function must not put the
 
758
point outside the tag-boundaries of the tag-argument. 
602
759
</td></tr>
603
760
</table>
604
761