cgit.sxemacs.org Git - packages/blob - xemacs-packages/xwem/man/tray.texi

   1 @node System Tray, Help, Manage Database, Subsystems
   2 @comment  node-name,  next,  previous,  up
   3 @section System Tray
   4 @cindex tray
   5 @cindex XEMBED
   6
   7 @dfn{System Tray} is some area in your screen, that used to hold some X
   8 applications called dock applications or dockapps in short.  XWEM's
   9 system tray uses @ref{XWEM Minibuffer} as that area, so you does not
  10 lost it.  It is morden to implement system tray using XEMBED protocol,
  11 which describes how dockapps and tray window should communicate.  XWEM's
  12 system tray uses extended version of XEMBED protocol, which allow any
  13 dockapp to run Emacs Lisp!
  14
  15 @defvar xwem-tray-enabled
  16 Non-@code{nil} mean that System tray will be used by XWEM.
  17 @end defvar
  18
  19 @defvar xwem-tray-max-docks
  20 Maximum number of dockapps to be used in system tray.  If value is to
  21 much, than system tray may eat too much space in XWEM's minibuffer and
  22 you will not be able to comfortable interact with it. Default value is
  23 6.
  24 @end defvar
  25
  26 @defvar xwem-tray-minib-position
  27 Symbol that may be @code{'right} or @code{'left} specifies position in
  28 XWEM's minibuffer where first dockapp appears.
  29 @end defvar
  30
  31 @defvar xwem-tray-minib-posoffset
  32 Offset in pixels from XWEM's minibuffer edge.
  33 @end defvar
  34
  35 @defvar xwem-tray-minib-docoffset
  36 Offset in pixels between two dockapps.
  37 @end defvar
  38
  39 @defvar xwem-tray-cursor-shape
  40 Shape of cursor when pointer is over one of dockapp, see @code{X-XC-XXX}
  41 constants values. Default is value of @code{X-XC-right_ptr}.
  42 @end defvar
  43
  44 @defvar xwem-tray-cursor-foreground-color
  45 Specifies foreground color of cursor, when pointer is over one of
  46 dockapp.
  47 @end defvar
  48
  49 @defvar xwem-tray-cursor-background-color
  50 Cursor's background color, when pointer over System tray.
  51 @end defvar
  52
  53 @defvar xwem-tray-config
  54 This is a list of vectors and each vector is in form @code{[type
  55 value]}. Type is one of @code{XWEM-TRAY-DOCK} or
  56 @code{XWEM-TRAY-DELIM}. If type is @code{XWEM-TRAY-DOCK} than value is
  57 string and it specifies program and program's arguments you need to
  58 launch and put in system tray. If type is @code{XWEM-TRAY-DELIM} than
  59 value is integer, which specifies offset in pixels to be inserted in
  60 system tray.
  61 @example
  62 xwem-tray-config
  63 @result{}
  64 ([XWEM-TRAY-DOCK "/path/to/xwem-minitime -f 004400 -b bbbbbb"]
  65  [XWEM-TRAY-DOCK "/path/to/xwem-miniapm"]
  66  [XWEM-TRAY-DELIM 10]
  67  [XWEM-TRAY-DOCK "path/to/xwem-minilaunch
  68                   -l /path/to/icons/xterm.xpm xterm"]
  69  [XWEM-TRAY-DOCK "/path/to/xwem-minilaunch
  70                   -l /path/to/icons/xterm_big.xpm
  71                   xterm -fn 10x20"]
  72  [XWEM-TRAY-DOCK "/path/to/xwem-minilaunch
  73                   -e \"(make-frame)\"
  74                   /path/to/icons/xemacs.xpm emacs"]
  75  [XWEM-TRAY-DOCK "/path/to/xwem-minilaunch
  76                   -l /path/to/icons/netscape.xpm
  77                   netscape"])
  78 @end example
  79 @end defvar
  80
  81 @defun xwem-tray-run-config &optional config
  82 This function takes @var{config} in format described above, and executes
  83 it.  See example of its usage.
  84 @example
  85 (add-hook 'xwem-after-init-hooks 'xwem-tray-run-config)
  86 @end example
  87 @end defun