home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / man / cat3 / xkeyevent.0 < prev    next >
Encoding:
Text File  |  1996-10-17  |  8.4 KB  |  199 lines
  1.  
  2.  
  3.  
  4. XButtonEvent(3X11)      XLIB FUNCTIONS       XButtonEvent(3X11)
  5.  
  6.  
  7. NNAAMMEE
  8.        XButtonEvent, XKeyEvent, XMotionEvent - KeyPress, KeyRe-
  9.        lease, ButtonPress, ButtonRelease, and MotionNotify event
  10.        structures
  11.  
  12. SSTTRRUUCCTTUURREESS
  13.        The structures for _K_e_y_P_r_e_s_s, _K_e_y_R_e_l_e_a_s_e, _B_u_t_t_o_n_P_r_e_s_s,
  14.        _B_u_t_t_o_n_R_e_l_e_a_s_e, and _M_o_t_i_o_n_N_o_t_i_f_y events contain:
  15.  
  16.        typedef struct {
  17.         int type;             /* ButtonPress or ButtonRelease */
  18.         unsigned long serial;    /* # of last request processed by server */
  19.         Bool send_event;         /* true if this came from a SendEvent request */
  20.         Display *display;         /* Display the event was read from */
  21.         Window window;         /* ``event'' window it is reported relative to */
  22.         Window root;         /* root window that the event occurred on */
  23.         Window subwindow;         /* child window */
  24.         Time time;             /* milliseconds */
  25.         int x, y;             /* pointer x, y coordinates in event window */
  26.         int x_root, y_root;         /* coordinates relative to root */
  27.         unsigned int state;         /* key or button mask */
  28.         unsigned int button;     /* detail */
  29.         Bool same_screen;         /* same screen flag */
  30.        } XButtonEvent;
  31.        typedef XButtonEvent XButtonPressedEvent;
  32.        typedef XButtonEvent XButtonReleasedEvent;
  33.  
  34.        typedef struct {
  35.         int type;             /* KeyPress or KeyRelease */
  36.         unsigned long serial;    /* # of last request processed by server */
  37.         Bool send_event;         /* true if this came from a SendEvent request */
  38.         Display *display;         /* Display the event was read from */
  39.         Window window;         /* ``event'' window it is reported relative to */
  40.         Window root;         /* root window that the event occurred on */
  41.         Window subwindow;         /* child window */
  42.         Time time;             /* milliseconds */
  43.         int x, y;             /* pointer x, y coordinates in event window */
  44.         int x_root, y_root;         /* coordinates relative to root */
  45.         unsigned int state;         /* key or button mask */
  46.         unsigned int keycode;    /* detail */
  47.         Bool same_screen;         /* same screen flag */
  48.        } XKeyEvent;
  49.        typedef XKeyEvent XKeyPressedEvent;
  50.        typedef XKeyEvent XKeyReleasedEvent;
  51.  
  52.        typedef struct {
  53.         int type;             /* MotionNotify */
  54.         unsigned long serial;    /* # of last request processed by server */
  55.         Bool send_event;         /* true if this came from a SendEvent request */
  56.         Display *display;         /* Display the event was read from */
  57.         Window window;         /* ``event'' window reported relative to */
  58.         Window root;         /* root window that the event occurred on */
  59.         Window subwindow;         /* child window */
  60.         Time time;             /* milliseconds */
  61.  
  62.  
  63.  
  64. X Version 11           Release 6.1                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XButtonEvent(3X11)      XLIB FUNCTIONS       XButtonEvent(3X11)
  71.  
  72.  
  73.         int x, y;             /* pointer x, y coordinates in event window */
  74.         int x_root, y_root;         /* coordinates relative to root */
  75.         unsigned int state;         /* key or button mask */
  76.         char is_hint;         /* detail */
  77.         Bool same_screen;         /* same screen flag */
  78.        } XMotionEvent;
  79.        typedef XMotionEvent XPointerMovedEvent;
  80.  
  81.        When you receive these events, their structure members are
  82.        set as follows.
  83.  
  84.        The type member is set to the event type constant name
  85.        that uniquely identifies it.  For example, when the X
  86.        server reports a _G_r_a_p_h_i_c_s_E_x_p_o_s_e event to a client applica-
  87.        tion, it sends an _X_G_r_a_p_h_i_c_s_E_x_p_o_s_e_E_v_e_n_t structure with the
  88.        type member set to _G_r_a_p_h_i_c_s_E_x_p_o_s_e.  The display member is
  89.        set to a pointer to the display the event was read on.
  90.        The send_event member is set to _T_r_u_e if the event came
  91.        from a _S_e_n_d_E_v_e_n_t protocol request.  The serial member is
  92.        set from the serial number reported in the protocol but
  93.        expanded from the 16-bit least-significant bits to a full
  94.        32-bit value.  The window member is set to the window that
  95.        is most useful to toolkit dispatchers.
  96.  
  97.        These structures have the following common members: win-
  98.        dow, root, subwindow, time, x, y, x_root, y_root, state,
  99.        and same_screen.     The window member is set to the window
  100.        on which the event was generated and is referred to as the
  101.        event window.  As long as the conditions previously dis-
  102.        cussed are met, this is the window used by the X server to
  103.        report the event.  The root member is set to the source
  104.        window's root window.  The x_root and y_root members are
  105.        set to the pointer's coordinates relative to the root win-
  106.        dow's origin at the time of the event.
  107.  
  108.        The same_screen member is set to indicate whether the
  109.        event window is on the same screen as the root window and
  110.        can be either _T_r_u_e or _F_a_l_s_e.  If _T_r_u_e, the event and root
  111.        windows are on the same screen.    If _F_a_l_s_e, the event and
  112.        root windows are not on the same screen.
  113.  
  114.        If the source window is an inferior of the event window,
  115.        the subwindow member of the structure is set to the child
  116.        of the event window that is the source window or the child
  117.        of the event window that is an ancestor of the source win-
  118.        dow.  Otherwise, the X server sets the subwindow member to
  119.        _N_o_n_e.  The time member is set to the time when the event
  120.        was generated and is expressed in milliseconds.
  121.  
  122.        If the event window is on the same screen as the root win-
  123.        dow, the x and y members are set to the coordinates rela-
  124.        tive to the event window's origin.  Otherwise, these mem-
  125.        bers are set to zero.
  126.  
  127.  
  128.  
  129.  
  130. X Version 11           Release 6.1                2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XButtonEvent(3X11)      XLIB FUNCTIONS       XButtonEvent(3X11)
  137.  
  138.  
  139.        The state member is set to indicate the logical state of
  140.        the pointer buttons and modifier keys just prior to the
  141.        event, which is the bitwise inclusive OR of one or more of
  142.        the button or modifier key masks: _B_u_t_t_o_n_1_M_a_s_k,
  143.        _B_u_t_t_o_n_2_M_a_s_k, _B_u_t_t_o_n_3_M_a_s_k, _B_u_t_t_o_n_4_M_a_s_k, _B_u_t_t_o_n_5_M_a_s_k,
  144.        _S_h_i_f_t_M_a_s_k, _L_o_c_k_M_a_s_k, _C_o_n_t_r_o_l_M_a_s_k, _M_o_d_1_M_a_s_k, _M_o_d_2_M_a_s_k,
  145.        _M_o_d_3_M_a_s_k, _M_o_d_4_M_a_s_k, and _M_o_d_5_M_a_s_k.
  146.  
  147.        Each of these structures also has a member that indicates
  148.        the detail.  For the _X_K_e_y_P_r_e_s_s_e_d_E_v_e_n_t and _X_K_e_y_R_e_l_e_a_s_e_d_E_-
  149.        _v_e_n_t structures, this member is called a keycode.  It is
  150.        set to a number that represents a physical key on the key-
  151.        board.  The keycode is an arbitrary representation for any
  152.        key on the keyboard (see sections 12.7 and 16.1).
  153.  
  154.        For the _X_B_u_t_t_o_n_P_r_e_s_s_e_d_E_v_e_n_t and _X_B_u_t_t_o_n_R_e_l_e_a_s_e_d_E_v_e_n_t
  155.        structures, this member is called button.  It represents
  156.        the pointer button that changed state and can be the
  157.        _B_u_t_t_o_n_1, _B_u_t_t_o_n_2, _B_u_t_t_o_n_3, _B_u_t_t_o_n_4, or _B_u_t_t_o_n_5 value.  For
  158.        the _X_P_o_i_n_t_e_r_M_o_v_e_d_E_v_e_n_t structure, this member is called
  159.        is_hint.     It can be set to _N_o_t_i_f_y_N_o_r_m_a_l or _N_o_t_i_f_y_H_i_n_t.
  160.  
  161. SSEEEE AALLSSOO
  162.        XAnyEvent(3X11), XCreateWindowEvent(3X11), XCircula-
  163.        teEvent(3X11), XCirculateRequestEvent(3X11), XCol-
  164.        ormapEvent(3X11), XConfigureEvent(3X11), XConfigur-
  165.        eRequestEvent(3X11), XCrossingEvent(3X11), XDestroyWindow-
  166.        Event(3X11), XErrorEvent(3X11), XExposeEvent(3X11), XFo-
  167.        cusChangeEvent(3X11), XGraphicsExposeEvent(3X11), XGravi-
  168.        tyEvent(3X11), XKeymapEvent(3X11), XMapEvent(3X11),
  169.        XMapRequestEvent(3X11), XPropertyEvent(3X11), XRepar-
  170.        entEvent(3X11), XResizeRequestEvent(3X11), XSelection-
  171.        ClearEvent(3X11), XSelectionEvent(3X11), XSelectionRe-
  172.        questEvent(3X11), XUnmapEvent(3X11), XVisibili-
  173.        tyEvent(3X11)
  174.        _X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  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.