<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXCommand
— 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::FXCommand";
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">FXCommand</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::FXCommand
</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::FXCommand</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/fox16/undolist.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>FXCommand is an “abstract” base class for your application’s commands. At a minimum, your concrete subclasses of FXCommand should implement the #undo, #redo, #undoName, and #redoName methods.</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="#redo-instance_method" title="#redo (instance method)">#<strong>redo</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Redo this command; this should save enough information for a subsequent undo.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#redoName-instance_method" title="#redoName (instance method)">#<strong>redoName</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Name of the redo command to be shown on a button or menu command; for example, “Redo Delete”.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#size-instance_method" title="#size (instance method)">#<strong>size</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the size of the information in the undo record, i.e.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#undo-instance_method" title="#undo (instance method)">#<strong>undo</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Undo this command; this should save enough information for a subsequent redo.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#undoName-instance_method" title="#undoName (instance method)">#<strong>undoName</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Name of the undo command to be shown on a button or menu command; for example, “Undo Delete”.</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="redo-instance_method">
#<strong>redo</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Redo this command; this should save enough information for a subsequent undo.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>NotImpError</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
425
426
427</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/fox16/undolist.rb', line 425</span>
<span class='kw'>def</span> <span class='kw'>redo</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImpError</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="redoName-instance_method">
#<strong>redoName</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Name of the redo command to be shown on a button or menu command; for example, “Redo Delete”.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>NotImpError</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
441
442
443</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/fox16/undolist.rb', line 441</span>
<span class='kw'>def</span> <span class='id identifier rubyid_redoName'>redoName</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImpError</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="size-instance_method">
#<strong>size</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the size of the information in the undo record, i.e. the number of bytes required to store it in memory. This is only used by the FXUndoList#trimSize method, which can be called to reduce the memory use of the undo list to a certain size.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
451
452
453</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/fox16/undolist.rb', line 451</span>
<span class='kw'>def</span> <span class='id identifier rubyid_size'>size</span>
<span class='int'>0</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="undo-instance_method">
#<strong>undo</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Undo this command; this should save enough information for a subsequent redo.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>NotImpError</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
417
418
419</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/fox16/undolist.rb', line 417</span>
<span class='kw'>def</span> <span class='id identifier rubyid_undo'>undo</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImpError</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="undoName-instance_method">
#<strong>undoName</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Name of the undo command to be shown on a button or menu command; for example, “Undo Delete”.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>NotImpError</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
433
434
435</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/fox16/undolist.rb', line 433</span>
<span class='kw'>def</span> <span class='id identifier rubyid_undoName'>undoName</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImpError</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jan 2 11:48:21 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>