<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXFileItem
— 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::FXFileItem";
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">FXFileItem</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::FXFileItem
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="FXIconItem.html" title="Fox::FXIconItem (class)">FXIconItem</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"><span class='object_link'><a href="FXIconItem.html" title="Fox::FXIconItem (class)">FXIconItem</a></span></li>
<li class="next">Fox::FXFileItem</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>rdoc-sources/FXFileList.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>File item</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="#assoc-instance_method" title="#assoc (instance method)">#<strong>assoc</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>The file association object for this item <span class='object_link'><a href="FXFileAssoc.html" title="Fox::FXFileAssoc (class)">FXFileAssoc</a></span>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#date-instance_method" title="#date (instance method)">#<strong>date</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Date for this item [Time].</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="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>The file size for this item [Integer].</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="FXIconItem.html" title="Fox::FXIconItem (class)">FXIconItem</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXIconItem.html#bigIcon-instance_method" title="Fox::FXIconItem#bigIcon (method)">#bigIcon</a></span>, <span class='object_link'><a href="FXIconItem.html#data-instance_method" title="Fox::FXIconItem#data (method)">#data</a></span>, <span class='object_link'><a href="FXIconItem.html#draggable=-instance_method" title="Fox::FXIconItem#draggable= (method)">#draggable</a></span>, <span class='object_link'><a href="FXIconItem.html#enabled=-instance_method" title="Fox::FXIconItem#enabled= (method)">#enabled</a></span>, <span class='object_link'><a href="FXIconItem.html#miniIcon-instance_method" title="Fox::FXIconItem#miniIcon (method)">#miniIcon</a></span>, <span class='object_link'><a href="FXIconItem.html#selected=-instance_method" title="Fox::FXIconItem#selected= (method)">#selected</a></span>, <span class='object_link'><a href="FXIconItem.html#text-instance_method" title="Fox::FXIconItem#text (method)">#text</a></span></p>
<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="#blockdev%3F-instance_method" title="#blockdev? (instance method)">#<strong>blockdev?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if this is a block device item.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#chardev%3F-instance_method" title="#chardev? (instance method)">#<strong>chardev?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if this is a character device item.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#directory%3F-instance_method" title="#directory? (instance method)">#<strong>directory?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if this is a directory item.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#executable%3F-instance_method" title="#executable? (instance method)">#<strong>executable?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if this is an executable item.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fifo%3F-instance_method" title="#fifo? (instance method)">#<strong>fifo?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if this is an FIFO item.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#file%3F-instance_method" title="#file? (instance method)">#<strong>file?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if this is a file item.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(text, bi = nil, mi = nil, ptr = nil) ⇒ FXFileItem </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Returns an initialized FXFileItem instance.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#share%3F-instance_method" title="#share? (instance method)">#<strong>share?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if this is a share item.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#socket%3F-instance_method" title="#socket? (instance method)">#<strong>socket?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if this is a socket.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#symlink%3F-instance_method" title="#symlink? (instance method)">#<strong>symlink?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if this is a symbolic link item.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="FXIconItem.html" title="Fox::FXIconItem (class)">FXIconItem</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXIconItem.html#<=>-instance_method" title="Fox::FXIconItem#<=> (method)">#<=></a></span>, <span class='object_link'><a href="FXIconItem.html#create-instance_method" title="Fox::FXIconItem#create (method)">#create</a></span>, <span class='object_link'><a href="FXIconItem.html#destroy-instance_method" title="Fox::FXIconItem#destroy (method)">#destroy</a></span>, <span class='object_link'><a href="FXIconItem.html#detach-instance_method" title="Fox::FXIconItem#detach (method)">#detach</a></span>, <span class='object_link'><a href="FXIconItem.html#draggable%3F-instance_method" title="Fox::FXIconItem#draggable? (method)">#draggable?</a></span>, <span class='object_link'><a href="FXIconItem.html#enabled%3F-instance_method" title="Fox::FXIconItem#enabled? (method)">#enabled?</a></span>, <span class='object_link'><a href="FXIconItem.html#getHeight-instance_method" title="Fox::FXIconItem#getHeight (method)">#getHeight</a></span>, <span class='object_link'><a href="FXIconItem.html#getWidth-instance_method" title="Fox::FXIconItem#getWidth (method)">#getWidth</a></span>, <span class='object_link'><a href="FXIconItem.html#hasFocus%3F-instance_method" title="Fox::FXIconItem#hasFocus? (method)">#hasFocus?</a></span>, <span class='object_link'><a href="FXIconItem.html#selected%3F-instance_method" title="Fox::FXIconItem#selected? (method)">#selected?</a></span>, <span class='object_link'><a href="FXIconItem.html#setFocus-instance_method" title="Fox::FXIconItem#setFocus (method)">#setFocus</a></span>, <span class='object_link'><a href="FXIconItem.html#to_s-instance_method" title="Fox::FXIconItem#to_s (method)">#to_s</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>(text, bi = nil, mi = nil, ptr = nil) ⇒ <tt><span class='object_link'><a href="" title="Fox::FXFileItem (class)">FXFileItem</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns an initialized FXFileItem instance</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXFileList.rb', line 17</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_bi'>bi</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_mi'>mi</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_ptr'>ptr</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span> <span class='comment'># :yields: theFileItem
</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="assoc-instance_method">
#<strong>assoc</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>The file association object for this item <span class='object_link'><a href="FXFileAssoc.html" title="Fox::FXFileAssoc (class)">Fox::FXFileAssoc</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/FXFileList.rb', line 8</span>
<span class='kw'>def</span> <span class='id identifier rubyid_assoc'>assoc</span>
<span class='ivar'>@assoc</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="date-instance_method">
#<strong>date</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Date for this item [Time]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXFileList.rb', line 14</span>
<span class='kw'>def</span> <span class='id identifier rubyid_date'>date</span>
<span class='ivar'>@date</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="size-instance_method">
#<strong>size</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>The file size for this item [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXFileList.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_size'>size</span>
<span class='ivar'>@size</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="blockdev?-instance_method">
#<strong>blockdev?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if this is a block device item</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">
39</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXFileList.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_blockdev?'>blockdev?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="chardev?-instance_method">
#<strong>chardev?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if this is a character device item</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">
36</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXFileList.rb', line 36</span>
<span class='kw'>def</span> <span class='id identifier rubyid_chardev?'>chardev?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="directory?-instance_method">
#<strong>directory?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if this is a directory item</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">
24</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXFileList.rb', line 24</span>
<span class='kw'>def</span> <span class='id identifier rubyid_directory?'>directory?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="executable?-instance_method">
#<strong>executable?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if this is an executable item</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">
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXFileList.rb', line 30</span>
<span class='kw'>def</span> <span class='id identifier rubyid_executable?'>executable?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fifo?-instance_method">
#<strong>fifo?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if this is an FIFO item</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">
42</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXFileList.rb', line 42</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fifo?'>fifo?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="file?-instance_method">
#<strong>file?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if this is a file item</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">
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXFileList.rb', line 21</span>
<span class='kw'>def</span> <span class='id identifier rubyid_file?'>file?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="share?-instance_method">
#<strong>share?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if this is a share item</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">
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXFileList.rb', line 27</span>
<span class='kw'>def</span> <span class='id identifier rubyid_share?'>share?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="socket?-instance_method">
#<strong>socket?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if this is a socket</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">
45</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXFileList.rb', line 45</span>
<span class='kw'>def</span> <span class='id identifier rubyid_socket?'>socket?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="symlink?-instance_method">
#<strong>symlink?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if this is a symbolic link item</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">
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXFileList.rb', line 33</span>
<span class='kw'>def</span> <span class='id identifier rubyid_symlink?'>symlink?</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:47:41 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>