lauchmelder/SFML
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

I forgot to actually include the documentation to the commit.

Browse source 
git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1659 4e206d99-4929-0410-ac5d-dfc041789085
This commit is contained in:
groogy 2010-11-16 16:41:16 +00:00
parent 85a4e5155e
commit 01b0f37451
144 changed files with 12034 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

226
bindings/ruby/sfml-window/doc/classes/SFML/Event/MouseWheel.html Normal file
View file

@ -0,0 +1,226 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Class: SFML::Event::MouseWheel</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">SFML::Event::MouseWheel</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../../files/window/Event_cpp.html">
window/Event.cpp
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
Object
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
<a href="../Event.html">SFML::Event</a> holds all the informations about a
system event that just happened.
</p>
<p>
Events are retrieved using the SFML::Window#GetEvent function.
</p>
<p>
A <a href="../Event.html">SFML::Event</a> instance contains the type of the
event (mouse moved, key pressed, window closed, &#8230;) as well as the
details about this particular event. Please note that the event parameters
are defined in a union, which means that only the member matching the type
of the event will be properly filled; all other members will have undefined
values and must not be read if the type of the event doesn&#8216;t match.
For example, if you received a KeyPressed event, then you must read the
event.Key
</p>
<pre>
member, all other members such as event.MouseMove or event.Text will have undefined values.
</pre>
<p>
The ruby version differs from C++ in that the parameters are still stored
in a union but that the values can be directly accessed from the event
object. If you try to access any data which would be considered undefined
then SFML::SomeKindOfException will be thrown.
</p>
<p>
Usage example:
</p>
<pre>
while event = window.getEvent()
# Request for closing the window
if event.type == SFML::Event::Closed
window.close
# The escape key was pressed
if ( event.type == sf::Event::KeyPressed ) &amp;&amp; ( event.code == SFML::Key::Escape )
window.close
# The window was resized
if event.type == SFML::Event::Resized
DoSomethingWithTheNewSize(event.size);
# etc ...
end
</pre>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000098">delta</a>&nbsp;&nbsp;
<a href="#M000099">x</a>&nbsp;&nbsp;
<a href="#M000100">y</a>&nbsp;&nbsp;
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000098" class="method-detail">
<a name="M000098"></a>
<div class="method-heading">
<a href="MouseWheel.src/M000098.html" target="Code" class="method-signature"
onclick="popupCode('MouseWheel.src/M000098.html');return false;">
<span class="method-name">delta</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Number of ticks the wheel has moved (positive is up, negative is down).
</p>
</div>
</div>
<div id="method-M000099" class="method-detail">
<a name="M000099"></a>
<div class="method-heading">
<a href="MouseWheel.src/M000099.html" target="Code" class="method-signature"
onclick="popupCode('MouseWheel.src/M000099.html');return false;">
<span class="method-name">x</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
X position of the mouse pointer, relative to the left of the owner window
</p>
</div>
</div>
<div id="method-M000100" class="method-detail">
<a name="M000100"></a>
<div class="method-heading">
<a href="MouseWheel.src/M000100.html" target="Code" class="method-signature"
onclick="popupCode('MouseWheel.src/M000100.html');return false;">
<span class="method-name">y</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Y position of the mouse pointer, relative to the top of the owner window
</p>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>