<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXIcon
— 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::FXIcon";
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">FXIcon</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::FXIcon
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="FXImage.html" title="Fox::FXImage (class)">FXImage</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="FXId.html" title="Fox::FXId (class)">FXId</a></span></li>
<li class="next"><span class='object_link'><a href="FXDrawable.html" title="Fox::FXDrawable (class)">FXDrawable</a></span></li>
<li class="next"><span class='object_link'><a href="FXImage.html" title="Fox::FXImage (class)">FXImage</a></span></li>
<li class="next">Fox::FXIcon</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>rdoc-sources/FXIcon.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>An Icon is an image with two additional server-side resources: a shape bitmap, which is used to mask those pixels where the background should be preserved during the drawing, and a etch bitmap, which is used to draw the icon when it is disabled.</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="FXBMPIcon.html" title="Fox::FXBMPIcon (class)">FXBMPIcon</a></span>, <span class='object_link'><a href="FXGIFIcon.html" title="Fox::FXGIFIcon (class)">FXGIFIcon</a></span>, <span class='object_link'><a href="FXICOIcon.html" title="Fox::FXICOIcon (class)">FXICOIcon</a></span>, <span class='object_link'><a href="FXJPGIcon.html" title="Fox::FXJPGIcon (class)">FXJPGIcon</a></span>, <span class='object_link'><a href="FXPCXIcon.html" title="Fox::FXPCXIcon (class)">FXPCXIcon</a></span>, <span class='object_link'><a href="FXPNGIcon.html" title="Fox::FXPNGIcon (class)">FXPNGIcon</a></span>, <span class='object_link'><a href="FXPPMIcon.html" title="Fox::FXPPMIcon (class)">FXPPMIcon</a></span>, <span class='object_link'><a href="FXRGBIcon.html" title="Fox::FXRGBIcon (class)">FXRGBIcon</a></span>, <span class='object_link'><a href="FXTGAIcon.html" title="Fox::FXTGAIcon (class)">FXTGAIcon</a></span>, <span class='object_link'><a href="FXTIFIcon.html" title="Fox::FXTIFIcon (class)">FXTIFIcon</a></span>, <span class='object_link'><a href="FXXBMIcon.html" title="Fox::FXXBMIcon (class)">FXXBMIcon</a></span>, <span class='object_link'><a href="FXXPMIcon.html" title="Fox::FXXPMIcon (class)">FXXPMIcon</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="#transparentColor-instance_method" title="#transparentColor (instance method)">#<strong>transparentColor</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Transparency color <span class='object_link'><a href="FXColor.html" title="Fox::FXColor (class)">FXColor</a></span>.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="FXImage.html" title="Fox::FXImage (class)">FXImage</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXImage.html#data-instance_method" title="Fox::FXImage#data (method)">#data</a></span>, <span class='object_link'><a href="FXImage.html#dataPtr-instance_method" title="Fox::FXImage#dataPtr (method)">#dataPtr</a></span>, <span class='object_link'><a href="FXImage.html#options-instance_method" title="Fox::FXImage#options (method)">#options</a></span>, <span class='object_link'><a href="FXImage.html#pixels-instance_method" title="Fox::FXImage#pixels (method)">#pixels</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="FXDrawable.html" title="Fox::FXDrawable (class)">FXDrawable</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXDrawable.html#height-instance_method" title="Fox::FXDrawable#height (method)">#height</a></span>, <span class='object_link'><a href="FXDrawable.html#visual-instance_method" title="Fox::FXDrawable#visual (method)">#visual</a></span>, <span class='object_link'><a href="FXDrawable.html#width-instance_method" title="Fox::FXDrawable#width (method)">#width</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="FXId.html" title="Fox::FXId (class)">FXId</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXId.html#app-instance_method" title="Fox::FXId#app (method)">#app</a></span>, <span class='object_link'><a href="FXId.html#userData-instance_method" title="Fox::FXId#userData (method)">#userData</a></span>, <span class='object_link'><a href="FXId.html#xid-instance_method" title="Fox::FXId#xid (method)">#xid</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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(app, pix = nil, clr = 0, opts = 0, width = 1, height = 1) ⇒ FXIcon </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Create an icon with an initial pixel buffer <em>pix</em>, a transparent color <em>clr</em>, and <em>opts</em> as in FXImage.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="FXImage.html" title="Fox::FXImage (class)">FXImage</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXImage.html#blend-instance_method" title="Fox::FXImage#blend (method)">#blend</a></span>, <span class='object_link'><a href="FXImage.html#crop-instance_method" title="Fox::FXImage#crop (method)">#crop</a></span>, <span class='object_link'><a href="FXImage.html#fade-instance_method" title="Fox::FXImage#fade (method)">#fade</a></span>, <span class='object_link'><a href="FXImage.html#fill-instance_method" title="Fox::FXImage#fill (method)">#fill</a></span>, <span class='object_link'><a href="FXImage.html#getPixel-instance_method" title="Fox::FXImage#getPixel (method)">#getPixel</a></span>, <span class='object_link'><a href="FXImage.html#gradient-instance_method" title="Fox::FXImage#gradient (method)">#gradient</a></span>, <span class='object_link'><a href="FXImage.html#hasAlpha%3F-instance_method" title="Fox::FXImage#hasAlpha? (method)">#hasAlpha?</a></span>, <span class='object_link'><a href="FXImage.html#hgradient-instance_method" title="Fox::FXImage#hgradient (method)">#hgradient</a></span>, <span class='object_link'><a href="FXImage.html#initialize_without_data_string-instance_method" title="Fox::FXImage#initialize_without_data_string (method)">#initialize_without_data_string</a></span>, <span class='object_link'><a href="FXImage.html#loadPixels-instance_method" title="Fox::FXImage#loadPixels (method)">#loadPixels</a></span>, <span class='object_link'><a href="FXImage.html#mirror-instance_method" title="Fox::FXImage#mirror (method)">#mirror</a></span>, <span class='object_link'><a href="FXImage.html#pixel_string-instance_method" title="Fox::FXImage#pixel_string (method)">#pixel_string</a></span>, <span class='object_link'><a href="FXImage.html#release-instance_method" title="Fox::FXImage#release (method)">#release</a></span>, <span class='object_link'><a href="FXImage.html#render-instance_method" title="Fox::FXImage#render (method)">#render</a></span>, <span class='object_link'><a href="FXImage.html#restore-instance_method" title="Fox::FXImage#restore (method)">#restore</a></span>, <span class='object_link'><a href="FXImage.html#rotate-instance_method" title="Fox::FXImage#rotate (method)">#rotate</a></span>, <span class='object_link'><a href="FXImage.html#savePixels-instance_method" title="Fox::FXImage#savePixels (method)">#savePixels</a></span>, <span class='object_link'><a href="FXImage.html#scale-instance_method" title="Fox::FXImage#scale (method)">#scale</a></span>, <span class='object_link'><a href="FXImage.html#setPixel-instance_method" title="Fox::FXImage#setPixel (method)">#setPixel</a></span>, <span class='object_link'><a href="FXImage.html#setPixels-instance_method" title="Fox::FXImage#setPixels (method)">#setPixels</a></span>, <span class='object_link'><a href="FXImage.html#setPixels_without_data_string-instance_method" title="Fox::FXImage#setPixels_without_data_string (method)">#setPixels_without_data_string</a></span>, <span class='object_link'><a href="FXImage.html#vgradient-instance_method" title="Fox::FXImage#vgradient (method)">#vgradient</a></span>, <span class='object_link'><a href="FXImage.html#xshear-instance_method" title="Fox::FXImage#xshear (method)">#xshear</a></span>, <span class='object_link'><a href="FXImage.html#yshear-instance_method" title="Fox::FXImage#yshear (method)">#yshear</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="FXDrawable.html" title="Fox::FXDrawable (class)">FXDrawable</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXDrawable.html#resize-instance_method" title="Fox::FXDrawable#resize (method)">#resize</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="FXId.html" title="Fox::FXId (class)">FXId</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXId.html#create-instance_method" title="Fox::FXId#create (method)">#create</a></span>, <span class='object_link'><a href="FXId.html#created%3F-instance_method" title="Fox::FXId#created? (method)">#created?</a></span>, <span class='object_link'><a href="FXId.html#destroy-instance_method" title="Fox::FXId#destroy (method)">#destroy</a></span>, <span class='object_link'><a href="FXId.html#detach-instance_method" title="Fox::FXId#detach (method)">#detach</a></span>, <span class='object_link'><a href="FXId.html#runOnUiThread-instance_method" title="Fox::FXId#runOnUiThread (method)">#runOnUiThread</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>(app, pix = nil, clr = 0, opts = 0, width = 1, height = 1) ⇒ <tt><span class='object_link'><a href="" title="Fox::FXIcon (class)">FXIcon</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create an icon with an initial pixel buffer <em>pix</em>, a transparent color <em>clr</em>, and <em>opts</em> as in FXImage. The transparent color is used to determine which pixel values are transparent, i.e. need to be masked out in the absence of a true alpha channel. If the flag <code>IMAGE_OPAQUE</code> is passed, the shape and etch bitmaps are generated as if the image is fully opaque, even if it has an alpha channel or transparancy color. The flag <code>IMAGE_ALPHACOLOR</code> is used to force a specific alpha color instead of the alpha channel obtained from the image file. Specifying <code>IMAGE_ALPHAGUESS</code> causes FXIcon to obtain the alpha color from the background color of the image; it has the same effect as <code>IMAGE_ALPHACOLOR</code> in the sense that the icon will be transparent for those colors matching the alpha color.</p>
<h4 id="label-Parameters-3A">Parameters:</h4>
<dl class="rdoc-list note-list"><dt><code>a</code>
<dd>
<p>an application instance <span class='object_link'><a href="FXApp.html" title="Fox::FXApp (class)">Fox::FXApp</a></span></p>
</dd><dt><code>pix</code>
<dd>
<p>initial pixel buffer [String]</p>
</dd><dt><code>clr</code>
<dd>
<p>transparency color <span class='object_link'><a href="FXColor.html" title="Fox::FXColor (class)">Fox::FXColor</a></span></p>
</dd><dt><code>opts</code>
<dd>
<p>options [Integer]</p>
</dd><dt><code>width</code>
<dd>
<p>width [Integer]</p>
</dd><dt><code>height</code>
<dd>
<p>height [Integer]</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
35
36</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXIcon.rb', line 35</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_app'>app</span><span class='comma'>,</span> <span class='id identifier rubyid_pix'>pix</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_clr'>clr</span><span class='op'>=</span><span class='int'>0</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='op'>=</span><span class='int'>0</span><span class='comma'>,</span> <span class='id identifier rubyid_width'>width</span><span class='op'>=</span><span class='int'>1</span><span class='comma'>,</span> <span class='id identifier rubyid_height'>height</span><span class='op'>=</span><span class='int'>1</span><span class='rparen'>)</span> <span class='comment'># :yields: theIcon
</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="transparentColor=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="transparentColor-instance_method">
#<strong>transparentColor</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Transparency color <span class='object_link'><a href="FXColor.html" title="Fox::FXColor (class)">Fox::FXColor</a></span></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/FXIcon.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_transparentColor'>transparentColor</span>
<span class='ivar'>@transparentColor</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jan 2 11:47:23 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>