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

   1 @node Client, XWEM Minibuffer, Window, Primitives
   2 @section Client
   3 @cindex client
   4
   5 @dfn{Client} is normal X11 application already managed by XWEM. All XWEM
   6 Clients manages according to XWEM Manage Database(@pxref{Manage
   7 Database}). Default behaviour is to enlarge each XWEM Client which have
   8 no override redirect flag ot XWEM Window used to hold that Client.
   9
  10
  11 @menu
  12 * Client Basics::               What is Client.
  13 * Client Properties::           Describes what properties have each Client.
  14 * Current Client::              There is always some Client is active.
  15 * Clients Lists::               How does Clients organizes lists.
  16 * Client Hooks::                How you can control Clients.
  17 * Operating on Clients::        What you can do with Clients.
  18 @end menu
  19
  20 @node Client Basics, Client Properties, Client, Client
  21 @comment  node-name,  next,  previous,  up
  22 @subsection Client Basics
  23 @cindex basics
  24
  25 TODO: describe what is XWEM Client.
  26
  27 @defun xwem-cl-p client
  28 Returns non-@code{nil} if @var{client} is Client.
  29 @end defun
  30
  31 @node Client Properties, Current Client, Client Basics, Client
  32 @comment  node-name,  next,  previous,  up
  33 @subsection Client Properties
  34 @cindex properties
  35
  36 Each Client in XWEM have some properties associated with it.
  37
  38 @defun xwem-client-name cl &optional clist
  39 Return unique name for Client @var{cl} using @var{clist} as list of
  40 Clients.
  41 @end defun
  42
  43 @node Current Client, Clients Lists, Client Properties, Client
  44 @comment  node-name,  next,  previous,  up
  45 @subsection Current Client
  46
  47 @dfn{Current Client} is client in selected Window.
  48
  49 TODO: describe things related to special XEmacs frames.
  50
  51 @defun xwem-cl-selected
  52 Return selected Client.
  53 @end defun
  54
  55 @node Clients Lists, Client Hooks, Current Client, Client
  56 @comment  node-name,  next,  previous,  up
  57 @subsection Clients Lists
  58 @cindex lists
  59
  60 TODO: describe client lists.
  61
  62 @defvar xwem-clients
  63 List of all Clients.
  64 @end defvar
  65
  66 @node Client Hooks, Operating on Clients, Clients Lists, Client
  67 @comment  node-name,  next,  previous,  up
  68 @subsection Client Hooks
  69 @cindex hooks
  70
  71 TODO: genaral overview of hooks used in Client processing.
  72
  73 @defvar xwem-cl-setup-hooks
  74 List of hooks which is called after XWEM Client is managed. Functions in
  75 that list should accept one argument - XWEM Client.
  76 @end defvar
  77
  78 @defvar xwem-cl-manage-hook
  79 Functions to call when Client managed.  They are passed with one
  80 argument - @code{cl}.
  81 @end defvar
  82
  83 @defvar xwem-cl-demanage-hook
  84 Functions to call when Cliend demanages.  Called with with one argument
  85 - @code{cl}.
  86 @end defvar
  87
  88 @node Operating on Clients, , Client Hooks, Client
  89 @comment  node-name,  next,  previous,  up
  90 @subsection Operating on Clients
  91 @cindex operating
  92
  93 Here is some usefull functions you can use to operate on Clients.
  94
  95 @defun xwem-find-client xwin-or-id
  96 Find Client by X window @var{xwin-or-id}.
  97 @end defun
  98
  99 @defun xwem-remove-client cl
 100 Remove @var{cl} from Clients list @code{xwem-clients}.
 101 @end defun
 102
 103 TODO: write me