src/events/SDL_mouse_c.h
author Sam Lantinga
Mon, 23 Dec 2013 12:17:52 -0800
changeset 8066 658b461d81be
parent 7191 75360622e65f
child 8071 1ac2db4abe11
permissions -rw-r--r--
Added support for double-clicks, through a new "clicks" field in the mouse button event.
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 #include "SDL_config.h"
    22 
    23 #ifndef _SDL_mouse_c_h
    24 #define _SDL_mouse_c_h
    25 
    26 #include "SDL_mouse.h"
    27 
    28 typedef Uint32 SDL_MouseID;
    29 
    30 struct SDL_Cursor
    31 {
    32     struct SDL_Cursor *next;
    33     void *driverdata;
    34 };
    35 
    36 typedef struct
    37 {
    38     int last_x, last_y;
    39     Uint32 last_timestamp;
    40     Uint8 click_count;
    41 } SDL_MouseClickState;
    42 
    43 typedef struct
    44 {
    45     /* Create a cursor from a surface */
    46     SDL_Cursor *(*CreateCursor) (SDL_Surface * surface, int hot_x, int hot_y);
    47 
    48     /* Create a system cursor */
    49     SDL_Cursor *(*CreateSystemCursor) (SDL_SystemCursor id);
    50 
    51     /* Show the specified cursor, or hide if cursor is NULL */
    52     int (*ShowCursor) (SDL_Cursor * cursor);
    53 
    54     /* This is called when a mouse motion event occurs */
    55     void (*MoveCursor) (SDL_Cursor * cursor);
    56 
    57     /* Free a window manager cursor */
    58     void (*FreeCursor) (SDL_Cursor * cursor);
    59 
    60     /* Warp the mouse to (x,y) */
    61     void (*WarpMouse) (SDL_Window * window, int x, int y);
    62 
    63     /* Set relative mode */
    64     int (*SetRelativeMouseMode) (SDL_bool enabled);
    65 
    66     /* Data common to all mice */
    67     SDL_MouseID mouseID;
    68     SDL_Window *focus;
    69     int x;
    70     int y;
    71     int xdelta;
    72     int ydelta;
    73     int last_x, last_y;         /* the last reported x and y coordinates */
    74     Uint32 buttonstate;
    75     SDL_bool relative_mode;
    76     /* the x and y coordinates when relative mode was activated */
    77     int original_x, original_y;
    78 
    79     /* Data for double-click tracking */
    80     int num_clickstates;
    81     SDL_MouseClickState *clickstate;
    82 
    83     SDL_Cursor *cursors;
    84     SDL_Cursor *def_cursor;
    85     SDL_Cursor *cur_cursor;
    86     SDL_bool cursor_shown;
    87 
    88     /* Driver-dependent data. */
    89     void *driverdata;
    90 } SDL_Mouse;
    91 
    92 
    93 /* Initialize the mouse subsystem */
    94 extern int SDL_MouseInit(void);
    95 
    96 /* Get the mouse state structure */
    97 SDL_Mouse *SDL_GetMouse(void);
    98 
    99 /* Set the default double-click interval */
   100 extern void SDL_SetDoubleClickTime(Uint32 interval);
   101 
   102 /* Set the default mouse cursor */
   103 extern void SDL_SetDefaultCursor(SDL_Cursor * cursor);
   104 
   105 /* Set the mouse focus window */
   106 extern void SDL_SetMouseFocus(SDL_Window * window);
   107 
   108 /* Send a mouse motion event */
   109 extern int SDL_SendMouseMotion(SDL_Window * window, SDL_MouseID mouseID, int relative, int x, int y);
   110 
   111 /* Send a mouse button event */
   112 extern int SDL_SendMouseButton(SDL_Window * window, SDL_MouseID mouseID, Uint8 state, Uint8 button);
   113 
   114 /* Send a mouse wheel event */
   115 extern int SDL_SendMouseWheel(SDL_Window * window, SDL_MouseID mouseID, int x, int y);
   116 
   117 /* Shutdown the mouse subsystem */
   118 extern void SDL_MouseQuit(void);
   119 
   120 #endif /* _SDL_mouse_c_h */
   121 
   122 /* vi: set ts=4 sw=4 expandtab: */