1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-12-26 10:49:33 +00:00

(x-get-selection, x-set-selection): Doc fixes.

This commit is contained in:
Luc Teirlinck 2004-07-24 21:53:10 +00:00
parent 7630911d61
commit 15a24762a4

View File

@ -3,7 +3,7 @@
;; Maintainer: FSF ;; Maintainer: FSF
;; Keywords: internal ;; Keywords: internal
;; Copyright (c) 1993, 1994 Free Software Foundation, Inc. ;; Copyright (c) 1993, 1994, 2004 Free Software Foundation, Inc.
;; Based partially on earlier release by Lucid. ;; Based partially on earlier release by Lucid.
;; This file is part of GNU Emacs. ;; This file is part of GNU Emacs.
@ -35,7 +35,11 @@ The argument TYPE (default `PRIMARY') says which selection,
and the argument DATA-TYPE (default `STRING') says and the argument DATA-TYPE (default `STRING') says
how to convert the data. how to convert the data.
TYPE may be `SECONDARY' or `CLIPBOARD', in addition to `PRIMARY'. TYPE may be any symbol \(but nil stands for `PRIMARY'). However,
only a few symbols are commonly used. They conventionally have
all upper-case names. The most often used ones, in addition to
`PRIMARY', are `SECONDARY' and `CLIPBOARD'.
DATA-TYPE is usually `STRING', but can also be one of the symbols DATA-TYPE is usually `STRING', but can also be one of the symbols
in `selection-converter-alist', which see." in `selection-converter-alist', which see."
(let ((data (x-get-selection-internal (or type 'PRIMARY) (let ((data (x-get-selection-internal (or type 'PRIMARY)
@ -57,9 +61,11 @@ in `selection-converter-alist', which see."
(defun x-set-selection (type data) (defun x-set-selection (type data)
"Make an X Windows selection of type TYPE and value DATA. "Make an X Windows selection of type TYPE and value DATA.
The argument TYPE (default `PRIMARY') says which selection, The argument TYPE (nil means `PRIMARY') says which selection, and
and DATA specifies the contents. DATA may be a string, DATA specifies the contents. TYPE must be a symbol. \(It can also
a symbol, an integer (or a cons of two integers or list of two integers). be a string, which stands for the symbol with that name, but this
is considered obsolete.) DATA may be a string, a symbol, an
integer (or a cons of two integers or list of two integers).
The selection may also be a cons of two markers pointing to the same buffer, The selection may also be a cons of two markers pointing to the same buffer,
or an overlay. In these cases, the selection is considered to be the text or an overlay. In these cases, the selection is considered to be the text
@ -69,8 +75,11 @@ can alter the effective value of the selection.
The data may also be a vector of valid non-vector selection values. The data may also be a vector of valid non-vector selection values.
Interactively, the text of the region is used as the selection value The return value is DATA.
if the prefix arg is set."
Interactively, this command sets the primary selection. Without
prefix argument, it reads the selection in the minibuffer. With
prefix argument, it uses the text of the region as the selection value ."
(interactive (if (not current-prefix-arg) (interactive (if (not current-prefix-arg)
(list 'PRIMARY (read-string "Set text for pasting: ")) (list 'PRIMARY (read-string "Set text for pasting: "))
(list 'PRIMARY (buffer-substring (region-beginning) (region-end))))) (list 'PRIMARY (buffer-substring (region-beginning) (region-end)))))