diff options
author | Paul Eggert <eggert@cs.ucla.edu> | 2011-12-10 16:56:50 -0800 |
---|---|---|
committer | Paul Eggert <eggert@cs.ucla.edu> | 2011-12-10 16:56:50 -0800 |
commit | 8f50130c565eaf0ad7c49e4ad044c3291ecdfa71 (patch) | |
tree | c8129448cbbf387fe82667ccac02983592c688f1 /src/minibuf.c | |
parent | 85a83e2e2585a1906dec5168ed96ad521b5849ed (diff) | |
parent | 7b9d523a07395ecea505be88f45c33d73aea7038 (diff) | |
download | emacs-8f50130c565eaf0ad7c49e4ad044c3291ecdfa71.tar.gz |
Merge from trunk.
Diffstat (limited to 'src/minibuf.c')
-rw-r--r-- | src/minibuf.c | 34 |
1 files changed, 22 insertions, 12 deletions
diff --git a/src/minibuf.c b/src/minibuf.c index 7dd189c325b..9a4df333788 100644 --- a/src/minibuf.c +++ b/src/minibuf.c @@ -905,26 +905,36 @@ DEFUN ("read-from-minibuffer", Fread_from_minibuffer, The optional second arg INITIAL-CONTENTS is an obsolete alternative to DEFAULT-VALUE. It normally should be nil in new code, except when HIST is a cons. It is discussed in more detail below. + Third arg KEYMAP is a keymap to use whilst reading; if omitted or nil, the default is `minibuffer-local-map'. -If fourth arg READ is non-nil, then interpret the result as a Lisp object + +If fourth arg READ is non-nil, interpret the result as a Lisp object and return that object: in other words, do `(car (read-from-string INPUT-STRING))' + Fifth arg HIST, if non-nil, specifies a history list and optionally the initial position in the list. It can be a symbol, which is the - history list variable to use, or it can be a cons cell - (HISTVAR . HISTPOS). In that case, HISTVAR is the history list variable - to use, and HISTPOS is the initial position for use by the minibuffer - history commands. For consistency, you should also specify that - element of the history as the value of INITIAL-CONTENTS. Positions - are counted starting from 1 at the beginning of the list. -Sixth arg DEFAULT-VALUE is a default value or list of default values. - If non-nil, it is available via history commands. If READ is - non-nil, it is also the default to `read' if the user enters empty - input. If READ is non-nil, `read-from-minibuffer' does NOT return - DEFAULT-VALUE for empty input! It returns the empty string. + history list variable to use, or a cons cell (HISTVAR . HISTPOS). + In that case, HISTVAR is the history list variable to use, and + HISTPOS is the initial position for use by the minibuffer history + commands. For consistency, you should also specify that element of + the history as the value of INITIAL-CONTENTS. Positions are counted + starting from 1 at the beginning of the list. + +Sixth arg DEFAULT-VALUE, if non-nil, should be a string, which is used + as the default to `read' if READ is non-nil and the user enters + empty input. But if READ is nil, this function does _not_ return + DEFAULT-VALUE for empty input! Instead, it returns the empty string. + + Whatever the value of READ, DEFAULT-VALUE is made available via the + minibuffer history commands. DEFAULT-VALUE can also be a list of + strings, in which case all the strings are available in the history, + and the first string is the default to `read' if READ is non-nil. + Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits the current input method and the setting of `enable-multibyte-characters'. + If the variable `minibuffer-allow-text-properties' is non-nil, then the string which is returned includes whatever text properties were present in the minibuffer. Otherwise the value has no text properties. |