<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXDataTarget
— 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::FXDataTarget";
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">FXDataTarget</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::FXDataTarget
</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::FXDataTarget</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="../Responder2.html" title="Responder2 (module)">Responder2</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>rdoc-sources/FXDataTarget.rb<span class="defines">,<br />
lib/fox16/core.rb,<br /> lib/fox16/responder2.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A data target allows a valuator widget such as an FXSlider or FXTextField to be directly connected with a variable in the program. Whenever the valuator control changes, the variable connected through the data target is automatically updated; conversely, whenever the program changes a variable, all the connected valuator widgets will be updated to reflect this new value on the display. For example:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'>FXDataTarget</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Fox::FXDataTarget#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Some Text</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_textfield'>textfield</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="FXTextField.html" title="Fox::FXTextField (class)">FXTextField</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="FXTextField.html#initialize-instance_method" title="Fox::FXTextField#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_p'>p</span><span class='comma'>,</span> <span class='int'>12</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='const'>FXDataTarget</span><span class='op'>::</span><span class='const'>ID_VALUE</span><span class='rparen'>)</span>
</code></pre>
<p>Data targets also allow connecting other kinds of widgets (like FXRadioButton and FXMenuCommand) to a variable. In this case, the new value of the connected variable is computed by subtracting <code>FXDataTarget::ID_OPTION</code> from the message identifier. For example, to tie a group of radio buttons to a single data target’s value (so that the buttons are mutually exclusive), use code like this:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'>FXDataTarget</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Fox::FXDataTarget#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='int'>0</span><span class='rparen'>)</span>
<span class='id identifier rubyid_radio1'>radio1</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="FXRadioButton.html" title="Fox::FXRadioButton (class)">FXRadioButton</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="FXRadioButton.html#initialize-instance_method" title="Fox::FXRadioButton#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_p'>p</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1st choice</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='const'>FXDataTarget</span><span class='op'>::</span><span class='const'>ID_OPTION</span><span class='rparen'>)</span>
<span class='id identifier rubyid_radio2'>radio2</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="FXRadioButton.html" title="Fox::FXRadioButton (class)">FXRadioButton</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="FXRadioButton.html#initialize-instance_method" title="Fox::FXRadioButton#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_p'>p</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>2nd choice</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='const'>FXDataTarget</span><span class='op'>::</span><span class='const'>ID_OPTION</span> <span class='op'>+</span> <span class='int'>1</span><span class='rparen'>)</span>
<span class='id identifier rubyid_radio3'>radio3</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="FXRadioButton.html" title="Fox::FXRadioButton (class)">FXRadioButton</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="FXRadioButton.html#initialize-instance_method" title="Fox::FXRadioButton#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_p'>p</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>3rd choice</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='const'>FXDataTarget</span><span class='op'>::</span><span class='const'>ID_OPTION</span> <span class='op'>+</span> <span class='int'>2</span><span class='rparen'>)</span>
</code></pre>
<p>Note that if you’d like the data target to “forward” its <code>SEL_COMMAND</code> or <code>SEL_CHANGED</code> to some other target object after it has updated the data target value, you can do that just as you would for any other widget. For example, continuing the previous code snippet:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_connect'>connect</span><span class='lparen'>(</span><span class='const'>SEL_COMMAND</span><span class='rparen'>)</span> <span class='lbrace'>{</span>
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>The new data target value is </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='rbrace'>}</span>
</code></pre>
<h3 id="label-Events">Events</h3>
<p>The following messages are sent by FXDataTarget to its target:</p>
<dl class="rdoc-list note-list"><dt><code>SEL_COMMAND</code>
<dd>
<p>Sent after the data target processes a <code>SEL_COMMAND</code> message itself</p>
</dd><dt><code>SEL_CHANGED</code>
<dd>
<p>Sent after the data target processes a <code>SEL_CHANGED</code> message itself</p>
</dd></dl>
<h3 id="label-Message+identifiers">Message identifiers</h3>
<dl class="rdoc-list note-list"><dt><code>ID_VALUE</code>
<dd>
<p>Causes the FXDataTarget to ask sender for value</p>
</dd><dt><code>ID_OPTION</code>
<dd>
<p><code>ID_OPTION+</code><em>i</em> will set the value to <em>i</em>, where -10000 <= <em>i</em> <= 10000</p>
</dd></dl>
</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="#selector-instance_method" title="#selector (instance method)">#<strong>selector</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The message identifier for this data target [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#target-instance_method" title="#target (instance method)">#<strong>target</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The message target object for this data target <span class='object_link'><a href="FXObject.html" title="Fox::FXObject (class)">FXObject</a></span>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#value-instance_method" title="#value (instance method)">#<strong>value</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The data target’s current value [Object].</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>(value = nil, target = nil, selector = 0) ⇒ FXDataTarget </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Return a new FXDataTarget instance, initialized with the specified <em>value</em>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the stringified representation of this data target’s value.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../Responder2.html" title="Responder2 (module)">Responder2</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Responder2.html#connect-instance_method" title="Responder2#connect (method)">#connect</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>(value = nil, target = nil, selector = 0) ⇒ <tt><span class='object_link'><a href="" title="Fox::FXDataTarget (class)">FXDataTarget</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return a new FXDataTarget instance, initialized with the specified <em>value</em>. If the optional message target object and message identifier (<em>tgt</em> and <em>sel</em>) are specified, the data target will forward the <code>SEL_COMMAND</code> or <code>SEL_COMMAND</code> to this other target.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
62
63</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDataTarget.rb', line 62</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_target'>target</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_selector'>selector</span><span class='op'>=</span><span class='int'>0</span><span class='rparen'>)</span> <span class='comment'># :yields: theDataTarget
</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="selector=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="selector-instance_method">
#<strong>selector</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The message identifier for this data target [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
51
52
53</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDataTarget.rb', line 51</span>
<span class='kw'>def</span> <span class='id identifier rubyid_selector'>selector</span>
<span class='ivar'>@selector</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="target=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="target-instance_method">
#<strong>target</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The message target object for this data target <span class='object_link'><a href="FXObject.html" title="Fox::FXObject (class)">Fox::FXObject</a></span></p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
48
49
50</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDataTarget.rb', line 48</span>
<span class='kw'>def</span> <span class='id identifier rubyid_target'>target</span>
<span class='ivar'>@target</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="value=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="value-instance_method">
#<strong>value</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The data target’s current value [Object]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
54
55
56</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDataTarget.rb', line 54</span>
<span class='kw'>def</span> <span class='id identifier rubyid_value'>value</span>
<span class='ivar'>@value</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="to_s-instance_method">
#<strong>to_s</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the stringified representation of this data target’s value.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
82
83
84</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/fox16/core.rb', line 82</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
<span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jan 2 11:48:01 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>