File: speedbar.el.html

The speedbar provides a frame or a window in which files, and locations in files are displayed. These items can be clicked on with mouse-2 in to display that file location.

; Customizing and Developing for speedbar

Please see the speedbar manual for information.

Defined variables (98)

speedbar--buffer-nameSpeedbar buffer name.
speedbar--windowThe window displaying ‘speedbar-window’.
speedbar--window-widthStores the current width of ‘speedbar-window’.
speedbar-after-create-hookHooks called after popping up the speedbar frame.
speedbar-before-delete-hookHooks called before deleting the speedbar frame.
speedbar-before-popup-hookHooks called before popping up the speedbar frame.
speedbar-before-visiting-file-hookHooks run before speedbar visits a file in the selected frame.
speedbar-before-visiting-tag-hookHooks run before speedbar visits a tag in the selected frame.
speedbar-bufferThe buffer displaying the speedbar.
speedbar-buffer-easymenu-definitionMenu item elements shown when displaying a buffer list.
speedbar-buffers-key-mapKeymap used when in the buffers display mode.
speedbar-cached-frameThe frame that was last created, then removed from the display.
speedbar-default-positionDefault position of the speedbar frame relative to the attached frame.
speedbar-desired-bufferNon-nil when speedbar is showing buttons specific to a special mode.
speedbar-directory-button-trim-methodControl how the directory button in speedbar will be displayed.
speedbar-directory-contents-alistAn association list of directories and their contents.
speedbar-directory-unshown-regexpRegular expression matching directories not to show in speedbar.
speedbar-dynamic-tags-function-listSet to a list of functions which will return and insert a list of tags.
speedbar-easymenu-definition-baseBase part of the speedbar menu.
speedbar-easymenu-definition-specialAdditional menu items while in file-mode.
speedbar-expand-image-button-alistList of text and image associations.
speedbar-fetch-etags-argumentsList of arguments to use with ‘speedbar-fetch-etags-command’.
speedbar-fetch-etags-commandCommand used to create an etags file.
speedbar-fetch-etags-parse-listAssociations of file extensions and expressions for extracting tags.
speedbar-file-key-mapKeymap used in speedbar buffer while files are displayed.
speedbar-file-regexpRegular expression matching files we know how to expand.
speedbar-file-unshown-regexpRegexp matching files we don’t want displayed in a speedbar buffer.
speedbar-frameThe frame displaying speedbar.
speedbar-frame-parametersParameters to use when creating the speedbar frame in Emacs.
speedbar-full-text-cacheThe last open directory is saved in its entirety for ultra-fast switching.
speedbar-generic-list-group-expand-button-typeThe type of button created for groups of tags.
speedbar-generic-list-tag-button-typeThe type of button created for tags in generic lists.
speedbar-hide-button-brackets-flagIf non-nil, speedbar will hide the brackets around the + or -.
speedbar-highlight-one-tag-lineOverlay used for highlighting the most recently jumped to tag line.
speedbar-ignored-directory-expressionsList of regular expressions matching directories speedbar will ignore.
speedbar-ignored-directory-regexpRegular expression matching directories speedbar will not switch to.
speedbar-ignored-modesList of major modes which speedbar will not switch directories for.
speedbar-incompatible-versionThis version of speedbar is incompatible with this version.
speedbar-indentation-widthWhen sub-nodes are expanded, the number of spaces used for indentation.
speedbar-indicator-regexRegular expression used when identifying files.
speedbar-indicator-separatorString separating file text from indicator characters.
speedbar-initial-expansion-list-nameA symbol name representing the expansion list to use.
speedbar-initial-expansion-mode-alistList of named expansion elements for filling the speedbar frame.
speedbar-last-selected-fileThe last file which was selected in speedbar buffer.
speedbar-load-hookHooks run when speedbar is loaded.
speedbar-mode-abbrev-tableAbbrev table for ‘speedbar-mode’.
speedbar-mode-functions-listList of function tables to use for different major display modes.
speedbar-mode-hookHook run after creating a speedbar buffer.
speedbar-mode-mapKeymap used in speedbar buffer.
speedbar-mode-specific-contents-flagNon-nil means speedbar will show special mode contents.
speedbar-mode-syntax-tableSyntax-table used on the speedbar.
speedbar-obj-alistAlist of file extensions, and their corresponding object file type.
speedbar-obj-do-checkIf non-nil, check all files in speedbar to see if they have an object file.
speedbar-obj-indicatorText used to mark files that have a corresponding hidden object file.
speedbar-obj-to-do-pointLocal variable maintaining the current version control check position.
speedbar-object-read-only-indicatorIndicator to append onto a line if that item is Read Only.
speedbar-power-clickNever set this by hand. Value is t when S-mouse activity occurs.
speedbar-prefer-windowIf t, the command ‘speedbar’ opens the speedbar in a window.
speedbar-previous-menuThe menu before the last ‘speedbar-reconfigure-keymaps’ was called.
speedbar-previously-used-expansion-list-nameSave the last expansion list method.
speedbar-query-confirmation-methodControl querying for file operations.
speedbar-reconfigure-keymaps-hookHooks run when the keymaps are regenerated.
speedbar-ro-to-do-pointLocal variable maintaining the current read only check position.
speedbar-scanner-reset-hookHook called whenever generic scanners are reset.
speedbar-select-frame-methodSpecify how to select a frame for displaying a file.
speedbar-show-unknown-filesNon-nil means show files we can’t expand with a ? in the expand button.
speedbar-shown-directoriesMaintain list of directories simultaneously open in the current speedbar.
speedbar-smart-directory-expand-flagNon-nil means speedbar should use smart expansion.
speedbar-sort-tagsIf non-nil, sort tags in the speedbar display.
speedbar-special-mode-expansion-listDefault function list for creating specialized button lists.
speedbar-special-mode-key-mapDefault keymap used when identifying a specialized display mode.
speedbar-stealthy-function-listList of functions to periodically call stealthily.
speedbar-stealthy-update-recurseRecursion avoidance variable for stealthy update.
speedbar-supported-extension-expressionsList of regular expressions which will match files supported by tagging.
speedbar-tag-group-name-minimum-lengthThe minimum length of a prefix group name before expanding.
speedbar-tag-hierarchy-methodList of hooks which speedbar will use to organize tags into groups.
speedbar-tag-regroup-maximum-lengthMaximum length of submenus that are regrouped.
speedbar-tag-split-minimum-lengthMinimum length before we stop trying to create sub-lists in tags.
speedbar-timer-hookHooks called after running the speedbar timer function.
speedbar-track-mouse-flagNon-nil means to display info about the line under the mouse pointer.
speedbar-update-flagNon-nil means to automatically update the display.
speedbar-update-flag-disablePermanently disable changing of the update flag.
speedbar-use-imagesNon-nil if speedbar should display icons.
speedbar-use-imenu-flagWhether to use imenu or etags for file parsing.
speedbar-use-tool-tips-flagNon-nil means to use tool tips if they are available.
speedbar-vc-directory-enable-hookReturn non-nil if the current directory should be checked for Version Control.
speedbar-vc-do-checkIf non-nil, check all files in speedbar to see if they have been checked out.
speedbar-vc-in-control-hookReturn non-nil if the specified file is under Version Control.
speedbar-vc-indicatorText used to mark files which are currently checked out.
speedbar-vc-to-do-pointLocal variable maintaining the current version control check position.
speedbar-verbosity-levelVerbosity level of the speedbar.
speedbar-versionThe current version of speedbar.
speedbar-visiting-file-hookHooks run when speedbar visits a file in the selected frame.
speedbar-visiting-tag-hookHooks run when speedbar visits a tag in the selected frame.
speedbar-window-dedicated-windowWhether to make the ‘speedbar-window’ dedicated.
speedbar-window-default-widthInitial width in characters of ‘speedbar-window’.
speedbar-window-max-widthThe maximum allowed width in characters of the ‘speedbar-window’.
speedbar-window-sideControl the side of the frame on which to show the speedbar window.

Defined functions (172)

speedbar(&optional ARG)
speedbar--get-line-indent-level()
speedbar--speedbar-live-p()
speedbar-add-expansion-list(NEW-LIST)
speedbar-add-ignored-directory-regexp(DIRECTORY-EXPRESSION)
speedbar-add-indicator(INDICATOR-STRING &optional REPLACE-THIS)
speedbar-add-localized-speedbar-support(BUFFER)
speedbar-add-mode-functions-list(NEW-LIST)
speedbar-add-supported-extension(EXTENSION)
speedbar-backward-list()
speedbar-buffer-buttons(DIRECTORY ZERO)
speedbar-buffer-buttons-engine(TEMP)
speedbar-buffer-buttons-temp(DIRECTORY ZERO)
speedbar-buffer-click(TEXT TOKEN INDENT)
speedbar-buffer-kill-buffer()
speedbar-buffer-revert-buffer()
speedbar-buffers-item-info()
speedbar-buffers-line-directory(&optional DEPTH)
speedbar-buffers-tail-notes(BUFFER)
speedbar-center-buffer-smartly()
speedbar-change-expand-button-char(CHAR)
speedbar-change-initial-expansion-list(NEW-DEFAULT)
speedbar-check-obj-this-line(DEPTH)
speedbar-check-objects()
speedbar-check-read-only()
speedbar-check-vc()
speedbar-check-vc-this-line(DEPTH)
speedbar-clear-current-file()
speedbar-click(E)
speedbar-contract-line()
speedbar-contract-line-descendants()
speedbar-create-directory()
speedbar-create-tag-hierarchy(LST)
speedbar-current-frame()
speedbar-customize()
speedbar-default-directory-list(DIRECTORY INDEX)
speedbar-delete-overlay(OVERLAY)
speedbar-delete-subblock(INDENT)
speedbar-dir-follow(TEXT TOKEN INDENT)
speedbar-directory-buttons(DIRECTORY INDEX)
speedbar-directory-buttons-follow(TEXT TOKEN INDENT)
speedbar-directory-line(DIRECTORY)
speedbar-dired(TEXT TOKEN INDENT)
speedbar-disable-update()
speedbar-do-function-pointer()
speedbar-easymenu-definition-trailer()
speedbar-edit-line()
speedbar-enable-update()
speedbar-expand-line(&optional ARG)
speedbar-expand-line-descendants(&optional ARG)
speedbar-extension-list-to-regex(EXTLIST)
speedbar-extract-one-symbol(EXPR)
speedbar-fetch-dynamic-etags(FILE)
speedbar-fetch-dynamic-imenu(FILE)
speedbar-fetch-dynamic-tags(FILE)
speedbar-fetch-replacement-function(FUNCTION)
speedbar-file-lists(DIRECTORY)
speedbar-files-item-info()
speedbar-files-line-directory(&optional DEPTH)
speedbar-find-file(TEXT TOKEN INDENT)
speedbar-find-file-in-frame(FILE)
speedbar-find-selected-file(FILE)
speedbar-flush-expand-line()
speedbar-forward-list()
speedbar-frame(&optional ARG)
speedbar-frame-mode(&optional ARG)
speedbar-frame-or-window()
speedbar-frame-reposition-smartly()
speedbar-frame-width()
speedbar-generic-item-info()
speedbar-generic-list-group-p(SUBLST)
speedbar-generic-list-positioned-group-p(SUBLST)
speedbar-generic-list-tag-p(SUBLST)
speedbar-get-focus()
speedbar-goto-this-file(FILE)
speedbar-handle-delete-frame(E)
speedbar-highlight-one-tag-line()
speedbar-image-dump()
speedbar-initial-expansion-list()
speedbar-initial-keymap()
speedbar-initial-menu()
speedbar-initial-stealthy-functions()
speedbar-insert-button(TEXT FACE MOUSE FUNCTION &optional TOKEN PREVLINE)
speedbar-insert-etags-list(INDENT LST)
speedbar-insert-files-at-point(FILES LEVEL)
speedbar-insert-generic-list(LEVEL LST EXPAND-FUN FIND-FUN)
speedbar-insert-image-button-maybe(START LENGTH)
speedbar-insert-imenu-list(INDENT LST)
speedbar-insert-separator(TEXT)
speedbar-item-byte-compile()
speedbar-item-copy()
speedbar-item-delete()
speedbar-item-info()
speedbar-item-info-file-helper(&optional FILENAME)
speedbar-item-info-tag-helper()
speedbar-item-load()
speedbar-item-object-delete()
speedbar-item-rename()
speedbar-line-directory(&optional DEPTH)
speedbar-line-file(&optional P)
speedbar-line-text(&optional P)
speedbar-line-token(&optional P)
speedbar-make-button(START END FACE MOUSE FUNCTION &optional TOKEN)
speedbar-make-overlay(BEG END &optional BUFFER FRONT-ADVANCE REAR-ADVANCE)
speedbar-make-specialized-keymap()
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)
speedbar-maybe-add-localized-support(BUFFER)
speedbar-maybee-jump-to-attached-frame()
speedbar-message(FMT &rest ARGS)
speedbar-mode()
speedbar-mode-line-update(&optional ALL)
speedbar-mouse-item-info(EVENT)
speedbar-navigate-list(ARG)
speedbar-next(ARG)
speedbar-overlay-put(OVERLAY PROP VALUE)
speedbar-parse-c-or-c++tag()
speedbar-parse-tex-string()
speedbar-position-cursor-on-line()
speedbar-prefix-group-tag-hierarchy(LST)
speedbar-prev(ARG)
speedbar-recenter()
speedbar-recenter-to-top()
speedbar-reconfigure-keymaps()
speedbar-refresh(&optional ARG)
speedbar-remove-localized-speedbar-support(BUFFER)
speedbar-reset-scanners()
speedbar-restricted-move(ARG)
speedbar-restricted-next(ARG)
speedbar-restricted-prev(ARG)
speedbar-scroll-down(&optional ARG)
speedbar-scroll-up(&optional ARG)
speedbar-select-attached-frame()
speedbar-set-mode-line-format()
speedbar-set-timer(TIMEOUT)
speedbar-show-info-under-mouse()
speedbar-simple-group-tag-hierarchy(LST)
speedbar-sort-tag-hierarchy(LST)
speedbar-stealthy-updates()
speedbar-tag-expand(TEXT TOKEN INDENT)
speedbar-tag-file(TEXT TOKEN INDENT)
speedbar-tag-find(TEXT TOKEN INDENT)
speedbar-this-file-in-vc(DIRECTORY NAME)
speedbar-timer-fn()
speedbar-toggle-etags(FLAG)
speedbar-toggle-images()
speedbar-toggle-line-expansion()
speedbar-toggle-show-all-files()
speedbar-toggle-sorting()
speedbar-toggle-updates()
speedbar-track-mouse(EVENT)
speedbar-trim-words-tag-hierarchy(LST)
speedbar-try-completion(STRING ALIST)
speedbar-unhighlight-one-tag-line()
speedbar-up-directory()
speedbar-update-contents()
speedbar-update-current-file()
speedbar-update-directory-contents()
speedbar-update-localized-contents()
speedbar-update-special-contents()
speedbar-vc-check-dir-p(DIRECTORY)
speedbar-width()
speedbar-window(&optional ARG)
speedbar-window--buffer-live-p()
speedbar-window--close()
speedbar-window--live-p()
speedbar-window--width()
speedbar-window--window-live-p()
speedbar-window-current-window()
speedbar-window-mode(&optional ARG)
speedbar-with-attached-buffer(&rest FORMS)
speedbar-with-writable(&rest FORMS)
speedbar-y-or-n-p(PROMPT &optional DELETING)

Defined faces (7)

speedbar-button-faceSpeedbar face for +/- buttons.
speedbar-directory-faceSpeedbar face for directory names.
speedbar-file-faceSpeedbar face for file names.
speedbar-highlight-faceSpeedbar face for highlighting buttons with the mouse.
speedbar-selected-faceSpeedbar face for the file in the active window.
speedbar-separator-faceSpeedbar face for separator labels in a display.
speedbar-tag-faceSpeedbar face for tags.