File: imenu.el.html
Purpose of this package:
To present a framework for mode-specific buffer indexes.
A buffer index is an alist of names and buffer positions.
For instance all functions in a C-file and their positions.
It is documented in the Emacs Lisp manual.
How it works:
A mode-specific function is called to generate the index. It is
then presented to the user, who can choose from this index.
Defined variables (25)
imenu--history-list | History list for ‘jump-to-function-in-buffer’. |
imenu--index-alist | The buffer index alist computed for this buffer in Imenu. |
imenu--last-menubar-index-alist | The latest buffer index alist used to update the menu bar menu. |
imenu-after-jump-hook | Hooks called after jumping to a place in the buffer. |
imenu-auto-rescan | Non-nil means Imenu should always rescan the buffers. |
imenu-auto-rescan-maxout | Imenu auto-rescan is disabled in buffers larger than this size (in bytes). |
imenu-case-fold-search | Defines whether ‘imenu--generic-function’ should fold case when matching. |
imenu-create-index-function | The function to use for creating an index alist of the current buffer. |
imenu-default-goto-function | The default function called when selecting an Imenu item. |
imenu-eager-completion-buffer | If non-nil, eagerly popup the completion buffer. |
imenu-extract-index-name-function | Function for extracting the index item name, given a position. |
imenu-generic-expression | List of definition matchers for creating an Imenu index. |
imenu-generic-skip-comments-and-strings | When non-nil, ignore text inside comments and strings. |
imenu-level-separator | The separator between index names of different levels. |
imenu-max-index-time | Max time to use when creating imenu indices. |
imenu-max-item-length | If a number, truncate Imenu entries to that length. |
imenu-max-items | Maximum number of elements in a mouse menu for Imenu. |
imenu-menubar-modified-tick | Value of (buffer-chars-modified-tick) when ‘imenu-update-menubar’ was called. |
imenu-name-lookup-function | Function to compare string with index item. |
imenu-prev-index-position-function | Function for finding the next index position. |
imenu-sort-function | The function to use for sorting the index mouse-menu. |
imenu-space-replacement | The replacement string for spaces in index names. |
imenu-syntax-alist | Alist of syntax table modifiers to use while in ‘imenu--generic-function’. |
imenu-use-markers | Non-nil means use markers instead of integers for Imenu buffer positions. |
imenu-use-popup-menu | Use a popup menu rather than a minibuffer prompt. |
Defined functions (25)
imenu | (INDEX-ITEM) |
imenu--cleanup | (&optional ALIST) |
imenu--completion-buffer | (INDEX-ALIST &optional PROMPT) |
imenu--create-keymap | (TITLE ALIST &optional CMD) |
imenu--generic-function | (PATTERNS) |
imenu--in-alist | (STR ALIST) |
imenu--make-index-alist | (&optional NOERROR) |
imenu--menubar-select | (ITEM) |
imenu--mouse-menu | (INDEX-ALIST EVENT &optional TITLE) |
imenu--relative-position | (&optional REVERSE) |
imenu--sort-by-name | (ITEM1 ITEM2) |
imenu--sort-by-position | (ITEM1 ITEM2) |
imenu--split | (LIST N) |
imenu--split-menu | (MENULIST TITLE) |
imenu--split-submenus | (ALIST) |
imenu--subalist-p | (ITEM) |
imenu--truncate-items | (MENULIST) |
imenu-add-menubar-index | () |
imenu-add-to-menubar | (NAME) |
imenu-choose-buffer-index | (&optional PROMPT ALIST) |
imenu-default-create-index-function | () |
imenu-default-goto-function | (NAME POSITION &rest REST) |
imenu-find-default | (GUESS COMPLETIONS) |
imenu-progress-message | (PREVPOS &optional RELPOS REVERSE) |
imenu-unavailable-error | (FORMAT &rest ARGS) |