<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXGradient
— 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::FXGradient";
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">FXGradient</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::FXGradient
</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::FXGradient</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>rdoc-sources/FXGradientBar.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>An FXGradientBar widget is defined in part by its array of “segments”, each of which is an FXGradient instance. An FXGradient instance defines the properties of one segment, namely, the lower, middle and upper values (all Floats); the lower and upper color values; and the blending mode for the segment.</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="#blend-instance_method" title="#blend (instance method)">#<strong>blend</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Blend mode [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#lower-instance_method" title="#lower (instance method)">#<strong>lower</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Lower value [Float].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#lowerColor-instance_method" title="#lowerColor (instance method)">#<strong>lowerColor</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Lower color <span class='object_link'><a href="FXColor.html" title="Fox::FXColor (class)">FXColor</a></span>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#middle-instance_method" title="#middle (instance method)">#<strong>middle</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Middle value [Float].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#upper-instance_method" title="#upper (instance method)">#<strong>upper</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Upper value [Float].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#upperColor-instance_method" title="#upperColor (instance method)">#<strong>upperColor</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Upper color <span class='object_link'><a href="FXColor.html" title="Fox::FXColor (class)">FXColor</a></span>.</p>
</div></span>
</li>
</ul>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="blend=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="blend-instance_method">
#<strong>blend</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Blend mode [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
26
27
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXGradientBar.rb', line 26</span>
<span class='kw'>def</span> <span class='id identifier rubyid_blend'>blend</span>
<span class='ivar'>@blend</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="lower=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="lower-instance_method">
#<strong>lower</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Lower value [Float]</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/FXGradientBar.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_lower'>lower</span>
<span class='ivar'>@lower</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="lowerColor=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="lowerColor-instance_method">
#<strong>lowerColor</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Lower 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">
20
21
22</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXGradientBar.rb', line 20</span>
<span class='kw'>def</span> <span class='id identifier rubyid_lowerColor'>lowerColor</span>
<span class='ivar'>@lowerColor</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="middle=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="middle-instance_method">
#<strong>middle</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Middle value [Float]</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/FXGradientBar.rb', line 14</span>
<span class='kw'>def</span> <span class='id identifier rubyid_middle'>middle</span>
<span class='ivar'>@middle</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="upper=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="upper-instance_method">
#<strong>upper</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Upper value [Float]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXGradientBar.rb', line 17</span>
<span class='kw'>def</span> <span class='id identifier rubyid_upper'>upper</span>
<span class='ivar'>@upper</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="upperColor=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="upperColor-instance_method">
#<strong>upperColor</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Upper 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">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXGradientBar.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_upperColor'>upperColor</span>
<span class='ivar'>@upperColor</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jan 2 11:48:09 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>