File: minibuffer.el.html

Names with "--" are for functions and variables that are meant to be for internal use only.

Functional completion tables have an extended calling conventions: The action can be (additionally to nil, t, and lambda) of the form
- (boundaries . SUFFIX) in which case it should return
  (boundaries START . END). See completion-boundaries.
  Any other return value should be ignored (so we ignore values returned
  from completion tables that don't know about this new action form).
- metadata in which case it should return (metadata . ALIST) where
  ALIST is the metadata of this table. See completion-metadata.
  Any other return value should be ignored (so we ignore values returned
  from completion tables that don't know about this new action form).

Defined variables (51)

completing-read-functionThe function called by ‘completing-read’ to do its work.
completion--capf-misbehave-funsList of functions found on ‘completion-at-point-functions’ that misbehave.
completion--capf-safe-funsList of well-behaved functions found on ‘completion-at-point-functions’.
completion-annotate-functionFunction to add annotations in the *Completions* buffer.
completion-at-point-functionsSpecial hook to find the completion table for the entity at point.
completion-auto-helpNon-nil means automatically provide help for invalid completion input.
completion-category-defaultsDefault settings for specific completion categories.
completion-category-overridesList of category-specific user overrides for completion styles.
completion-cycle-thresholdNumber of completion candidates below which cycling is used.
completion-extra-propertiesProperty list of extra properties of the current completion job.
completion-fail-discreetlyIf non-nil, stay quiet when there is no match.
completion-flex-nospaceNon-nil if ‘flex’ completion rejects spaces in search pattern.
completion-in-region-functionFunction to perform the job of ‘completion-in-region’.
completion-in-region-functionsWrapper hook around ‘completion--in-region’.
completion-in-region-mode--predicateCopy of the value of ‘completion-in-region-mode-predicate’.
completion-in-region-mode-hookHook run after entering or leaving ‘completion-in-region-mode’.
completion-in-region-mode-mapKeymap activated during ‘completion-in-region’.
completion-in-region-mode-predicatePredicate to tell ‘completion-in-region-mode’ when to exit.
completion-pcm--delim-wild-regexRegular expression matching delimiters controlling the partial-completion.
completion-pcm-complete-word-inserts-delimitersTreat the SPC or - inserted by ‘minibuffer-complete-word’ as delimiters.
completion-pcm-word-delimitersA string of characters treated as word delimiters for completion.
completion-setup-hookNormal hook run at the end of setting up a completion list buffer.
completion-show-inline-helpIf non-nil, print helpful inline messages during completion.
completion-stylesList of completion styles to use.
completion-styles-alistList of available completion styles.
completions-detailedWhen non-nil, display completions with details added as prefix/suffix.
completions-formatDefine the appearance and sorting of completions.
completions-groupEnable grouping of completion candidates in the *Completions* buffer.
completions-group-formatFormat string used for the group title.
completions-group-sortSort groups in the *Completions* buffer.
flex-score-match-tightnessControls how the ‘flex’ completion style scores its matches.
insert-default-directoryNon-nil means when reading a filename start with default dir in minibuffer.
minibuffer--original-bufferBuffer that was current when ‘completing-read’ was called.
minibuffer--require-matchValue of REQUIRE-MATCH passed to ‘completing-read’.
minibuffer-beginning-of-buffer-movementControl how the ‘M-<’ command in the minibuffer behaves.
minibuffer-confirm-exit-commandsList of commands which cause an immediately following
minibuffer-default-prompt-formatFormat string used to output "default" values.
minibuffer-inactive-mode-hookHook run after entering InactiveMinibuffer mode.
minibuffer-inactive-mode-mapKeymap for use in the minibuffer when it is not active.
minibuffer-inactive-mode-syntax-tableSyntax table for ‘minibuffer-inactive-mode’.
minibuffer-local-completion-mapLocal keymap for minibuffer input with completion.
minibuffer-local-filename-completion-mapLocal keymap for minibuffer input with completion for filenames.
minibuffer-local-filename-syntaxSyntax table used when reading a file name in the minibuffer.
minibuffer-local-must-match-mapLocal keymap for minibuffer input with completion, for exact match.
minibuffer-local-ns-mapLocal keymap for the minibuffer when spaces are not allowed.
minibuffer-message-clear-timeoutHow long to display an echo-area message when the minibuffer is active.
minibuffer-message-propertiesText properties added to the text shown by ‘minibuffer-message’.
minibuffer-mode-hookHook run after entering Minibuffer mode.
minibuffer-mode-mapKeymap for ‘minibuffer-mode’.
read-file-name-completion-ignore-caseNon-nil means when reading a file name completion ignores case.
read-file-name-functionThe function called by ‘read-file-name’ to do its work.

Defined functions (135)

clear-minibuffer-message()
complete-with-action(ACTION COLLECTION STRING PREDICATE)
completing-read-default(PROMPT COLLECTION &optional PREDICATE REQUIRE-MATCH INITIAL-INPUT HIST DEF INHERIT-INPUT-METHOD)
completion--cache-all-sorted-completions(BEG END COMPS)
completion--capf-wrapper(FUN WHICH)
completion--category-override(CATEGORY TAG)
completion--common-suffix(STRS)
completion--complete-and-exit(BEG END EXIT-FUNCTION COMPLETION-FUNCTION)
completion--cycle-threshold(METADATA)
completion--do-completion(BEG END &optional TRY-COMPLETION-FUNCTION EXPECT-EXACT)
completion--done(STRING &optional FINISHED MESSAGE)
completion--embedded-envvar-table(STRING PRED ACTION)
completion--field-metadata(FIELD-START)
completion--file-name-table(ARG1 ARG2 ARG3)
completion--flex-adjust-metadata(METADATA)
completion--flush-all-sorted-completions(&optional START END LEN)
completion--in-region(START END COLLECTION &optional PREDICATE)
completion--in-region-1(BEG END)
completion--insert(STR GROUP-FUN)
completion--insert-horizontal(STRINGS GROUP-FUN LENGTH WWIDTH COLWIDTH COLUMNS)
completion--insert-one-column(STRINGS GROUP-FUN &rest _)
completion--insert-strings(STRINGS &optional GROUP-FUN)
completion--insert-vertical(STRINGS GROUP-FUN LENGTH WWIDTH COLWIDTH COLUMNS)
completion--merge-suffix(COMPLETION POINT SUFFIX)
completion--message(MSG)
completion--metadata(STRING BASE MD-AT-POINT TABLE PRED)
completion--nth-completion(N STRING TABLE PRED POINT METADATA)
completion--replace(BEG END NEWTEXT)
completion--sifn-requote(UPOS QSTR)
completion--some(FUN XS)
completion--string-equal-p(S1 S2)
completion--styles(METADATA)
completion--try-word-completion(STRING TABLE PREDICATE POINT MD)
completion--twq-all(STRING USTRING COMPLETIONS BOUNDARY UNQUOTE REQUOTE)
completion--twq-try(STRING USTRING COMPLETION POINT UNQUOTE REQUOTE)
completion-all-completions(STRING TABLE PRED POINT &optional METADATA)
completion-all-sorted-completions(&optional START END)
completion-at-point()
completion-basic--pattern(BEFOREPOINT AFTERPOINT BOUNDS)
completion-basic-all-completions(STRING TABLE PRED POINT)
completion-basic-try-completion(STRING TABLE PRED POINT)
completion-boundaries(STRING COLLECTION PRED SUFFIX)
completion-complete-and-exit(BEG END EXIT-FUNCTION)
completion-emacs21-all-completions(STRING TABLE PRED POINT)
completion-emacs21-try-completion(STRING TABLE PRED POINT)
completion-emacs22-all-completions(STRING TABLE PRED POINT)
completion-emacs22-try-completion(STRING TABLE PRED POINT)
completion-file-name-table(STRING PRED ACTION)
completion-flex--make-flex-pattern(PATTERN)
completion-flex-all-completions(STRING TABLE PRED POINT)
completion-flex-try-completion(STRING TABLE PRED POINT)
completion-help-at-point()
completion-hilit-commonality(COMPLETIONS PREFIX-LEN &optional BASE-SIZE)
completion-in-region(START END COLLECTION &optional PREDICATE)
completion-in-region--single-word(BEG END)
completion-in-region-mode(&optional ARG)
completion-initials-all-completions(STRING TABLE PRED POINT)
completion-initials-expand(STR TABLE PRED)
completion-initials-try-completion(STRING TABLE PRED POINT)
completion-metadata(STRING TABLE PRED)
completion-metadata-get(METADATA PROP)
completion-pcm--all-completions(PREFIX PATTERN TABLE PRED)
completion-pcm--filename-try-filter(ALL)
completion-pcm--find-all-completions(STRING TABLE PRED POINT &optional FILTER)
completion-pcm--hilit-commonality(PATTERN COMPLETIONS)
completion-pcm--merge-completions(STRS PATTERN)
completion-pcm--merge-try(PATTERN ALL PREFIX SUFFIX)
completion-pcm--optimize-pattern(P)
completion-pcm--pattern->regex(PATTERN &optional GROUP)
completion-pcm--pattern->string(PATTERN)
completion-pcm--pattern-point-idx(PATTERN)
completion-pcm--pattern-trivial-p(PATTERN)
completion-pcm--prepare-delim-re(DELIMS)
completion-pcm--string->pattern(STRING &optional POINT)
completion-pcm-all-completions(STRING TABLE PRED POINT)
completion-pcm-try-completion(STRING TABLE PRED POINT)
completion-shorthand-all-completions(STRING TABLE PRED POINT)
completion-shorthand-try-completion(STRING TABLE PRED POINT)
completion-substring--all-completions(STRING TABLE PRED POINT &optional TRANSFORM-PATTERN-FN)
completion-substring-all-completions(STRING TABLE PRED POINT)
completion-substring-try-completion(STRING TABLE PRED POINT)
completion-table-case-fold(TABLE &optional DONT-FOLD)
completion-table-dynamic(FUN &optional SWITCH-BUFFER)
completion-table-in-turn(&rest TABLES)
completion-table-merge(&rest TABLES)
completion-table-subvert(TABLE S1 S2)
completion-table-with-cache(FUN &optional IGNORE-CASE)
completion-table-with-context(PREFIX TABLE STRING PRED ACTION)
completion-table-with-predicate(TABLE PRED1 STRICT STRING PRED2 ACTION)
completion-table-with-quoting(TABLE UNQUOTE REQUOTE)
completion-table-with-terminator(TERMINATOR TABLE STRING PRED ACTION)
completion-try-completion(STRING TABLE PRED POINT &optional METADATA)
delete-minibuffer-contents()
display-completion-list(COMPLETIONS)
exit-minibuffer()
format-prompt(PROMPT DEFAULT &rest FORMAT-ARGS)
internal-complete-buffer-except(&optional BUFFER)
lazy-completion-table(VAR FUN)
minibuffer--bitset(MODIFIED COMPLETIONS EXACT)
minibuffer--double-dollars(STR)
minibuffer--group-by(GROUP-FUN SORT-FUN ELEMS)
minibuffer--message-overlay-pos()
minibuffer--sort-by-key(ELEMS KEYFUN)
minibuffer--sort-by-length-alpha(ELEMS)
minibuffer--sort-by-position(HIST ELEMS)
minibuffer--sort-preprocess-history(BASE)
minibuffer-beginning-of-buffer(&optional ARG)
minibuffer-complete()
minibuffer-complete-and-exit()
minibuffer-complete-word()
minibuffer-completion-contents()
minibuffer-completion-help(&optional START END)
minibuffer-force-complete(&optional START END DONT-CYCLE)
minibuffer-force-complete-and-exit()
minibuffer-hide-completions()
minibuffer-inactive-mode()
minibuffer-insert-file-name-at-point()
minibuffer-maybe-quote-filename(FILENAME)
minibuffer-message(MESSAGE &rest ARGS)
minibuffer-mode()
minibuffer-quit-recursive-edit(&optional LEVELS)
minibuffer-recenter-top-bottom(&optional ARG)
minibuffer-restore-windows()
minibuffer-scroll-down-command(&optional ARG)
minibuffer-scroll-other-window(&optional ARG)
minibuffer-scroll-other-window-down(&optional ARG)
minibuffer-scroll-up-command(&optional ARG)
read-file-name(PROMPT &optional DIR DEFAULT-FILENAME MUSTMATCH INITIAL PREDICATE)
read-file-name--defaults(&optional DIR INITIAL)
read-file-name-default(PROMPT &optional DIR DEFAULT-FILENAME MUSTMATCH INITIAL PREDICATE)
read-file-name-internal(ARG1 ARG2 ARG3)
read-no-blanks-input(PROMPT &optional INITIAL INHERIT-INPUT-METHOD)
self-insert-and-exit()
set-minibuffer-message(MESSAGE)
with-minibuffer-selected-window(&rest BODY)

Defined faces (5)

completions-annotationsFace to use for annotations in the *Completions* buffer. This face is only used if the strings used for completions doesn't already specify a face.
completions-common-partFace for the parts of completions which matched the pattern. See also the face `completions-first-difference'.
completions-first-differenceFace for the first character after point in completions. See also the face `completions-common-part'.
completions-group-separatorFace used for the separator lines between the candidate groups.
completions-group-titleFace used for the title text of the candidate group headlines.