added constants to SDL::Events docs

[sdlgit/SDL-Site.git] / pages / SDL-Events.html-inc

diff --git a/pages/SDL-Events.html-inc b/pages/SDL-Events.html-inc
index 1bedb74..1a09919 100644 (file)
--- a/pages/SDL-Events.html-inc
+++ b/pages/SDL-Events.html-inc
@@ -7,7 +7,7 @@
 </ul>
 </li>
 <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
-<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
+<li><a href="#CONSTANTS">CONSTANTS</a></li>
 <li><a href="#METHODS">METHODS</a>
 <ul><li><a href="#pump_events">pump_events</a></li>
 <li><a href="#peep_events_event_num_events_action_">peep_events (event, num_events, action, mask) </a>
@@ -67,9 +67,9 @@
 <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
 <div id="SYNOPSIS_CONTENT">
 <p>Most likely you just want to know how to get events for you app.</p>
-<pre>  use SDL;
+<pre>  use SDL ':init';
   use SDL::Event;
-  use SDL::Events;
+  use SDL::Events ':all';
 
   SDL::init(SDL_INIT_VIDEO); # Event can only be grabbed in the same thread as this 
 
@@ -91,12 +91,171 @@
 </pre>
 
 </div>
-<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="DESCRIPTION_CONTENT">
+<h1 id="CONSTANTS">CONSTANTS</h1><p><a href="#TOP" class="toplink">Top</a></p>
+<div id="CONSTANTS_CONTENT">
+<p>The constants are not exported by default. You can export them into your namespace by doing:</p>
+<pre> use SDL::Events ':all';
 
+</pre>
+<p>or access them directly:</p>
+<pre> SDL::Events::SDL_ACTIVEEVENT;
+
+</pre>
+<p>or by choosing the export tags below:</p>
+<p>Export tag: ':type'</p>
+<pre> SDL_ACTIVEEVENT
+ SDL_KEYDOWN
+ SDL_KEYUP
+ SDL_MOUSEMOTION
+ SDL_MOUSEBUTTONDOWN
+ SDL_MOUSEBUTTONUP
+ SDL_JOYAXISMOTION
+ SDL_JOYBALLMOTION
+ SDL_JOYHATMOTION
+ SDL_JOYBUTTONDOWN
+ SDL_JOYBUTTONUP
+ SDL_QUIT
+ SDL_SYSWMEVENT
+ SDL_VIDEORESIZE
+ SDL_VIDEOEXPOSE
+ SDL_USEREVENT
+ SDL_NUMEVENTS
+
+</pre>
+<p>Export tag: ':mask'</p>
+<pre> SDL_EVENTMASK
+ SDL_ACTIVEEVENTMASK
+ SDL_KEYDOWNMASK
+ SDL_KEYUPMASK
+ SDL_KEYEVENTMASK
+ SDL_MOUSEMOTIONMASK
+ SDL_MOUSEBUTTONDOWNMASK
+ SDL_MOUSEBUTTONUPMASK
+ SDL_MOUSEEVENTMASK
+ SDL_JOYAXISMOTIONMASK
+ SDL_JOYBALLMOTIONMASK
+ SDL_JOYHATMOTIONMASK
+ SDL_JOYBUTTONDOWNMASK
+ SDL_JOYBUTTONUPMASK
+ SDL_JOYEVENTMASK
+ SDL_VIDEORESIZEMASK
+ SDL_VIDEOEXPOSEMASK
+ SDL_QUITMASK
+ SDL_SYSWMEVENTMASK
+ SDL_ALLEVENTS
+
+</pre>
+<p>Export tag: ':action'</p>
+<pre> SDL_ADDEVENT
+ SDL_PEEKEVENT
+ SDL_GETEVENT
+
+</pre>
+<p>Export tag: ':state'</p>
+<pre> SDL_QUERY
+ SDL_IGNORE
+ SDL_DISABLE / SDL_ENABLE
+ SDL_RELEASED / SDL_PRESSED
 
+</pre>
+<p>Export tag: ':hat'</p>
+<pre> SDL_HAT_CENTERED
+ SDL_HAT_UP / SDL_HAT_RIGHT / SDL_HAT_DOWN / SDL_HAT_LEFT
+ SDL_HAT_RIGHTUP / SDL_HAT_RIGHTDOWN / SDL_HAT_LEFTUP / SDL_HAT_LEFTDOWN
 
+</pre>
+<p>Export tag: ':app'</p>
+<pre> SDL_APPMOUSEFOCUS
+ SDL_APPINPUTFOCUS
+ SDL_APPACTIVE
 
+</pre>
+<p>Export tag: ':button'</p>
+<pre> SDL_BUTTON
+ SDL_BUTTON_LEFT / SDL_BUTTON_MIDDLE / SDL_BUTTON_RIGHT
+ SDL_BUTTON_WHEELUP / SDL_BUTTON_WHEELDOWN
+ SDL_BUTTON_X1 / SDL_BUTTON_X2
+ SDL_BUTTON_LMASK / SDL_BUTTON_MMASK / SDL_BUTTON_RMASK
+ SDL_BUTTON_X1MASK / SDL_BUTTON_X2MASK
+
+</pre>
+<p>Export tag: ':keysym'</p>
+<pre> SDLK_UNKNOWN
+ SDLK_FIRST
+ SDLK_BACKSPACE
+ SDLK_TAB
+ SDLK_CLEAR
+ SDLK_RETURN
+ SDLK_PAUSE
+ SDLK_ESCAPE
+ SDLK_SPACE
+ SDLK_EXCLAIM
+ SDLK_QUOTEDBL
+ SDLK_HASH
+ SDLK_DOLLAR
+ SDLK_AMPERSAND
+ SDLK_QUOTE
+ SDLK_LEFTPAREN / SDLK_RIGHTPAREN
+ SDLK_ASTERISK
+ SDLK_PLUS / SDLK_MINUS
+ SDLK_COMMA
+ SDLK_PERIOD
+ SDLK_0 .. SDLK_9
+ SDLK_COLON
+ SDLK_SEMICOLON
+ SDLK_LESS / SDLK_GREATER
+ SDLK_EQUALS
+ SDLK_QUESTION
+ SDLK_AT
+ SDLK_LEFTBRACKET / SDLK_RIGHTBRACKET
+ SDLK_SLASH / SDLK_BACKSLASH
+ SDLK_CARET
+ SDLK_UNDERSCORE
+ SDLK_BACKQUOTE
+ SDLK_a .. SDLK_z
+ SDLK_DELETE
+ SDLK_WORLD_0 .. SDLK_WORLD_95
+ SDLK_KP0 .. SDLK_KP9
+ SDLK_KP_PERIOD
+ SDLK_KP_DIVIDE / SDLK_KP_MULTIPLY
+ SDLK_KP_MINUS / SDLK_KP_PLUS
+ SDLK_KP_ENTER
+ SDLK_KP_EQUALS
+ SDLK_UP / SDLK_DOWN / SDLK_RIGHT / SDLK_LEFT
+ SDLK_INSERT
+ SDLK_HOME / SDLK_END
+ SDLK_PAGEUP / SDLK_PAGEDOWN
+ SDLK_F1 .. SDLK_F15
+ SDLK_NUMLOCK / SDLK_CAPSLOCK / SDLK_SCROLLOCK
+ SDLK_RSHIFT / SDLK_LSHIFT
+ SDLK_RCTRL  / SDLK_LCTRL
+ SDLK_RALT   / SDLK_LALT
+ SDLK_RMETA  / SDLK_LMETA
+ SDLK_LSUPER / SDLK_RSUPER
+ SDLK_MODE
+ SDLK_COMPOSE
+ SDLK_HELP
+ SDLK_PRINT
+ SDLK_SYSREQ
+ SDLK_BREAK
+ SDLK_MENU
+ SDLK_POWER
+ SDLK_EURO
+ SDLK_UNDO
+
+</pre>
+<p>Export tag ':keymod'</p>
+<pre> KMOD_NONE
+ KMOD_LSHIFT / KMOD_RSHIFT / KMOD_SHIFT
+ KMOD_LCTRL  / KMOD_RCTRL  / KMOD_CTRL
+ KMOD_LALT   / KMOD_RALT   / KMOD_ALT
+ KMOD_LMETA  / KMOD_RMETA  / KMOD_META
+ KMOD_NUM
+ KMOD_CAPS
+ KMOD_MODE
+ KMOD_RESERVED
+
+</pre>
 
 </div>
 <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>