annotate doc/misc/speedbar.texi @ 98597:36ba1f7c4d10

*** empty log message ***
author Eli Zaretskii <eliz@gnu.org>
date Fri, 10 Oct 2008 08:54:08 +0000
parents beeefbf6b7d7
children 6de181810d0f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
84317
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1 \input texinfo @c -*-texinfo-*-
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2
84329
3d431f1997d8 (setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents: 84317
diff changeset
3 @setfilename ../../info/speedbar
84317
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4 @settitle Speedbar: File/Tag summarizing utility
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5 @syncodeindex fn cp
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7 @copying
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8 Copyright @copyright{} 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
87903
5d58981e6690 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84329
diff changeset
9 2007, 2008 Free Software Foundation, Inc.
84317
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11 @quotation
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12 Permission is granted to copy, distribute and/or modify this document
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13 under the terms of the GNU Free Documentation License, Version 1.2 or
95934
beeefbf6b7d7 Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
14 any later version published by the Free Software Foundation; with no
beeefbf6b7d7 Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
15 Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
beeefbf6b7d7 Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
16 and with the Back-Cover Texts as in (a) below. A copy of the license
beeefbf6b7d7 Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
17 is included in the section entitled ``GNU Free Documentation License''.
84317
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18
95934
beeefbf6b7d7 Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
19 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
beeefbf6b7d7 Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
20 modify this GNU manual. Buying copies from the FSF supports it in
beeefbf6b7d7 Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
21 developing GNU and promoting software freedom.''
84317
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22 @end quotation
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
23 @end copying
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
24
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
25 @dircategory Emacs
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
26 @direntry
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
27 * Speedbar: (speedbar). File/Tag summarizing utility.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
28 @end direntry
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
29
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
30 @titlepage
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
31 @sp 10
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
32 @center @titlefont{Speedbar}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
33 @sp 2
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
34 @center Eric Ludlam
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
35 @vskip 0pt plus 1 fill
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
36 @page
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
37 @vskip 0pt plus 1filll
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
38 @insertcopying
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
39 @end titlepage
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
40
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
41 @node Top, , , (dir)Top
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
42 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
43
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
44 Speedbar is a program for Emacs which can be used to summarize
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
45 information related to the current buffer. Its original inspiration
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
46 is the `explorer' often used in modern development environments, office
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
47 packages, and web browsers.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
48
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
49 Speedbar displays a narrow frame in which a tree view is shown. This
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
50 tree view defaults to containing a list of files and directories. Files
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
51 can be `expanded' to list tags inside. Directories can be expanded to
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
52 list the files within itself. Each file or tag can be jumped to
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
53 immediately.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
54
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
55 Speedbar expands upon `explorer' windows by maintaining context with the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
56 user. For example, when using the file view, the current buffer's file
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
57 is highlighted. Speedbar also mimics the explorer windows by providing
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
58 multiple display modes. These modes come in two flavors. Major display
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
59 modes remain consistent across buffers, and minor display modes appear
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
60 only when a buffer of the applicable type is shown. This allows
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
61 authors of other packages to provide speedbar summaries customized to
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
62 the needs of that mode.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
63
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
64 Throughout this manual, activities are defined as `clicking on', or
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
65 `expanding' items. Clicking means using @kbd{Mouse-2} on a
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
66 button. Expanding refers to clicking on an expansion button to display
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
67 an expanded summary of the entry the expansion button is
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
68 on. @xref{Basic Navigation}.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
69
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
70 @menu
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
71 * Introduction:: Basics of speedbar.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
72 * Basic Navigation:: Basics of speedbar common between all modes.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
73 * File Mode:: Summarizing files.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
74 * Buffer Mode:: Summarizing buffers.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
75 * Minor Modes:: Additional minor modes such as Info and RMAIL.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
76 * Customizing:: Changing speedbar behavior.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
77 * Extending:: Extend speedbar for your own project.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
78 * GNU Free Documentation License:: The license for this documentation.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
79 * Index::
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
80 @end menu
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
81
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
82 @node Introduction, Basic Navigation, , Top
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
83 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
84 @chapter Introduction
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
85 @cindex introduction
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
86
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
87 To start using speedbar use the command @kbd{M-x speedbar RET} or
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
88 select it from the @samp{Options->Show/Hide} sub-menu. This command
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
89 will open a new frame to summarize the local files. On X Window
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
90 systems or on MS-Windows, speedbar's frame is twenty characters wide,
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
91 and will mimic the height of the frame from which it was started. It
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
92 positions itself to the left or right of the frame you started it
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
93 from.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
94
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
95 To use speedbar effectively, it is important to understand its
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
96 relationship with the frame you started it from. This frame is the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
97 @dfn{attached frame} which speedbar will use as a reference point. Once
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
98 started, speedbar watches the contents of this frame, and attempts to
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
99 make its contents relevant to the buffer loaded into the attached
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
100 frame. In addition, all requests made in speedbar that require the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
101 display of another buffer will display in the attached frame.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
102
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
103 When used in terminal mode, the new frame appears the same size as the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
104 terminal. Since it is not visible while working in the attached frame,
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
105 speedbar will save time by using the @dfn{slowbar mode}, where no tracking is
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
106 done until speedbar is requested to show itself (i.e., the speedbar's
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
107 frame becomes the selected frame).
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
108
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
109 @cindex @code{speedbar-get-focus}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
110 The function to use when switching between frames using the keyboard is
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
111 @code{speedbar-get-focus}. This function will toggle between frames, and
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
112 it's useful to bind it to a key in terminal mode. @xref{Customizing}.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
113
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
114 @node Basic Navigation, File Mode, Introduction, Top
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
115 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
116 @chapter Basic Navigation
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
117
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
118 Speedbar can display different types of data, and has several display
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
119 and behavior modes. These modes all have a common behavior, menu
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
120 system, and look. If one mode is learned, then the other modes are easy
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
121 to use.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
122
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
123 @menu
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
124 * Basic Key Bindings::
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
125 * Basic Visuals::
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
126 * Mouse Bindings::
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
127 * Displays Submenu::
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
128 @end menu
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
129
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
130 @node Basic Key Bindings, Basic Visuals, Basic Navigation, Basic Navigation
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
131 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
132 @section Basic Key Bindings
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
133 @cindex key bindings
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
134
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
135 These key bindings are common across all modes:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
136
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
137 @table @kbd
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
138 @item Q
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
139 @cindex quitting speedbar
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
140 Quit speedbar, and kill the frame.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
141 @item q
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
142 Quit speedbar, and hide the frame. This makes it faster to restore the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
143 speedbar frame, than if you press @kbd{Q}.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
144 @item g
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
145 @cindex refresh speedbar display
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
146 Refresh whatever contents are in speedbar.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
147 @item t
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
148 @cindex slowbar mode
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
149 Toggle speedbar to and from slowbar mode. In slowbar mode, frame
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
150 tracking is not done.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
151 @item n
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
152 @itemx p
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
153 @cindex navigation
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
154 Move, respectively, to the next or previous item. A summary of that
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
155 item will be displayed in the attached frame's minibuffer.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
156 @item M-n
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
157 @itemx M-p
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
158 Move to the next or previous item in a restricted fashion. If a list is
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
159 open, the cursor will skip over it. If the cursor is in an open list,
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
160 it will not leave it.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
161 @item C-M-n
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
162 @itemx C-M-n
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
163 Move forwards and backwards across extended groups. This lets you
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
164 quickly skip over all files, directories, or other common sub-items at
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
165 the same current depth.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
166 @item C-x b
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
167 Switch buffers in the attached frame.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
168 @end table
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
169
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
170 Speedbar can handle multiple modes. Two are provided by default.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
171 These modes are File mode, and Buffers mode. There are accelerators to
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
172 switch into these different modes.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
173
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
174 @cindex mode switching hotkeys
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
175 @table @kbd
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
176 @item b
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
177 Switch into Quick Buffers mode (@pxref{Buffer Mode}). After one use, the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
178 previous display mode is restored.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
179 @item f
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
180 Switch into File mode.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
181 @item r
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
182 Switch back to the previous mode.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
183 @end table
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
184
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
185 Some modes provide groups, lists and tags. @xref{Basic Visuals}. When
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
186 these are available, some additional common bindings are available.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
187
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
188 @cindex common keys
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
189 @table @kbd
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
190 @item RET
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
191 @itemx e
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
192 Edit/Open the current group or tag. This behavior is dependent on the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
193 mode. In general, files or buffers are opened in the attached frame,
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
194 and directories or group nodes are expanded locally.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
195 @item +
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
196 @itemx =
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
197 Expand the current group, displaying sub items.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
198 When used with a prefix argument, any data that may have been cached is
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
199 flushed. This is similar to a power click. @xref{Mouse Bindings}.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
200 @item -
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
201 Contract the current group, hiding sub items.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
202 @end table
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
203
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
204 @node Basic Visuals, Mouse Bindings, Basic Key Bindings, Basic Navigation
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
205 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
206 @section Basic Visuals
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
207 @cindex visuals
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
208
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
209 Speedbar has visual cues for indicating different types of data. These
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
210 cues are used consistently across the different speedbar modes to make
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
211 them easier to interpret.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
212
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
213 At a high level, in File mode, there are directory buttons, sub
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
214 directory buttons, file buttons, tag buttons, and expansion buttons.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
215 This makes it easy to use the mouse to navigate a directory tree, and
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
216 quickly view files, or a summary of those files.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
217
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
218 The most basic visual effect used to distinguish between these button
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
219 types is color and mouse highlighting. Anything the mouse highlights
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
220 can be clicked on and is called a button (@pxref{Mouse Bindings}).
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
221 Anything not highlighted by the mouse will not be clickable.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
222
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
223 Text in speedbar consists of four different types of data. Knowing how
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
224 to read these textual elements will make it easier to navigate by
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
225 identifying the types of data available.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
226
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
227 @subsubsection Groups
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
228 @cindex groups
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
229
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
230 Groups summarize information in a single line, and provide a high level
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
231 view of more complex systems, like a directory tree, or manual chapters.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
232
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
233 Groups appear at different indentation levels, and are prefixed with a
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
234 @samp{+} in some sort of `box'. The group name will summarize the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
235 information within it, and the expansion box will display that
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
236 information inline. In File mode, directories and files are `groups'
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
237 where the @samp{+} is surrounded by brackets like this:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
238
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
239 @example
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
240 <+> include
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
241 <-> src
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
242 [+] foo.c
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
243 @end example
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
244
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
245 In this example, we see both open and closed directories, in addition to
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
246 a file. The directories have a box consisting of angle brackets, and a
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
247 file uses square brackets.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
248
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
249 In all modes, a group can be `edited' by pressing @kbd{RET}, meaning a
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
250 file will be opened, or a directory explicitly opened in speedbar. A
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
251 group can be expanded or contracted using @kbd{+} or
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
252 @kbd{-}. @xref{Basic Key Bindings}.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
253
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
254 Sometimes groups may have a @samp{?} in its indicator box. This means
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
255 that it is a group type, but there are no contents, or no known way of
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
256 extracting contents of that group.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
257
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
258 When a group has been expanded, the indicator button changes from
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
259 @samp{+} to @samp{-}. This indicates that the contents are being shown.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
260 Click the @samp{-} button to contract the group, or hide the contents
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
261 currently displayed.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
262
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
263 @subsubsection Tags
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
264 @cindex tags
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
265
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
266 Tags are the leaf nodes of the tree system. Tags are generally prefixed
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
267 with a simple character, such as @samp{>}. Tags can only be jumped to using
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
268 @kbd{RET} or @kbd{e}.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
269
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
270 @subsubsection Boolean Flags
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
271
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
272 Sometimes a group or tag is given a boolean flag. These flags appear as
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
273 extra text characters at the end of the line. File mode uses boolean
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
274 flags, such as a @samp{*} to indicate that a file has been checked out
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
275 of a versioning system.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
276
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
277 For additional flags, see
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
278 @c Note to self, update these to sub-nodes which are more relevant.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
279 @ref{File Mode}, and @ref{Version Control}.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
280
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
281 @subsubsection Unadorned Text
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
282
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
283 Unadorned text generally starts in column 0, without any special symbols
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
284 prefixing them. In Buffers mode different buffer groups are prefixed
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
285 with a description of what the following buffers are (Files, scratch
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
286 buffers, and invisible buffers.)
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
287
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
288 Unadorned text will generally be colorless, and not clickable.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
289
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
290 @subsubsection Color Cues
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
291
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
292 Each type of Group, item indicator, and label is given a different
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
293 color. The colors chosen are dependent on whether the background color
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
294 is light or dark.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
295 Of important note is that the `current item', which may be a buffer or
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
296 file name, is highlighted red, and underlined.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
297
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
298 Colors can be customized from the group @code{speedbar-faces}. Some
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
299 modes, such as for Info, will use the Info colors instead of default
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
300 speedbar colors as an indication of what is currently being displayed.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
301
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
302 The face naming convention mirrors the File display mode. Modes which
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
303 do not use files will attempt to use the same colors on analogous
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
304 entries.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
305
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
306 @node Mouse Bindings, Displays Submenu, Basic Visuals, Basic Navigation
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
307 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
308 @section Mouse Bindings
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
309 @cindex mouse bindings
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
310
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
311 The mouse has become a common information navigation tool. Speedbar
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
312 will use the mouse to navigate file systems, buffer lists, and other
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
313 data. The different textual cues provide buttons which can be clicked
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
314 on (@pxref{Basic Visuals}). Anything that highlights can be clicked on
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
315 with the mouse, or affected by the menu.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
316
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
317 The mouse bindings are:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
318
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
319 @table @kbd
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
320 @item Mouse-1
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
321 Move cursor to that location.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
322 @item Mouse-2
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
323 @itemx Double-Mouse-1
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
324 Activate the current button. @kbd{Double-Mouse-1} is called a @dfn{double
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
325 click} on other platforms, and is useful for windows users with two
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
326 button mice.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
327 @c Isn't it true that with two-button mice, the right button is Mouse-2?
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
328 @c On GNU/Linux, the right button is Mouse-3.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
329 @item S-Mouse-2
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
330 @itemx S-Double-Mouse-1
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
331 @cindex power click
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
332 This has the same effect as @kbd{Mouse-2}, except it is called a power
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
333 click. This means that if a group with an expansion button @samp{+} is
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
334 clicked, any caches are flushed, and subitems re-read. If it is a name,
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
335 it will be opened in a new frame.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
336 @item Mouse-3
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
337 Activate the speedbar menu. The item selected affects the line clicked,
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
338 not the line where the cursor was.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
339 @item Mouse-1 @r{(mode line)}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
340 Activate the menu. This affects the item the cursor is on before the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
341 click, since the mouse was not clicked on anything.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
342 @item C-Mouse-1
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
343 Buffers sub-menu. The buffer in the attached frame is switched.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
344 @end table
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
345
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
346 When the mouse moves over buttons in speedbar, details of that item
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
347 should be displayed in the minibuffer of the attached frame. Sometimes
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
348 this can contain extra information such as file permissions, or tag
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
349 location.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
350
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
351 @node Displays Submenu, , Mouse Bindings, Basic Navigation
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
352 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
353 @section Displays Submenu
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
354 @cindex displays submenu
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
355
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
356 You can display different data by using different display modes. These
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
357 specialized modes make it easier to navigate the relevant pieces of
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
358 information, such as files and directories, or buffers.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
359
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
360 In the main menu, found by clicking @kbd{Mouse-3}, there is a submenu
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
361 labeled @samp{Displays}. This submenu lets you easily choose between
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
362 different display modes.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
363
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
364 The contents are modes currently loaded into emacs. By default, this
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
365 would include Files, Quick Buffers, and Buffers. Other major display
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
366 modes such as Info are loaded separately.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
367
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
368 @node File Mode, Buffer Mode, Basic Navigation, Top
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
369 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
370 @chapter File Mode
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
371 @cindex file mode
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
372
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
373 File mode displays a summary of your current directory. You can display
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
374 files in the attached frame, or summarize the tags found in files. You
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
375 can even see if a file is checked out of a version control system, or
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
376 has some associated object file.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
377
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
378 Advanced behavior, like copying and renaming files, is also provided.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
379
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
380 @menu
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
381 * Directory Display:: What the display means.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
382 * Hidden Files:: How to display hidden files.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
383 * File Key Bindings:: Performing file operations.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
384 @end menu
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
385
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
386 @node Directory Display, Hidden Files, File Mode, File Mode
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
387 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
388 @section Directory Display
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
389 @cindex directory display
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
390
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
391 There are three major sections in the display. The first line or two is
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
392 the root directory speedbar is currently viewing. You can jump to one
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
393 of the parent directories by clicking on the name of the directory you
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
394 wish to jump to.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
395
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
396 Next, directories are listed. A directory starts with the group
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
397 indicator button @samp{<+>}. Clicking the directory name makes speedbar
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
398 load that directory as the root directory for its display. Clicking the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
399 @samp{<+>} button will list all directories and files beneath.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
400
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
401 Next, files are listed. Files start with the group indicator @samp{[+]}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
402 or @samp{[?]}. You can jump to a file in the attached frame by clicking
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
403 on the file name. You can expand a file and look at its tags by
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
404 clicking on the @samp{[+]} symbol near the file name.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
405
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
406 A typical session might look like this:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
407
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
408 @example
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
409 ~/lisp/
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
410 <+> checkdoc
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
411 <+> eieio
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
412 <-> speedbar
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
413 [+] Makefile
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
414 [+] rpm.el #
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
415 [+] sb-gud.el #
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
416 [+] sb-info.el #
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
417 [+] sb-rmail.el #
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
418 [+] sb-w3.el
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
419 [-] speedbar.el *!
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
420 @{+@} Types
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
421 @{+@} Variables
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
422 @{+@} def (group)
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
423 @{+@} speedbar-
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
424 [+] speedbar.texi *
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
425 <+> testme
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
426 [+] align.el
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
427 [+] autoconf.el
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
428 @end example
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
429
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
430 In this example, you can see several directories. The directory
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
431 @file{speedbar} has been opened inline. Inside the directory
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
432 @file{speedbar}, the file @file{speedbar.el} has its tags exposed.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
433 These tags are extensive, and they are summarized into tag groups.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
434
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
435 Files get additional boolean flags associated with them. Valid flags are:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
436
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
437 @cindex file flags
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
438 @table @code
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
439 @item *
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
440 This file has been checked out of a version control
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
441 system. @xref{Version Control}.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
442 @cindex @code{speedbar-obj-alist}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
443 @item #
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
444 This file has an up to date object file associated with it. The
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
445 variable @code{speedbar-obj-alist} defines how speedbar determines this
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
446 value.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
447 @item !
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
448 This file has an out of date object file associated with it.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
449 @end table
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
450
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
451 A Tag group is prefixed with the symbol @samp{@{+@}}. Clicking this
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
452 symbol will show all symbols that have been organized into that group.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
453 Different types of files have unique tagging methods as defined by their
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
454 major mode. Tags are generated with either the @code{imenu} package, or
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
455 through the @code{etags} interface.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
456
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
457 Tag groups are defined in multiple ways which make it easier to find the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
458 tag you are looking for. Imenu keywords explicitly create groups, and
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
459 speedbar will automatically create groups if tag lists are too long.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
460
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
461 In our example, Imenu created the groups @samp{Types} and
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
462 @samp{Variables}. All remaining top-level symbols are then regrouped
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
463 based on the variable @code{speedbar-tag-hierarchy-method}. The
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
464 subgroups @samp{def} and @samp{speedbar-} are groupings where the first
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
465 few characters of the given symbols are specified in the group name.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
466 Some group names may say something like @samp{speedbar-t to speedbar-v},
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
467 indicating that all symbols which alphabetically fall between those
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
468 categories are included in that sub-group. @xref{Tag Hierarchy Methods}.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
469
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
470 @node Hidden Files, File Key Bindings, Directory Display, File Mode
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
471 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
472 @section Hidden Files
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
473 @cindex hidden files
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
474
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
475 On GNU and Unix systems, a hidden file is a file whose name starts
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
476 with a period. They are hidden from a regular directory listing
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
477 because the user is not generally interested in them.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
478
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
479 In speedbar, a hidden file is a file which isn't very interesting and
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
480 might prove distracting to the user. Any uninteresting files are
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
481 removed from the File display. There are two levels of uninterest in
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
482 speedbar. The first level of uninterest are files which have no
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
483 expansion method, or way of extracting tags. The second level is any
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
484 file that matches the same pattern used for completion in
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
485 @code{find-file}. This is derived from the variable
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
486 @code{completion-ignored-extensions}.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
487
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
488 You can toggle the display of uninteresting files from the toggle menu
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
489 item @samp{Show All Files}. This will display all level one hidden files.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
490 These files will be shown with a @samp{?} indicator. Level 2 hidden
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
491 files will still not be shown.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
492
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
493 Object files fall into the category of level 2 hidden files. You can
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
494 determine their presence by the @samp{#} and @samp{!} file indicators.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
495 @xref{Directory Display}.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
496
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
497 @node File Key Bindings, , Hidden Files, File Mode
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
498 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
499 @section File Key Bindings
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
500 @cindex file key bindings
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
501
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
502 File mode has key bindings permitting different file system operations
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
503 such as copy or rename. These commands all operate on the @dfn{current
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
504 file}. In this case, the current file is the file at point, or clicked
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
505 on when pulling up the menu.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
506
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
507 @table @kbd
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
508 @item U
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
509 Move the entire speedbar display up one directory.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
510 @item I
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
511 Display information in the minibuffer about this line. This is the same
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
512 information shown when navigating with @kbd{n} and @kbd{p}, or moving
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
513 the mouse over an item.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
514 @item B
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
515 Byte compile the Emacs Lisp file on this line.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
516 @item L
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
517 Load the Emacs Lisp file on this line. If a @file{.elc} file exists,
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
518 optionally load that.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
519 @item C
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
520 Copy the current file to some other location.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
521 @item R
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
522 Rename the current file, possibly moving it to some other location.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
523 @item D
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
524 Delete the current file.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
525 @item O
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
526 Delete the current file's object file. Use the symbols @samp{#} and
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
527 @samp{!} to determine if there is an object file available.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
528 @end table
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
529
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
530 One menu item toggles the display of all available files. By default,
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
531 only files which Emacs understands, and knows how to convert into a tag
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
532 list, are shown. By showing all files, additional files such as text files are
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
533 also displayed, but they are prefixed with the @samp{[?]} symbol. This
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
534 means that it is a file, but Emacs doesn't know how to expand it.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
535
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
536 @node Buffer Mode, Minor Modes, File Mode, Top
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
537 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
538 @chapter Buffer Mode
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
539 @cindex buffer mode
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
540
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
541 Buffer mode is very similar to File mode, except that instead of
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
542 tracking the current directory and all files available there, the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
543 current list of Emacs buffers is shown.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
544
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
545 These buffers can have their tags expanded in the same way as files,
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
546 and uses the same unknown file indicator (@pxref{File Mode}).
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
547
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
548 Buffer mode does not have file operation bindings, but the following
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
549 buffer specific key bindings are available:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
550
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
551 @table @kbd
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
552 @item k
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
553 Kill this buffer. Do not touch its file.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
554 @item r
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
555 Revert this buffer, reloading from disk.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
556 @end table
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
557
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
558 In addition to Buffer mode, there is also Quick Buffer mode. In fact,
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
559 Quick Buffers is bound to the @kbd{b} key. The only difference between
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
560 Buffers and Quick Buffers is that after one operation is performed
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
561 which affects the attached frame, the display is immediately reverted to
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
562 the last displayed mode.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
563
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
564 Thus, if you are in File mode, and you need quick access to a buffer,
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
565 press @kbd{b}, click on the buffer you want, and speedbar will revert
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
566 back to File mode.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
567
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
568 @node Minor Modes, Customizing, Buffer Mode, Top
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
569 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
570 @chapter Minor Display Modes
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
571 @cindex minor display modes
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
572
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
573 For some buffers, a list of files and tags makes no sense. This could
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
574 be because files are not currently in reference (such as web pages), or
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
575 that the files you might be interested have special properties (such as
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
576 email folders.)
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
577
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
578 In these cases, a minor display mode is needed. A minor display mode
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
579 will override any major display mode currently being displayed for the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
580 duration of the specialized buffer's use. Minor display modes
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
581 will follow the general rules of their major counterparts in terms of
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
582 key bindings and visuals, but will have specialized behaviors.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
583
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
584 @menu
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
585 * RMAIL:: Managing folders.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
586 * Info:: Browsing topics.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
587 * GDB:: Watching expressions or managing the current
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
588 stack trace.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
589 @end menu
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
590
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
591 @node RMAIL, Info, Minor Modes, Minor Modes
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
592 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
593 @section RMAIL
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
594 @cindex RMAIL
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
595
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
596 When using RMAIL, speedbar will display two sections. The first is a
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
597 layer one reply button. Clicking here will initialize a reply buffer
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
598 showing only this email address in the @samp{To:} field.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
599
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
600 The second section lists all RMAIL folders in the same directory as your
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
601 main RMAIL folder. The general rule is that RMAIL folders always appear
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
602 in all caps, or numbers. It is possible to save mail in folders with
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
603 lower case letters, but there is no clean way of detecting such RMAIL folders
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
604 without opening them all.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
605
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
606 Each folder can be visited by clicking the name. You can move mail from
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
607 the current RMAIL folder into a different folder by clicking the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
608 @samp{<M>} button. The @samp{M} stands for Move.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
609
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
610 In this way you can manage your existing RMAIL folders fairly easily
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
611 using the mouse.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
612
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
613 @node Info, GDB, RMAIL, Minor Modes
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
614 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
615 @section Info
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
616 @cindex Info
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
617
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
618 When browsing Info files, all local relevant information is displayed in
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
619 the info buffer and a topical high-level view is provided in speedbar.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
620 All top-level info nodes are shown in the speedbar frame, and can be
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
621 jumped to by clicking the name.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
622
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
623 You can open these nodes with the @samp{[+]} button to see what sub-topics
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
624 are available. Since these sub-topics are not examined until you click
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
625 the @samp{[+]} button, sometimes a @samp{[?]} will appear when you click on
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
626 a @samp{[+]}, indicating that there are no sub-topics.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
627
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
628 @node GDB, , Info, Minor Modes
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
629 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
630 @section GDB
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
631 @cindex gdb
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
632 @cindex gud
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
633
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
634 You can debug an application with GDB in Emacs using graphical mode or
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
635 text command mode (@pxref{GDB Graphical Interface,,, emacs, The
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
636 extensible self-documenting text editor}).
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
637
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
638 If you are using graphical mode you can see how selected variables
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
639 change each time your program stops (@pxref{Watch Expressions,,,
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
640 emacs, The extensible self-documenting text editor}).
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
641
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
642 If you are using text command mode, speedbar can show
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
643 you the current stack when the current buffer is the @file{*gdb*}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
644 buffer. Usually, it will just report that there is no stack, but when
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
645 the application is stopped, the current stack will be shown.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
646
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
647 You can click on any stack element and gdb will move to that stack
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
648 level. You can then check variables local to that level at the GDB
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
649 prompt.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
650
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
651 @node Customizing, Extending, Minor Modes, Top
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
652 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
653 @chapter Customizing
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
654 @cindex customizing
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
655
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
656 Speedbar is highly customizable, with a plethora of control elements.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
657 Since speedbar is so visual and reduces so much information, this is an
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
658 important aspect of its behavior.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
659
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
660 In general, there are three custom groups you can use to quickly modify
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
661 speedbar's behavior.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
662
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
663 @table @code
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
664 @item speedbar
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
665 Basic speedbar behaviors.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
666 @item speedbar-vc
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
667 Customizations regarding version control handling.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
668 @item speedbar-faces
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
669 Customize speedbar's many colors and fonts.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
670 @end table
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
671
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
672 @menu
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
673 * Frames and Faces:: Visible behaviors.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
674 * Tag Hierarchy Methods:: Customizing how tags are displayed.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
675 * Version Control:: Adding new VC detection modes.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
676 * Hooks:: The many hooks you can use.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
677 @end menu
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
678
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
679 @node Frames and Faces, Tag Hierarchy Methods, Customizing, Customizing
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
680 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
681 @section Frames and Faces
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
682 @cindex faces
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
683 @cindex frame parameters
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
684
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
685 There are several faces speedbar generates to provide a consistent
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
686 color scheme across display types. You can customize these faces using
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
687 your favorite method. They are:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
688
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
689 @table @asis
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
690 @cindex @code{speedbar-button-face}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
691 @item speedbar-button-face
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
692 Face used on expand/contract buttons.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
693 @cindex @code{speedbar-file-face}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
694 @item speedbar-file-face
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
695 Face used on Files. Should also be used on non-directory like nodes.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
696 @cindex @code{speedbar-directory-face}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
697 @item speedbar-directory-face
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
698 Face used for directories, or nodes which consist of groups of other nodes.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
699 @cindex @code{speedbar-tag-face}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
700 @item speedbar-tag-face
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
701 Face used for tags in a file, or for leaf items.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
702 @cindex @code{speedbar-selected-face}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
703 @item speedbar-selected-face
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
704 Face used to highlight the selected item. This would be the current
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
705 file being edited.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
706 @cindex @code{speedbar-highlight-face}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
707 @item speedbar-highlight-face
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
708 Face used when the mouse passes over a button.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
709 @end table
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
710
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
711 You can also customize speedbar's initial frame parameters. How this is
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
712 accomplished is dependent on your platform being Emacs or XEmacs.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
713
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
714 @cindex @code{speedbar-frame-parameters}, Emacs
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
715 In Emacs, change the alist @code{speedbar-frame-parameters}. This
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
716 variable is used to set up initial details. Height is also
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
717 automatically added when speedbar is created, though you can override
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
718 it.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
719
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
720 @cindex @code{speedbar-frame-plist}, XEmacs
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
721 In XEmacs, change the plist @code{speedbar-frame-plist}. This is the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
722 XEmacs way of doing the same thing.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
723
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
724 @node Tag Hierarchy Methods, Version Control, Frames and Faces, Customizing
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
725 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
726 @section Tag Hierarchy Methods
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
727 @cindex tag hierarchy
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
728 @cindex tag groups
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
729 @cindex tag sorting
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
730
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
731 When listing tags within a file, it is possible to get an annoyingly
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
732 long list of entries. Imenu (which generates the tag list in Emacs)
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
733 will group some classes of items automatically. Even here, however,
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
734 some tag groups can be quite large.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
735
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
736 @cindex @code{speedbar-tag-hierarchy-method}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
737 To solve this problem, tags can be grouped into logical units through a
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
738 hierarchy processor. The specific variable to use is
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
739 @code{speedbar-tag-hierarchy-method}. There are several methods that
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
740 can be applied in any order. They are:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
741
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
742 @table @code
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
743 @cindex @code{speedbar-trim-words-tag-hierarchy}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
744 @item speedbar-trim-words-tag-hierarchy
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
745 Find a common prefix for all elements of a group, and trim it off.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
746 @cindex @code{speedbar-prefix-group-tag-hierarchy}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
747 @item speedbar-prefix-group-tag-hierarchy
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
748 If a group is too large, place sets of tags into bins based on common
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
749 prefixes.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
750 @cindex @code{speedbar-simple-group-tag-hierarchy}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
751 @item speedbar-simple-group-tag-hierarchy
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
752 Take all items in the top level list not in a group, and stick them into
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
753 a @samp{Tags} group.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
754 @cindex @code{speedbar-sort-tag-hierarchy}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
755 @item speedbar-sort-tag-hierarchy
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
756 Sort all items, leaving groups on top.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
757 @end table
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
758
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
759 You can also add your own functions to reorganize tags as you see fit.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
760
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
761 Some other control variables are:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
762
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
763 @table @code
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
764 @cindex @code{speedbar-tag-group-name-minimum-length}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
765 @item speedbar-tag-group-name-minimum-length
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
766 Default value: 4.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
767
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
768 The minimum length of a prefix group name before expanding. Thus, if
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
769 the @code{speedbar-tag-hierarchy-method} includes
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
770 @code{speedbar-prefix-group-tag-hierarchy} and one such group's common
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
771 characters is less than this number of characters, then the group name
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
772 will be changed to the form of:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
773
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
774 @example
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
775 worda to wordb
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
776 @end example
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
777
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
778 instead of just
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
779
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
780 @example
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
781 word
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
782 @end example
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
783
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
784 This way we won't get silly looking listings.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
785
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
786 @cindex @code{speedbar-tag-split-minimum-length}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
787 @item speedbar-tag-split-minimum-length
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
788 Default value: 20.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
789
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
790 Minimum length before we stop trying to create sub-lists in tags.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
791 This is used by all tag-hierarchy methods that break large lists into
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
792 sub-lists.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
793
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
794 @cindex @code{speedbar-tag-regroup-maximum-length}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
795 @item speedbar-tag-regroup-maximum-length
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
796 Default value: 10.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
797
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
798 Maximum length of submenus that are regrouped.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
799 If the regrouping option is used, then if two or more short subgroups
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
800 are next to each other, then they are combined until this number of
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
801 items is reached.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
802 @end table
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
803
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
804 @node Version Control, Hooks, Tag Hierarchy Methods, Customizing
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
805 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
806 @section Version Control
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
807 @cindex version control
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
808 @cindex vc extensions
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
809
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
810 When using the file mode in speedbar, information regarding a version
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
811 control system adds small details to the display. If a file is in a
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
812 version control system, and is ``checked out'' or ``locked'' locally, an
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
813 asterisk @samp{*} appears at the end of the file name. In addition,
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
814 the directory name for Version Control systems are left out of the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
815 speedbar display.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
816
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
817 @cindex @code{speedbar-directory-unshown-regexp}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
818 You can easily add new version control systems into speedbar's detection
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
819 scheme. To make a directory ``disappear'' from the list, use the variable
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
820 @code{speedbar-directory-unshown-regexp}.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
821
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
822 @cindex @code{speedbar-vc-path-enable-hook}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
823 Next, you need to write entries for two hooks. The first is
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
824 @code{speedbar-vc-path-enable-hook} which will enable a VC check in the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
825 current directory for the group of files being checked. Your hook
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
826 function should take one parameter (the directory to check) and return
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
827 @code{t} if your VC method is in control here.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
828
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
829 @cindex @code{speedbar-vc-in-control-hook}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
830 The second function is @code{speedbar-vc-in-control-hook}. This hook
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
831 takes two parameters, the @var{path} of the file to check, and the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
832 @var{file} name. Return @code{t} if you want to have the asterisk
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
833 placed near this file.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
834
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
835 @cindex @code{speedbar-vc-indicator}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
836 Lastly, you can change the VC indicator using the variable
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
837 @code{speedbar-vc-indicator}, and specify a single character string.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
838
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
839 @node Hooks, , Version Control, Customizing
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
840 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
841 @section Hooks
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
842 @cindex hooks
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
843
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
844 There are several hooks in speedbar allowing custom behaviors to be
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
845 added. Available hooks are:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
846
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
847 @table @code
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
848 @cindex @code{speedbar-visiting-file-hook}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
849 @item speedbar-visiting-file-hook
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
850 Hooks run when speedbar visits a file in the selected frame.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
851 @cindex @code{speedbar-visiting-tag-hook}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
852 @item speedbar-visiting-tag-hook
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
853 Hooks run when speedbar visits a tag in the selected frame.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
854 @cindex @code{speedbar-load-hook}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
855 @item speedbar-load-hook
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
856 Hooks run when speedbar is loaded.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
857 @cindex @code{speedbar-reconfigure-keymaps-hook}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
858 @item speedbar-reconfigure-keymaps-hook
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
859 Hooks run when the keymaps are regenerated. Keymaps are reconfigured
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
860 whenever modes change. This will let you add custom key bindings.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
861 @cindex @code{speedbar-before-popup-hook}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
862 @item speedbar-before-popup-hook
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
863 Hooks called before popping up the speedbar frame.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
864 New frames are often popped up when ``power clicking'' on an item to view
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
865 it.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
866 @cindex @code{speedbar-before-delete-hook}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
867 @item speedbar-before-delete-hook
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
868 Hooks called before deleting or hiding the speedbar frame.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
869 @cindex @code{speedbar-mode-hook}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
870 @item speedbar-mode-hook
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
871 Hooks called after creating a speedbar buffer.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
872 @cindex @code{speedbar-timer-hook}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
873 @item speedbar-timer-hook
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
874 Hooks called after running the speedbar timer function.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
875 @cindex @code{speedbar-scanner-reset-hook}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
876 @item speedbar-scanner-reset-hook
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
877 Hook called whenever generic scanners are reset.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
878 Set this to implement your own scanning or rescan safe functions with
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
879 state data.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
880 @end table
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
881
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
882 @node Extending, GNU Free Documentation License, Customizing, Top
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
883 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
884 @chapter Extending
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
885 @cindex extending
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
886
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
887 Speedbar can run different types of Major display modes such as Files
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
888 (@pxref{File Mode}), and Buffers (@pxref{Buffer Mode}). It can also manage
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
889 different minor display modes for use with buffers handling specialized
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
890 data.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
891
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
892 These major and minor display modes are handled through an extension
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
893 system which permits specialized keymaps and menu extensions, in
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
894 addition to a unique rendering function. You can also specify a wide
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
895 range of tagging functions. The default uses @code{imenu}, but new
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
896 tagging methods can be easily added. In this chapter, you will
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
897 learn how to write your own major or minor display modes, and how to
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
898 create specialized tagging functions.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
899
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
900 @menu
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
901 * Minor Display Modes:: How to create a minor display mode.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
902 * Major Display Modes:: How to create a major display mode.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
903 * Tagging Extensions:: How to create your own tagging methods.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
904 * Creating a display:: How to insert buttons and hierarchies.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
905 @end menu
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
906
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
907 @node Minor Display Modes, Major Display Modes, Extending, Extending
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
908 @section Minor Display Modes
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
909 @cindex create minor display mode
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
910
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
911 A @dfn{minor display mode} is a mode useful when using a specific type of
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
912 buffer. This mode might not be useful for any other kind of data or
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
913 mode, or may just be more useful that a files or buffers based mode when
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
914 working with a specialized mode.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
915
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
916 Examples that already exist for speedbar include RMAIL, Info, and gdb.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
917 These modes display information specific to the major mode shown in the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
918 attached frame.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
919
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
920 To enable a minor display mode in your favorite Major mode, follow these
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
921 steps. The string @samp{@var{name}} is the name of the major mode being
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
922 augmented with speedbar.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
923
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
924 @enumerate
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
925 @item
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
926 Create the keymap variable @code{@var{name}-speedbar-key-map}.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
927
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
928 @item
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
929 Create a function, named whatever you like, which assigns values into your
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
930 keymap. Use this command to create the keymap before assigning
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
931 bindings:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
932
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
933 @smallexample
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
934 (setq @var{name}-speedbar-key-map (speedbar-make-specialized-keymap))
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
935 @end smallexample
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
936
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
937 This function creates a special keymap for use in speedbar.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
938
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
939 @item
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
940 Call your install function, or assign it to a hook like this:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
941
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
942 @smallexample
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
943 (if (featurep 'speedbar)
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
944 (@var{name}-install-speedbar-variables)
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
945 (add-hook 'speedbar-load-hook '@var{name}-install-speedbar-variables))
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
946 @end smallexample
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
947
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
948 @item
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
949 Create an easymenu compatible vector named
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
950 @code{@var{name}-speedbar-menu-items}. This will be spliced into
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
951 speedbar's control menu.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
952
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
953 @item
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
954 Create a function called @code{@var{name}-speedbar-buttons}. This function
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
955 should take one variable, which is the buffer for which it will create
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
956 buttons. At this time @code{(current-buffer)} will point to the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
957 uncleared speedbar buffer.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
958 @end enumerate
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
959
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
960 When writing @code{@var{name}-speedbar-buttons}, the first thing you will
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
961 want to do is execute a check to see if you need to re-create your
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
962 display. If it needs to be cleared, you need to erase the speedbar
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
963 buffer yourself, and start drawing buttons. @xref{Creating a display}.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
964
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
965 @node Major Display Modes, Tagging Extensions, Minor Display Modes, Extending
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
966 @section Major Display Modes
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
967 @cindex create major display mode
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
968
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
969 Creating a @dfn{Major Display Mode} for speedbar requires authoring a keymap,
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
970 an easy-menu segment, and writing several functions. These items can be
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
971 given any name, and are made the same way as in a minor display mode
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
972 (@pxref{Minor Display Modes}). Once this is done, these items need to be
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
973 registered.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
974
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
975 Because this setup activity may or may not have speedbar available when
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
976 it is being loaded, it is necessary to create an install function. This
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
977 function should create and initialize the keymap, and add your
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
978 expansions into the customization tables.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
979
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
980 @cindex @code{speedbar-make-specialized-keymap}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
981 When creating the keymap, use the function
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
982 @code{speedbar-make-specialized-keymap} instead of other keymap making
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
983 functions. This will provide you with the initial bindings needed.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
984 Some common speedbar functions you might want to bind are:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
985
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
986 @table @code
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
987 @cindex @code{speedbar-edit-line}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
988 @item speedbar-edit-line
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
989 Edit the item on the current line.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
990 @cindex @code{speedbar-expand-line}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
991 @item speedbar-expand-line
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
992 Expand the item under the cursor.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
993 With a numeric argument (@kbd{C-u}), flush cached data before expanding.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
994 @cindex @code{speedbar-contract-line}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
995 @item speedbar-contract-line
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
996 Contract the item under the cursor.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
997 @end table
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
998
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
999 @cindex @code{speedbar-line-path}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1000 These function require that function @code{speedbar-line-path} be
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1001 correctly overloaded to work.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1002
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1003 Next, register your extension like this;
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1004
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1005 @example
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1006 (speedbar-add-expansion-list '("MyExtension"
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1007 MyExtension-speedbar-menu-items
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1008 MyExtension-speedbar-key-map
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1009 MyExtension-speedbar-buttons))
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1010 @end example
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1011
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1012 There are no limitations to the names you use.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1013
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1014 The first parameter is the string representing your display mode.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1015 The second parameter is a variable name containing an easymenu compatible
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1016 menu definition. This will be stuck in the middle of speedbar's menu.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1017 The third parameter is the variable name containing the keymap we
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1018 discussed earlier.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1019 The last parameter is a function which draws buttons for your mode.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1020 This function must take two parameters. The directory currently being
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1021 displayed, and the depth at which you should start rendering buttons.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1022 The function will then draw (starting at the current cursor position)
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1023 any buttons deemed necessary based on the input parameters.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1024 @xref{Creating a display}.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1025
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1026 Next, you need to register function overrides. This may look something
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1027 like this:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1028
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1029 @example
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1030 (speedbar-add-mode-functions-list
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1031 '("MYEXTENSION"
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1032 (speedbar-item-info . MyExtension-speedbar-item-info)
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1033 (speedbar-line-path . MyExtension-speedbar-line-path)))
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1034 @end example
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1035
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1036 The first element in the list is the name of you extension. The second
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1037 is an alist of functions to overload. The function to overload is
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1038 first, followed by what you want called instead.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1039
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1040 For @code{speedbar-line-path} your function should take an optional DEPTH
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1041 parameter. This is the starting depth for heavily indented lines. If
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1042 it is not provided, you can derive it like this:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1043
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1044 @example
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1045 (save-match-data
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1046 (if (not depth)
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1047 (progn
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1048 (beginning-of-line)
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1049 (looking-at "^\\([0-9]+\\):")
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1050 (setq depth (string-to-int (match-string 1)))))
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1051 @end example
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1052
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1053 @noindent
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1054 where the depth is stored as invisible text at the beginning of each
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1055 line.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1056
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1057 The path returned should be the full path name of the file associated
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1058 with that line. If the cursor is on a tag, then the file containing
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1059 that tag should be returned. This is critical for built in file based
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1060 functions to work (meaning less code for you to write). If your display
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1061 does not deal in files, you do not need to overload this function.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1062
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1063 @cindex @code{speedbar-item-info}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1064 The function @code{speedbar-item-info}, however, is very likely to need
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1065 overloading. This function takes no parameters and must derive a text
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1066 summary to display in the minibuffer.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1067
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1068 There are several helper functions you can use if you are going to use
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1069 built in tagging. These functions can be @code{or}ed since each one
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1070 returns non-@code{nil} if it displays a message. They are:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1071
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1072 @table @code
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1073 @cindex @code{speedbar-item-info-file-helper}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1074 @item speedbar-item-info-file-helper
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1075 This takes an optional @var{filename} parameter. You can derive your own
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1076 filename, or it will derive it using a (possibly overloaded) function
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1077 @code{speedbar-line-file}. It shows details about a file.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1078 @cindex @code{speedbar-item-info-tag-helper}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1079 @item speedbar-item-info-tag-helper
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1080 If the current line is a tag, then display information about that tag,
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1081 such as its parent file, and location.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1082 @end table
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1083
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1084 Your custom function might look like this:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1085
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1086 @example
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1087 (defun MyExtension-item-info ()
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1088 "Display information about the current line."
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1089 (or (speedbar-item-info-tag-helper)
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1090 (message "Interesting detail.")))
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1091 @end example
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1092
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1093 Once you have done all this, speedbar will show an entry in the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1094 @samp{Displays} menu declaring that your extension is available.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1095
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1096 @node Tagging Extensions, Creating a display, Major Display Modes, Extending
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1097 @section Tagging Extensions
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1098
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1099 It is possible to create new methods for tagging files in speedbar.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1100 To do this, you need two basic functions, one function to fetch the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1101 tags from a buffer, the other to insert them below the filename.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1102
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1103 @defun my-fetch-dynamic-tags file
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1104 Parse @var{file} for a list of tags. Return the list, or @code{t} if there was
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1105 an error.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1106 @end defun
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1107
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1108 The non-error return value can be anything, as long as it can be
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1109 inserted by its paired function:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1110
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1111 @defun my-insert-tag-list level lst
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1112 Insert a list of tags @var{lst} started at indentation level
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1113 @var{level}. Creates buttons for each tag, and provides any other
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1114 display information required.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1115 @end defun
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1116
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1117 @cindex @code{speedbar-create-tag-hierarchy}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1118 It is often useful to use @code{speedbar-create-tag-hierarchy} on your
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1119 token list. See that function's documentation for details on what it
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1120 requires.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1121
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1122 @cindex @code{speedbar-dynamic-tags-function-list}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1123 Once these two functions are written, modify the variable
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1124 @code{speedbar-dynamic-tags-function-list} to include your parser at the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1125 beginning, like this:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1126
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1127 @example
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1128 (add-to-list 'speedbar-dynamic-tags-function-list
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1129 '(my-fetch-dynamic-tags . my-insert-tag-list))
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1130 @end example
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1131
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1132 If your parser is only good for a few types of files, make sure that it
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1133 is either a buffer local modification, or that the tag generator returns
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1134 @code{t} for non valid buffers.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1135
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1136 @node Creating a display, , Tagging Extensions, Extending
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1137 @section Creating a display
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1138 @cindex creating a display
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1139
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1140 Rendering a display in speedbar is completely flexible. When your
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1141 button function is called, see @ref{Minor Display Modes}, and @ref{Major
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1142 Display Modes}, you have control to @code{insert} anything you want.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1143
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1144 The conventions allow almost anything to be inserted, but several helper
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1145 functions are provided to make it easy to create the standardized
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1146 buttons.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1147
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1148 To understand the built in functions, each `button' in speedbar consists
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1149 of four important pieces of data. The text to be displayed, token
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1150 data to be associated with the text, a function to call, and some face to
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1151 display it in.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1152
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1153 When a function is provided, then that text becomes mouse activated,
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1154 meaning the mouse will highlight the text.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1155
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1156 Additionally, for data which can form deep trees, each line is given a
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1157 depth which indicates how far down the tree it is. This information is
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1158 stored in invisible text at the beginning of each line, and is used by
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1159 the navigation commands.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1160
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1161 @defun speedbar-insert-button text face mouse function &optional token prevline
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1162 This function inserts one button into the current location.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1163 @var{text} is the text to insert. @var{face} is the face in which it
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1164 will be displayed. @var{mouse} is the face to display over the text
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1165 when the mouse passes over it. @var{function} is called whenever the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1166 user clicks on the text.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1167
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1168 The optional argument @var{token} is extra data to associated with the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1169 text. Lastly @var{prevline} should be non-@code{nil} if you want this line to
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1170 appear directly after the last button which was created instead of on
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1171 the next line.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1172 @end defun
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1173
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1174 @defun speedbar-make-tag-line exp-button-type exp-button-char exp-button-function exp-button-data tag-button tag-button-function tag-button-data tag-button-face depth
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1175
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1176 Create a tag line with @var{exp-button-type} for the small expansion
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1177 button. This is the button that expands or contracts a node (if
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1178 applicable), and @var{exp-button-char} the character in it (@samp{+},
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1179 @samp{-}, @samp{?}, etc). @var{exp-button-function} is the function
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1180 to call if it's clicked on. Button types are @code{bracket},
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1181 @code{angle}, @code{curly}, @code{expandtag}, @code{statictag}, and
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1182 @code{nil}. @var{exp-button-data} is extra data attached to the text
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1183 forming the expansion button.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1184
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1185 Next, @var{tag-button} is the text of the tag.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1186 @var{tag-button-function} is the function to call if clicked on, and
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1187 @var{tag-button-data} is the data to attach to the text field (such a
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1188 tag positioning, etc). @var{tag-button-face} is a face used for this
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1189 type of tag.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1190
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1191 Lastly, @var{depth} shows the depth of expansion.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1192
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1193 This function assumes that the cursor is in the speedbar window at the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1194 position to insert a new item, and that the new item will end with a CR.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1195 @end defun
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1196
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1197 @defun speedbar-insert-generic-list level list expand-fun find-fun
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1198
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1199 At @var{level}, (the current indentation level desired) insert a generic
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1200 multi-level alist @var{list}. Associations with lists get @samp{@{+@}}
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1201 tags (to expand into more nodes) and those with positions or other data
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1202 just get a @samp{>} as the indicator. @samp{@{+@}} buttons will have the
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1203 function @var{expand-fun} and the token is the @code{cdr} list. The
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1204 token name will have the function @var{find-fun} and not token.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1205
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1206 Each element of the list can have one of these forms:
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1207
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1208 @table @code
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1209 @item (@var{name} . marker-or-number)
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1210 One tag at this level.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1211 @item (@var{name} (@var{name} . marker-or-number) (@var{name} . marker-or-number) ... )
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1212 One group of tags.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1213 @item (@var{name} marker-or-number (@var{name} . marker-or-number) ... )
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1214 One Group of tags where the group has a starting position.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1215 @end table
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1216
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1217 When you use @code{speedbar-insert-generic-list}, there are some
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1218 variables you can set buffer-locally to change the behavior. The most
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1219 obvious is @code{speedbar-tag-hierarchy-method}.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1220 @xref{Tag Hierarchy Methods}.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1221
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1222 @defvar speedbar-generic-list-group-expand-button-type
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1223 This is the button type used for groups of tags, whether expanded
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1224 or added in via a hierarchy method. Two good values are
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1225 @code{curly} and @code{expandtag}. Curly is the default button, and
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1226 @code{expandtag} is useful if the groups also has a position.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1227 @end defvar
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1228
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1229 @defvar speedbar-generic-list-tag-button-type
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1230 This is the button type used for a single tag.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1231 Two good values are @code{nil} and @code{statictag}.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1232 @code{nil} is the default, and @code{statictag} has the same width as
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1233 @code{expandtag}.
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1234 @end defvar
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1235
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1236 @end defun
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1237
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1238 @node GNU Free Documentation License, Index, Extending, Top
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1239 @appendix GNU Free Documentation License
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1240 @include doclicense.texi
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1241
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1242
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1243 @node Index, , GNU Free Documentation License, Top
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1244 @comment node-name, next, previous, up
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1245 @unnumbered Concept Index
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1246 @printindex cp
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1247
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1248 @bye
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1249 @c LocalWords: speedbar's xref slowbar kbd subsubsection
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1250 @c LocalWords: keybindings
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1251
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1252 @ignore
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1253 arch-tag: e1fc85f0-1eeb-489f-a8d4-a2bfe711fa02
822bdc208d59 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1254 @end ignore