sdl-ios-xcode: include/SDL_events.h comparison

comparison include/SDL_events.h @ 1662:782fd950bd46 SDL-1.3

Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API. WARNING: None of the video drivers have been updated for the new API yet! The API is still under design and very fluid. The code is now run through a consistent indent format: indent -i4 -nut -nsc -br -ce The headers are being converted to automatically generate doxygen documentation.

author	Sam Lantinga <slouken@libsdl.org>
date	Sun, 28 May 2006 13:04:16 +0000
parents	c71e05b4dc2e
children	4da1ee79c9af

comparison

equal deleted inserted replaced

-:281d3f4870e5
+:782fd950bd46
 Sam Lantinga
 slouken@libsdl.org
 */
-/* Include file for SDL event handling */
+/**
+* \file SDL_events.h
+*
+* Include file for SDL event handling
+*/
 #ifndef _SDL_events_h
 #define _SDL_events_h
 #include "SDL_stdinc.h"
 #include "SDL_error.h"
-#include "SDL_active.h"
+#include "SDL_video.h"
 #include "SDL_keyboard.h"
 #include "SDL_mouse.h"
 #include "SDL_joystick.h"
 #include "SDL_quit.h"
 #include "begin_code.h"
 /* Set up for C function definitions, even when using C++ */
 #ifdef __cplusplus
+/* *INDENT-OFF* */
 extern "C" {
+/* *INDENT-ON* */
 #endif
 /* General keyboard/mouse state definitions */
 #define SDL_RELEASED	0
 #define SDL_PRESSED	1
-/* Event enumerations */
+/**
-typedef enum {
+* \enum SDL_EventType
-SDL_NOEVENT = 0,			/* Unused (do not remove) */
+*
-SDL_ACTIVEEVENT,			/* Application loses/gains visibility */
+* \brief The types of events that can be delivered
-SDL_KEYDOWN,			/* Keys pressed */
+*/
-SDL_KEYUP,			/* Keys released */
+typedef enum
-SDL_MOUSEMOTION,			/* Mouse moved */
+{
-SDL_MOUSEBUTTONDOWN,		/* Mouse button pressed */
+SDL_NOEVENT = 0,            /**< Unused (do not remove) */
-SDL_MOUSEBUTTONUP,		/* Mouse button released */
+SDL_WINDOWEVENT,            /**< Window state change */
-SDL_JOYAXISMOTION,		/* Joystick axis motion */
+SDL_KEYDOWN,                /**< Keys pressed */
-SDL_JOYBALLMOTION,		/* Joystick trackball motion */
+SDL_KEYUP,                  /**< Keys released */
-SDL_JOYHATMOTION,		/* Joystick hat position change */
+SDL_MOUSEMOTION,            /**< Mouse moved */
-SDL_JOYBUTTONDOWN,		/* Joystick button pressed */
+SDL_MOUSEBUTTONDOWN,        /**< Mouse button pressed */
-SDL_JOYBUTTONUP,			/* Joystick button released */
+SDL_MOUSEBUTTONUP,          /**< Mouse button released */
-SDL_QUIT,			/* User-requested quit */
+SDL_JOYAXISMOTION,          /**< Joystick axis motion */
-SDL_SYSWMEVENT,			/* System specific event */
+SDL_JOYBALLMOTION,          /**< Joystick trackball motion */
-SDL_EVENT_RESERVEDA,		/* Reserved for future use.. */
+SDL_JOYHATMOTION,           /**< Joystick hat position change */
-SDL_EVENT_RESERVEDB,		/* Reserved for future use.. */
+SDL_JOYBUTTONDOWN,          /**< Joystick button pressed */
-SDL_VIDEORESIZE,			/* User resized video mode */
+SDL_JOYBUTTONUP,            /**< Joystick button released */
-SDL_VIDEOEXPOSE,			/* Screen needs to be redrawn */
+SDL_QUIT,                   /**< User-requested quit */
-SDL_EVENT_RESERVED2,		/* Reserved for future use.. */
+SDL_SYSWMEVENT,             /**< System specific event */
-SDL_EVENT_RESERVED3,		/* Reserved for future use.. */
+SDL_EVENT_RESERVED1,        /**< Reserved for future use... */
-SDL_EVENT_RESERVED4,		/* Reserved for future use.. */
+SDL_EVENT_RESERVED2,        /**< Reserved for future use... */
-SDL_EVENT_RESERVED5,		/* Reserved for future use.. */
+SDL_EVENT_RESERVED3,        /**< Reserved for future use... */
-SDL_EVENT_RESERVED6,		/* Reserved for future use.. */
+/* Events SDL_USEREVENT through SDL_MAXEVENTS-1 are for your use */
-SDL_EVENT_RESERVED7,		/* Reserved for future use.. */
+SDL_USEREVENT = 24,
-/* Events SDL_USEREVENT through SDL_MAXEVENTS-1 are for your use */
+/* This last event is only for bounding internal arrays
-SDL_USEREVENT = 24,
+It is the number of bits in the event mask datatype -- Uint32
-/* This last event is only for bounding internal arrays
+*/
-	  It is the number of bits in the event mask datatype -- Uint32
+SDL_NUMEVENTS = 32
-*/
-SDL_NUMEVENTS = 32
 } SDL_EventType;
-/* Predefined event masks */
+/**
+* \enum SDL_EventMask
+*
+* \brief Predefined event masks
+*/
 #define SDL_EVENTMASK(X)	(1<<(X))
-typedef enum {
+typedef enum
-	SDL_ACTIVEEVENTMASK	= SDL_EVENTMASK(SDL_ACTIVEEVENT),
+{
-	SDL_KEYDOWNMASK		= SDL_EVENTMASK(SDL_KEYDOWN),
+SDL_WINDOWEVENTMASK = SDL_EVENTMASK (SDL_WINDOWEVENT),
-	SDL_KEYUPMASK		= SDL_EVENTMASK(SDL_KEYUP),
+SDL_KEYDOWNMASK = SDL_EVENTMASK (SDL_KEYDOWN),
-	SDL_KEYEVENTMASK	= SDL_EVENTMASK(SDL_KEYDOWN)|
+SDL_KEYUPMASK = SDL_EVENTMASK (SDL_KEYUP),
-	                          SDL_EVENTMASK(SDL_KEYUP),
+SDL_KEYEVENTMASK = SDL_EVENTMASK (SDL_KEYDOWN) |
-	SDL_MOUSEMOTIONMASK	= SDL_EVENTMASK(SDL_MOUSEMOTION),
+SDL_EVENTMASK (SDL_KEYUP),
-	SDL_MOUSEBUTTONDOWNMASK	= SDL_EVENTMASK(SDL_MOUSEBUTTONDOWN),
+SDL_MOUSEMOTIONMASK = SDL_EVENTMASK (SDL_MOUSEMOTION),
-	SDL_MOUSEBUTTONUPMASK	= SDL_EVENTMASK(SDL_MOUSEBUTTONUP),
+SDL_MOUSEBUTTONDOWNMASK = SDL_EVENTMASK (SDL_MOUSEBUTTONDOWN),
-	SDL_MOUSEEVENTMASK	= SDL_EVENTMASK(SDL_MOUSEMOTION)|
+SDL_MOUSEBUTTONUPMASK = SDL_EVENTMASK (SDL_MOUSEBUTTONUP),
-	                          SDL_EVENTMASK(SDL_MOUSEBUTTONDOWN)|
+SDL_MOUSEEVENTMASK = SDL_EVENTMASK (SDL_MOUSEMOTION) |
-	                          SDL_EVENTMASK(SDL_MOUSEBUTTONUP),
+SDL_EVENTMASK (SDL_MOUSEBUTTONDOWN) |
-	SDL_JOYAXISMOTIONMASK	= SDL_EVENTMASK(SDL_JOYAXISMOTION),
+SDL_EVENTMASK (SDL_MOUSEBUTTONUP),
-	SDL_JOYBALLMOTIONMASK	= SDL_EVENTMASK(SDL_JOYBALLMOTION),
+SDL_JOYAXISMOTIONMASK = SDL_EVENTMASK (SDL_JOYAXISMOTION),
-	SDL_JOYHATMOTIONMASK	= SDL_EVENTMASK(SDL_JOYHATMOTION),
+SDL_JOYBALLMOTIONMASK = SDL_EVENTMASK (SDL_JOYBALLMOTION),
-	SDL_JOYBUTTONDOWNMASK	= SDL_EVENTMASK(SDL_JOYBUTTONDOWN),
+SDL_JOYHATMOTIONMASK = SDL_EVENTMASK (SDL_JOYHATMOTION),
-	SDL_JOYBUTTONUPMASK	= SDL_EVENTMASK(SDL_JOYBUTTONUP),
+SDL_JOYBUTTONDOWNMASK = SDL_EVENTMASK (SDL_JOYBUTTONDOWN),
-	SDL_JOYEVENTMASK	= SDL_EVENTMASK(SDL_JOYAXISMOTION)|
+SDL_JOYBUTTONUPMASK = SDL_EVENTMASK (SDL_JOYBUTTONUP),
-	                          SDL_EVENTMASK(SDL_JOYBALLMOTION)|
+SDL_JOYEVENTMASK = SDL_EVENTMASK (SDL_JOYAXISMOTION) |
-	                          SDL_EVENTMASK(SDL_JOYHATMOTION)|
+SDL_EVENTMASK (SDL_JOYBALLMOTION) |
-	                          SDL_EVENTMASK(SDL_JOYBUTTONDOWN)|
+SDL_EVENTMASK (SDL_JOYHATMOTION) |
-	                          SDL_EVENTMASK(SDL_JOYBUTTONUP),
+SDL_EVENTMASK (SDL_JOYBUTTONDOWN) | SDL_EVENTMASK (SDL_JOYBUTTONUP),
-	SDL_VIDEORESIZEMASK	= SDL_EVENTMASK(SDL_VIDEORESIZE),
+SDL_QUITMASK = SDL_EVENTMASK (SDL_QUIT),
-	SDL_VIDEOEXPOSEMASK	= SDL_EVENTMASK(SDL_VIDEOEXPOSE),
+SDL_SYSWMEVENTMASK = SDL_EVENTMASK (SDL_SYSWMEVENT)
-	SDL_QUITMASK		= SDL_EVENTMASK(SDL_QUIT),
+} SDL_EventMask;
-	SDL_SYSWMEVENTMASK	= SDL_EVENTMASK(SDL_SYSWMEVENT)
-} SDL_EventMask ;
 #define SDL_ALLEVENTS		0xFFFFFFFF
-/* Application visibility event structure */
+/**
-typedef struct SDL_ActiveEvent {
+* \struct SDL_WindowEvent
-	Uint8 type;	/* SDL_ACTIVEEVENT */
+*
-	Uint8 gain;	/* Whether given states were gained or lost (1/0) */
+* \brief Window state change event data
-	Uint8 state;	/* A mask of the focus states */
+*/
-} SDL_ActiveEvent;
+typedef struct SDL_WindowEvent
+{
-/* Keyboard event structure */
+Uint8 type;             /**< SDL_WINDOWEVENT */
-typedef struct SDL_KeyboardEvent {
+Uint8 event;            /**< SDL_WindowEventID */
-	Uint8 type;	/* SDL_KEYDOWN or SDL_KEYUP */
+int data1;              /**< event dependent data */
-	Uint8 which;	/* The keyboard device index */
+int data2;              /**< event dependent data */
-	Uint8 state;	/* SDL_PRESSED or SDL_RELEASED */
+SDL_WindowID windowID;  /**< The associated window */
-	SDL_keysym keysym;
+} SDL_WindowEvent;
+/**
+* \struct SDL_KeyboardEvent
+*
+* \brief Keyboard event structure
+*/
+typedef struct SDL_KeyboardEvent
+{
+Uint8 type;             /**< SDL_KEYDOWN or SDL_KEYUP */
+Uint8 which;            /**< The keyboard device index */
+Uint8 state;            /**< SDL_PRESSED or SDL_RELEASED */
+SDL_keysym keysym;      /**< The key that was pressed or released */
+SDL_WindowID windowID;  /**< The window with keyboard focus, if any */
 } SDL_KeyboardEvent;
-/* Mouse motion event structure */
+/**
-typedef struct SDL_MouseMotionEvent {
+* \struct SDL_MouseMotionEvent
-	Uint8 type;	/* SDL_MOUSEMOTION */
+*
-	Uint8 which;	/* The mouse device index */
+* \brief Mouse motion event structure
-	Uint8 state;	/* The current button state */
+*/
-	Uint16 x, y;	/* The X/Y coordinates of the mouse */
+typedef struct SDL_MouseMotionEvent
-	Sint16 xrel;	/* The relative motion in the X direction */
+{
-	Sint16 yrel;	/* The relative motion in the Y direction */
+Uint8 type;             /**< SDL_MOUSEMOTION */
+Uint8 which;            /**< The mouse device index */
+Uint8 state;            /**< The current button state */
+int x;                  /**< X coordinate, relative to window */
+int y;                  /**< Y coordinate, relative to window */
+int xrel;               /**< The relative motion in the X direction */
+int yrel;               /**< The relative motion in the Y direction */
+SDL_WindowID windowID;  /**< The window with mouse focus, if any */
 } SDL_MouseMotionEvent;
-/* Mouse button event structure */
+/**
-typedef struct SDL_MouseButtonEvent {
+* \struct SDL_MouseButtonEvent
-	Uint8 type;	/* SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP */
+*
-	Uint8 which;	/* The mouse device index */
+* \brief Mouse button event structure
-	Uint8 button;	/* The mouse button index */
+*/
-	Uint8 state;	/* SDL_PRESSED or SDL_RELEASED */
+typedef struct SDL_MouseButtonEvent
-	Uint16 x, y;	/* The X/Y coordinates of the mouse at press time */
+{
+Uint8 type;             /**< SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP */
+Uint8 which;            /**< The mouse device index */
+Uint8 button;           /**< The mouse button index */
+Uint8 state;            /**< SDL_PRESSED or SDL_RELEASED */
+int x;                  /**< X coordinate, relative to window */
+int y;                  /**< Y coordinate, relative to window */
+SDL_WindowID windowID;  /**< The window with mouse focus, if any */
 } SDL_MouseButtonEvent;
-/* Joystick axis motion event structure */
+/**
-typedef struct SDL_JoyAxisEvent {
+* \struct SDL_JoyAxisEvent
-	Uint8 type;	/* SDL_JOYAXISMOTION */
+*
-	Uint8 which;	/* The joystick device index */
+* \brief Joystick axis motion event structure
-	Uint8 axis;	/* The joystick axis index */
+*/
-	Sint16 value;	/* The axis value (range: -32768 to 32767) */
+typedef struct SDL_JoyAxisEvent
+{
+Uint8 type;         /**< SDL_JOYAXISMOTION */
+Uint8 which;        /**< The joystick device index */
+Uint8 axis;         /**< The joystick axis index */
+int value;          /**< The axis value (range: -32768 to 32767) */
 } SDL_JoyAxisEvent;
-/* Joystick trackball motion event structure */
+/**
-typedef struct SDL_JoyBallEvent {
+* \struct SDL_JoyBallEvent
-	Uint8 type;	/* SDL_JOYBALLMOTION */
+*
-	Uint8 which;	/* The joystick device index */
+* \brief Joystick trackball motion event structure
-	Uint8 ball;	/* The joystick trackball index */
+*/
-	Sint16 xrel;	/* The relative motion in the X direction */
+typedef struct SDL_JoyBallEvent
-	Sint16 yrel;	/* The relative motion in the Y direction */
+{
+Uint8 type;         /**< SDL_JOYBALLMOTION */
+Uint8 which;        /**< The joystick device index */
+Uint8 ball;         /**< The joystick trackball index */
+int xrel;           /**< The relative motion in the X direction */
+int yrel;           /**< The relative motion in the Y direction */
 } SDL_JoyBallEvent;
-/* Joystick hat position change event structure */
+/**
-typedef struct SDL_JoyHatEvent {
+* \struct SDL_JoyHatEvent
-	Uint8 type;	/* SDL_JOYHATMOTION */
+*
-	Uint8 which;	/* The joystick device index */
+* \brief Joystick hat position change event structure
-	Uint8 hat;	/* The joystick hat index */
+*/
-	Uint8 value;	/* The hat position value:
+typedef struct SDL_JoyHatEvent
-			    SDL_HAT_LEFTUP   SDL_HAT_UP       SDL_HAT_RIGHTUP
+{
-			    SDL_HAT_LEFT     SDL_HAT_CENTERED SDL_HAT_RIGHT
+Uint8 type;         /**< SDL_JOYHATMOTION */
-			    SDL_HAT_LEFTDOWN SDL_HAT_DOWN     SDL_HAT_RIGHTDOWN
+Uint8 which;        /**< The joystick device index */
-			   Note that zero means the POV is centered.
+Uint8 hat;          /**< The joystick hat index */
-			*/
+Uint8 value;        /**< The hat position value:
+SDL_HAT_LEFTUP   SDL_HAT_UP       SDL_HAT_RIGHTUP
+SDL_HAT_LEFT     SDL_HAT_CENTERED SDL_HAT_RIGHT
+SDL_HAT_LEFTDOWN SDL_HAT_DOWN     SDL_HAT_RIGHTDOWN
+Note that zero means the POV is centered.
+*/
 } SDL_JoyHatEvent;
-/* Joystick button event structure */
+/**
-typedef struct SDL_JoyButtonEvent {
+* \struct SDL_JoyButtonEvent
-	Uint8 type;	/* SDL_JOYBUTTONDOWN or SDL_JOYBUTTONUP */
+*
-	Uint8 which;	/* The joystick device index */
+* \brief Joystick button event structure
-	Uint8 button;	/* The joystick button index */
+*/
-	Uint8 state;	/* SDL_PRESSED or SDL_RELEASED */
+typedef struct SDL_JoyButtonEvent
+{
+Uint8 type;         /**< SDL_JOYBUTTONDOWN or SDL_JOYBUTTONUP */
+Uint8 which;        /**< The joystick device index */
+Uint8 button;       /**< The joystick button index */
+Uint8 state;        /**< SDL_PRESSED or SDL_RELEASED */
 } SDL_JoyButtonEvent;
-/* The "window resized" event
+/**
-When you get this event, you are responsible for setting a new video
+* \struct SDL_QuitEvent
-mode with the new width and height.
+*
-*/
+* \brief The "quit requested" event
-typedef struct SDL_ResizeEvent {
+*/
-	Uint8 type;	/* SDL_VIDEORESIZE */
+typedef struct SDL_QuitEvent
-	int w;		/* New width */
+{
-	int h;		/* New height */
+Uint8 type;         /**< SDL_QUIT */
-} SDL_ResizeEvent;
-/* The "screen redraw" event */
-typedef struct SDL_ExposeEvent {
-	Uint8 type;	/* SDL_VIDEOEXPOSE */
-} SDL_ExposeEvent;
-/* The "quit requested" event */
-typedef struct SDL_QuitEvent {
-	Uint8 type;	/* SDL_QUIT */
 } SDL_QuitEvent;
-/* A user-defined event type */
+/**
-typedef struct SDL_UserEvent {
+* \struct SDL_UserEvent
-	Uint8 type;	/* SDL_USEREVENT through SDL_NUMEVENTS-1 */
+*
-	int code;	/* User defined event code */
+* \brief A user-defined event type
-	void *data1;	/* User defined data pointer */
+*/
-	void *data2;	/* User defined data pointer */
+typedef struct SDL_UserEvent
+{
+Uint8 type;         /**< SDL_USEREVENT through SDL_NUMEVENTS-1 */
+int code;           /**< User defined event code */
+void *data1;        /**< User defined data pointer */
+void *data2;        /**< User defined data pointer */
 } SDL_UserEvent;
-/* If you want to use this event, you should include SDL_syswm.h */
+/**
+* \struct SDL_SysWMEvent
+*
+* \brief A video driver dependent system event
+*
+* \note If you want to use this event, you should include SDL_syswm.h
+*/
 struct SDL_SysWMmsg;
 typedef struct SDL_SysWMmsg SDL_SysWMmsg;
-typedef struct SDL_SysWMEvent {
+typedef struct SDL_SysWMEvent
-	Uint8 type;
+{
-	SDL_SysWMmsg *msg;
+Uint8 type;         /**< SDL_SYSWMEVENT */
+SDL_SysWMmsg *msg;  /**< driver dependent data, defined in SDL_syswm.h */
 } SDL_SysWMEvent;
-/* General event structure */
+/**
-typedef union SDL_Event {
+* \union SDL_Event
-	Uint8 type;
+*
-	SDL_ActiveEvent active;
+* \brief General event structure
-	SDL_KeyboardEvent key;
+*/
-	SDL_MouseMotionEvent motion;
+typedef union SDL_Event
-	SDL_MouseButtonEvent button;
+{
-	SDL_JoyAxisEvent jaxis;
+Uint8 type;                     /**< Event type, shared with all events */
-	SDL_JoyBallEvent jball;
+SDL_WindowEvent window;         /**< Window event data */
-	SDL_JoyHatEvent jhat;
+SDL_KeyboardEvent key;          /**< Keyboard event data */
-	SDL_JoyButtonEvent jbutton;
+SDL_MouseMotionEvent motion;    /**< Mouse motion event data */
-	SDL_ResizeEvent resize;
+SDL_MouseButtonEvent button;    /**< Mouse button event data */
-	SDL_ExposeEvent expose;
+SDL_JoyAxisEvent jaxis;         /**< Joystick axis event data */
-	SDL_QuitEvent quit;
+SDL_JoyBallEvent jball;         /**< Joystick ball event data */
-	SDL_UserEvent user;
+SDL_JoyHatEvent jhat;           /**< Joystick hat event data */
-	SDL_SysWMEvent syswm;
+SDL_JoyButtonEvent jbutton;     /**< Joystick button event data */
+SDL_QuitEvent quit;             /**< Quit request event data */
+SDL_UserEvent user;             /**< Custom event data */
+SDL_SysWMEvent syswm;           /**< System dependent window event data */
 } SDL_Event;
 /* Function prototypes */
 /* Pumps the event loop, gathering events from the input devices.
 This function updates the event queue and internal input device state.
 This should only be run in the thread that sets the video mode.
 */
-extern DECLSPEC void SDLCALL SDL_PumpEvents(void);
+extern DECLSPEC void SDLCALL SDL_PumpEvents (void);
 /* Checks the event queue for messages and optionally returns them.
 If 'action' is SDL_ADDEVENT, up to 'numevents' events will be added to
 the back of the event queue.
 If 'action' is SDL_PEEKEVENT, up to 'numevents' events at the front
 of the event queue, matching 'mask', will be returned and will be
 removed from the queue.
 This function returns the number of events actually stored, or -1
 if there was an error.  This function is thread-safe.
 */
-typedef enum {
+typedef enum
-	SDL_ADDEVENT,
+{
-	SDL_PEEKEVENT,
+SDL_ADDEVENT,
-	SDL_GETEVENT
+SDL_PEEKEVENT,
+SDL_GETEVENT
 } SDL_eventaction;
 /* */
-extern DECLSPEC int SDLCALL SDL_PeepEvents(SDL_Event *events, int numevents,
+extern DECLSPEC int SDLCALL SDL_PeepEvents (SDL_Event * events, int numevents,
-				SDL_eventaction action, Uint32 mask);
+SDL_eventaction action,
+Uint32 mask);
 /* Polls for currently pending events, and returns 1 if there are any pending
 events, or 0 if there are none available.  If 'event' is not NULL, the next
 event is removed from the queue and stored in that area.
 */
-extern DECLSPEC int SDLCALL SDL_PollEvent(SDL_Event *event);
+extern DECLSPEC int SDLCALL SDL_PollEvent (SDL_Event * event);
 /* Waits indefinitely for the next available event, returning 1, or 0 if there
 was an error while waiting for events.  If 'event' is not NULL, the next
 event is removed from the queue and stored in that area.
 */
-extern DECLSPEC int SDLCALL SDL_WaitEvent(SDL_Event *event);
+extern DECLSPEC int SDLCALL SDL_WaitEvent (SDL_Event * event);
 /* Add an event to the event queue.
 This function returns 0 on success, or -1 if the event queue was full
 or there was some other error.
 */
-extern DECLSPEC int SDLCALL SDL_PushEvent(SDL_Event *event);
+extern DECLSPEC int SDLCALL SDL_PushEvent (SDL_Event * event);
 /*
 This function sets up a filter to process all events before they
 change internal state and are posted to the internal event queue.
 The filter is protypted as:
 */
-typedef int (SDLCALL *SDL_EventFilter)(const SDL_Event *event);
+typedef int (SDLCALL * SDL_EventFilter) (const SDL_Event * event);
 /*
 If the filter returns 1, then the event will be added to the internal queue.
 If it returns 0, then the event will be dropped from the queue, but the
 internal state will still be updated.  This allows selective filtering of
 dynamically arriving events.
 application window.  If the event filter returns 1, then the window will
 be closed, otherwise the window will remain open if possible.
 If the quit event is generated by an interrupt signal, it will bypass the
 internal queue and be delivered to the application at the next event poll.
 */
-extern DECLSPEC void SDLCALL SDL_SetEventFilter(SDL_EventFilter filter);
+extern DECLSPEC void SDLCALL SDL_SetEventFilter (SDL_EventFilter filter);
 /*
 Return the current event filter - can be used to "chain" filters.
 If there is no event filter set, this function returns NULL.
 */
-extern DECLSPEC SDL_EventFilter SDLCALL SDL_GetEventFilter(void);
+extern DECLSPEC SDL_EventFilter SDLCALL SDL_GetEventFilter (void);
 /*
 This function allows you to set the state of processing certain events.
 If 'state' is set to SDL_IGNORE, that event will be automatically dropped
 from the event queue and will not event be filtered.
 */
 #define SDL_QUERY	-1
 #define SDL_IGNORE	 0
 #define SDL_DISABLE	 0
 #define SDL_ENABLE	 1
-extern DECLSPEC Uint8 SDLCALL SDL_EventState(Uint8 type, int state);
+extern DECLSPEC Uint8 SDLCALL SDL_EventState (Uint8 type, int state);
 /* Ends C function definitions when using C++ */
 #ifdef __cplusplus
+/* *INDENT-OFF* */
 }
+/* *INDENT-ON* */
 #endif
 #include "close_code.h"
 #endif /* _SDL_events_h */
+/* vi: set ts=4 sw=4 expandtab: */

Mercurial > sdl-ios-xcode

comparison include/SDL_events.h @ 1662:782fd950bd46 SDL-1.3