<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXTableItem
— 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::FXTableItem";
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">FXTableItem</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::FXTableItem
</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::FXTableItem</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>rdoc-sources/FXTable.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Represents a particular cell in an FXTable.</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="FXComboTableItem.html" title="Fox::FXComboTableItem (class)">FXComboTableItem</a></span></p>
</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="#borders-instance_method" title="#borders (instance method)">#<strong>borders</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Which borders will be drawn for this cell (some combination of <code>LBORDER</code>, <code>RBORDER</code>, <code>TBORDER</code> and <code>BBORDER</code>) [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#data-instance_method" title="#data (instance method)">#<strong>data</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>User data associated with this cell [Object].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#draggable=-instance_method" title="#draggable= (instance method)">#<strong>draggable</strong> ⇒ Object </a>
</span>
<span class="note title writeonly">writeonly</span>
<span class="summary_desc"><div class='inline'>
<p>Indicates whether this item is draggable [Boolean].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#enabled=-instance_method" title="#enabled= (instance method)">#<strong>enabled</strong> ⇒ Object </a>
</span>
<span class="note title writeonly">writeonly</span>
<span class="summary_desc"><div class='inline'>
<p>Indicates whether this item is enabled [Boolean].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#focus=-instance_method" title="#focus= (instance method)">#<strong>focus</strong> ⇒ Object </a>
</span>
<span class="note title writeonly">writeonly</span>
<span class="summary_desc"><div class='inline'>
<p>Indicates whether this item has the focus [Boolean].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#icon-instance_method" title="#icon (instance method)">#<strong>icon</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Icon associated with this cell <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">FXIcon</a></span>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#iconPosition-instance_method" title="#iconPosition (instance method)">#<strong>iconPosition</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The icon’s position in the cell, relative to the text (one of <code>BEFORE</code>, <code>AFTER</code>, <code>ABOVE</code> or <code>BELOW</code>) [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#justify-instance_method" title="#justify (instance method)">#<strong>justify</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Indicates how the text in the cell will be justified.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#selected=-instance_method" title="#selected= (instance method)">#<strong>selected</strong> ⇒ Object </a>
</span>
<span class="note title writeonly">writeonly</span>
<span class="summary_desc"><div class='inline'>
<p>Indicates whether this item is selected [Boolean].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#stipple-instance_method" title="#stipple (instance method)">#<strong>stipple</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The background stipple pattern for this cell [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#text-instance_method" title="#text (instance method)">#<strong>text</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Text associated with this cell [String].</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="#create-instance_method" title="#create (instance method)">#<strong>create</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Create the server-side resources associated with this table item.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#destroy-instance_method" title="#destroy (instance method)">#<strong>destroy</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Destroy the server-side resources associated with this table item.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#detach-instance_method" title="#detach (instance method)">#<strong>detach</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Detach the server-side resources associated with this table item.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#draggable%3F-instance_method" title="#draggable? (instance method)">#<strong>draggable?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return true if this item is draggable.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#draw-instance_method" title="#draw (instance method)">#<strong>draw</strong>(table, dc, x, y, w, h) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Draw this table item.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#drawBackground-instance_method" title="#drawBackground (instance method)">#<strong>drawBackground</strong>(table, dc, x, y, w, h) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Draw background behind the cell.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#drawBorders-instance_method" title="#drawBorders (instance method)">#<strong>drawBorders</strong>(table, dc, x, y, w, h) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Draw borders.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#drawContent-instance_method" title="#drawContent (instance method)">#<strong>drawContent</strong>(table, dc, x, y, w, h) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Draw content.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#drawPattern-instance_method" title="#drawPattern (instance method)">#<strong>drawPattern</strong>(table, dc, x, y, w, h) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Draw hatch pattern.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#enabled%3F-instance_method" title="#enabled? (instance method)">#<strong>enabled?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return true if this item is enabled.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#getControlFor-instance_method" title="#getControlFor (instance method)">#<strong>getControlFor</strong>(table) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Create input control for editing this item.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#getHeight-instance_method" title="#getHeight (instance method)">#<strong>getHeight</strong>(table) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return the height of this item (in pixels).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#getWidth-instance_method" title="#getWidth (instance method)">#<strong>getWidth</strong>(table) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return the width of this item (in pixels).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#hasFocus%3F-instance_method" title="#hasFocus? (instance method)">#<strong>hasFocus?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return true if this item has the focus.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(text, icon = nil, data = nil) ⇒ FXTableItem </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Return an initialized FXTableItem instance.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#selected%3F-instance_method" title="#selected? (instance method)">#<strong>selected?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return true if this item is selected.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#setFromControl-instance_method" title="#setFromControl (instance method)">#<strong>setFromControl</strong>(control) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Set item value from input <em>control</em> (an instance of some subclass of FXWindow).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#setIcon-instance_method" title="#setIcon (instance method)">#<strong>setIcon</strong>(icn, owned = false) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Change item icon, deleting the previous item icon if it was owned by this table item.</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>Return the text for this table item.</p>
</div></span>
</li>
</ul>
<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>(text, icon = nil, data = nil) ⇒ <tt><span class='object_link'><a href="" title="Fox::FXTableItem (class)">FXTableItem</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return an initialized FXTableItem instance.</p>
<h4 id="label-Parameters-3A">Parameters:</h4>
<dl class="rdoc-list note-list"><dt><code>text</code>
<dd>
<p>the text for this table item [String]</p>
</dd><dt><code>icon</code>
<dd>
<p>the icon, if any, for this table item <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">Fox::FXIcon</a></span></p>
</dd><dt><code>data</code>
<dd>
<p>the user data for this table item [Object]</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
88</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 88</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_text'>text</span><span class='comma'>,</span> <span class='id identifier rubyid_icon'>icon</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</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 id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="borders=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="borders-instance_method">
#<strong>borders</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Which borders will be drawn for this cell (some combination of <code>LBORDER</code>, <code>RBORDER</code>, <code>TBORDER</code> and <code>BBORDER</code>) [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
74
75
76</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 74</span>
<span class='kw'>def</span> <span class='id identifier rubyid_borders'>borders</span>
<span class='ivar'>@borders</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="data=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="data-instance_method">
#<strong>data</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>User data associated with this cell [Object]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
46
47
48</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 46</span>
<span class='kw'>def</span> <span class='id identifier rubyid_data'>data</span>
<span class='ivar'>@data</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="draggable=-instance_method">
#<strong>draggable=</strong>(value) ⇒ <tt>Object</tt> <span class="extras">(writeonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Indicates whether this item is draggable [Boolean]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
58
59
60</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 58</span>
<span class='kw'>def</span> <span class='id identifier rubyid_draggable='>draggable=</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='ivar'>@draggable</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="enabled=-instance_method">
#<strong>enabled=</strong>(value) ⇒ <tt>Object</tt> <span class="extras">(writeonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Indicates whether this item is enabled [Boolean]</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 'rdoc-sources/FXTable.rb', line 55</span>
<span class='kw'>def</span> <span class='id identifier rubyid_enabled='>enabled=</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='ivar'>@enabled</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="focus=-instance_method">
#<strong>focus=</strong>(value) ⇒ <tt>Object</tt> <span class="extras">(writeonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Indicates whether this item has the focus [Boolean]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
49
50
51</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 49</span>
<span class='kw'>def</span> <span class='id identifier rubyid_focus='>focus=</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='ivar'>@focus</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="icon=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="icon-instance_method">
#<strong>icon</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Icon associated with this cell <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">Fox::FXIcon</a></span></p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
43
44
45</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 43</span>
<span class='kw'>def</span> <span class='id identifier rubyid_icon'>icon</span>
<span class='ivar'>@icon</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="iconPosition=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="iconPosition-instance_method">
#<strong>iconPosition</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The icon’s position in the cell, relative to the text (one of <code>BEFORE</code>, <code>AFTER</code>, <code>ABOVE</code> or <code>BELOW</code>) [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
70
71
72</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 70</span>
<span class='kw'>def</span> <span class='id identifier rubyid_iconPosition'>iconPosition</span>
<span class='ivar'>@iconPosition</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="justify=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="justify-instance_method">
#<strong>justify</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Indicates how the text in the cell will be justified. This value is some combination of the horizontal justification flags <code>LEFT</code>, <code>CENTER_X</code> and <code>RIGHT</code>, and the vertical justification flags <code>TOP</code>, <code>CENTER_Y</code> and <code>BOTTOM</code>.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
66
67
68</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 66</span>
<span class='kw'>def</span> <span class='id identifier rubyid_justify'>justify</span>
<span class='ivar'>@justify</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="selected=-instance_method">
#<strong>selected=</strong>(value) ⇒ <tt>Object</tt> <span class="extras">(writeonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Indicates whether this item is selected [Boolean]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
52
53
54</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 52</span>
<span class='kw'>def</span> <span class='id identifier rubyid_selected='>selected=</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='ivar'>@selected</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="stipple=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="stipple-instance_method">
#<strong>stipple</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The background stipple pattern for this cell [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
77
78
79</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 77</span>
<span class='kw'>def</span> <span class='id identifier rubyid_stipple'>stipple</span>
<span class='ivar'>@stipple</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="text=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="text-instance_method">
#<strong>text</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Text associated with this cell [String]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
40
41
42</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 40</span>
<span class='kw'>def</span> <span class='id identifier rubyid_text'>text</span>
<span class='ivar'>@text</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="create-instance_method">
#<strong>create</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create the server-side resources associated with this table item</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
149</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 149</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="destroy-instance_method">
#<strong>destroy</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Destroy the server-side resources associated with this table item</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
155</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 155</span>
<span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="detach-instance_method">
#<strong>detach</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Detach the server-side resources associated with this table item</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
152</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 152</span>
<span class='kw'>def</span> <span class='id identifier rubyid_detach'>detach</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="draggable?-instance_method">
#<strong>draggable?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return true if this item is draggable</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">
106</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 106</span>
<span class='kw'>def</span> <span class='id identifier rubyid_draggable?'>draggable?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="draw-instance_method">
#<strong>draw</strong>(table, dc, x, y, w, h) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Draw this table item</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
118</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 118</span>
<span class='kw'>def</span> <span class='id identifier rubyid_draw'>draw</span><span class='lparen'>(</span><span class='id identifier rubyid_table'>table</span><span class='comma'>,</span> <span class='id identifier rubyid_dc'>dc</span><span class='comma'>,</span> <span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span><span class='comma'>,</span> <span class='id identifier rubyid_w'>w</span><span class='comma'>,</span> <span class='id identifier rubyid_h'>h</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="drawBackground-instance_method">
#<strong>drawBackground</strong>(table, dc, x, y, w, h) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Draw background behind the cell</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
130
131
132
133
134</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 130</span>
<span class='kw'>def</span> <span class='id identifier rubyid_drawBackground'>drawBackground</span><span class='lparen'>(</span><span class='id identifier rubyid_table'>table</span><span class='comma'>,</span> <span class='id identifier rubyid_dc'>dc</span><span class='comma'>,</span> <span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span><span class='comma'>,</span> <span class='id identifier rubyid_w'>w</span><span class='comma'>,</span> <span class='id identifier rubyid_h'>h</span><span class='rparen'>)</span>
<span class='id identifier rubyid_hg'>hg</span> <span class='op'>=</span> <span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_horizontalGridShown?'>horizontalGridShown?</span> <span class='op'>?</span> <span class='int'>1</span> <span class='op'>:</span> <span class='int'>0</span>
<span class='id identifier rubyid_vg'>vg</span> <span class='op'>=</span> <span class='id identifier rubyid_table'>table</span><span class='period'>.</span><span class='id identifier rubyid_verticalGridShown?'>verticalGridShown?</span> <span class='op'>?</span> <span class='int'>1</span> <span class='op'>:</span> <span class='int'>0</span>
<span class='id identifier rubyid_dc'>dc</span><span class='period'>.</span><span class='id identifier rubyid_fillRectangle'>fillRectangle</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span> <span class='op'>+</span> <span class='id identifier rubyid_vg'>vg</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span> <span class='op'>+</span> <span class='id identifier rubyid_hg'>hg</span><span class='comma'>,</span> <span class='id identifier rubyid_w'>w</span> <span class='op'>-</span> <span class='id identifier rubyid_vg'>vg</span><span class='comma'>,</span> <span class='id identifier rubyid_h'>h</span> <span class='op'>-</span> <span class='id identifier rubyid_hg'>hg</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="drawBorders-instance_method">
#<strong>drawBorders</strong>(table, dc, x, y, w, h) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Draw borders</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
121</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 121</span>
<span class='kw'>def</span> <span class='id identifier rubyid_drawBorders'>drawBorders</span><span class='lparen'>(</span><span class='id identifier rubyid_table'>table</span><span class='comma'>,</span> <span class='id identifier rubyid_dc'>dc</span><span class='comma'>,</span> <span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span><span class='comma'>,</span> <span class='id identifier rubyid_w'>w</span><span class='comma'>,</span> <span class='id identifier rubyid_h'>h</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="drawContent-instance_method">
#<strong>drawContent</strong>(table, dc, x, y, w, h) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Draw content</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
124</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 124</span>
<span class='kw'>def</span> <span class='id identifier rubyid_drawContent'>drawContent</span><span class='lparen'>(</span><span class='id identifier rubyid_table'>table</span><span class='comma'>,</span> <span class='id identifier rubyid_dc'>dc</span><span class='comma'>,</span> <span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span><span class='comma'>,</span> <span class='id identifier rubyid_w'>w</span><span class='comma'>,</span> <span class='id identifier rubyid_h'>h</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="drawPattern-instance_method">
#<strong>drawPattern</strong>(table, dc, x, y, w, h) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Draw hatch pattern</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
127</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 127</span>
<span class='kw'>def</span> <span class='id identifier rubyid_drawPattern'>drawPattern</span><span class='lparen'>(</span><span class='id identifier rubyid_table'>table</span><span class='comma'>,</span> <span class='id identifier rubyid_dc'>dc</span><span class='comma'>,</span> <span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span><span class='comma'>,</span> <span class='id identifier rubyid_w'>w</span><span class='comma'>,</span> <span class='id identifier rubyid_h'>h</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="enabled?-instance_method">
#<strong>enabled?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return true if this item is enabled</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">
103</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 103</span>
<span class='kw'>def</span> <span class='id identifier rubyid_enabled?'>enabled?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="getControlFor-instance_method">
#<strong>getControlFor</strong>(table) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create input control for editing this item. Should return a new instance of some subclass of FXWindow.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
140</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 140</span>
<span class='kw'>def</span> <span class='id identifier rubyid_getControlFor'>getControlFor</span><span class='lparen'>(</span><span class='id identifier rubyid_table'>table</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="getHeight-instance_method">
#<strong>getHeight</strong>(table) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return the height of this item (in pixels)</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
94</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 94</span>
<span class='kw'>def</span> <span class='id identifier rubyid_getHeight'>getHeight</span><span class='lparen'>(</span><span class='id identifier rubyid_table'>table</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="getWidth-instance_method">
#<strong>getWidth</strong>(table) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return the width of this item (in pixels)</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
91</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 91</span>
<span class='kw'>def</span> <span class='id identifier rubyid_getWidth'>getWidth</span><span class='lparen'>(</span><span class='id identifier rubyid_table'>table</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="hasFocus?-instance_method">
#<strong>hasFocus?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return true if this item has the focus</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">
97</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 97</span>
<span class='kw'>def</span> <span class='id identifier rubyid_hasFocus?'>hasFocus?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="selected?-instance_method">
#<strong>selected?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return true if this item is selected</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">
100</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 100</span>
<span class='kw'>def</span> <span class='id identifier rubyid_selected?'>selected?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="setFromControl-instance_method">
#<strong>setFromControl</strong>(control) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Set item value from input <em>control</em> (an instance of some subclass of FXWindow).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
146</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 146</span>
<span class='kw'>def</span> <span class='id identifier rubyid_setFromControl'>setFromControl</span><span class='lparen'>(</span><span class='id identifier rubyid_control'>control</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="setIcon-instance_method">
#<strong>setIcon</strong>(icn, owned = false) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Change item icon, deleting the previous item icon if it was owned by this table item.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
115</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 115</span>
<span class='kw'>def</span> <span class='id identifier rubyid_setIcon'>setIcon</span><span class='lparen'>(</span><span class='id identifier rubyid_icn'>icn</span><span class='comma'>,</span> <span class='id identifier rubyid_owned'>owned</span><span class='op'>=</span><span class='kw'>false</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="to_s-instance_method">
#<strong>to_s</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return the text for this table item</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
109
110
111</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXTable.rb', line 109</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
<span class='id identifier rubyid_text'>text</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jan 2 11:47:26 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>