<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXStringDict
— 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::FXStringDict";
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">FXStringDict</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::FXStringDict
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="FXDict.html" title="Fox::FXDict (class)">FXDict</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="FXDict.html" title="Fox::FXDict (class)">FXDict</a></span></li>
<li class="next">Fox::FXStringDict</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>rdoc-sources/FXStringDict.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>An FXStringDict (string dictionary) object maps one string to another string. The inserted strings are copied when they’re inserted.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="FXDict.html" title="Fox::FXDict (class)">FXDict</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXDict.html#first-instance_method" title="Fox::FXDict#first (method)">#first</a></span>, <span class='object_link'><a href="FXDict.html#last-instance_method" title="Fox::FXDict#last (method)">#last</a></span>, <span class='object_link'><a href="FXDict.html#length-instance_method" title="Fox::FXDict#length (method)">#length</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="#data-instance_method" title="#data (instance method)">#<strong>data</strong>(pos) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return the string at integer position <em>pos</em>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#find-instance_method" title="#find (instance method)">#<strong>find</strong>(key) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return the entry indexed by <em>key</em>, or nil if the key does not exist.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ FXStringDict </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Return an initialized FXStringDict instance.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#insert-instance_method" title="#insert (instance method)">#<strong>insert</strong>(key, value, mrk = false) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Insert a new string indexed by key, with given mark flag.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#remove-instance_method" title="#remove (instance method)">#<strong>remove</strong>(key) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Remove entry indexed by key.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#replace-instance_method" title="#replace (instance method)">#<strong>replace</strong>(key, value, mrk = false) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Replace or insert a new string indexed by key, unless given mark is lower than the existing mark.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="FXDict.html" title="Fox::FXDict (class)">FXDict</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXDict.html#clear-instance_method" title="Fox::FXDict#clear (method)">#clear</a></span>, <span class='object_link'><a href="FXDict.html#each_key-instance_method" title="Fox::FXDict#each_key (method)">#each_key</a></span>, <span class='object_link'><a href="FXDict.html#empty%3F-instance_method" title="Fox::FXDict#empty? (method)">#empty?</a></span>, <span class='object_link'><a href="FXDict.html#has_key%3F-instance_method" title="Fox::FXDict#has_key? (method)">#has_key?</a></span>, <span class='object_link'><a href="FXDict.html#key-instance_method" title="Fox::FXDict#key (method)">#key</a></span>, <span class='object_link'><a href="FXDict.html#keys-instance_method" title="Fox::FXDict#keys (method)">#keys</a></span>, <span class='object_link'><a href="FXDict.html#marked%3F-instance_method" title="Fox::FXDict#marked? (method)">#marked?</a></span>, <span class='object_link'><a href="FXDict.html#next-instance_method" title="Fox::FXDict#next (method)">#next</a></span>, <span class='object_link'><a href="FXDict.html#prev-instance_method" title="Fox::FXDict#prev (method)">#prev</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> ⇒ <tt><span class='object_link'><a href="" title="Fox::FXStringDict (class)">FXStringDict</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return an initialized FXStringDict instance.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
10</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStringDict.rb', line 10</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_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="data-instance_method">
#<strong>data</strong>(pos) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return the string at integer position <em>pos</em>.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
35</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStringDict.rb', line 35</span>
<span class='kw'>def</span> <span class='id identifier rubyid_data'>data</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="find-instance_method">
#<strong>find</strong>(key) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return the entry indexed by <em>key</em>, or nil if the key does not exist.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStringDict.rb', line 30</span>
<span class='kw'>def</span> <span class='id identifier rubyid_find'>find</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="insert-instance_method">
#<strong>insert</strong>(key, value, mrk = false) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Insert a new string indexed by key, with given mark flag.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStringDict.rb', line 15</span>
<span class='kw'>def</span> <span class='id identifier rubyid_insert'>insert</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_mrk'>mrk</span><span class='op'>=</span><span class='kw'>false</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="remove-instance_method">
#<strong>remove</strong>(key) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Remove entry indexed by key.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStringDict.rb', line 25</span>
<span class='kw'>def</span> <span class='id identifier rubyid_remove'>remove</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="replace-instance_method">
#<strong>replace</strong>(key, value, mrk = false) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Replace or insert a new string indexed by key, unless given mark is lower than the existing mark.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
20</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStringDict.rb', line 20</span>
<span class='kw'>def</span> <span class='id identifier rubyid_replace'>replace</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_mrk'>mrk</span><span class='op'>=</span><span class='kw'>false</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:48:06 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>