docs for SDL::Mixer::Groups done, fixed link creation
[sdlgit/SDL-Site.git] / pages / SDL-Events.html-inc
index b51f9fd..3f76c29 100644 (file)
@@ -2,7 +2,10 @@
 <!-- INDEX START -->
 <h3 id="TOP">Index</h3>
 
-<ul><li><a href="#NAME">NAME</a></li>
+<ul><li><a href="#NAME">NAME</a>
+<ul><li><a href="#CATEGORY">CATEGORY</a></li>
+</ul>
+</li>
 <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
 <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
 <li><a href="#METHODS">METHODS</a>
 <ul><li><a href="#RETURN-4">RETURN</a></li>
 </ul>
 </li>
+<li><a href="#set_event_filter">set_event_filter</a></li>
+<li><a href="#get_key_state">get_key_state</a></li>
+<li><a href="#get_mod_state">get_mod_state</a></li>
+<li><a href="#set_mod_state">set_mod_state</a></li>
+<li><a href="#event_state">event_state </a></li>
+<li><a href="#get_key_name">get_key_name</a></li>
+<li><a href="#enable_unicode">enable_unicode </a></li>
+<li><a href="#enable_key_repeat">enable_key_repeat </a></li>
+<li><a href="#get_mouse_state">get_mouse_state </a></li>
+<li><a href="#get_relative_mouse_state">get_relative_mouse_state </a></li>
+<li><a href="#get_app_state">get_app_state </a></li>
+<li><a href="#joystick_event_state">joystick_event_state </a></li>
 </ul>
 </li>
 <li><a href="#SEE_ALSO">SEE ALSO</a>
 <p>SDL::Events - Bindings to the Events Category in SDL API</p>
 
 </div>
+<h2 id="CATEGORY">CATEGORY</h2>
+<div id="CATEGORY_CONTENT">
+<p>Core, Events</p>
+
+</div>
 <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.
 
 </pre>
 <p>pump_events gathers all the pending input information from devices and places it on the event queue. Without calls to pump_events no events would ever be placed on the queue. 
-Often the need for calls to pump_events is hidden from the user since <cite>poll_event</cite> and <cite>wait_event</cite> implicitly call pump_events. 
+Often the need for calls to pump_events is hidden from the user since <a href="http://search.cpan.org/perldoc?poll_event">poll_event</a> and <a href="http://search.cpan.org/perldoc?wait_event">wait_event</a> implicitly call pump_events. 
 However, if you are not polling or waiting for events (e.g. you are filtering them), then you must call pump_events to force an event queue update.</p>
 
 
@@ -118,8 +138,8 @@ However, if you are not polling or waiting for events (e.g. you are filtering th
 <h2 id="poll_event_event">poll_event($event)</h2>
 <div id="poll_event_event_CONTENT">
 <p>Polls for currently pending events. </p>
-<p>If $event is not NULL, the next event is removed from the queue and stored in the <cite>SDL::Event</cite> structure pointed to by $event.</p>
-<p>As this function implicitly calls pump_events, you can only call this function in the thread that set the video mode with <cite>SDL::Video::set_video_mode</cite>. </p>
+<p>If $event is not NULL, the next event is removed from the queue and stored in the <a href="SDL-Event">SDL::Event</a> structure pointed to by $event.</p>
+<p>As this function implicitly calls pump_events, you can only call this function in the thread that set the video mode with <a href="/SDL-Video.html#set_video_mode">SDL::Video::set_video_mode</a>. </p>
 
 </div>
 <h3 id="RETURN-2">RETURN</h3>
@@ -145,7 +165,7 @@ The event is copied into the queue, and the caller may dispose of the memory poi
 <div id="wait_event_event_CONTENT">
 <p>Waits indefinitely for the next available $event, returning 0 if there was an error while waiting for events, 1 otherwise.</p>
 <p>If $event is not NULL, the next event is removed from the queue and stored in $event.</p>
-<p>As this function implicitly calls SDL_PumpEvents, you can only call this function in the thread that  <cite>SDL::Video::set_video_mode</cite>.  </p>
+<p>As this function implicitly calls SDL_PumpEvents, you can only call this function in the thread that  <a href="/SDL-Video.html#set_video_mode">SDL::Video::set_video_mode</a>.  </p>
 
 </div>
 <h3 id="RETURN-4">RETURN</h3>
@@ -153,9 +173,62 @@ The event is copied into the queue, and the caller may dispose of the memory poi
 <p>0 if there was an error while waiting for events, 1 otherwise</p>
 
 </div>
+<h2 id="set_event_filter">set_event_filter</h2>
+<div id="set_event_filter_CONTENT">
+
+</div>
+<h2 id="get_key_state">get_key_state</h2>
+<div id="get_key_state_CONTENT">
+
+</div>
+<h2 id="get_mod_state">get_mod_state</h2>
+<div id="get_mod_state_CONTENT">
+
+</div>
+<h2 id="set_mod_state">set_mod_state</h2>
+<div id="set_mod_state_CONTENT">
+
+</div>
+<h2 id="event_state">event_state </h2>
+<div id="event_state_CONTENT">
+
+</div>
+<h2 id="get_key_name">get_key_name</h2>
+<div id="get_key_name_CONTENT">
+
+</div>
+<h2 id="enable_unicode">enable_unicode </h2>
+<div id="enable_unicode_CONTENT">
+
+</div>
+<h2 id="enable_key_repeat">enable_key_repeat </h2>
+<div id="enable_key_repeat_CONTENT">
+
+</div>
+<h2 id="get_mouse_state">get_mouse_state </h2>
+<div id="get_mouse_state_CONTENT">
+
+</div>
+<h2 id="get_relative_mouse_state">get_relative_mouse_state </h2>
+<div id="get_relative_mouse_state_CONTENT">
+
+</div>
+<h2 id="get_app_state">get_app_state </h2>
+<div id="get_app_state_CONTENT">
+
+</div>
+<h2 id="joystick_event_state">joystick_event_state </h2>
+<div id="joystick_event_state_CONTENT">
+
+
+
+
+
+</div>
 <h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
 <div id="SEE_ALSO_CONTENT">
-<p><cite>SDL::Event</cite>, <cite>SDL::Video</cite></p>
+<p><a href="SDL-Event">SDL::Event</a>, <a href="SDL-Video">SDL::Video</a>
+</p>
 
 </div>
 </div>
\ No newline at end of file