<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXIconDict
— 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::FXIconDict";
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">FXIconDict</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::FXIconDict
</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::FXIconDict</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>rdoc-sources/FXIconDict.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>The Icon Dictionary manages a collection of icons. The icons are referenced by their file name. When first encountering a new file name, the icon is located by searching the icon search path for the icon file. If found, the services of the icon source object are used to load the icon from the file. A custom icon source may be installed to furnish support for additonal image file formats. Once the icon is loaded, an association between the icon name and the icon is entered into the icon dictionary. Subsequent searches for an icon with this name will be satisfied from the cached value. The lifetype of the icons is managed by the icon dictionary, and thus all icons will be deleted when the dictionary is deleted.</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>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#defaultIconPath-class_method" title="defaultIconPath (class method)">.<strong>defaultIconPath</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return the default icon search path (as a string).</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="#find-instance_method" title="#find (instance method)">#<strong>find</strong>(name) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Find icon by name and return a reference to it.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#iconPath-instance_method" title="#iconPath (instance method)">#<strong>iconPath</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return current icon search path.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#iconPath=-instance_method" title="#iconPath= (instance method)">#<strong>iconPath=</strong>(path) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Set icon search path.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#iconSource-instance_method" title="#iconSource (instance method)">#<strong>iconSource</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return icon source.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#iconSource=-instance_method" title="#iconSource= (instance method)">#<strong>iconSource=</strong>(src) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Change icon source to <em>src</em> (an FXIconSource instance).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(app, path = FXIconDict.defaultIconPath) ⇒ FXIconDict </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Construct icon dictionary, and set initial search path; also creates a default icon source object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#insert-instance_method" title="#insert (instance method)">#<strong>insert</strong>(filename) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Insert unique icon loaded from <em>filename</em> into dictionary, and return a reference to the icon (an FXIcon instance).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#remove-instance_method" title="#remove (instance method)">#<strong>remove</strong>(name) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Remove icon from dictionary; returns a reference to the icon.</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>(app, path = FXIconDict.defaultIconPath) ⇒ <tt><span class='object_link'><a href="" title="Fox::FXIconDict (class)">FXIconDict</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Construct icon dictionary, and set initial search path; also creates a default icon source object.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXIconDict.rb', line 24</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_app'>app</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='op'>=</span><span class='const'>FXIconDict</span><span class='period'>.</span><span class='id identifier rubyid_defaultIconPath'>defaultIconPath</span><span class='rparen'>)</span><span class='semicolon'>;</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="defaultIconPath-class_method">
.<strong>defaultIconPath</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return the default icon search path (as a string)</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXIconDict.rb', line 18</span>
<span class='kw'>def</span> <span class='const'><span class='object_link'><a href="" title="Fox::FXIconDict (class)">FXIconDict</a></span></span><span class='period'>.</span><span class='id identifier rubyid_defaultIconPath'>defaultIconPath</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="find-instance_method">
#<strong>find</strong>(name) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Find icon by name and return a reference to it.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
46</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXIconDict.rb', line 46</span>
<span class='kw'>def</span> <span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</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="iconPath-instance_method">
#<strong>iconPath</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return current icon search path</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXIconDict.rb', line 37</span>
<span class='kw'>def</span> <span class='id identifier rubyid_iconPath'>iconPath</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="iconPath=-instance_method">
#<strong>iconPath=</strong>(path) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Set icon search path</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXIconDict.rb', line 34</span>
<span class='kw'>def</span> <span class='id identifier rubyid_iconPath='>iconPath=</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</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="iconSource-instance_method">
#<strong>iconSource</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return icon source</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXIconDict.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_iconSource'>iconSource</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="iconSource=-instance_method">
#<strong>iconSource=</strong>(src) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Change icon source to <em>src</em> (an FXIconSource instance).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXIconDict.rb', line 28</span>
<span class='kw'>def</span> <span class='id identifier rubyid_iconSource='>iconSource=</span><span class='lparen'>(</span><span class='id identifier rubyid_src'>src</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>(filename) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Insert unique icon loaded from <em>filename</em> into dictionary, and return a reference to the icon (an FXIcon instance).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
40</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXIconDict.rb', line 40</span>
<span class='kw'>def</span> <span class='id identifier rubyid_insert'>insert</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</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>(name) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Remove icon from dictionary; returns a reference to the icon.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
43</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXIconDict.rb', line 43</span>
<span class='kw'>def</span> <span class='id identifier rubyid_remove'>remove</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</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:43 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>