Mercurial > sdl-ios-xcode

comparison include/SDL_mouse.h @ 2718:abacf2555bb4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Removed unneccesary code lines. Fixed mousename bug. Added lacking code in mousebutton
author Szymon Wilczek <kazeuser@gmail.com>
date Mon, 25 Aug 2008 18:02:14 +0000
parents 44e49d3fa6cf
children f55c87ae336b
comparison
equal deleted inserted replaced
2717:50bc882455e5 2718:abacf2555bb4
53 * \sa SDL_SelectMouse() 53 * \sa SDL_SelectMouse()
54 */ 54 */
55 extern DECLSPEC int SDLCALL SDL_GetNumMice(void); 55 extern DECLSPEC int SDLCALL SDL_GetNumMice(void);
56 56
57 /** 57 /**
58 * \fn char* SDL_GetMouseName(int index)
59 *
60 * \brief Gets the name of a mouse with the given index.
61 *
62 * \param index is the index of the mouse, which name is to be returned.
63 *
64 * \return the name of the mouse with the specified index
65 */
66 extern DECLSPEC char *SDLCALL SDL_GetMouseName(int index);
67
68 /**
58 * \fn int SDL_SelectMouse(int index) 69 * \fn int SDL_SelectMouse(int index)
59 * 70 *
60 * \brief Set the index of the currently selected mouse. 71 * \brief Set the index of the currently selected mouse.
61 * 72 *
62 * \return The index of the previously selected mouse. 73 * \return The index of the previously selected mouse.
204 Button 1: Left mouse button 215 Button 1: Left mouse button
205 Button 2: Middle mouse button 216 Button 2: Middle mouse button
206 Button 3: Right mouse button 217 Button 3: Right mouse button
207 */ 218 */
208 219
209 /* FIXME: Where do these functions go in this header? 220 /**
210 Also, add doxygen documentation for these... 221 * \fn int SDL_GetCursorsNumber(int index)
211 */ 222 *
212 extern DECLSPEC char *SDLCALL SDL_GetMouseName(int index); 223 * \brief Gets the number of cursors a pointing device supports.
213 224 * Useful for tablet users. Useful only under Windows.
225 *
226 * \param index is the index of the pointing device, which number of cursors we
227 * want to receive.
228 *
229 * \return the number of cursors supported by the pointing device. On Windows
230 * if a device is a tablet it returns a number >=1. Normal mice always return 1.
231 * On Linux every device reports one cursor.
232 */
214 extern DECLSPEC int SDLCALL SDL_GetCursorsNumber(int index); 233 extern DECLSPEC int SDLCALL SDL_GetCursorsNumber(int index);
215 234
235 /**
236 * \fn int SDL_GetCurrentCursor(int index)
237 *
238 * \brief Returns the index of the current cursor used by a specific pointing
239 * device. Useful only under Windows.
240 *
241 * \param index is the index of the pointing device, which cursor index we want
242 * to receive.
243 *
244 * \return the index of the cursor currently used by a specific pointing device.
245 * Always 0 under Linux. On Windows if the device isn't a tablet it returns 0.
246 * If the device is the tablet it returns the cursor index.
247 * 0 - stylus, 1 - eraser, 2 - cursor.
248 */
216 extern DECLSPEC int SDLCALL SDL_GetCurrentCursor(int index); 249 extern DECLSPEC int SDLCALL SDL_GetCurrentCursor(int index);
217 250
218 #define SDL_BUTTON(X) (1 << ((X)-1)) 251 #define SDL_BUTTON(X) (1 << ((X)-1))
219 #define SDL_BUTTON_LEFT 1 252 #define SDL_BUTTON_LEFT 1
220 #define SDL_BUTTON_MIDDLE 2 253 #define SDL_BUTTON_MIDDLE 2