<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXRegistry
— 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::FXRegistry";
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">FXRegistry</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::FXRegistry
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="FXSettings.html" title="Fox::FXSettings (class)">FXSettings</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"><span class='object_link'><a href="FXSettings.html" title="Fox::FXSettings (class)">FXSettings</a></span></li>
<li class="next">Fox::FXRegistry</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>rdoc-sources/FXRegistry.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>The registry maintains a database of persistent settings for an application. The settings database is organized in two groups of three layers each. The system-wide settings group contains settings information pertaining to all users on a system. The per-user settings group contains settings affecting that user only. Each settings group contains a desktop layer, which comprises the settings which affect all FOX programs, a vendor layer which holds settings that affect all applications from that vendor (e.g. a application-suite), and an application layer which holds settings only for a single application. The vendor-key and application-key determine which files these layers come from, while the “Desktop” key is used for all FOX applications. Settings in the system-wide group are overwritten by the per-user group, and settings from the “Desktop” layer are overwritten by the vendor-layer; vendor-layer settings are overwritten by the application-layer settings. Only the per-user, per-application settings ever gets written; the layers in the system-group only get written during installation and configuration of the application. The registry is read when FXApp::init() is called, and written back to the system when FXApp::exit() is called.</p>
</div>
</div>
<div class="tags">
</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="#appKey-instance_method" title="#appKey (instance method)">#<strong>appKey</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Application key [String].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#asciiMode=-instance_method" title="#asciiMode= (instance method)">#<strong>asciiMode</strong> ⇒ Object </a>
</span>
<span class="note title writeonly">writeonly</span>
<span class="summary_desc"><div class='inline'>
<p>Use file-based registry instead of Windows Registry [Boolean].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#vendorKey-instance_method" title="#vendorKey (instance method)">#<strong>vendorKey</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Vendor key [String].</p>
</div></span>
</li>
</ul>
<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="#asciiMode%3F-instance_method" title="#asciiMode? (instance method)">#<strong>asciiMode?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if we’re using a file-based registry mechanism instead of the Windows Registry (only relevant on Windows systems).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(appKey = "", vendorKey = "") ⇒ FXRegistry </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Construct registry object; <em>appKey</em> and <em>vendorKey</em> must be string constants.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#read-instance_method" title="#read (instance method)">#<strong>read</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Read registry.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#write-instance_method" title="#write (instance method)">#<strong>write</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Write registry.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="FXSettings.html" title="Fox::FXSettings (class)">FXSettings</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXSettings.html#data-instance_method" title="Fox::FXSettings#data (method)">#data</a></span>, <span class='object_link'><a href="FXSettings.html#deleteEntry-instance_method" title="Fox::FXSettings#deleteEntry (method)">#deleteEntry</a></span>, <span class='object_link'><a href="FXSettings.html#deleteSection-instance_method" title="Fox::FXSettings#deleteSection (method)">#deleteSection</a></span>, <span class='object_link'><a href="FXSettings.html#each_section-instance_method" title="Fox::FXSettings#each_section (method)">#each_section</a></span>, <span class='object_link'><a href="FXSettings.html#existingEntry%3F-instance_method" title="Fox::FXSettings#existingEntry? (method)">#existingEntry?</a></span>, <span class='object_link'><a href="FXSettings.html#existingSection%3F-instance_method" title="Fox::FXSettings#existingSection? (method)">#existingSection?</a></span>, <span class='object_link'><a href="FXSettings.html#find-instance_method" title="Fox::FXSettings#find (method)">#find</a></span>, <span class='object_link'><a href="FXSettings.html#modified=-instance_method" title="Fox::FXSettings#modified= (method)">#modified=</a></span>, <span class='object_link'><a href="FXSettings.html#modified%3F-instance_method" title="Fox::FXSettings#modified? (method)">#modified?</a></span>, <span class='object_link'><a href="FXSettings.html#parseFile-instance_method" title="Fox::FXSettings#parseFile (method)">#parseFile</a></span>, <span class='object_link'><a href="FXSettings.html#readBoolEntry-instance_method" title="Fox::FXSettings#readBoolEntry (method)">#readBoolEntry</a></span>, <span class='object_link'><a href="FXSettings.html#readColorEntry-instance_method" title="Fox::FXSettings#readColorEntry (method)">#readColorEntry</a></span>, <span class='object_link'><a href="FXSettings.html#readIntEntry-instance_method" title="Fox::FXSettings#readIntEntry (method)">#readIntEntry</a></span>, <span class='object_link'><a href="FXSettings.html#readRealEntry-instance_method" title="Fox::FXSettings#readRealEntry (method)">#readRealEntry</a></span>, <span class='object_link'><a href="FXSettings.html#readStringEntry-instance_method" title="Fox::FXSettings#readStringEntry (method)">#readStringEntry</a></span>, <span class='object_link'><a href="FXSettings.html#readUnsignedEntry-instance_method" title="Fox::FXSettings#readUnsignedEntry (method)">#readUnsignedEntry</a></span>, <span class='object_link'><a href="FXSettings.html#unparseFile-instance_method" title="Fox::FXSettings#unparseFile (method)">#unparseFile</a></span>, <span class='object_link'><a href="FXSettings.html#writeBoolEntry-instance_method" title="Fox::FXSettings#writeBoolEntry (method)">#writeBoolEntry</a></span>, <span class='object_link'><a href="FXSettings.html#writeColorEntry-instance_method" title="Fox::FXSettings#writeColorEntry (method)">#writeColorEntry</a></span>, <span class='object_link'><a href="FXSettings.html#writeIntEntry-instance_method" title="Fox::FXSettings#writeIntEntry (method)">#writeIntEntry</a></span>, <span class='object_link'><a href="FXSettings.html#writeRealEntry-instance_method" title="Fox::FXSettings#writeRealEntry (method)">#writeRealEntry</a></span>, <span class='object_link'><a href="FXSettings.html#writeStringEntry-instance_method" title="Fox::FXSettings#writeStringEntry (method)">#writeStringEntry</a></span>, <span class='object_link'><a href="FXSettings.html#writeUnsignedEntry-instance_method" title="Fox::FXSettings#writeUnsignedEntry (method)">#writeUnsignedEntry</a></span></p>
<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>(appKey = "", vendorKey = "") ⇒ <tt><span class='object_link'><a href="" title="Fox::FXRegistry (class)">FXRegistry</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Construct registry object; <em>appKey</em> and <em>vendorKey</em> must be string constants. Regular applications SHOULD set a vendor key!</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
38</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRegistry.rb', line 38</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_appKey'>appKey</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_vendorKey'>vendorKey</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</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="appKey-instance_method">
#<strong>appKey</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Application key [String]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
26
27
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRegistry.rb', line 26</span>
<span class='kw'>def</span> <span class='id identifier rubyid_appKey'>appKey</span>
<span class='ivar'>@appKey</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="asciiMode=-instance_method">
#<strong>asciiMode=</strong>(value) ⇒ <tt>Object</tt> <span class="extras">(writeonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Use file-based registry instead of Windows Registry [Boolean]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRegistry.rb', line 32</span>
<span class='kw'>def</span> <span class='id identifier rubyid_asciiMode='>asciiMode=</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='ivar'>@asciiMode</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="vendorKey-instance_method">
#<strong>vendorKey</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Vendor key [String]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
29
30
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRegistry.rb', line 29</span>
<span class='kw'>def</span> <span class='id identifier rubyid_vendorKey'>vendorKey</span>
<span class='ivar'>@vendorKey</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="asciiMode?-instance_method">
#<strong>asciiMode?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if we’re using a file-based registry mechanism instead of the Windows Registry (only relevant on Windows systems).</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">
54</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRegistry.rb', line 54</span>
<span class='kw'>def</span> <span class='id identifier rubyid_asciiMode?'>asciiMode?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="read-instance_method">
#<strong>read</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Read registry.</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/FXRegistry.rb', line 43</span>
<span class='kw'>def</span> <span class='id identifier rubyid_read'>read</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="write-instance_method">
#<strong>write</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Write registry.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
48</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXRegistry.rb', line 48</span>
<span class='kw'>def</span> <span class='id identifier rubyid_write'>write</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:44 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>