<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Fox::FTNonModal
— 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::FTNonModal";
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">FTNonModal</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>Module: Fox::FTNonModal
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/fox16/execute_nonmodal.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Module to include in FXDialogBox to provide an easy nonmodal version of execute.</p>
</div>
</div>
<div class="tags">
</div>
<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="#execute_modal-instance_method" title="#execute_modal (instance method)">#<strong>execute_modal</strong>(placement = PLACEMENT_CURSOR, &block) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Creates and shows the dialog, and registers the associated block to be called when the dialog is closed.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#execute_nonmodal-instance_method" title="#execute_nonmodal (instance method)">#<strong>execute_nonmodal</strong>(placement = PLACEMENT_CURSOR, &block) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Creates and shows the dialog, and registers the associated block to be called when the dialog is closed.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(*args) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#on_nonmodal_close-instance_method" title="#on_nonmodal_close (instance method)">#<strong>on_nonmodal_close</strong>(accepted) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Called when dialog is closed, with <em>accepted</em> equal to <code>true</code> if and only if the user accepted the dialog.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#onCmdAccept-instance_method" title="#onCmdAccept (instance method)">#<strong>onCmdAccept</strong>(*args) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>:nodoc:.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#onCmdCancel-instance_method" title="#onCmdCancel (instance method)">#<strong>onCmdCancel</strong>(*args) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>:nodoc:.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="execute_modal-instance_method">
#<strong>execute_modal</strong>(placement = PLACEMENT_CURSOR, &block) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Creates and shows the dialog, and registers the associated block to be called when the dialog is closed. The block is passed a boolean argument which is true if and only if the dialog was accepted.</p>
<p>For example:</p>
<pre class="code ruby"><code class="ruby">dialogBox.execute_modal do |accepted|
if accepted
puts "Dialog accepted"
else
puts "Dialog cancelled"
end
</code></pre>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
26
27
28
29</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/fox16/execute_nonmodal.rb', line 26</span>
<span class='kw'>def</span> <span class='id identifier rubyid_execute_modal'>execute_modal</span><span class='lparen'>(</span><span class='id identifier rubyid_placement'>placement</span> <span class='op'>=</span> <span class='const'>PLACEMENT_CURSOR</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='ivar'>@__FTNonModal_block</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
<span class='id identifier rubyid_execute'>execute</span><span class='lparen'>(</span><span class='id identifier rubyid_placement'>placement</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="execute_nonmodal-instance_method">
#<strong>execute_nonmodal</strong>(placement = PLACEMENT_CURSOR, &block) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Creates and shows the dialog, and registers the associated block to be called when the dialog is closed. The block is passed a boolean argument which is true if and only if the dialog was accepted.</p>
<p>For example:</p>
<pre class="code ruby"><code class="ruby">dialogBox.execute_nonmodal do |accepted|
if accepted
puts "Dialog accepted"
else
puts "Dialog cancelled"
end
</code></pre>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
45
46
47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/fox16/execute_nonmodal.rb', line 45</span>
<span class='kw'>def</span> <span class='id identifier rubyid_execute_nonmodal'>execute_nonmodal</span><span class='lparen'>(</span><span class='id identifier rubyid_placement'>placement</span> <span class='op'>=</span> <span class='const'>PLACEMENT_CURSOR</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='ivar'>@__FTNonModal_block</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
<span class='id identifier rubyid_create'>create</span>
<span class='id identifier rubyid_show'>show</span> <span class='id identifier rubyid_placement'>placement</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="initialize-instance_method">
#<strong>initialize</strong>(*args) ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
6
7
8
9
10</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/fox16/execute_nonmodal.rb', line 6</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
<span class='kw'>super</span> <span class='kw'>if</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='kw'>super</span><span class='rparen'>)</span>
<span class='const'>FXMAPFUNC</span><span class='lparen'>(</span><span class='const'>SEL_COMMAND</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="FXDialogBox.html" title="Fox::FXDialogBox (class)">FXDialogBox</a></span></span><span class='op'>::</span><span class='const'>ID_CANCEL</span><span class='comma'>,</span> <span class='symbol'>:onCmdCancel</span><span class='rparen'>)</span>
<span class='const'>FXMAPFUNC</span><span class='lparen'>(</span><span class='const'>SEL_COMMAND</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="FXDialogBox.html" title="Fox::FXDialogBox (class)">FXDialogBox</a></span></span><span class='op'>::</span><span class='const'>ID_ACCEPT</span><span class='comma'>,</span> <span class='symbol'>:onCmdAccept</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="on_nonmodal_close-instance_method">
#<strong>on_nonmodal_close</strong>(accepted) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Called when dialog is closed, with <em>accepted</em> equal to <code>true</code> if and only if the user accepted the dialog.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
61
62
63
64
65
66
67
68</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/fox16/execute_nonmodal.rb', line 61</span>
<span class='kw'>def</span> <span class='id identifier rubyid_on_nonmodal_close'>on_nonmodal_close</span><span class='lparen'>(</span><span class='id identifier rubyid_accepted'>accepted</span><span class='rparen'>)</span>
<span class='ivar'>@__FTNonModal_block</span><span class='lbracket'>[</span><span class='id identifier rubyid_accepted'>accepted</span><span class='rbracket'>]</span>
<span class='comment'>##return 0 -- why isn't this enough to close window?
</span> <span class='comment'>## oh well, let's imitate FXTopWindow:
</span> <span class='id identifier rubyid_getApp'>getApp</span><span class='lparen'>(</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_stopModal'>stopModal</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_accepted'>accepted</span> <span class='op'>?</span> <span class='int'>1</span> <span class='op'>:</span> <span class='int'>0</span><span class='rparen'>)</span>
<span class='id identifier rubyid_hide'>hide</span><span class='lparen'>(</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="onCmdAccept-instance_method">
#<strong>onCmdAccept</strong>(*args) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>:nodoc:</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
55
56
57</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/fox16/execute_nonmodal.rb', line 55</span>
<span class='kw'>def</span> <span class='id identifier rubyid_onCmdAccept'>onCmdAccept</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span> <span class='comment'># :nodoc:
</span> <span class='id identifier rubyid_on_nonmodal_close'>on_nonmodal_close</span><span class='lparen'>(</span><span class='kw'>true</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="onCmdCancel-instance_method">
#<strong>onCmdCancel</strong>(*args) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>:nodoc:</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 'lib/fox16/execute_nonmodal.rb', line 51</span>
<span class='kw'>def</span> <span class='id identifier rubyid_onCmdCancel'>onCmdCancel</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span> <span class='comment'># :nodoc:
</span> <span class='id identifier rubyid_on_nonmodal_close'>on_nonmodal_close</span><span class='lparen'>(</span><span class='kw'>false</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri Nov 27 21:10:34 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.24 (ruby-2.7.2).
</div>
</div>
</body>
</html>