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

« back to all changes in this revision

Viewing changes to info-help/ecb.info-4

  • 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:
6
6
END-INFO-DIR-ENTRY
7
7
 
8
8
 
 
9
File: ecb.info,  Node: Maximizing the ECB windows,  Next: Back/forward navigation,  Prev: Hiding the ECB windows,  Up: Usage of ECB
 
10
 
 
11
Maximizing the ECB windows
 
12
==========================
 
13
 
 
14
To get a better overlook about the contents of a certain ECB-window every
 
15
ECB-window can be "maximized", means all other ECB-windows are deleted so
 
16
only the edit-window(s) and this maximized ECB-window are visible (and maybe
 
17
a compile-window if active). There are several ways to do this:
 
18
 
 
19
 * Via the popup-menus of the ECB-windows
 
20
 
 
21
 * Via the main "ECB"-menu and here "Display window maximized"
 
22
 
 
23
 * Via calling the adviced version of `delete-other-windows'(1) (bound to
 
24
   `C-x 1') in one of the ECB windows.
 
25
 
 
26
 * Via one of the commands `ecb-maximize-window-directories',
 
27
   `ecb-maximize-window-sources', `ecb-maximize-window-methods',
 
28
   `ecb-maximize-window-history' or `ecb-maximize-window-speedbar' or the
 
29
   bound short-cuts for those commands.
 
30
 
 
31
 * Via the new command `ecb-cycle-maximized-ecb-buffers' which cycles through
 
32
   all ecb-buffers of current layout by maximizing exactly one of the
 
33
   ecb-windows after every cycle-step.
 
34
 
 
35
 * Via the option `ecb-maximize-ecb-window-after-selection' and then just by
 
36
   selecting an ECB-window. "Deselecting" an ECB-window brings back all
 
37
   ECB-windows of current layout.
 
38
 
 
39
 * Via the default modeline-mechanisms for deleting other windows. GNU Emacs
 
40
   binds `mouse-2' in its modeline to `delete-other-window'. ECB now supports
 
41
   this mechanism by binding a toggle-command to `mouse-2' in the modeline of
 
42
   each tree-buffer: If all ECB-windows are visible then this command
 
43
   maximizes the current tree-window and if current tree-window is maximized
 
44
   all ECB-windows are displayed again. XEmacs binds a popup-menu with some
 
45
   window commands to `button-3' in its modeline. ECB supports this mechanism
 
46
   by replacing this menu by a menu which offers exactly 2 commands:
 
47
   Maximizing current tree-window and displaying all ECB-windows.
 
48
 
 
49
Minimizing such a maximized ECB-window, i.e. bringing back to its original
 
50
size, can simply be done by redrawing the layout via the command
 
51
`ecb-redraw-layout' (bound to `C-c . lr').
 
52
 
 
53
---------- Footnotes ----------
 
54
 
 
55
(1) This command is adviced per default, see *Note The edit-area::.
 
56
 
 
57
 
 
58
File: ecb.info,  Node: Back/forward navigation,  Next: ECB-window synchronizing,  Prev: Maximizing the ECB windows,  Up: Usage of ECB
 
59
 
 
60
Back- and forward navigation like a browser
 
61
===========================================
 
62
 
 
63
With ECB you can "browse" in your source-files like with a web-browser. This
 
64
means ECB stores the current buffer- and window-position relative to the
 
65
current tag(1) in the edit-window after
 
66
 
 
67
 - selecting a tag in the ECB-methods buffer or
 
68
 
 
69
 - selecting a source-file in the ECB-sources/history-buffer.
 
70
 
 
71
ECB offers two commands `ecb-nav-goto-next' (`C-c . n') and
 
72
`ecb-nav-goto-previous' (`C-c . p') to go forward and backward within this
 
73
navigation history-list. These commands are also available via the menu "ECB
 
74
-> Navigate".
 
75
 
 
76
Aside normal "location-browsing" this is useful for example in a scenario
 
77
where the buffer is narrowed to a tag (see `ecb-tag-visit-post-actions'):
 
78
 
 
79
1. You edit a function
 
80
 
 
81
2. Goto another function above the current in the same file
 
82
 
 
83
3. Add a few lines
 
84
 
 
85
4. Call ecb-nav-goto-previous
 
86
 
 
87
   Now you will edit at the same place in the function.
 
88
 
 
89
---------- Footnotes ----------
 
90
 
 
91
(1) e.g. a method, a variable or any other semantic tag
 
92
 
 
93
 
 
94
File: ecb.info,  Node: ECB-window synchronizing,  Next: Interactive ECB commands,  Prev: Back/forward navigation,  Up: Usage of ECB
 
95
 
 
96
Synchronization of the ECB-windows
 
97
==================================
 
98
 
 
99
Per default ECB synchronizes automatically the contents of the
 
100
ECB-windows/tree-buffers with the current active edit-window (rsp. the
 
101
current buffer of the edit window):
 
102
 
 
103
 * ECB-directories:
 
104
 
 
105
   This windows is synchronized to display the directory where the
 
106
   source-file which is displayed in the current active edit-window is
 
107
   located. If the source-path (i.e. an element of the option
 
108
   `ecb-source-path') containing this directory is not expanded it will be
 
109
   auto. expanded according to the value of the option
 
110
   `ecb-auto-expand-directory-tree' (*note ecb-directories::).
 
111
 
 
112
 * ECB-sources:
 
113
 
 
114
   The ECB-sources-buffer contains after synchronizing all the sources of the
 
115
   directory of the "current" source-file displayed in the edit-window. The
 
116
   entry of the "current" source-file is highlighted.
 
117
 
 
118
 * ECB-methods:
 
119
 
 
120
   Contains after synchronizing all the tags of the buffer in the current
 
121
   selected edit-window, i.e. all methods, variables etc... depending of the
 
122
   major-mode.
 
123
 
 
124
 * ECB-history:
 
125
 
 
126
   Highlights the entry of the buffer displayed in the current active
 
127
   edit-window if this buffer is a source-file.
 
128
 
 
129
 
 
130
This feature can be customized with the option `ecb-window-sync':
 
131
 
 
132
If active then the synchronization takes place always a buffer changes in an
 
133
edit window or if another edit-window with another buffer will be selected,
 
134
if deactivated then never. But you can also set this option to a list of
 
135
major-modes and then the sync. will only be done if the major-mode of the
 
136
current buffer belongs NOT to this list.
 
137
 
 
138
But in every case the synchronization takes only place if the major-mode of
 
139
the current-buffer in the current selected edit-window has a relation to
 
140
files or directories. Examples for the former one are all
 
141
programming-language-modes like `c++-mode' or `java-mode', `Info-mode' too,
 
142
an example for the latter one is `dired-mode'. For all major-modes related to
 
143
non-file/directory-buffers like `help-mode', `customize-mode' and others
 
144
never a synchronization will be done!
 
145
 
 
146
It's recommended to exclude at least `Info-mode' because it makes no sense to
 
147
synchronize the ECB-windows after calling the Info help.  Per default also
 
148
`dired-mode' is excluded but it can also making sense to synchronize the
 
149
ECB-directories/sources windows with the current directory of the
 
150
dired-buffer in the edit-window.
 
151
 
 
152
If you often need to toggle between autom. synchronization on and off then
 
153
customizing the option `ecb-window-sync' is inefficient and therefore ECB
 
154
offers the command `ecb-toggle-window-sync'.
 
155
 
 
156
*Please note*: With the command `ecb-window-sync' you can do a manually
 
157
synchronization if the automatic one is switched off or if you just want to
 
158
do this!
 
159
 
 
160
 
9
161
File: ecb.info,  Node: Interactive ECB commands,  Prev: ECB-window synchronizing,  Up: Usage of ECB
10
162
 
11
163
Interactive ECB commands
35
187
   `ecb-minor-mode' with a positive argument.
36
188
 
37
189
 - Command: add-all-buffers-to-history
38
 
   Add all current file-buffers to the history-buffer of ECB. If
39
 
   `ecb-sort-history-items' is not nil then afterwards the history is sorted
40
 
   alphabetically. Otherwise the most recently used buffers are on the top of
41
 
   the history and the seldom used buffers at the bottom.
 
190
   Add all current file-buffers to the history-buffer of ECB. Dependend on
 
191
   the value of `ecb-history-sort-method' afterwards the history is sorted
 
192
   either by name or by extension. If `ecb-history-sort-method' is nil the
 
193
   most recently used buffers are on the top of the history and the seldom
 
194
   used buffers at the bottom.
42
195
 
43
196
 - Command: change-layout &optional preselect-type
44
197
   Select a layout-name from all current available layouts (TAB-completion is
178
331
   other file types which are parsed by imenu or etags (see
179
332
   `ecb-process-non-semantic-files') FORCE-ALL is always true!
180
333
 
 
334
 - Command: dump-semantic-toplevel
 
335
   Dump the current semantic-tags in special buffer and display them.
 
336
 
181
337
 - Command: eshell-current-buffer-sync
182
338
   Synchronize the eshell with the directory of current source-buffer.  This
183
339
   is only done if the eshell is currently visible in the compile-window of
280
436
   compile-window). Does nothing if the speedbar-window is not visible within
281
437
   the ECB-frame.
282
438
 
 
439
 - Command: methods-filter
 
440
   Apply a filter to the Methods-buffer to reduce the number of entries.  So
 
441
   you get a better overlooking. There are six choices:
 
442
 
 
443
    * Filter by protection: Just insert the protection you want the
 
444
      Methods-buffer being filtered: private, protected or public!
 
445
 
 
446
    * Filter by regexp: Insert the filter as regular expression.
 
447
 
 
448
    * Filter by tag-class: You can filter by the tag-classes of current
 
449
      major-mode. The available tag-classes come from the variable
 
450
      `semantic--symbol->name-assoc-list'. The are normally methods,
 
451
      variables etc.
 
452
 
 
453
    * Filter by current type: In languages which have types like Java or C++
 
454
      this filter displays only the current type and all its members (e.g.
 
455
      attributes and methods). If ECB can not identify the current type in the
 
456
      source-buffer or in the methods-window then nothing will be done.
 
457
 
 
458
    * Filter by a filter-function: Such a function gets two arguments: a tag
 
459
      and the source-buffer of this tag. If the tag should be displayed (i.e.
 
460
      not being filtered out) then the function has to return not nil
 
461
      otherwise nil.
 
462
 
 
463
    * No special filter: This means to display all tags specified with the
 
464
      option `ecb-show-tokens'. If currently some of the above filters are
 
465
      applied they will be all removed.
 
466
 
 
467
    * Delete the last added: This removes only the topmost filter-layer,
 
468
      means that filter added last.
 
469
 
 
470
   The protection-, current-type- and the tag-class-filter are only available
 
471
   for semantic-supported sources.
 
472
 
 
473
   Be aware that the tag-list specified by the option `ecb-show-tags' is the
 
474
   basis of all filters, i.e. tags which are excluded by that option will
 
475
   never be shown regardless of the filter type here!
 
476
 
 
477
   All tags which match the applied filter(s) will be displayed in the
 
478
   Methods-buffer.
 
479
 
 
480
   If called with a prefix-argument or when optional arg INVERSE is not nil
 
481
   then an inverse filter is applied to the Methods-buffer, i.e. all tags
 
482
   which do NOT match the choosen filter will be displayed in the
 
483
   Methods-buffer!
 
484
 
 
485
   Per default the choosen filter will be applied on top of already existing
 
486
   filters. This means that filters applied before are combined with the new
 
487
   filter. This behavior can changed via the option
 
488
   `ecb-methods-filter-replace-existing'. But regardless of the setting in
 
489
   `ecb-methods-filter-replace-existing' applying one of the not-inverse
 
490
   filters protection, tag-class or current-type always replaces exactly
 
491
   already existing filters of that type. On the other hand applying more
 
492
   than one inverse tag-class- or protection-filter can make sense.
 
493
 
 
494
   Such a filter is only applied to the current source-buffer, i.e. each
 
495
   source-buffer can have its own tag-filters.
 
496
 
 
497
   The current active filter will be displayed in the modeline of the
 
498
   Methods-buffer [regexp, prot (= protection), tag-class, function (=
 
499
   filter-function)]. If an inverse filter has been applied then this is
 
500
   signalized by a preceding caret ^. If currently more than 1 filter is
 
501
   applied then always the top-most filter is displayed in the modeline but
 
502
   the fact of more than 1 filter is visualized by the number of the filters
 
503
   - included in parens. You can see all currently applied filters by moving
 
504
   the mouse over the filter-string in modeline of the Methods-buffer: They
 
505
   will displayed as help-echo.
 
506
 
 
507
   See the option `ecb-default-tag-filter' if you search for automatically
 
508
   applied default-tag-filters.
 
509
 
 
510
 - Command: methods-filter-current-type
 
511
   Display in the Methods-buffer only the current type and its members.  For
 
512
   further details see `ecb-methods-filter'.
 
513
 
 
514
 - Command: methods-filter-delete-last
 
515
   Remove the most recent filter from the Methods-buffer. For further details
 
516
   see `ecb-methods-filter'.
 
517
 
 
518
 - Command: methods-filter-function &optional inverse
 
519
   Filter the methods-buffer by a function. If INVERSE is not nil (called
 
520
   with a prefix arg) then an inverse filter is applied. For further details
 
521
   see `ecb-methods-filter'.
 
522
 
 
523
 - Command: methods-filter-nofilter
 
524
   Remove any filter from the Methods-buffer. For further details see
 
525
   `ecb-methods-filter'.
 
526
 
 
527
 - Command: methods-filter-protection &optional inverse
 
528
   Filter the methods-buffer by protection. If INVERSE is not nil (called
 
529
   with a prefix arg) then an inverse filter is applied. For further details
 
530
   see `ecb-methods-filter'.
 
531
 
 
532
 - Command: methods-filter-regexp &optional inverse
 
533
   Filter the methods-buffer by a regexp. If INVERSE is not nil (called with
 
534
   a prefix arg) then an inverse filter is applied. For further details see
 
535
   `ecb-methods-filter'.
 
536
 
 
537
 - Command: methods-filter-tagclass &optional inverse
 
538
   Filter the methods-buffer by tag-class. If INVERSE is not nil (called with
 
539
   a prefix arg) then an inverse filter is applied. For further details see
 
540
   `ecb-methods-filter'.
 
541
 
283
542
 - Command: minor-mode &optional arg
284
543
   Toggle ECB minor mode. With prefix argument ARG, turn on if positive,
285
544
   otherwise off. Return non-`nil' if the minor mode is enabled.
407
666
   Such a filter is only applied to the current selected directory, i.e. each
408
667
   directory has its own filtered sources-buffer.
409
668
 
410
 
 - Command: store-window-sizes &optional fix
 
669
 - Command: store-window-sizes &optional FIX
411
670
   Stores the sizes of the ECB windows for the current layout. The size of
412
671
   the ECB windows will be set to their stored values when
413
672
   `ecb-redraw-layout' or `ecb-restore-window-sizes' is called.  To reset the
417
676
 
418
677
   The windows sizes are stored per default as fractions of current
419
678
   frame-width and -height of the ecb-frame, so the stored values will "work"
420
 
   for other frame sizes too. But if FIX is not nil (means called with a
421
 
   prefix argument) then the fixed values of current width and height are
422
 
   stored!
 
679
   for other frame sizes too. If a permanent compile-window is visible then
 
680
   ECB will tell you that window-sizes should be stored with hidden
 
681
   compile-window and ask you if you want proceed; if you proceed then the
 
682
   window-heights will be stored as fractions of current (frame-height minus
 
683
   current visible compile-window-height) so you should ensure that the
 
684
   current compile-window has its standard-height as specified in
 
685
   `ecb-compile-window-height'!. If FIX is not nil (means called with a
 
686
   prefix argument) then always the fixed values of current width and height
 
687
   are stored!
423
688
 
424
689
 - Command: submit-problem-report
425
690
   Submit a problem report for the ECB to the ECB mailing-list. This command
460
725
   (de)activating ECB but only affects the visibility of the ECB windows. ECB
461
726
   minor mode remains active!
462
727
 
463
 
 - Command: toggle-layout
 
728
 - Command: toggle-layout &optional last-one
464
729
   Toggles between the layouts defined in `ecb-toggle-layout-sequence' (See
465
730
   also option `ecb-show-sources-in-directories-buffer'). Note: This function
466
731
   works by changing the options `ecb-layout-name' but only for current
467
732
   Emacs-session.
468
733
 
 
734
   If optional argument LAST-ONE is not nil (e.g. called with a prefix-arg)
 
735
   then always the last selected layout was choosen regardless of the setting
 
736
   in `ecb-toggle-layout-sequence'. The last selected layout is always that
 
737
   layout which was current direct before the most recent layout-switch. So
 
738
   now a user can switch to another layout via `ecb-change-layout' and always
 
739
   come back to his previous layout via `[C-u]' `ecb-toggle-layout'.
 
740
 
469
741
 - Command: toggle-scroll-other-window-scrolls-compile &optional ARG
470
742
   Toggle the state of `ecb-scroll-other-window-scrolls-compile-window'. With
471
743
   prefix argument ARG, set it to `t', otherwise to `nil'. For all details
856
1128
* ecb-download::                Customizing how to download ECB
857
1129
* ecb-help::                    Customizing the online help of ECB
858
1130
* ecb-eshell::                  Customizing the eshell-integration
 
1131
* ecb-speedbar::                Customizing the speedbar-integration
859
1132
* ecb-non-semantic::            Customizing parsing non-semantic sources
860
1133
* ecb-winman::                  Customizing window-manager support
861
1134
* ecb-mode-line::               Customizing the tree-buffer-modelines