<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXCursor
— FXRuby API Documentation
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Fox::FXCursor";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (F)</a> »
<span class='title'><span class='object_link'><a href="../Fox.html" title="Fox (module)">Fox</a></span></span>
»
<span class="title">FXCursor</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Fox::FXCursor
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="FXId.html" title="Fox::FXId (class)">FXId</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="FXObject.html" title="Fox::FXObject (class)">FXObject</a></span></li>
<li class="next"><span class='object_link'><a href="FXId.html" title="Fox::FXId (class)">FXId</a></span></li>
<li class="next">Fox::FXCursor</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>rdoc-sources/FXCursor.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Cursor class</p>
<h3 id="label-Stock+cursors">Stock cursors</h3>
<dl class="rdoc-list note-list"><dt><code>CURSOR_ARROW</code>
<dd>
<p>Default left pointing arrow</p>
</dd><dt><code>CURSOR_RARROW</code>
<dd>
<p>Right arrow</p>
</dd><dt><code>CURSOR_IBEAM</code>
<dd>
<p>Text I-Beam</p>
</dd><dt><code>CURSOR_WATCH</code>
<dd>
<p>Stopwatch or hourglass</p>
</dd><dt><code>CURSOR_CROSS</code>
<dd>
<p>Crosshair</p>
</dd><dt><code>CURSOR_UPDOWN</code>
<dd>
<p>Move up, down</p>
</dd><dt><code>CURSOR_LEFTRIGHT</code>
<dd>
<p>Move left, right</p>
</dd><dt><code>CURSOR_MOVE</code>
<dd>
<p>Move up, down, left, right</p>
</dd></dl>
<h3 id="label-Cursor+options">Cursor options</h3>
<dl class="rdoc-list note-list"><dt><code>CURSOR_KEEP</code>
<dd>
<p>Keep pixel data in client</p>
</dd><dt><code>CURSOR_OWNED</code>
<dd>
<p>Pixel data is owned by cursor</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="FXCURCursor.html" title="Fox::FXCURCursor (class)">FXCURCursor</a></span>, <span class='object_link'><a href="FXGIFCursor.html" title="Fox::FXGIFCursor (class)">FXGIFCursor</a></span></p>
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#height-instance_method" title="#height (instance method)">#<strong>height</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Height of cursor, in pixels (returns zero for stock cursors) [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#hotX-instance_method" title="#hotX (instance method)">#<strong>hotX</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Hotspot x-coordinate (returns zero for stock cursors) [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#hotY-instance_method" title="#hotY (instance method)">#<strong>hotY</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Hotspot y-coordinate (returns zero for stock cursors) [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#width-instance_method" title="#width (instance method)">#<strong>width</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Width of cursor, in pixels (returns zero for stock cursors) [Integer].</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="FXId.html" title="Fox::FXId (class)">FXId</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXId.html#app-instance_method" title="Fox::FXId#app (method)">#app</a></span>, <span class='object_link'><a href="FXId.html#userData-instance_method" title="Fox::FXId#userData (method)">#userData</a></span>, <span class='object_link'><a href="FXId.html#xid-instance_method" title="Fox::FXId#xid (method)">#xid</a></span></p>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#color%3F-instance_method" title="#color? (instance method)">#<strong>color?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if there is color in the cursor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(a, pixels, width = 32, height = 32, hotX = -1,, hotY = -1)) ⇒ FXCursor </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Make cursor from FXColor pixels; cursor size should be 32x32 for portability!.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#loadPixels-instance_method" title="#loadPixels (instance method)">#<strong>loadPixels</strong>(stream) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Load pixel data only.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#savePixels-instance_method" title="#savePixels (instance method)">#<strong>savePixels</strong>(stream) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Save pixel data only.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="FXId.html" title="Fox::FXId (class)">FXId</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXId.html#create-instance_method" title="Fox::FXId#create (method)">#create</a></span>, <span class='object_link'><a href="FXId.html#created%3F-instance_method" title="Fox::FXId#created? (method)">#created?</a></span>, <span class='object_link'><a href="FXId.html#destroy-instance_method" title="Fox::FXId#destroy (method)">#destroy</a></span>, <span class='object_link'><a href="FXId.html#detach-instance_method" title="Fox::FXId#detach (method)">#detach</a></span>, <span class='object_link'><a href="FXId.html#runOnUiThread-instance_method" title="Fox::FXId#runOnUiThread (method)">#runOnUiThread</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="FXObject.html" title="Fox::FXObject (class)">FXObject</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXObject.html#bind-instance_method" title="Fox::FXObject#bind (method)">#bind</a></span>, <span class='object_link'><a href="FXObject.html#handle-instance_method" title="Fox::FXObject#handle (method)">#handle</a></span>, <span class='object_link'><a href="FXObject.html#load-instance_method" title="Fox::FXObject#load (method)">#load</a></span>, <span class='object_link'><a href="FXObject.html#save-instance_method" title="Fox::FXObject#save (method)">#save</a></span>, <span class='object_link'><a href="FXObject.html#subclasses-class_method" title="Fox::FXObject.subclasses (method)">subclasses</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(a, pixels, width = 32, height = 32, hotX = -1,, hotY = -1)) ⇒ <tt><span class='object_link'><a href="" title="Fox::FXCursor (class)">FXCursor</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Make cursor from FXColor pixels; cursor size should be 32x32 for portability!</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXCursor.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_a'>a</span><span class='comma'>,</span> <span class='id identifier rubyid_curid'>curid</span><span class='op'>=</span><span class='const'>CURSOR_ARROW</span><span class='rparen'>)</span> <span class='comment'># :yields: theCursor
</span><span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="height-instance_method">
#<strong>height</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Height of cursor, in pixels (returns zero for stock cursors) [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXCursor.rb', line 27</span>
<span class='kw'>def</span> <span class='id identifier rubyid_height'>height</span>
<span class='ivar'>@height</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="hotX=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="hotX-instance_method">
#<strong>hotX</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Hotspot x-coordinate (returns zero for stock cursors) [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
30
31
32</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXCursor.rb', line 30</span>
<span class='kw'>def</span> <span class='id identifier rubyid_hotX'>hotX</span>
<span class='ivar'>@hotX</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="hotY=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="hotY-instance_method">
#<strong>hotY</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Hotspot y-coordinate (returns zero for stock cursors) [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
33
34
35</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXCursor.rb', line 33</span>
<span class='kw'>def</span> <span class='id identifier rubyid_hotY'>hotY</span>
<span class='ivar'>@hotY</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="width-instance_method">
#<strong>width</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Width of cursor, in pixels (returns zero for stock cursors) [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
24
25
26</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXCursor.rb', line 24</span>
<span class='kw'>def</span> <span class='id identifier rubyid_width'>width</span>
<span class='ivar'>@width</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="color?-instance_method">
#<strong>color?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if there is color in the cursor.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
65</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXCursor.rb', line 65</span>
<span class='kw'>def</span> <span class='id identifier rubyid_color?'>color?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="loadPixels-instance_method">
#<strong>loadPixels</strong>(stream) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Load pixel data only.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
62</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXCursor.rb', line 62</span>
<span class='kw'>def</span> <span class='id identifier rubyid_loadPixels'>loadPixels</span><span class='lparen'>(</span><span class='id identifier rubyid_stream'>stream</span><span class='rparen'>)</span> <span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="savePixels-instance_method">
#<strong>savePixels</strong>(stream) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Save pixel data only.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
57</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXCursor.rb', line 57</span>
<span class='kw'>def</span> <span class='id identifier rubyid_savePixels'>savePixels</span><span class='lparen'>(</span><span class='id identifier rubyid_stream'>stream</span><span class='rparen'>)</span> <span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jan 2 11:47:29 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.2).
</div>
</div>
</body>
</html>