Function: ido-completing-read

ido-completing-read is an autoloaded and byte-compiled function defined in ido.el.gz.

Signature

(ido-completing-read PROMPT CHOICES &optional PREDICATE REQUIRE-MATCH INITIAL-INPUT HIST DEF INHERIT-INPUT-METHOD)

Documentation

Ido replacement for the built-in completing-read.

Read a string in the minibuffer with Ido-style completion. PROMPT is a string to prompt with; normally it ends in a colon and a space. CHOICES is a list of strings which are the possible completions. PREDICATE and INHERIT-INPUT-METHOD are currently ignored; they are included
 to be compatible with completing-read.
If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
 the input is (or completes to) an element of CHOICES or is null.
 If the input is null, ido-completing-read returns DEF, or an empty
 string if DEF is nil, regardless of the value of REQUIRE-MATCH.
If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
 with point positioned at the end.
HIST, if non-nil, specifies a history list. DEF, if non-nil, is the default value.

Source Code

;; Defined in /usr/src/emacs/lisp/ido.el.gz
;;;###autoload
(defun ido-completing-read (prompt choices &optional _predicate require-match
                            initial-input hist def _inherit-input-method)
  "Ido replacement for the built-in `completing-read'.
Read a string in the minibuffer with Ido-style completion.
PROMPT is a string to prompt with; normally it ends in a colon and a space.
CHOICES is a list of strings which are the possible completions.
PREDICATE and INHERIT-INPUT-METHOD are currently ignored; they are included
 to be compatible with `completing-read'.
If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
 the input is (or completes to) an element of CHOICES or is null.
 If the input is null, `ido-completing-read' returns DEF, or an empty
 string if DEF is nil, regardless of the value of REQUIRE-MATCH.
If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
 with point positioned at the end.
HIST, if non-nil, specifies a history list.
DEF, if non-nil, is the default value."
  (let ((ido-current-directory nil)
	(ido-directory-nonreadable nil)
	(ido-directory-too-big nil)
	(ido-context-switch-command 'ignore)
	(ido-choice-list choices))
    ;; Initialize ido before invoking ido-read-internal
    (ido-common-initialization)
    (ido-read-internal 'list prompt hist def require-match initial-input)))