<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXDict
— 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::FXDict";
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">FXDict</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::FXDict
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="FXObject.html" title="Fox::FXObject (class)">FXObject</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">Fox::FXDict</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>rdoc-sources/FXDict.rb<span class="defines">,<br />
lib/fox16/dict.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>The dictionary class maintains a fast-access hash table of entities indexed by a character string. It is typically used to map strings to pointers; however, derived classes may allow any type of data to be indexed by strings.</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="FXFileDict.html" title="Fox::FXFileDict (class)">FXFileDict</a></span>, <span class='object_link'><a href="FXIconDict.html" title="Fox::FXIconDict (class)">FXIconDict</a></span>, <span class='object_link'><a href="FXSettings.html" title="Fox::FXSettings (class)">FXSettings</a></span>, <span class='object_link'><a href="FXStringDict.html" title="Fox::FXStringDict (class)">FXStringDict</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="#first-instance_method" title="#first (instance method)">#<strong>first</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Position of first filled slot, or >= total [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#last-instance_method" title="#last (instance method)">#<strong>last</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Position of last filled slot, or -1 [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#length-instance_method" title="#length (instance method)">#<strong>length</strong> ⇒ Object </a>
(also: #size)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Total number of entries in the table [Integer].</p>
</div></span>
</li>
</ul>
<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="#clear-instance_method" title="#clear (instance method)">#<strong>clear</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Clear all entries.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#each_key-instance_method" title="#each_key (instance method)">#<strong>each_key</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Iterate over the keys in this dictionary.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#empty%3F-instance_method" title="#empty? (instance method)">#<strong>empty?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns <code>true</code> if this dictionary contains no key-value pairs.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#has_key%3F-instance_method" title="#has_key? (instance method)">#<strong>has_key?</strong>(key) ⇒ Boolean </a>
(also: #include?, #member?)
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns <code>true</code> if the given <em>key</em> is present.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ FXDict </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Construct an empty dictionary.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#key-instance_method" title="#key (instance method)">#<strong>key</strong>(pos) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return key at position <em>pos</em>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#keys-instance_method" title="#keys (instance method)">#<strong>keys</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns a new array populated with the keys from this dictionary.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#marked%3F-instance_method" title="#marked? (instance method)">#<strong>marked?</strong>(pos) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return mark flag of entry at position <em>pos</em>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#next-instance_method" title="#next (instance method)">#<strong>next</strong>(pos) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return position of next filled slot after <em>pos</em> in the hash table, or a value greater than or equal to total if no filled slot was found.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#prev-instance_method" title="#prev (instance method)">#<strong>prev</strong>(pos) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return position of previous filled slot before <em>pos</em> in the hash table, or a -1 if no filled slot was found.</p>
</div></span>
</li>
</ul>
<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> ⇒ <tt><span class='object_link'><a href="" title="Fox::FXDict (class)">FXDict</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Construct an empty dictionary.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
24</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDict.rb', line 24</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> <span class='semicolon'>;</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="first-instance_method">
#<strong>first</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Position of first filled slot, or >= total [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDict.rb', line 14</span>
<span class='kw'>def</span> <span class='id identifier rubyid_first'>first</span>
<span class='ivar'>@first</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="last-instance_method">
#<strong>last</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Position of last filled slot, or -1 [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDict.rb', line 17</span>
<span class='kw'>def</span> <span class='id identifier rubyid_last'>last</span>
<span class='ivar'>@last</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="length-instance_method">
#<strong>length</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='size-instance_method'>size</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Total number of entries in the table [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDict.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_length'>length</span>
<span class='ivar'>@length</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="clear-instance_method">
#<strong>clear</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Clear all entries</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDict.rb', line 52</span>
<span class='kw'>def</span> <span class='id identifier rubyid_clear'>clear</span><span class='lparen'>(</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="each_key-instance_method">
#<strong>each_key</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Iterate over the keys in this dictionary.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
57
58</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDict.rb', line 57</span>
<span class='kw'>def</span> <span class='id identifier rubyid_each_key'>each_key</span> <span class='comment'># :yields: key
</span><span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="empty?-instance_method">
#<strong>empty?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns <code>true</code> if this dictionary contains no key-value pairs.</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">
76</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDict.rb', line 76</span>
<span class='kw'>def</span> <span class='id identifier rubyid_empty?'>empty?</span><span class='lparen'>(</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="has_key?-instance_method">
#<strong>has_key?</strong>(key) ⇒ <tt>Boolean</tt>
<span class="aliases">Also known as:
<span class="names"><span id='include?-instance_method'>include?</span>, <span id='member?-instance_method'>member?</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns <code>true</code> if the given <em>key</em> is present.</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">
68</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDict.rb', line 68</span>
<span class='kw'>def</span> <span class='id identifier rubyid_has_key?'>has_key?</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</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="key-instance_method">
#<strong>key</strong>(pos) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return key at position <em>pos</em>.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
29</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDict.rb', line 29</span>
<span class='kw'>def</span> <span class='id identifier rubyid_key'>key</span><span class='lparen'>(</span><span class='id identifier rubyid_pos'>pos</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="keys-instance_method">
#<strong>keys</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new array populated with the keys from this dictionary.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
63</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDict.rb', line 63</span>
<span class='kw'>def</span> <span class='id identifier rubyid_keys'>keys</span><span class='lparen'>(</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="marked?-instance_method">
#<strong>marked?</strong>(pos) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return mark flag of entry at position <em>pos</em>.</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">
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDict.rb', line 34</span>
<span class='kw'>def</span> <span class='id identifier rubyid_marked?'>marked?</span><span class='lparen'>(</span><span class='id identifier rubyid_pos'>pos</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="next-instance_method">
#<strong>next</strong>(pos) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return position of next filled slot after <em>pos</em> in the hash table, or a value greater than or equal to total if no filled slot was found.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDict.rb', line 41</span>
<span class='kw'>def</span> <span class='kw'>next</span><span class='lparen'>(</span><span class='id identifier rubyid_pos'>pos</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="prev-instance_method">
#<strong>prev</strong>(pos) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return position of previous filled slot before <em>pos</em> in the hash table, or a -1 if no filled slot was found.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
47</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDict.rb', line 47</span>
<span class='kw'>def</span> <span class='id identifier rubyid_prev'>prev</span><span class='lparen'>(</span><span class='id identifier rubyid_pos'>pos</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:23 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>