<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXTranslator
— 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::FXTranslator";
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">FXTranslator</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::FXTranslator
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Fox::FXTranslator</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>rdoc-sources/FXTranslator.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A translator translates a message to another language.</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="#app-instance_method" title="#app (instance method)">#<strong>app</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>The application associated with this translator <span class='object_link'><a href="FXApp.html" title="Fox::FXApp (class)">FXApp</a></span>.</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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(a) ⇒ FXTranslator </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Return a new translator for the application <em>a</em> (an FXApp instance).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#textCodec-instance_method" title="#textCodec (instance method)">#<strong>textCodec</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return a reference to the text codec.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#textCodec=-instance_method" title="#textCodec= (instance method)">#<strong>textCodec=</strong>(codec) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Change the text codec used to decode the messages embedded in the source.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#tr-instance_method" title="#tr (instance method)">#<strong>tr</strong>(context, message, hint = nil) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Translate a message.</p>
</div></span>
</li>
</ul>
<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) ⇒ <tt><span class='object_link'><a href="" title="Fox::FXTranslator (class)">FXTranslator</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return a new translator for the application <em>a</em> (an FXApp instance).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTranslator.rb', line 13</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='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="app-instance_method">
#<strong>app</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>The application associated with this translator <span class='object_link'><a href="FXApp.html" title="Fox::FXApp (class)">Fox::FXApp</a></span></p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTranslator.rb', line 8</span>
<span class='kw'>def</span> <span class='id identifier rubyid_app'>app</span>
<span class='ivar'>@app</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="textCodec-instance_method">
#<strong>textCodec</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return a reference to the text codec.</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/FXTranslator.rb', line 29</span>
<span class='kw'>def</span> <span class='id identifier rubyid_textCodec'>textCodec</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="textCodec=-instance_method">
#<strong>textCodec=</strong>(codec) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Change the text codec used to decode the messages embedded in the source.</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/FXTranslator.rb', line 24</span>
<span class='kw'>def</span> <span class='id identifier rubyid_textCodec='>textCodec=</span><span class='lparen'>(</span><span class='id identifier rubyid_codec'>codec</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="tr-instance_method">
#<strong>tr</strong>(context, message, hint = nil) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Translate a message.</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/FXTranslator.rb', line 18</span>
<span class='kw'>def</span> <span class='id identifier rubyid_tr'>tr</span><span class='lparen'>(</span><span class='id identifier rubyid_context'>context</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_hint'>hint</span><span class='op'>=</span><span class='kw'>nil</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>