annotate man/lispref/dragndrop.texi @ 371:cc15677e0335 r21-2b1

Import from CVS: tag r21-2b1
author cvs
date Mon, 13 Aug 2007 11:03:08 +0200
parents 341dac730539
children 6240c7796c7a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
284
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
1 @c -*-texinfo-*-
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
2 @c This is part of the XEmacs Lisp Reference Manual.
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
3 @c Copyright (C) 1998 Oliver Graf <ograf@fga.de>
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
4 @c Original reference is (c) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc.
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
5 @c See the file lispref.texi for copying conditions.
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
6 @setfilename ../../info/dragndrop.texi
290
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
7 @node Drag and Drop, Modes, Scrollbars, Top
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
8 @chapter Drag and Drop
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
9 @cindex drag and drop
284
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
10
288
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
11 @emph{WARNING}: the Drag'n'Drop API is still under development and the
290
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
12 interface may change! The current implementation is considered experimental.
288
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
13
284
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
14 Drag'n'drop is a way to transfer information between multiple applications.
371
cc15677e0335 Import from CVS: tag r21-2b1
cvs
parents: 314
diff changeset
15 To do this serveral GUIs define their own protocols. Examples are OffiX, CDE,
284
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
16 Motif, KDE, MSWindows, GNOME, and many more. To catch all these protocols,
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
17 XEmacs provides a generic API.
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
18
288
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
19 One prime idea behind the API is to use a data interface that is
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
20 transparent for all systems. The author thinks that this is best
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
21 archived by using URL and MIME data, cause any internet enabled system
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
22 must support these for email already. XEmacs also already provides
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
23 powerful interfaces to support these types of data (tm and w3).
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
24
284
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
25 @menu
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
26 * Supported Protocols:: Which low-level protocols are supported.
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
27 * Drop Interface:: How XEmacs handles a drop from another application.
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
28 * Drag Interface:: Calls to initiate a drag from XEmacs.
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
29 @end menu
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
30
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
31 @node Supported Protocols
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
32 @section Supported Protocols
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
33
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
34 The current release of XEmacs only support a small set of Drag'n'drop
371
cc15677e0335 Import from CVS: tag r21-2b1
cvs
parents: 314
diff changeset
35 protocols. Some of these only support limited options avaiable in the API.
284
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
36
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
37 @menu
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
38 * OffiX DND:: A generic X based protocol.
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
39 * CDE dt:: Common Desktop Environment used on suns.
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
40 * MSWindows OLE:: Mr. Gates way of live.
288
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
41 * Loose ends:: The other protocols.
284
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
42 @end menu
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
43
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
44 @node OffiX DND
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
45 @subsection OffiX DND
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
46 @cindex OffiX DND
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
47
298
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 290
diff changeset
48 @emph{WARNING}: If you compile in OffiX, you may not be able to use
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 290
diff changeset
49 multiple X displays successfully. If the two servers are from
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 290
diff changeset
50 different vendors, the results may be unpredictable.
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 290
diff changeset
51
284
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
52 The OffiX Drag'n'Drop protocol is part of a X API/Widget library created by
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
53 Cesar Crusius. It is based on X-Atoms and ClientMessage events, and works with
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
54 any X platform supporting them.
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
55
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
56 OffiX is supported if 'offix is member of the variable dragdrop-protocols, or
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
57 the feature 'offix is defined.
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
58
288
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
59 Unfortunately it uses it's own data types. Examples are: File, Files,
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
60 Exe, Link, URL, MIME. The API tries to choose the right type for the data that
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
61 is dragged from XEmacs (well, not yet...).
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
62
284
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
63 XEmacs supports both MIME and URL drags and drops using this API. No application
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
64 interaction is possible while dragging is in progress.
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
65
371
cc15677e0335 Import from CVS: tag r21-2b1
cvs
parents: 314
diff changeset
66 For infomation about the OffiX project have a look at http://leb.net/~offix/
284
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
67
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
68 @node CDE dt
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
69 @subsection CDE dt
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
70 @cindex CDE dt
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
71
288
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
72 CDE stands for Common Desktop Environment. It is based on the Motif
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
73 widget library. It's drag'n'drop protocol is also an abstraction of the
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
74 Motif protocol (so it might be possible, that XEmacs will also support
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
75 the Motif protocol soon).
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
76
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
77 CDE has three different types: file, buffer, and text. XEmacs only uses
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
78 file and buffer drags. The API will disallow full URL drags, only file
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
79 method URLs are passed through.
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
80
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
81 Buffer drags are always converted to plain text.
284
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
82
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
83 @node MSWindows OLE
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
84 @subsection MSWindows OLE
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
85 @cindex MSWindows OLE
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
86
288
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
87 Only allows file drags and drops.
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
88
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
89 @node Loose ends
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
90 @subsection Loose ends
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
91
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
92 The following protocols will be supported soon: Xdnd, Motif, Xde (if I
290
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
93 get some specs), KDE OffiX (if KDE can find XEmacs windows).
288
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
94
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
95 In particular Xdnd will be one of the protocols that can benefit from
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
96 the XEmacs API, cause it also uses MIME types to encode dragged data.
284
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
97
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
98 @node Drop Interface
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
99 @section Drop Interface
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
100 @cindex drop
288
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
101 @cindex Drop API
284
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
102
288
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
103 For each activated low-level protocol, a internal routine will catch
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
104 incoming drops and convert them to a dragdrop-drop type
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
105 misc-user-event.
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
106
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
107 This misc-user-event has its function argument set to
290
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
108 @code{dragdrop-drop-dispatch} and the object contains the data of the drop
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
109 (converted to URL/MIME specific data). This function will search the variable
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
110 @code{experimental-dragdrop-drop-functions} for a function that can handle the
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
111 dropped data.
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
112
371
cc15677e0335 Import from CVS: tag r21-2b1
cvs
parents: 314
diff changeset
113 To modify the drop behaviour, the user can modify the variable
290
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
114 @code{experimental-dragdrop-drop-functions}. Each element of this list
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
115 specifies a possible handler for dropped data. The first one that can handle
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
116 the data will return @code{t} and exit. Another possibility is to set a
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
117 extent-property with the same name. Extents are checked prior to the
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
118 variable.
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
119
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
120 The customization group @code{drag-n-drop} shows all variables of user
c9fe270a4101 Import from CVS: tag r21-0b43
cvs
parents: 288
diff changeset
121 interest.
284
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
122
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
123 @node Drag Interface
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
124 @section Drag Interface
288
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
125 @cindex drag
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 284
diff changeset
126 @cindex Drag API
284
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
127
558f606b08ae Import from CVS: tag r21-0b40
cvs
parents:
diff changeset
128 This describes the drag API (not implemented yet).