src/events/SDL_mouse_c.h
author Szymon Wilczek
Sat, 05 Jul 2008 20:02:07 +0000
branchgsoc2008_manymouse
changeset 3765 ed9b7fe8f902
parent 3764 2970fcfbdd54
child 3766 24db5d326f57
permissions -rw-r--r--
Estethic changes noted on the SDL meeting 05.07.08
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2006 Sam Lantinga
     4 
     5     This library is free software; you can redistribute it and/or
     6     modify it under the terms of the GNU Lesser General Public
     7     License as published by the Free Software Foundation; either
     8     version 2.1 of the License, or (at your option) any later version.
     9 
    10     This library is distributed in the hope that it will be useful,
    11     but WITHOUT ANY WARRANTY; without even the implied warranty of
    12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    13     Lesser General Public License for more details.
    14 
    15     You should have received a copy of the GNU Lesser General Public
    16     License along with this library; if not, write to the Free Software
    17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    18 
    19     Sam Lantinga
    20     slouken@libsdl.org
    21 */
    22 #include "SDL_config.h"
    23 
    24 #ifndef _SDL_mouse_c_h
    25 #define _SDL_mouse_c_h
    26 
    27 typedef struct SDL_Mouse SDL_Mouse;
    28 
    29 struct SDL_Cursor
    30 {
    31     SDL_Mouse *mouse;
    32 
    33     SDL_Cursor *next;
    34 
    35     void *driverdata;
    36 };
    37 
    38 struct SDL_Mouse
    39 {
    40     /* Create a cursor from a surface */
    41     SDL_Cursor *(*CreateCursor) (SDL_Surface * surface, int hot_x, int hot_y);
    42 
    43     /* Show the specified cursor, or hide if cursor is NULL */
    44     int (*ShowCursor) (SDL_Cursor * cursor);
    45 
    46     /* This is called when a mouse motion event occurs */
    47     void (*MoveCursor) (SDL_Cursor * cursor);
    48 
    49     /* Free a window manager cursor */
    50     void (*FreeCursor) (SDL_Cursor * cursor);
    51 
    52     /* Warp the mouse to (x,y) */
    53     void (*WarpMouse) (SDL_Mouse * mouse, SDL_WindowID windowID, int x,
    54                        int y);
    55 
    56     /* Free the mouse when it's time */
    57     void (*FreeMouse) (SDL_Mouse * mouse);
    58 
    59     /* Data common to all mice */
    60     SDL_WindowID focus;
    61     int which;
    62     int x;
    63     int y;
    64     int z;/*for future use*/
    65     int xdelta;
    66     int ydelta;
    67     int pressure;
    68     int tilt;/*for future use*/
    69     int rotation;/*for future use*/
    70     char* name;
    71     Uint8 buttonstate;
    72     SDL_bool relative_mode;
    73     SDL_bool proximity;
    74     SDL_bool flush_motion;
    75 
    76     SDL_Cursor *cursors;
    77     SDL_Cursor *def_cursor;
    78     SDL_Cursor *cur_cursor;
    79     SDL_bool cursor_shown;
    80 
    81     void *driverdata;
    82 };
    83 
    84 
    85 /* Initialize the mouse subsystem */
    86 extern int SDL_MouseInit(void);
    87 
    88 /* Get the mouse at an index */
    89 extern SDL_Mouse *SDL_GetMouse(int index);
    90 
    91 /* Add a mouse, possibly reattaching at a particular index (or -1),
    92    returning the index of the mouse, or -1 if there was an error.
    93  */
    94 extern int SDL_AddMouse(const SDL_Mouse * mouse, int index, char* name);
    95 
    96 /* Remove a mouse at an index, clearing the slot for later */
    97 extern void SDL_DelMouse(int index);
    98 
    99 /* Clear the button state of a mouse at an index */
   100 extern void SDL_ResetMouse(int index);
   101 
   102 /* Set the mouse focus window */
   103 extern void SDL_SetMouseFocus(int index, SDL_WindowID windowID);
   104 
   105 /* Send a mouse motion event for a mouse at an index */
   106 extern int SDL_SendMouseMotion(int index, int relative, int x, int y, int z);
   107 
   108 /* Send a mouse button event for a mouse at an index */
   109 extern int SDL_SendMouseButton(int index, Uint8 state, Uint8 button);
   110 
   111 /* Send a mouse wheel event for a mouse at an index */
   112 extern int SDL_SendMouseWheel(int index, int x, int y);
   113 
   114 /* Shutdown the mouse subsystem */
   115 extern void SDL_MouseQuit(void);
   116 
   117 extern int SDL_GetIndexById(int id);
   118 
   119 extern void SDL_SetIndexId(int id, int index);
   120 
   121 extern int SDL_GetNumOfMice(void);
   122 
   123 extern char* SDL_GetMouseName(int index);
   124 
   125 extern void SDL_UpdateCoordinates(int x, int y);
   126 
   127 #endif /* _SDL_mouse_c_h */
   128 
   129 /* vi: set ts=4 sw=4 expandtab: */