RubyGems - gglib - Versions diffs - 1.2.1 → 1.3.0 - Mend

gglib 1.2.1 → 1.3.0

Files changed (624) hide show

data/doc/classes/GGLib/Cursor.html ADDED

@@ -0,0 +1,485 @@
+<?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: GGLib::Cursor</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">GGLib::Cursor</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/mouse_rb.html">
+                mouse.rb
+                </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>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000146">draw</a>&nbsp;&nbsp;
+      <a href="#M000131">forceVisible</a>&nbsp;&nbsp;
+      <a href="#M000145">moveTo</a>&nbsp;&nbsp;
+      <a href="#M000129">new</a>&nbsp;&nbsp;
+      <a href="#M000135">restrictX</a>&nbsp;&nbsp;
+      <a href="#M000139">restrictX?</a>&nbsp;&nbsp;
+      <a href="#M000136">restrictY</a>&nbsp;&nbsp;
+      <a href="#M000140">restrictY?</a>&nbsp;&nbsp;
+      <a href="#M000130">toggleVisible</a>&nbsp;&nbsp;
+      <a href="#M000132">unforceVisible</a>&nbsp;&nbsp;
+      <a href="#M000137">unrestrictX</a>&nbsp;&nbsp;
+      <a href="#M000138">unrestrictY</a>&nbsp;&nbsp;
+      <a href="#M000134">visible=</a>&nbsp;&nbsp;
+      <a href="#M000133">visible?</a>&nbsp;&nbsp;
+      <a href="#M000141">x</a>&nbsp;&nbsp;
+      <a href="#M000143">x=</a>&nbsp;&nbsp;
+      <a href="#M000142">y</a>&nbsp;&nbsp;
+      <a href="#M000144">y=</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">img</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">imgObj</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">visible</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        </table>
+      </div>
+    </div>
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000129" class="method-detail">
+        <a name="M000129"></a>
+        <div class="method-heading">
+          <a href="Cursor.src/M000129.html" target="Code" class="method-signature"
+            onclick="popupCode('Cursor.src/M000129.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(img,visible=true)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000146" class="method-detail">
+        <a name="M000146"></a>
+        <div class="method-heading">
+          <a href="Cursor.src/M000146.html" target="Code" class="method-signature"
+            onclick="popupCode('Cursor.src/M000146.html');return false;">
+          <span class="method-name">draw</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000131" class="method-detail">
+        <a name="M000131"></a>
+        <div class="method-heading">
+          <a href="Cursor.src/M000131.html" target="Code" class="method-signature"
+            onclick="popupCode('Cursor.src/M000131.html');return false;">
+          <span class="method-name">forceVisible</span><span class="method-args">(visible=true)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Forces the cursor to adhere to the visibility specified by parameter
+visible. Subsequent calls to <a
+href="Cursor.html#M000130">toggleVisible</a> and <a
+href="Cursor.html#M000134">visible=</a> will have no effect. See also <a
+href="Cursor.html#M000132">unforceVisible</a>.
+</p>
+        </div>
+      </div>
+      <div id="method-M000145" class="method-detail">
+        <a name="M000145"></a>
+        <div class="method-heading">
+          <a href="Cursor.src/M000145.html" target="Code" class="method-signature"
+            onclick="popupCode('Cursor.src/M000145.html');return false;">
+          <span class="method-name">moveTo</span><span class="method-args">(xp, yp)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Sets the position of the cursor.
+</p>
+        </div>
+      </div>
+      <div id="method-M000135" class="method-detail">
+        <a name="M000135"></a>
+        <div class="method-heading">
+          <a href="Cursor.src/M000135.html" target="Code" class="method-signature"
+            onclick="popupCode('Cursor.src/M000135.html');return false;">
+          <span class="method-name">restrictX</span><span class="method-args">(restrict=true)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Restricts mouse movement along the <a href="Cursor.html#M000141">x</a>
+axis.
+</p>
+        </div>
+      </div>
+      <div id="method-M000139" class="method-detail">
+        <a name="M000139"></a>
+        <div class="method-heading">
+          <a href="Cursor.src/M000139.html" target="Code" class="method-signature"
+            onclick="popupCode('Cursor.src/M000139.html');return false;">
+          <span class="method-name">restrictX?</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns true if movement along the <a href="Cursor.html#M000141">x</a> axis
+is currently restricted, false otherwise.
+</p>
+        </div>
+      </div>
+      <div id="method-M000136" class="method-detail">
+        <a name="M000136"></a>
+        <div class="method-heading">
+          <a href="Cursor.src/M000136.html" target="Code" class="method-signature"
+            onclick="popupCode('Cursor.src/M000136.html');return false;">
+          <span class="method-name">restrictY</span><span class="method-args">(restrict=true)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Restricts mouse movement along the <a href="Cursor.html#M000142">y</a>
+axis.
+</p>
+        </div>
+      </div>
+      <div id="method-M000140" class="method-detail">
+        <a name="M000140"></a>
+        <div class="method-heading">
+          <a href="Cursor.src/M000140.html" target="Code" class="method-signature"
+            onclick="popupCode('Cursor.src/M000140.html');return false;">
+          <span class="method-name">restrictY?</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns true if movement along the <a href="Cursor.html#M000142">y</a> axis
+is currently restricted, false otherwise.
+</p>
+        </div>
+      </div>
+      <div id="method-M000130" class="method-detail">
+        <a name="M000130"></a>
+        <div class="method-heading">
+          <a href="Cursor.src/M000130.html" target="Code" class="method-signature"
+            onclick="popupCode('Cursor.src/M000130.html');return false;">
+          <span class="method-name">toggleVisible</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+If the cursor is currently invisible, makes it visible. If the cursor is
+currently visible, makes it invisible. Subject to the constraints of <a
+href="Cursor.html#M000131">forceVisible</a>.
+</p>
+        </div>
+      </div>
+      <div id="method-M000132" class="method-detail">
+        <a name="M000132"></a>
+        <div class="method-heading">
+          <a href="Cursor.src/M000132.html" target="Code" class="method-signature"
+            onclick="popupCode('Cursor.src/M000132.html');return false;">
+          <span class="method-name">unforceVisible</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Allows the cursor to be made invisible via <a
+href="Cursor.html#M000130">toggleVisible</a> or <a
+href="Cursor.html#M000134">visible=</a>.
+</p>
+        </div>
+      </div>
+      <div id="method-M000137" class="method-detail">
+        <a name="M000137"></a>
+        <div class="method-heading">
+          <a href="Cursor.src/M000137.html" target="Code" class="method-signature"
+            onclick="popupCode('Cursor.src/M000137.html');return false;">
+          <span class="method-name">unrestrictX</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Stops restriction of mouse movement along the <a
+href="Cursor.html#M000141">x</a> axis.
+</p>
+        </div>
+      </div>
+      <div id="method-M000138" class="method-detail">
+        <a name="M000138"></a>
+        <div class="method-heading">
+          <a href="Cursor.src/M000138.html" target="Code" class="method-signature"
+            onclick="popupCode('Cursor.src/M000138.html');return false;">
+          <span class="method-name">unrestrictY</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Stops restriction of mouse movement along the <a
+href="Cursor.html#M000142">y</a> axis.
+</p>
+        </div>
+      </div>
+      <div id="method-M000134" class="method-detail">
+        <a name="M000134"></a>
+        <div class="method-heading">
+          <a href="Cursor.src/M000134.html" target="Code" class="method-signature"
+            onclick="popupCode('Cursor.src/M000134.html');return false;">
+          <span class="method-name">visible=</span><span class="method-args">(visible)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Reverses the effects of <a href="Cursor.html#M000131">forceVisible</a>.
+Calls to <a href="Cursor.html#M000130">toggleVisible</a> and <a
+href="Cursor.html#M000134">visible=</a> will again have an effect.
+</p>
+        </div>
+      </div>
+      <div id="method-M000133" class="method-detail">
+        <a name="M000133"></a>
+        <div class="method-heading">
+          <a href="Cursor.src/M000133.html" target="Code" class="method-signature"
+            onclick="popupCode('Cursor.src/M000133.html');return false;">
+          <span class="method-name">visible?</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns true if the cursor is currently visible, false otherwise.
+</p>
+        </div>
+      </div>
+      <div id="method-M000141" class="method-detail">
+        <a name="M000141"></a>
+        <div class="method-heading">
+          <a href="Cursor.src/M000141.html" target="Code" class="method-signature"
+            onclick="popupCode('Cursor.src/M000141.html');return false;">
+          <span class="method-name">x</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns the current <a href="Cursor.html#M000141">x</a> coordinate of the
+cursor.
+</p>
+        </div>
+      </div>
+      <div id="method-M000143" class="method-detail">
+        <a name="M000143"></a>
+        <div class="method-heading">
+          <a href="Cursor.src/M000143.html" target="Code" class="method-signature"
+            onclick="popupCode('Cursor.src/M000143.html');return false;">
+          <span class="method-name">x=</span><span class="method-args">(val)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Sets the current <a href="Cursor.html#M000141">x</a> coordinate of the
+cursor.
+</p>
+        </div>
+      </div>
+      <div id="method-M000142" class="method-detail">
+        <a name="M000142"></a>
+        <div class="method-heading">
+          <a href="Cursor.src/M000142.html" target="Code" class="method-signature"
+            onclick="popupCode('Cursor.src/M000142.html');return false;">
+          <span class="method-name">y</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns the current <a href="Cursor.html#M000142">y</a> coordinate of the
+cursor.
+</p>
+        </div>
+      </div>
+      <div id="method-M000144" class="method-detail">
+        <a name="M000144"></a>
+        <div class="method-heading">
+          <a href="Cursor.src/M000144.html" target="Code" class="method-signature"
+            onclick="popupCode('Cursor.src/M000144.html');return false;">
+          <span class="method-name">y=</span><span class="method-args">(val)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Sets the current <a href="Cursor.html#M000142">y</a> coordinate of the
+cursor.
+</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>