cgit.sxemacs.org Git - sxemacs/blob - info/lispref/dragndrop.texi

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