home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / man / cat3 / xsendextensionevent.0 < prev    next >
Encoding:
Text File  |  1996-10-17  |  5.7 KB  |  199 lines
  1.  
  2.  
  3.  
  4. XSendExtensionEvent(3X11)  X FUNCTIONS    XSendExtensionEvent(3X11)
  5.  
  6.  
  7. NNAAMMEE
  8.        XSendExtensionEvent  -  send  input  extension events to a
  9.        client
  10.  
  11. SSYYNNTTAAXX
  12.        Status XSendExtensionEvent(_d_i_s_p_l_a_y,  _d_e_v_i_c_e,  _d_e_s_t_i_n_a_t_i_o_n,
  13.        _p_r_o_p_a_g_a_t_e, _e_v_e_n_t___c_o_u_n_t, _e_v_e_n_t___l_i_s_t, _e_v_e_n_t___s_e_n_d)
  14.          Display *_d_i_s_p_l_a_y;
  15.          XDevice *_d_e_v_i_c_e;
  16.          Window _d_e_s_t_i_n_a_t_i_o_n;
  17.          Bool _p_r_o_p_a_g_a_t_e;
  18.          int _e_v_e_n_t___c_o_u_n_t;
  19.          XEventClass *_e_v_e_n_t___l_i_s_t;
  20.          XEvent *_e_v_e_n_t___s_e_n_d;
  21.  
  22. AARRGGUUMMEENNTTSS
  23.        _d_i_s_p_l_a_y       Specifies the connection to the X server.
  24.  
  25.        _d_e_v_i_c_e       Specifies the device from which the events are
  26.            to be sent.
  27.  
  28.        _d_e_s_t_i_n_a_t_i_o_n Specifies the window the event is to     be  sent
  29.            to.    You can pass window id, _P_o_i_n_t_e_r_W_i_n_d_o_w, or
  30.            _I_n_p_u_t_F_o_c_u_s.
  31.  
  32.        _p_r_o_p_a_g_a_t_e   Specifies a Boolean value that is either  True
  33.            or False.
  34.  
  35.        _e_v_e_n_t___c_o_u_n_t Specifies   the   count  of    XEventClasses  in
  36.            event_list.
  37.  
  38.        _e_v_e_n_t___l_i_s_t  Specifies the list of event selections  to  be
  39.            used.
  40.  
  41.        _e_v_e_n_t___s_e_n_d  Specifies a pointer to the event that is to be
  42.            sent.
  43.  
  44.  
  45.        DDEESSCCRRIIPPTTIIOONN
  46.           The _X_S_e_n_d_E_x_t_e_n_s_i_o_n_E_v_e_n_t request identifies the des-
  47.           tination    window,     determines  which clients should
  48.           receive  the  specified  events,    and  ignores  any
  49.           active grabs.  This request requires you to pass an
  50.           event class list.     For a discussion  of  the  valid
  51.           event  class  names,  see     _X_O_p_e_n_D_e_v_i_c_e_(_3_X_1_1_).  This
  52.           request uses the w argument to identify the  desti-
  53.           nation window as follows:
  54.  
  55.        +o    If w is _P_o_i_n_t_e_r_W_i_n_d_o_w , the destination window is the
  56.         window that contains the pointer.
  57.  
  58.        +o    If w is _I_n_p_u_t_F_o_c_u_s and if the focus     window     contains
  59.         the     pointer,  the    destination  window is the window
  60.         that contains the pointer; otherwise, the destination
  61.  
  62.  
  63.  
  64. X Version 11           Release 6.1                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XSendExtensionEvent(3X11)  X FUNCTIONS    XSendExtensionEvent(3X11)
  71.  
  72.  
  73.         window is the focus window.
  74.  
  75.        To  determine  which  clients should receive the specified
  76.        events, _X_S_e_n_d_E_x_t_e_n_s_i_o_n_E_v_e_n_t uses the propagate argument as
  77.        follows:
  78.  
  79.        +o    If    event_list is the empty set, the event is sent to
  80.         the client that created the destination  window.   If
  81.         that client no longer exists, no event is sent.
  82.  
  83.        +o    If    propagate  is  _F_a_l_s_e,  the event is sent to every
  84.         client selecting on     destination  any  of  the  event
  85.         types specified by the event_list array.
  86.  
  87.        +o    If    propagate is _T_r_u_e and no clients have selected on
  88.         destination     any  of  the  events  specified  by  the
  89.         event_list    array,    the  destination is replaced with
  90.         the closest ancestor of destination     for  which  some
  91.         client  has     selected  a type specified by the event-
  92.         list array and for which no     intervening  window  has
  93.         that  type    in its do-not-propagate-mask.  If no such
  94.         window exists or if the window is an ancestor of  the
  95.         focus  window and _I_n_p_u_t_F_o_c_u_s was originally specified
  96.         as the destination, the event  is  not  sent  to  any
  97.         clients.   Otherwise,  the event is reported to every
  98.         client selecting on the final destination any of  the
  99.         events specified in the event_list array.
  100.  
  101.        The  event  in  the  _X_E_v_e_n_t  structure  must be one of the
  102.        events defined by the input extension (or a _B_a_d_V_a_l_u_e error
  103.        results)     so that the X server can correctly byte-swap the
  104.        contents as necessary.  The contents of the event are oth-
  105.        erwise  unaltered  and unchecked by the X server except to
  106.        force send_event to _T_r_u_e in the forwarded event and to set
  107.        the serial number in the event correctly.
  108.  
  109.        _X_S_e_n_d_E_x_t_e_n_s_i_o_n_E_v_e_n_t returns zero if the conversion to wire
  110.        protocol format    failed    and  returns  nonzero  otherwise.
  111.        _X_S_e_n_d_E_x_t_e_n_s_i_o_n_E_v_e_n_t can generate _B_a_d_C_l_a_s_s, _B_a_d_D_e_v_i_c_e, _B_a_d_-
  112.        _V_a_l_u_e, and _B_a_d_W_i_n_d_o_w errors.
  113.  
  114. DDIIAAGGNNOOSSTTIICCSS
  115.        _B_a_d_D_e_v_i_c_e   An invalid device was specified.   The  speci-
  116.            fied     device     does  not  exist or has not been
  117.            opened by this  client  via    _X_O_p_e_n_I_n_p_u_t_D_e_v_i_c_e.
  118.            This     error    may  also  occur if the specified
  119.            device is the X keyboard or X pointer  device.
  120.  
  121.        _B_a_d_V_a_l_u_e       Some     numeric value falls outside the range of
  122.            values accepted by the request.  Unless a spe-
  123.            cific  range is specified for an argument, the
  124.            full range defined by the argument's     type  is
  125.            accepted.   Any  argument  defined as a set of
  126.            alternatives can generate this error.
  127.  
  128.  
  129.  
  130. X Version 11           Release 6.1                2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XSendExtensionEvent(3X11)  X FUNCTIONS    XSendExtensionEvent(3X11)
  137.  
  138.  
  139.        _B_a_d_W_i_n_d_o_w   A value for a Window argument does not name    a
  140.            defined Window.
  141.  
  142. SSEEEE AALLSSOO
  143.        _P_r_o_g_r_a_m_m_i_n_g _w_i_t_h _X_l_i_b
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196. X Version 11           Release 6.1                3
  197.  
  198.  
  199.