comparison src/minibuf.c @ 42881:aa810c4a602b

(Fminibuffer_contents) (Fminibuffer_contents_no_properties, Fread_from_minibuffer) (Fread_string, Fread_no_blanks_input, Fcompleting_read): Doc fixes.
author Pavel Janík <Pavel@Janik.cz>
date Mon, 21 Jan 2002 16:15:12 +0000
parents e08cd63afb2e
children c16f32068114
comparison
equal deleted inserted replaced
42880:196bb8bbcc88 42881:aa810c4a602b
340 return end; 340 return end;
341 } 341 }
342 342
343 DEFUN ("minibuffer-contents", Fminibuffer_contents, 343 DEFUN ("minibuffer-contents", Fminibuffer_contents,
344 Sminibuffer_contents, 0, 0, 0, 344 Sminibuffer_contents, 0, 0, 0,
345 doc: /* Return the user input in a minbuffer as a string. 345 doc: /* Return the user input in a minibuffer as a string.
346 The current buffer must be a minibuffer. */) 346 The current buffer must be a minibuffer. */)
347 () 347 ()
348 { 348 {
349 int prompt_end = XINT (Fminibuffer_prompt_end ()); 349 int prompt_end = XINT (Fminibuffer_prompt_end ());
350 return make_buffer_string (prompt_end, ZV, 1); 350 return make_buffer_string (prompt_end, ZV, 1);
351 } 351 }
352 352
353 DEFUN ("minibuffer-contents-no-properties", Fminibuffer_contents_no_properties, 353 DEFUN ("minibuffer-contents-no-properties", Fminibuffer_contents_no_properties,
354 Sminibuffer_contents_no_properties, 0, 0, 0, 354 Sminibuffer_contents_no_properties, 0, 0, 0,
355 doc: /* Return the user input in a minbuffer as a string, without text-properties. 355 doc: /* Return the user input in a minibuffer as a string, without text-properties.
356 The current buffer must be a minibuffer. */) 356 The current buffer must be a minibuffer. */)
357 () 357 ()
358 { 358 {
359 int prompt_end = XINT (Fminibuffer_prompt_end ()); 359 int prompt_end = XINT (Fminibuffer_prompt_end ());
360 return make_buffer_string (prompt_end, ZV, 0); 360 return make_buffer_string (prompt_end, ZV, 0);
832 Positions are counted starting from 1 at the beginning of the list. 832 Positions are counted starting from 1 at the beginning of the list.
833 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available 833 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available
834 for history commands; but `read-from-minibuffer' does NOT return DEFAULT-VALUE 834 for history commands; but `read-from-minibuffer' does NOT return DEFAULT-VALUE
835 if the user enters empty input! It returns the empty string. 835 if the user enters empty input! It returns the empty string.
836 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits 836 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
837 the current input method and the setting of enable-multibyte-characters. 837 the current input method and the setting of `enable-multibyte-characters'.
838 If the variable `minibuffer-allow-text-properties' is non-nil, 838 If the variable `minibuffer-allow-text-properties' is non-nil,
839 then the string which is returned includes whatever text properties 839 then the string which is returned includes whatever text properties
840 were present in the minibuffer. Otherwise the value has no text properties. */) 840 were present in the minibuffer. Otherwise the value has no text properties. */)
841 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method) 841 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
842 Lisp_Object prompt, initial_contents, keymap, read, hist, default_value; 842 Lisp_Object prompt, initial_contents, keymap, read, hist, default_value;
934 See `read-from-minibuffer' for details of HISTORY argument. 934 See `read-from-minibuffer' for details of HISTORY argument.
935 Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used 935 Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used
936 for history commands, and as the value to return if the user enters 936 for history commands, and as the value to return if the user enters
937 the empty string. 937 the empty string.
938 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits 938 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
939 the current input method and the setting of enable-multibyte-characters. */) 939 the current input method and the setting of `enable-multibyte-characters'. */)
940 (prompt, initial_input, history, default_value, inherit_input_method) 940 (prompt, initial_input, history, default_value, inherit_input_method)
941 Lisp_Object prompt, initial_input, history, default_value; 941 Lisp_Object prompt, initial_input, history, default_value;
942 Lisp_Object inherit_input_method; 942 Lisp_Object inherit_input_method;
943 { 943 {
944 Lisp_Object val; 944 Lisp_Object val;
952 952
953 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0, 953 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
954 doc: /* Read a string from the terminal, not allowing blanks. 954 doc: /* Read a string from the terminal, not allowing blanks.
955 Prompt with PROMPT, and provide INITIAL as an initial value of the input string. 955 Prompt with PROMPT, and provide INITIAL as an initial value of the input string.
956 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits 956 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
957 the current input method and the setting of enable-multibyte-characters. */) 957 the current input method and the setting of `enable-multibyte-characters'. */)
958 (prompt, initial, inherit_input_method) 958 (prompt, initial, inherit_input_method)
959 Lisp_Object prompt, initial, inherit_input_method; 959 Lisp_Object prompt, initial, inherit_input_method;
960 { 960 {
961 CHECK_STRING (prompt); 961 CHECK_STRING (prompt);
962 if (! NILP (initial)) 962 if (! NILP (initial))
1463 which INITIAL-INPUT corresponds to). 1463 which INITIAL-INPUT corresponds to).
1464 Positions are counted starting from 1 at the beginning of the list. 1464 Positions are counted starting from 1 at the beginning of the list.
1465 DEF, if non-nil, is the default value. 1465 DEF, if non-nil, is the default value.
1466 1466
1467 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits 1467 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits
1468 the current input method and the setting of enable-multibyte-characters. 1468 the current input method and the setting of `enable-multibyte-characters'.
1469 1469
1470 Completion ignores case if the ambient value of 1470 Completion ignores case if the ambient value of
1471 `completion-ignore-case' is non-nil. */) 1471 `completion-ignore-case' is non-nil. */)
1472 (prompt, table, predicate, require_match, initial_input, hist, def, inherit_input_method) 1472 (prompt, table, predicate, require_match, initial_input, hist, def, inherit_input_method)
1473 Lisp_Object prompt, table, predicate, require_match, initial_input; 1473 Lisp_Object prompt, table, predicate, require_match, initial_input;