include/SDL_events.h
branchSDL-1.3
changeset 1686 8d7fecceb9ef
parent 1669 9857d21967bb
child 1722 5daa04d862f1
equal deleted inserted replaced
1685:66267c6a0b12 1686:8d7fecceb9ef
   127 } SDL_WindowEvent;
   127 } SDL_WindowEvent;
   128 
   128 
   129 /**
   129 /**
   130  * \struct SDL_KeyboardEvent
   130  * \struct SDL_KeyboardEvent
   131  *
   131  *
   132  * \brief Keyboard event structure
   132  * \brief Keyboard button event structure
   133  */
   133  */
   134 typedef struct SDL_KeyboardEvent
   134 typedef struct SDL_KeyboardEvent
   135 {
   135 {
   136     Uint8 type;             /**< SDL_KEYDOWN or SDL_KEYUP */
   136     Uint8 type;             /**< SDL_KEYDOWN or SDL_KEYUP */
   137     Uint8 which;            /**< The keyboard device index */
   137     Uint8 which;            /**< The keyboard device index */
   138     Uint8 state;            /**< SDL_PRESSED or SDL_RELEASED */
   138     Uint8 state;            /**< SDL_PRESSED or SDL_RELEASED */
   139     SDL_keysym keysym;      /**< The key that was pressed or released */
   139     SDL_keysym keysym;      /**< The key that was pressed or released */
   140     SDL_WindowID windowID;  /**< The window with keyboard focus, if any */
   140     SDL_WindowID windowID;  /**< The window with keyboard focus, if any */
   141 } SDL_KeyboardEvent;
   141 } SDL_KeyboardEvent;
       
   142 
       
   143 /**
       
   144  * \struct SDL_CharEvent
       
   145  *
       
   146  * \brief Keyboard input event structure
       
   147  */
       
   148 typedef struct SDL_CharEvent
       
   149 {
       
   150     Uint8 type;             /**< SDL_CHARINPUT (FIXME: NYI) */
       
   151     Uint8 which;            /**< The keyboard device index */
       
   152     char text[32];          /**< The input text */
       
   153     SDL_WindowID windowID;  /**< The window with keyboard focus, if any */
       
   154 } SDL_CharEvent;
   142 
   155 
   143 /**
   156 /**
   144  * \struct SDL_MouseMotionEvent
   157  * \struct SDL_MouseMotionEvent
   145  *
   158  *
   146  * \brief Mouse motion event structure
   159  * \brief Mouse motion event structure
   362   This function sets up a filter to process all events before they
   375   This function sets up a filter to process all events before they
   363   change internal state and are posted to the internal event queue.
   376   change internal state and are posted to the internal event queue.
   364 
   377 
   365   The filter is protypted as:
   378   The filter is protypted as:
   366 */
   379 */
   367 typedef int (SDLCALL * SDL_EventFilter) (const SDL_Event * event);
   380 typedef int (SDLCALL * SDL_EventFilter) (SDL_Event * event);
   368 /*
   381 /*
   369   If the filter returns 1, then the event will be added to the internal queue.
   382   If the filter returns 1, then the event will be added to the internal queue.
   370   If it returns 0, then the event will be dropped from the queue, but the 
   383   If it returns 0, then the event will be dropped from the queue, but the 
   371   internal state will still be updated.  This allows selective filtering of
   384   internal state will still be updated.  This allows selective filtering of
   372   dynamically arriving events.
   385   dynamically arriving events.