Codebase list ruby-fxruby / a4f3bb2
Import upstream version 1.6.45+git20230116.1.57f414d Kali Janitor 1 year, 3 months ago
292 changed file(s) with 1563 addition(s) and 1544 deletion(s). Raw diff Collapse all Expand all
+0
-26
.gitignore less more
0 doap.rdf
1 *.tmproj
2 doc/api
3 users_guide/*.html
4 ext/fox16_c/*_wrap.cpp
5 ext/fox16_c/*.o
6 ext/fox16_c/conftest.dSYM
7 ext/fox16_c/include/inlinestubs.h
8 ext/fox16_c/extconf.h
9 ext/fox16_c/swigruby.h
10 ext/fox16_c/fox16.bundle
11 ext/fox16_c/mkmf.log
12 lib/fox16/kwargs.rb
13 lib/[0-9].[0-9]
14 lib/*.so
15 fox-includes/diffs.py
16 fox-includes/diffs.txt
17 pkg
18 tmp
19 vendor
20 *.orig
21 *.rej
22 /Gemfile.lock
23 /ports
24 /.bundle
25 /.yardoc
0 ## 1.6.45 / 2022-01-14
1
2 * Add binary gem support for ruby-3.1 on platform x64-mingw-ucrt and drop ruby-2.3.
3 * Update to libz-1.2.11, libjpeg-turbo-2.1.2, libtiff-4.3.0 for Windows binary gems.
4
05 ## 1.6.44 / 2020-12-31
16
27 * Add binary gem support for ruby-3.0. #66
22 * http://github.com/larskanis/fxruby
33 * Full API-description: http://rubydoc.info/gems/fxruby/frames or https://larskanis.github.io/fxruby/
44 * Latest fxruby {<img src="https://badge.fury.io/rb/fxruby.svg" alt="Gem Version" />}[http://badge.fury.io/rb/fxruby]
5 * Status on Linux: {<img src="https://travis-ci.com/larskanis/fxruby.svg?branch=1.6" alt="Build Status on Linux" />}[https://travis-ci.com/larskanis/fxruby]
6 on Windows: {<img src="https://ci.appveyor.com/api/projects/status/too7sj4gq643ts8w/branch/1.6?svg=true" alt="Build Status on Windows" />}[https://ci.appveyor.com/project/larskanis/fxruby/branch/1.6]
7
5 * CI-Status: {<img src="https://github.com/larskanis/fxruby/actions/workflows/ci.yml/badge.svg?branch=1.6" alt="Build Status" />}[https://github.com/larskanis/fxruby/actions/workflows/ci.yml] and on Windows: {<img src="https://ci.appveyor.com/api/projects/status/too7sj4gq643ts8w/branch/1.6?svg=true" alt="Build Status on Windows" />}[https://ci.appveyor.com/project/larskanis/fxruby/branch/1.6]
86
97
108 == DESCRIPTION:
3331 FXRuby runs on Linux, Windows and OS-X with Ruby-2.2 or newer. Installation on Unix requires
3432 FOX development headers and libraries installed:
3533 * on Debian/Ubuntu: <tt>sudo apt-get install g++ libxrandr-dev libfox-1.6-dev</tt>
34 * on Mac: <tt>sudo port install rb-fxruby</tt> OR <tt>brew install fox && brew install xquartz</tt>
35 * on Windows: the binary fxruby gems already contain all required libraries
3636 * see also detailed installation instructions in the {Wiki}[https://github.com/lylejohnson/fxruby/wiki]
37 * on Windows: the binary fxruby gems already contain all required libararies
3837
3938 Then, install the gem:
4039 * gem install fxruby
40
41 On Mac, before running applications, you must also run: <tt>open -a /Applications/Utilities/XQuartz.app</tt>
42
43 (otherwise, you end up getting this message when running applications on Mac: <tt>FXRbApp::openDisplay: unable to open display :0.0</tt>)
4144
4245 == DIRECTORIES
4346 The directory structure is:
9191
9292 ext_task = Rake::ExtensionTask.new("fox16_c", gem_spec) do |ext|
9393 ext.cross_compile = true
94 ext.cross_platform = ['x86-mingw32', 'x64-mingw32']
94 ext.cross_platform = ['x86-mingw32', 'x64-mingw-ucrt', 'x64-mingw32']
9595 # Enable FXTRACE and FXASSERT for 'rake compile'
9696 ext.config_options << "--enable-debug"
9797
108108
109109 platform_host_map = {
110110 'x86-mingw32' => ['i686-w64-mingw32'],
111 'x64-mingw-ucrt' => ['x86_64-w64-mingw32'],
111112 'x64-mingw32' => ['x86_64-w64-mingw32'],
112113 }
113114
116117
117118 gcc_shared_dlls = %w[libwinpthread-1.dll libgcc_s_dw2-1.dll libgcc_s_sjlj-1.dll libgcc_s_seh-1.dll libstdc++-6.dll]
118119
119 dlls = gcc_shared_dlls.select{|dll| File.exist?("ports/#{host}/bin/#{dll}") }
120 dlls = gcc_shared_dlls.select{|dll| File.exist?("ports/#{gemplat}/bin/#{dll}") }
120121 dlls += [
121122 "libfxscintilla-20.dll",
122123 "libFOX-1.6-0.dll",
126127 "zlib1.dll",
127128 ]
128129
129 spec.files += dlls.map{|dll| "ports/#{host}/bin/#{dll}" }
130 spec.files += dlls.map{|dll| "ports/#{gemplat}/bin/#{dll}" }
130131
131132 unless ENV['FXRUBY_MINGW_DEBUG']
132133 dlls.each do |dll|
133 task "ports/#{host}/bin/#{dll}" do |t|
134 task "ports/#{gemplat}/bin/#{dll}" do |t|
134135 sh "#{host}-strip", t.name
135136 end
136137 end
152153 sh "bundle package"
153154 end
154155
156 desc "Build a binary gem for platform #{plat}"
155157 task plat => ['gem', 'prepare'] do
156158 debug = "FXRUBY_MINGW_DEBUG=#{ENV['FXRUBY_MINGW_DEBUG'].inspect}" if ENV['FXRUBY_MINGW_DEBUG']
157159 RakeCompilerDock.sh <<-EOT, platform: plat
203205 line.gsub! /rb_ensure\(VALUEFUNC\((.*)\), self, VALUEFUNC\((.*)\), self\);/, 'rb_ensure(RUBY_VALUE_METHOD_FUNC(\\1), self, RUBY_VALUE_METHOD_FUNC(\\2), self);'
204206 line.gsub! /rb_rescue\(RUBY_METHOD_FUNC\((.*)\), \(VALUE\)a, RUBY_METHOD_FUNC\((.*)\), 0\)/, 'rb_rescue(RUBY_VALUE_METHOD_FUNC(\\1), (VALUE)a, RUBY_VALUE_METHOD_FUNC(\\2), 0)'
205207
208 # Allow Truffleruby-22.1.0 to compile the sources without fxscintilla.
209 # Unfortunately Truffleruby still fails with various runtime errors.
210 if RUBY_ENGINE == "truffleruby"
211 line.gsub! '#include <ruby.h>', <<-EOT
212 #include <ruby.h>
213 #define rb_define_virtual_variable(x,y,z)
214 EOT
215 line.gsub!('rb_define_class("swig_runtime_data", rb_cObject);', 'rb_define_class("SWIG_RUNTIME_DATA", rb_cObject);')
216 line.gsub! 'rb_define_readonly_variable("$swig_runtime_data_type_pointer" SWIG_RUNTIME_VERSION SWIG_TYPE_TABLE_NAME, &swig_runtime_data_type_pointer);', <<-EOT
217 if (rb_gv_get("$swig_runtime_data_type_pointer" SWIG_RUNTIME_VERSION SWIG_TYPE_TABLE_NAME) == RUBY_Qnil) {
218 rb_gv_set("$swig_runtime_data_type_pointer" SWIG_RUNTIME_VERSION SWIG_TYPE_TABLE_NAME, swig_runtime_data_type_pointer);
219 }
220 EOT
221 end
222
206223 line
207224 end
208225
0 image: Visual Studio 2019
0 image: Visual Studio 2022
11
22 clone_depth: 1
33
44 init:
5 - SET PATH=c:/Ruby%ruby_version%/bin;c:/msys64/%MSYSTEM%/bin;%PATH%
6 - SET RAKEOPT=-rdevkit
5 - SET PATH=c:/Ruby%ruby_version%/bin;%PATH%
76 install:
87 - ps: |
98 if ($env:ruby_version -like "*head*") {
109 $(new-object net.webclient).DownloadFile("https://github.com/oneclick/rubyinstaller2/releases/download/rubyinstaller-head/rubyinstaller-$env:ruby_version.exe", "$pwd/ruby-setup.exe")
11 cmd /c ruby-setup.exe /verysilent /dir=C:/Ruby$env:ruby_version
10 cmd /c ruby-setup.exe /currentuser /verysilent /dir=C:/Ruby$env:ruby_version
1211 }
1312 - ruby --version
1413 - gem --version
1514 - ridk version
16 # Remove gcc-ada and gcc-objc, since they are no longer supported by msys2 and therefore cause a dependency issue
17 - c:/msys64/usr/bin/bash -lc "pacman --noconfirm --remove mingw-w64-i686-gcc-ada mingw-w64-i686-gcc-objc mingw-w64-x86_64-gcc-ada mingw-w64-x86_64-gcc-objc"
18 - c:/msys64/usr/bin/bash -lc "pacman -Syu --noconfirm --ask 20"
19 - c:/msys64/usr/bin/bash -lc "pacman -Su --noconfirm"
20 - c:/msys64/usr/bin/bash -lc "pacman -S --noconfirm --needed ${MINGW_PACKAGE_PREFIX}-fox ${MINGW_PACKAGE_PREFIX}-swig"
15 - ridk enable
16 # Install required packages
17 - c:/msys64/usr/bin/bash -lc "pacman -S --noconfirm --needed ${MINGW_PACKAGE_PREFIX}-pkgconf ${MINGW_PACKAGE_PREFIX}-fox ${MINGW_PACKAGE_PREFIX}-swig ${MINGW_PACKAGE_PREFIX}-gcc"
18 - gcc -v
2119 - swig -version
2220 - gem install bundler --conservative
2321 - bundle config set force_ruby_platform true
2927 environment:
3028 matrix:
3129 - ruby_version: "head-x64"
32 MINGW_PACKAGE_PREFIX: "mingw-w64-x86_64"
33 MSYSTEM: "MINGW64"
3430 - ruby_version: "24"
35 MINGW_PACKAGE_PREFIX: "mingw-w64-i686"
36 MSYSTEM: "MINGW32"
113113 </div>
114114
115115 <div id="footer">
116 Generated on Fri Nov 27 21:11:34 2020 by
117 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
118 0.9.24 (ruby-2.7.2).
116 Generated on Mon Jan 2 11:48:19 2023 by
117 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
118 0.9.28 (ruby-3.1.2).
119119 </div>
120120
121121 </div>
466466 </div>
467467
468468 <div id="footer">
469 Generated on Fri Nov 27 21:11:35 2020 by
470 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
471 0.9.24 (ruby-2.7.2).
469 Generated on Mon Jan 2 11:48:19 2023 by
470 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
471 0.9.28 (ruby-3.1.2).
472472 </div>
473473
474474 </div>
466466 </div>
467467
468468 <div id="footer">
469 Generated on Fri Nov 27 21:11:35 2020 by
470 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
471 0.9.24 (ruby-2.7.2).
469 Generated on Mon Jan 2 11:48:19 2023 by
470 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
471 0.9.28 (ruby-3.1.2).
472472 </div>
473473
474474 </div>
994994 </div>
995995
996996 <div id="footer">
997 Generated on Fri Nov 27 21:11:34 2020 by
998 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
999 0.9.24 (ruby-2.7.2).
997 Generated on Mon Jan 2 11:48:19 2023 by
998 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
999 0.9.28 (ruby-3.1.2).
10001000 </div>
10011001
10021002 </div>
134134 </div>
135135
136136 <div id="footer">
137 Generated on Fri Nov 27 21:11:35 2020 by
138 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
139 0.9.24 (ruby-2.7.2).
137 Generated on Mon Jan 2 11:48:19 2023 by
138 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
139 0.9.28 (ruby-3.1.2).
140140 </div>
141141
142142 </div>
428428 </div>
429429
430430 <div id="footer">
431 Generated on Fri Nov 27 21:11:34 2020 by
432 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
433 0.9.24 (ruby-2.7.2).
431 Generated on Mon Jan 2 11:48:19 2023 by
432 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
433 0.9.28 (ruby-3.1.2).
434434 </div>
435435
436436 </div>
341341 </div>
342342
343343 <div id="footer">
344 Generated on Fri Nov 27 21:11:35 2020 by
345 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
346 0.9.24 (ruby-2.7.2).
344 Generated on Mon Jan 2 11:48:20 2023 by
345 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
346 0.9.28 (ruby-3.1.2).
347347 </div>
348348
349349 </div>
369369
370370
371371 <span class="summary_desc"><div class='inline'>
372 <p>Set this shape&#39;s draggability.</p>
372 <p>Set this shape’s draggability.</p>
373373 </div></span>
374374
375375 </li>
12221222 </h3><div class="docstring">
12231223 <div class="discussion">
12241224
1225 <p>Set this shape&#39;s draggability</p>
1225 <p>Set this shape’s draggability</p>
12261226
12271227
12281228 </div>
19441944 </div>
19451945
19461946 <div id="footer">
1947 Generated on Fri Nov 27 21:11:34 2020 by
1948 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1949 0.9.24 (ruby-2.7.2).
1947 Generated on Mon Jan 2 11:48:19 2023 by
1948 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1949 0.9.28 (ruby-3.1.2).
19501950 </div>
19511951
19521952 </div>
17211721 <span class='kw'>end</span>
17221722
17231723 <span class='comment'># Must have pressed
1724 </span> <span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_flg'>flg</span> <span class='op'>&amp;</span> <span class='const'><span class='object_link'><a href="#FLAG_PRESSED-constant" title="Fox::Canvas::ShapeCanvas::FLAG_PRESSED (constant)">FLAG_PRESSED</a></span></span><span class='rparen'>)</span> <span class='op'>!=</span> <span class='int'>0</span> <span class='comment'># Change selection
1725 </span>
1726 <span class='kw'>if</span> <span class='ivar'>@currentShape</span> <span class='op'>&amp;&amp;</span> <span class='ivar'>@currentShape</span><span class='period'>.</span><span class='id identifier rubyid_enabled?'>enabled?</span>
1724 </span> <span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_flg'>flg</span> <span class='op'>&amp;</span> <span class='const'><span class='object_link'><a href="#FLAG_PRESSED-constant" title="Fox::Canvas::ShapeCanvas::FLAG_PRESSED (constant)">FLAG_PRESSED</a></span></span><span class='rparen'>)</span> <span class='op'>!=</span> <span class='int'>0</span>
1725 <span class='comment'># Change selection
1726 </span> <span class='kw'>if</span> <span class='ivar'>@currentShape</span> <span class='op'>&amp;&amp;</span> <span class='ivar'>@currentShape</span><span class='period'>.</span><span class='id identifier rubyid_enabled?'>enabled?</span>
17271727 <span class='id identifier rubyid_deselectShape'>deselectShape</span><span class='lparen'>(</span><span class='ivar'>@currentShape</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rparen'>)</span>
17281728 <span class='kw'>end</span>
17291729
20202020 </div>
20212021
20222022 <div id="footer">
2023 Generated on Fri Nov 27 21:11:35 2020 by
2024 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2025 0.9.24 (ruby-2.7.2).
2023 Generated on Mon Jan 2 11:48:20 2023 by
2024 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2025 0.9.28 (ruby-3.1.2).
20262026 </div>
20272027
20282028 </div>
516516 </div>
517517
518518 <div id="footer">
519 Generated on Fri Nov 27 21:11:34 2020 by
520 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
521 0.9.24 (ruby-2.7.2).
519 Generated on Mon Jan 2 11:48:19 2023 by
520 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
521 0.9.28 (ruby-3.1.2).
522522 </div>
523523
524524 </div>
280280 </div>
281281
282282 <div id="footer">
283 Generated on Fri Nov 27 21:11:35 2020 by
284 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
285 0.9.24 (ruby-2.7.2).
283 Generated on Mon Jan 2 11:48:20 2023 by
284 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
285 0.9.28 (ruby-3.1.2).
286286 </div>
287287
288288 </div>
598598 </div>
599599
600600 <div id="footer">
601 Generated on Fri Nov 27 21:11:35 2020 by
602 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
603 0.9.24 (ruby-2.7.2).
601 Generated on Mon Jan 2 11:48:19 2023 by
602 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
603 0.9.28 (ruby-3.1.2).
604604 </div>
605605
606606 </div>
8585 <h2>Overview</h2><div class="docstring">
8686 <div class="discussion">
8787
88 <p>The Canvas module defines a framework similar to that provided by Tk&#39;s Canvas widget (and subsequent improvements, such as GNOME&#39;s Canvas and wxWindows&#39; Object Graphics Library).</p>
88 <p>The Canvas module defines a framework similar to that provided by Tk’s Canvas widget (and subsequent improvements, such as GNOME’s Canvas and wxWindows’ Object Graphics Library).</p>
8989
9090 <p>Links</p>
9191
9292 <h5 id="label-"></h5>
9393
94 <p>Tk&#39;s Canvas Widget</p>
94 <p>Tk’s Canvas Widget</p>
9595
9696 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_http'>http</span><span class='symbol'>:/</span><span class='op'>/</span><span class='id identifier rubyid_starship'>starship</span><span class='period'>.</span><span class='id identifier rubyid_python'>python</span><span class='period'>.</span><span class='id identifier rubyid_net'>net</span><span class='op'>/</span><span class='id identifier rubyid_crew'>crew</span><span class='op'>/</span><span class='id identifier rubyid_fredrik'>fredrik</span><span class='op'>/</span><span class='id identifier rubyid_tkmanual'>tkmanual</span><span class='op'>/</span><span class='id identifier rubyid_canvas'>canvas</span><span class='period'>.</span><span class='id identifier rubyid_html'>html</span>
9797 <span class='id identifier rubyid_http'>http</span><span class='symbol'>:/</span><span class='op'>/</span><span class='id identifier rubyid_www'>www</span><span class='period'>.</span><span class='id identifier rubyid_dci'>dci</span><span class='period'>.</span><span class='id identifier rubyid_clrc'>clrc</span><span class='period'>.</span><span class='id identifier rubyid_ac'>ac</span><span class='period'>.</span><span class='id identifier rubyid_uk'>uk</span><span class='op'>/</span><span class='const'>Publications</span><span class='op'>/</span><span class='const'>Cookbook</span><span class='op'>/</span><span class='id identifier rubyid_chap4'>chap4</span><span class='period'>.</span><span class='id identifier rubyid_html'>html</span>
9898 </code></pre>
9999
100 <p>GNOME&#39;s Canvas Widget</p>
100 <p>GNOME’s Canvas Widget</p>
101101
102102 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_http'>http</span><span class='symbol'>:/</span><span class='op'>/</span><span class='id identifier rubyid_developer'>developer</span><span class='period'>.</span><span class='id identifier rubyid_gnome'>gnome</span><span class='period'>.</span><span class='id identifier rubyid_org'>org</span><span class='op'>/</span><span class='id identifier rubyid_doc'>doc</span><span class='op'>/</span><span class='id identifier rubyid_whitepapers'>whitepapers</span><span class='op'>/</span><span class='id identifier rubyid_canvas'>canvas</span><span class='op'>/</span><span class='id identifier rubyid_canvas'>canvas</span><span class='period'>.</span><span class='id identifier rubyid_html'>html</span>
103103 </code></pre>
130130 </div>
131131
132132 <div id="footer">
133 Generated on Fri Nov 27 21:10:34 2020 by
134 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
135 0.9.24 (ruby-2.7.2).
133 Generated on Mon Jan 2 11:47:22 2023 by
134 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
135 0.9.28 (ruby-3.1.2).
136136 </div>
137137
138138 </div>
539539 </div>
540540
541541 <div id="footer">
542 Generated on Fri Nov 27 21:10:34 2020 by
543 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
544 0.9.24 (ruby-2.7.2).
542 Generated on Mon Jan 2 11:47:22 2023 by
543 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
544 0.9.28 (ruby-3.1.2).
545545 </div>
546546
547547 </div>
13251325 </div>
13261326
13271327 <div id="footer">
1328 Generated on Fri Nov 27 21:10:59 2020 by
1329 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1330 0.9.24 (ruby-2.7.2).
1328 Generated on Mon Jan 2 11:47:46 2023 by
1329 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1330 0.9.28 (ruby-3.1.2).
13311331 </div>
13321332
13331333 </div>
999999 </div>
10001000
10011001 <div id="footer">
1002 Generated on Fri Nov 27 21:10:52 2020 by
1003 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1004 0.9.24 (ruby-2.7.2).
1002 Generated on Mon Jan 2 11:47:39 2023 by
1003 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1004 0.9.28 (ruby-3.1.2).
10051005 </div>
10061006
10071007 </div>
393393 <span class='const'>FXSEL</span><span class='lparen'>(</span><span class='const'>SEL_COMMAND</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="FXWindow.html" title="Fox::FXWindow (class)">FXWindow</a></span></span><span class='op'>::</span><span class='const'>ID_SHOW</span><span class='rparen'>)</span><span class='rparen'>)</span>
394394 </code></pre>
395395
396 <p>The problem with this form is that you need to be familiar with the message types and identifiers that different widgets respond to, and this information isn&#39;t very well documented. A more straightforward way to use <em>addAccel</em> from Ruby code is to instead pass one or more callable objects in as the second and third arguments. For example:</p>
396 <p>The problem with this form is that you need to be familiar with the message types and identifiers that different widgets respond to, and this information isn’t very well documented. A more straightforward way to use <em>addAccel</em> from Ruby code is to instead pass one or more callable objects in as the second and third arguments. For example:</p>
397397
398398 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_accelTable'>accelTable</span><span class='period'>.</span><span class='id identifier rubyid_addAccel'>addAccel</span><span class='lparen'>(</span><span class='id identifier rubyid_hotKey'>hotKey</span><span class='comma'>,</span> <span class='id identifier rubyid_lambda'>lambda</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_window'>window</span><span class='period'>.</span><span class='id identifier rubyid_hide'>hide</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
399399 </code></pre>
472472 <span class='id identifier rubyid_selup'>selup</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>2</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>&gt;</span> <span class='int'>2</span>
473473 <span class='kw'>end</span>
474474 <span class='kw'>end</span>
475 <span class='kw'>end</span> <span class='comment'># FIXME: The target objects stored in the accelerator table are currently
475 <span class='kw'>end</span>
476 <span class='comment'># FIXME: The target objects stored in the accelerator table are currently
476477 </span> <span class='comment'># private. Therefore FXRbAccelTable::markfunc() doesn&#39;t mark them as used.
477478 </span> <span class='comment'># As a workaround the objects are additionally stored in @targets Hash.
478 </span>
479 <span class='ivar'>@targets</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='kw'>unless</span> <span class='id identifier rubyid_instance_variable_defined?'>instance_variable_defined?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>@targets</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
479 </span> <span class='ivar'>@targets</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='kw'>unless</span> <span class='id identifier rubyid_instance_variable_defined?'>instance_variable_defined?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>@targets</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
480480 <span class='ivar'>@targets</span><span class='lbracket'>[</span><span class='id identifier rubyid_hotKey'>hotKey</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_tgt'>tgt</span>
481481 <span class='id identifier rubyid_addAccelOrig'>addAccelOrig</span><span class='lparen'>(</span><span class='id identifier rubyid_hotKey'>hotKey</span><span class='comma'>,</span> <span class='id identifier rubyid_tgt'>tgt</span><span class='comma'>,</span> <span class='id identifier rubyid_seldn'>seldn</span><span class='comma'>,</span> <span class='id identifier rubyid_selup'>selup</span><span class='rparen'>)</span>
482482 <span class='kw'>end</span></pre>
704704 </div>
705705
706706 <div id="footer">
707 Generated on Fri Nov 27 21:11:14 2020 by
708 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
709 0.9.24 (ruby-2.7.2).
707 Generated on Mon Jan 2 11:48:00 2023 by
708 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
709 0.9.28 (ruby-3.1.2).
710710 </div>
711711
712712 </div>
109109
110110 <h3 id="label-Events">Events</h3>
111111
112 <p>The FXApp object itself doesn&#39;t have a designated message target like other FOX objects, but it can send messages to objects for a few special events.</p>
112 <p>The FXApp object itself doesn’t have a designated message target like other FOX objects, but it can send messages to objects for a few special events.</p>
113113 <dl class="rdoc-list label-list"><dt><strong>Timers</strong>
114114 <dd>
115115 <p>When a timeout event is registered with the application using the addTimeout method, a <code>SEL_TIMEOUT</code> message is sent to the message target.</p>
11391139
11401140
11411141 <span class="summary_desc"><div class='inline'>
1142 <p>Amount of time (in milliseconds) to yield to Ruby&#39;s thread scheduler [Integer].</p>
1142 <p>Amount of time (in milliseconds) to yield to Ruby’s thread scheduler [Integer].</p>
11431143 </div></span>
11441144
11451145 </li>
13011301
13021302
13031303 <span class="summary_desc"><div class='inline'>
1304 <p>Typing speed used for the FXIconList, FXList and FXTreeList widgets&#39; lookup features, in milliseconds.</p>
1304 <p>Typing speed used for the FXIconList, FXList and FXTreeList widgets’ lookup features, in milliseconds.</p>
13051305 </div></span>
13061306
13071307 </li>
16941694
16951695
16961696 <span class="summary_desc"><div class='inline'>
1697 <p>Changes the default application cursor to an hourglass shape, to provide a visual cue to the user that it&#39;s time to wait.</p>
1697 <p>Changes the default application cursor to an hourglass shape, to provide a visual cue to the user that it’s time to wait.</p>
16981698 </div></span>
16991699
17001700 </li>
17661766
17671767
17681768 <span class="summary_desc"><div class='inline'>
1769 <p>Create application&#39;s windows.</p>
1769 <p>Create application’s windows.</p>
17701770 </div></span>
17711771
17721772 </li>
17901790
17911791
17921792 <span class="summary_desc"><div class='inline'>
1793 <p>Destroy application&#39;s windows.</p>
1793 <p>Destroy application’s windows.</p>
17941794 </div></span>
17951795
17961796 </li>
18141814
18151815
18161816 <span class="summary_desc"><div class='inline'>
1817 <p>Detach application&#39;s windows.</p>
1817 <p>Detach application’s windows.</p>
18181818 </div></span>
18191819
18201820 </li>
22482248
22492249
22502250 <span class="summary_desc"><div class='inline'>
2251 <p>Construct application object; the <em>appName</em> and <em>vendorName</em> strings are used as keys into the registry database for this application&#39;s settings.</p>
2251 <p>Construct application object; the <em>appName</em> and <em>vendorName</em> strings are used as keys into the registry database for this application’s settings.</p>
22522252 </div></span>
22532253
22542254 </li>
22722272
22732273
22742274 <span class="summary_desc"><div class='inline'>
2275 <p>Construct application object; the <em>appName</em> and <em>vendorName</em> strings are used as keys into the registry database for this application&#39;s settings.</p>
2275 <p>Construct application object; the <em>appName</em> and <em>vendorName</em> strings are used as keys into the registry database for this application’s settings.</p>
22762276 </div></span>
22772277
22782278 </li>
23922392
23932393
23942394 <span class="summary_desc"><div class='inline'>
2395 <p>Peek to determine if there&#39;s an event.</p>
2395 <p>Peek to determine if there’s an event.</p>
23962396 </div></span>
23972397
23982398 </li>
31233123 </h3><div class="docstring">
31243124 <div class="discussion">
31253125
3126 <p>Construct application object; the <em>appName</em> and <em>vendorName</em> strings are used as keys into the registry database for this application&#39;s settings. Only one single application object can be constructed.</p>
3126 <p>Construct application object; the <em>appName</em> and <em>vendorName</em> strings are used as keys into the registry database for this application’s settings. Only one single application object can be constructed.</p>
31273127
31283128
31293129 </div>
45024502 </h3><div class="docstring">
45034503 <div class="discussion">
45044504
4505 <p>Amount of time (in milliseconds) to yield to Ruby&#39;s thread scheduler [Integer]</p>
4505 <p>Amount of time (in milliseconds) to yield to Ruby’s thread scheduler [Integer]</p>
45064506
45074507
45084508 </div>
47604760 </h3><div class="docstring">
47614761 <div class="discussion">
47624762
4763 <p>Typing speed used for the FXIconList, FXList and FXTreeList widgets&#39; lookup features, in milliseconds. Default value is 1000 milliseconds.</p>
4763 <p>Typing speed used for the FXIconList, FXList and FXTreeList widgets’ lookup features, in milliseconds. Default value is 1000 milliseconds.</p>
47644764
47654765
47664766 </div>
55745574 </h3><div class="docstring">
55755575 <div class="discussion">
55765576
5577 <p>Changes the default application cursor to an hourglass shape, to provide a visual cue to the user that it&#39;s time to wait. To revert the default application cursor to its normal shape, call the #endWaitCursor method. For example,</p>
5577 <p>Changes the default application cursor to an hourglass shape, to provide a visual cue to the user that it’s time to wait. To revert the default application cursor to its normal shape, call the #endWaitCursor method. For example,</p>
55785578
55795579 <pre class="code ruby"><code class="ruby">getApp().beginWaitCursor()
55805580 ... time-consuming operation ...
57185718 </h3><div class="docstring">
57195719 <div class="discussion">
57205720
5721 <p>Create application&#39;s windows</p>
5721 <p>Create application’s windows</p>
57225722
57235723
57245724 </div>
57555755 </h3><div class="docstring">
57565756 <div class="discussion">
57575757
5758 <p>Destroy application&#39;s windows</p>
5758 <p>Destroy application’s windows</p>
57595759
57605760
57615761 </div>
57925792 </h3><div class="docstring">
57935793 <div class="discussion">
57945794
5795 <p>Detach application&#39;s windows</p>
5795 <p>Detach application’s windows</p>
57965796
57975797
57985798 </div>
62536253 <pre class="code ruby"><code class="ruby">chore = app.addChore { ... }
62546254 </code></pre>
62556255
6256 <p>but decide that you want to “cancel” that chore later (before it&#39;s had a chance to run):</p>
6256 <p>but decide that you want to “cancel” that chore later (before it’s had a chance to run):</p>
62576257
62586258 <pre class="code ruby"><code class="ruby"><span class='kw'>if</span> <span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_hasChore?'>hasChore?</span><span class='lparen'>(</span><span class='id identifier rubyid_chore'>chore</span><span class='rparen'>)</span>
62596259 <span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_removeChore'>removeChore</span><span class='lparen'>(</span><span class='id identifier rubyid_chore'>chore</span><span class='rparen'>)</span>
64166416 <pre class="code ruby"><code class="ruby">timeout = app.addTimeout(10*1000, ...)
64176417 </code></pre>
64186418
6419 <p>but in the meantime, you decide that you want to cancel it if it hasn&#39;t run yet:</p>
6419 <p>but in the meantime, you decide that you want to cancel it if it hasn’t run yet:</p>
64206420
64216421 <pre class="code ruby"><code class="ruby"><span class='kw'>if</span> <span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_hasTimeout?'>hasTimeout?</span><span class='lparen'>(</span><span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
64226422 <span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_removeTimeout'>removeTimeout</span><span class='lparen'>(</span><span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
65596559 </h3><div class="docstring">
65606560 <div class="discussion">
65616561
6562 <p>Construct application object; the <em>appName</em> and <em>vendorName</em> strings are used as keys into the registry database for this application&#39;s settings. Only one single application object can be constructed. :nodoc:</p>
6562 <p>Construct application object; the <em>appName</em> and <em>vendorName</em> strings are used as keys into the registry database for this application’s settings. Only one single application object can be constructed. :nodoc:</p>
65636563
65646564
65656565 </div>
67906790 </h3><div class="docstring">
67916791 <div class="discussion">
67926792
6793 <p>Peek to determine if there&#39;s an event.</p>
6793 <p>Peek to determine if there’s an event.</p>
67946794
67956795
67966796 </div>
79877987 </div>
79887988
79897989 <div id="footer">
7990 Generated on Fri Nov 27 21:10:35 2020 by
7991 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
7992 0.9.24 (ruby-2.7.2).
7990 Generated on Mon Jan 2 11:47:23 2023 by
7991 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
7992 0.9.28 (ruby-3.1.2).
79937993 </div>
79947994
79957995 </div>
137137
138138
139139 <span class="summary_desc"><div class='inline'>
140 <p>Start of the arc, relative to the three-o&#39;clock position from the center, in units of degrees * 64 [Integer].</p>
140 <p>Start of the arc, relative to the three-o’clock position from the center, in units of degrees * 64 [Integer].</p>
141141 </div></span>
142142
143143 </li>
164164
165165
166166 <span class="summary_desc"><div class='inline'>
167 <p>Path and extent of the arc, relative to the three-o&#39;clock position from the center, in units of degrees * 64 [Integer].</p>
167 <p>Path and extent of the arc, relative to the three-o’clock position from the center, in units of degrees * 64 [Integer].</p>
168168 </div></span>
169169
170170 </li>
301301 </h3><div class="docstring">
302302 <div class="discussion">
303303
304 <p>Start of the arc, relative to the three-o&#39;clock position from the center, in units of degrees * 64 [Integer]</p>
304 <p>Start of the arc, relative to the three-o’clock position from the center, in units of degrees * 64 [Integer]</p>
305305
306306
307307 </div>
344344 </h3><div class="docstring">
345345 <div class="discussion">
346346
347 <p>Path and extent of the arc, relative to the three-o&#39;clock position from the center, in units of degrees * 64 [Integer]</p>
347 <p>Path and extent of the arc, relative to the three-o’clock position from the center, in units of degrees * 64 [Integer]</p>
348348
349349
350350 </div>
551551 </div>
552552
553553 <div id="footer">
554 Generated on Fri Nov 27 21:10:34 2020 by
555 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
556 0.9.24 (ruby-2.7.2).
554 Generated on Mon Jan 2 11:47:22 2023 by
555 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
556 0.9.28 (ruby-3.1.2).
557557 </div>
558558
559559 </div>
854854 </div>
855855
856856 <div id="footer">
857 Generated on Fri Nov 27 21:11:20 2020 by
858 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
859 0.9.24 (ruby-2.7.2).
857 Generated on Mon Jan 2 11:48:06 2023 by
858 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
859 0.9.28 (ruby-3.1.2).
860860 </div>
861861
862862 </div>
439439 </div>
440440
441441 <div id="footer">
442 Generated on Fri Nov 27 21:10:46 2020 by
443 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
444 0.9.24 (ruby-2.7.2).
442 Generated on Mon Jan 2 11:47:33 2023 by
443 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
444 0.9.28 (ruby-3.1.2).
445445 </div>
446446
447447 </div>
423423 </div>
424424
425425 <div id="footer">
426 Generated on Fri Nov 27 21:10:52 2020 by
427 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
428 0.9.24 (ruby-2.7.2).
426 Generated on Mon Jan 2 11:47:39 2023 by
427 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
428 0.9.28 (ruby-3.1.2).
429429 </div>
430430
431431 </div>
13511351 </div>
13521352
13531353 <div id="footer">
1354 Generated on Fri Nov 27 21:10:41 2020 by
1355 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1356 0.9.24 (ruby-2.7.2).
1354 Generated on Mon Jan 2 11:47:28 2023 by
1355 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1356 0.9.28 (ruby-3.1.2).
13571357 </div>
13581358
13591359 </div>
584584 </div>
585585
586586 <div id="footer">
587 Generated on Fri Nov 27 21:11:20 2020 by
588 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
589 0.9.24 (ruby-2.7.2).
587 Generated on Mon Jan 2 11:48:06 2023 by
588 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
589 0.9.28 (ruby-3.1.2).
590590 </div>
591591
592592 </div>
14401440 </div>
14411441
14421442 <div id="footer">
1443 Generated on Fri Nov 27 21:11:14 2020 by
1444 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1445 0.9.24 (ruby-2.7.2).
1443 Generated on Mon Jan 2 11:48:01 2023 by
1444 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1445 0.9.28 (ruby-3.1.2).
14461446 </div>
14471447
14481448 </div>
523523 </div>
524524
525525 <div id="footer">
526 Generated on Fri Nov 27 21:10:41 2020 by
527 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
528 0.9.24 (ruby-2.7.2).
526 Generated on Mon Jan 2 11:47:28 2023 by
527 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
528 0.9.28 (ruby-3.1.2).
529529 </div>
530530
531531 </div>
250250 </div>
251251
252252 <div id="footer">
253 Generated on Fri Nov 27 21:10:59 2020 by
254 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
255 0.9.24 (ruby-2.7.2).
253 Generated on Mon Jan 2 11:47:46 2023 by
254 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
255 0.9.28 (ruby-3.1.2).
256256 </div>
257257
258258 </div>
869869 </div>
870870
871871 <div id="footer">
872 Generated on Fri Nov 27 21:11:36 2020 by
873 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
874 0.9.24 (ruby-2.7.2).
872 Generated on Mon Jan 2 11:48:21 2023 by
873 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
874 0.9.28 (ruby-3.1.2).
875875 </div>
876876
877877 </div>
300300 </div>
301301
302302 <div id="footer">
303 Generated on Fri Nov 27 21:10:41 2020 by
304 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
305 0.9.24 (ruby-2.7.2).
303 Generated on Mon Jan 2 11:47:29 2023 by
304 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
305 0.9.28 (ruby-3.1.2).
306306 </div>
307307
308308 </div>
938938 </div>
939939
940940 <div id="footer">
941 Generated on Fri Nov 27 21:11:21 2020 by
942 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
943 0.9.24 (ruby-2.7.2).
941 Generated on Mon Jan 2 11:48:07 2023 by
942 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
943 0.9.28 (ruby-3.1.2).
944944 </div>
945945
946946 </div>
331331 </h3><div class="docstring">
332332 <div class="discussion">
333333
334 <p>Construct choice box with given caption, icon, message text, and with choices from array of strings. If <em>owner</em> is another FXWindow, the dialog box is created as a child of that window. If <em>owner</em> is an FXApp instance, it&#39;s created as a free-floating dialog box.</p>
334 <p>Construct choice box with given caption, icon, message text, and with choices from array of strings. If <em>owner</em> is another FXWindow, the dialog box is created as a child of that window. If <em>owner</em> is an FXApp instance, it’s created as a free-floating dialog box.</p>
335335
336336 <h4 id="label-Parameters-3A">Parameters:</h4>
337337 <dl class="rdoc-list note-list"><dt><code>owner</code>
461461 </div>
462462
463463 <div id="footer">
464 Generated on Fri Nov 27 21:11:00 2020 by
465 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
466 0.9.24 (ruby-2.7.2).
464 Generated on Mon Jan 2 11:47:47 2023 by
465 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
466 0.9.28 (ruby-3.1.2).
467467 </div>
468468
469469 </div>
15081508 </div>
15091509
15101510 <div id="footer">
1511 Generated on Fri Nov 27 21:11:35 2020 by
1512 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1513 0.9.24 (ruby-2.7.2).
1511 Generated on Mon Jan 2 11:48:20 2023 by
1512 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1513 0.9.28 (ruby-3.1.2).
15141514 </div>
15151515
15161516 </div>
748748 </div>
749749
750750 <div id="footer">
751 Generated on Fri Nov 27 21:10:52 2020 by
752 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
753 0.9.24 (ruby-2.7.2).
751 Generated on Mon Jan 2 11:47:39 2023 by
752 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
753 0.9.28 (ruby-3.1.2).
754754 </div>
755755
756756 </div>
124124 <p>The following messages are sent by FXColorDialog to its target:</p>
125125 <dl class="rdoc-list note-list"><dt><code>SEL_CHANGED</code>
126126 <dd>
127 <p>sent continuously, while the color selector&#39;s color is changing</p>
127 <p>sent continuously, while the color selector’s color is changing</p>
128128 </dd><dt><code>SEL_COMMAND</code>
129129 <dd>
130130 <p>sent when the new color is set</p>
580580 </div>
581581
582582 <div id="footer">
583 Generated on Fri Nov 27 21:11:22 2020 by
584 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
585 0.9.24 (ruby-2.7.2).
583 Generated on Mon Jan 2 11:48:07 2023 by
584 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
585 0.9.28 (ruby-3.1.2).
586586 </div>
587587
588588 </div>
312312 </div>
313313
314314 <div id="footer">
315 Generated on Fri Nov 27 21:11:00 2020 by
316 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
317 0.9.24 (ruby-2.7.2).
315 Generated on Mon Jan 2 11:47:47 2023 by
316 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
317 0.9.28 (ruby-3.1.2).
318318 </div>
319319
320320 </div>
701701 </div>
702702
703703 <div id="footer">
704 Generated on Fri Nov 27 21:11:00 2020 by
705 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
706 0.9.24 (ruby-2.7.2).
704 Generated on Mon Jan 2 11:47:47 2023 by
705 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
706 0.9.28 (ruby-3.1.2).
707707 </div>
708708
709709 </div>
806806 </div>
807807
808808 <div id="footer">
809 Generated on Fri Nov 27 21:11:00 2020 by
810 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
811 0.9.24 (ruby-2.7.2).
809 Generated on Mon Jan 2 11:47:47 2023 by
810 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
811 0.9.28 (ruby-3.1.2).
812812 </div>
813813
814814 </div>
785785 </div>
786786
787787 <div id="footer">
788 Generated on Fri Nov 27 21:11:31 2020 by
789 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
790 0.9.24 (ruby-2.7.2).
788 Generated on Mon Jan 2 11:48:16 2023 by
789 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
790 0.9.28 (ruby-3.1.2).
791791 </div>
792792
793793 </div>
111111 <h2>Overview</h2><div class="docstring">
112112 <div class="discussion">
113113
114 <p>A Color Well is a widget which controls color settings. Colors may be dragged and dropped from one color well to another. A double-click inside a color well will bring up the standard color dialog panel to edit the color well&#39;s color. Colors may be also pasted by name using middle-mouse click into/out of color wells from/to other selection-capable applications; for example, you can highlight the word `red&#39; and paste it into a color well.</p>
114 <p>A Color Well is a widget which controls color settings. Colors may be dragged and dropped from one color well to another. A double-click inside a color well will bring up the standard color dialog panel to edit the color well’s color. Colors may be also pasted by name using middle-mouse click into/out of color wells from/to other selection-capable applications; for example, you can highlight the word ‘red’ and paste it into a color well.</p>
115115
116116 <h3 id="label-Events">Events</h3>
117117
809809 </h3><div class="docstring">
810810 <div class="discussion">
811811
812 <p>Set the color for this color well to <em>clr</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_COMMAND</code> message is sent to the color well&#39;s message target after the color is changed.</p>
812 <p>Set the color for this color well to <em>clr</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_COMMAND</code> message is sent to the color well’s message target after the color is changed.</p>
813813
814814
815815 </div>
839839 </div>
840840
841841 <div id="footer">
842 Generated on Fri Nov 27 21:11:01 2020 by
843 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
844 0.9.24 (ruby-2.7.2).
842 Generated on Mon Jan 2 11:47:48 2023 by
843 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
844 0.9.28 (ruby-3.1.2).
845845 </div>
846846
847847 </div>
759759 </div>
760760
761761 <div id="footer">
762 Generated on Fri Nov 27 21:11:14 2020 by
763 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
764 0.9.24 (ruby-2.7.2).
762 Generated on Mon Jan 2 11:48:01 2023 by
763 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
764 0.9.28 (ruby-3.1.2).
765765 </div>
766766
767767 </div>
690690
691691
692692 <span class="summary_desc"><div class='inline'>
693 <p>Calls block once for each item in the list, passing the item&#39;s text and user data as parameters.</p>
693 <p>Calls block once for each item in the list, passing the item’s text and user data as parameters.</p>
694694 </div></span>
695695
696696 </li>
21052105 </h3><div class="docstring">
21062106 <div class="discussion">
21072107
2108 <p>Calls block once for each item in the list, passing the item&#39;s text and user data as parameters.</p>
2108 <p>Calls block once for each item in the list, passing the item’s text and user data as parameters.</p>
21092109
21102110
21112111 </div>
27132713 </h3><div class="docstring">
27142714 <div class="discussion">
27152715
2716 <p>Set current item to <em>index</em>, where <em>index</em> is the zero-based index of the item. If <em>notify</em> is <code>true</code>, a <code>SEL_COMMAND</code> message is sent to the combo box&#39;s message target.</p>
2716 <p>Set current item to <em>index</em>, where <em>index</em> is the zero-based index of the item. If <em>notify</em> is <code>true</code>, a <code>SEL_COMMAND</code> message is sent to the combo box’s message target.</p>
27172717
27182718
27192719 </div>
29282928 </div>
29292929
29302930 <div id="footer">
2931 Generated on Fri Nov 27 21:10:52 2020 by
2932 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2933 0.9.24 (ruby-2.7.2).
2931 Generated on Mon Jan 2 11:47:40 2023 by
2932 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2933 0.9.28 (ruby-3.1.2).
29342934 </div>
29352935
29362936 </div>
533533 </div>
534534
535535 <div id="footer">
536 Generated on Fri Nov 27 21:11:34 2020 by
537 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
538 0.9.24 (ruby-2.7.2).
536 Generated on Mon Jan 2 11:48:19 2023 by
537 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
538 0.9.28 (ruby-3.1.2).
539539 </div>
540540
541541 </div>
101101 <h2>Overview</h2><div class="docstring">
102102 <div class="discussion">
103103
104 <p>FXCommand is an “abstract” base class for your application&#39;s commands. At a minimum, your concrete subclasses of FXCommand should implement the #undo, #redo, #undoName, and #redoName methods.</p>
104 <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>
105105
106106
107107 </div>
515515 </div>
516516
517517 <div id="footer">
518 Generated on Fri Nov 27 21:11:36 2020 by
519 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
520 0.9.24 (ruby-2.7.2).
518 Generated on Mon Jan 2 11:48:21 2023 by
519 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
520 0.9.28 (ruby-3.1.2).
521521 </div>
522522
523523 </div>
116116 <p>The following messages are sent from FXComposite to its target:</p>
117117 <dl class="rdoc-list note-list"><dt><code>SEL_KEYPRESS</code>
118118 <dd>
119 <p>sent when a key goes down, but only if there is no other widget with the focus (or if the focused widget doesn&#39;t handle this keypress). The message data is an FXEvent instance.</p>
119 <p>sent when a key goes down, but only if there is no other widget with the focus (or if the focused widget doesn’t handle this keypress). The message data is an FXEvent instance.</p>
120120 </dd><dt><code>SEL_KEYRELEASE</code>
121121 <dd>
122 <p>sent when a key goes up, but only if there is no other widget with the focus (or if the focused widget doesn&#39;t handle this key release). The message data is an FXEvent instance.</p>
122 <p>sent when a key goes up, but only if there is no other widget with the focus (or if the focused widget doesn’t handle this key release). The message data is an FXEvent instance.</p>
123123 </dd></dl>
124124
125125
422422 </div>
423423
424424 <div id="footer">
425 Generated on Fri Nov 27 21:11:01 2020 by
426 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
427 0.9.24 (ruby-2.7.2).
425 Generated on Mon Jan 2 11:47:48 2023 by
426 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
427 0.9.28 (ruby-3.1.2).
428428 </div>
429429
430430 </div>
768768 </div>
769769
770770 <div id="footer">
771 Generated on Fri Nov 27 21:10:41 2020 by
772 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
773 0.9.24 (ruby-2.7.2).
771 Generated on Mon Jan 2 11:47:29 2023 by
772 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
773 0.9.28 (ruby-3.1.2).
774774 </div>
775775
776776 </div>
171171 <h3 id="label-Line+Cap+Styles">Line Cap Styles</h3>
172172 <dl class="rdoc-list note-list"><dt><code>CAP_NOT_LAST</code>
173173 <dd>
174 <p>Don&#39;t include last end cap</p>
174 <p>Don’t include last end cap</p>
175175 </dd><dt><code>CAP_BUTT</code>
176176 <dd>
177177 <p>Butting line end caps</p>
32033203 </h3><div class="docstring">
32043204 <div class="discussion">
32053205
3206 <p>Draw an arc. The argument <em>start</em> specifies the start of the arc relative to the three-o&#39;clock position from the center, in units of degrees*64. The argument <em>extent</em> specifies the path and extent of the arc, relative to the start of the arc (also in units of degrees*64). The arguments <em>x</em>, <em>y</em>, <em>w</em>, and <em>h</em> specify the bounding rectangle of the arc.</p>
3206 <p>Draw an arc. The argument <em>start</em> specifies the start of the arc relative to the three-o’clock position from the center, in units of degrees*64. The argument <em>extent</em> specifies the path and extent of the arc, relative to the start of the arc (also in units of degrees*64). The arguments <em>x</em>, <em>y</em>, <em>w</em>, and <em>h</em> specify the bounding rectangle of the arc.</p>
32073207
32083208 <h3 id="label-Parameters-3A">Parameters:</h3>
32093209 <dl class="rdoc-list note-list"><dt><code>x</code>
34283428
34293429 <h3 id="label-Parameters-3A">Parameters:</h3>
34303430
3431 <p><code>x</code>:: x-coordinate of the circle&#39;s center [Integer] <code>y</code>:: y-coordinate of the circle&#39;s center [Integer] <code>r</code>:: radius of the circle, in pixels [Integer]</p>
3431 <p><code>x</code>:: x-coordinate of the circle’s center [Integer] <code>y</code>:: y-coordinate of the circle’s center [Integer] <code>r</code>:: radius of the circle, in pixels [Integer]</p>
34323432
34333433 <p>See also #fillCircle.</p>
34343434
39163916 </h3><div class="docstring">
39173917 <div class="discussion">
39183918
3919 <p>Draw connected lines, where <em>points</em> is an array of FXPoint instances. The number of lines drawn is equal to the size of the <em>points</em> array minus one. Treats all points&#39; coordinates as relative to the origin.</p>
3919 <p>Draw connected lines, where <em>points</em> is an array of FXPoint instances. The number of lines drawn is equal to the size of the <em>points</em> array minus one. Treats all points’ coordinates as relative to the origin.</p>
39203920
39213921 <h4 id="label-Parameters-3A">Parameters:</h4>
39223922 <dl class="rdoc-list note-list"><dt><code>points</code>
40044004 </h3><div class="docstring">
40054005 <div class="discussion">
40064006
4007 <p>Draw connected lines, where <em>points</em> is an array of FXPoint instances. The number of lines drawn is equal to the size of the <em>points</em> array minus one. Treats each point&#39;s coordinates (after the first) as relative to the previous point.</p>
4007 <p>Draw connected lines, where <em>points</em> is an array of FXPoint instances. The number of lines drawn is equal to the size of the <em>points</em> array minus one. Treats each point’s coordinates (after the first) as relative to the previous point.</p>
40084008
40094009 <h4 id="label-Parameters-3A">Parameters:</h4>
40104010 <dl class="rdoc-list note-list"><dt><code>points</code>
45504550
45514551 <h3 id="label-Parameters-3A">Parameters:</h3>
45524552
4553 <p><code>x</code>:: x-coordinate of the circle&#39;s center [Integer] <code>y</code>:: y-coordinate of the circle&#39;s center [Integer] <code>r</code>:: radius of the circle, in pixels [Integer]</p>
4553 <p><code>x</code>:: x-coordinate of the circle’s center [Integer] <code>y</code>:: y-coordinate of the circle’s center [Integer] <code>r</code>:: radius of the circle, in pixels [Integer]</p>
45544554
45554555 <p>See also #drawCircle.</p>
45564556
52205220 </div>
52215221
52225222 <div id="footer">
5223 Generated on Fri Nov 27 21:10:35 2020 by
5224 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
5225 0.9.24 (ruby-2.7.2).
5223 Generated on Mon Jan 2 11:47:22 2023 by
5224 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
5225 0.9.28 (ruby-3.1.2).
52265226 </div>
52275227
52285228 </div>
685685 </div>
686686
687687 <div id="footer">
688 Generated on Fri Nov 27 21:10:46 2020 by
689 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
690 0.9.24 (ruby-2.7.2).
688 Generated on Mon Jan 2 11:47:33 2023 by
689 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
690 0.9.28 (ruby-3.1.2).
691691 </div>
692692
693693 </div>
347347 </div>
348348
349349 <div id="footer">
350 Generated on Fri Nov 27 21:10:52 2020 by
351 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
352 0.9.24 (ruby-2.7.2).
350 Generated on Mon Jan 2 11:47:40 2023 by
351 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
352 0.9.28 (ruby-3.1.2).
353353 </div>
354354
355355 </div>
116116 <span class='id identifier rubyid_textfield'>textfield</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="FXTextField.html" title="Fox::FXTextField (class)">FXTextField</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="FXTextField.html#initialize-instance_method" title="Fox::FXTextField#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_p'>p</span><span class='comma'>,</span> <span class='int'>12</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='const'>FXDataTarget</span><span class='op'>::</span><span class='const'>ID_VALUE</span><span class='rparen'>)</span>
117117 </code></pre>
118118
119 <p>Data targets also allow connecting other kinds of widgets (like FXRadioButton and FXMenuCommand) to a variable. In this case, the new value of the connected variable is computed by subtracting <code>FXDataTarget::ID_OPTION</code> from the message identifier. For example, to tie a group of radio buttons to a single data target&#39;s value (so that the buttons are mutually exclusive), use code like this:</p>
119 <p>Data targets also allow connecting other kinds of widgets (like FXRadioButton and FXMenuCommand) to a variable. In this case, the new value of the connected variable is computed by subtracting <code>FXDataTarget::ID_OPTION</code> from the message identifier. For example, to tie a group of radio buttons to a single data target’s value (so that the buttons are mutually exclusive), use code like this:</p>
120120
121121 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'>FXDataTarget</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Fox::FXDataTarget#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='int'>0</span><span class='rparen'>)</span>
122122 <span class='id identifier rubyid_radio1'>radio1</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="FXRadioButton.html" title="Fox::FXRadioButton (class)">FXRadioButton</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="FXRadioButton.html#initialize-instance_method" title="Fox::FXRadioButton#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_p'>p</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1st choice</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='const'>FXDataTarget</span><span class='op'>::</span><span class='const'>ID_OPTION</span><span class='rparen'>)</span>
124124 <span class='id identifier rubyid_radio3'>radio3</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="FXRadioButton.html" title="Fox::FXRadioButton (class)">FXRadioButton</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="FXRadioButton.html#initialize-instance_method" title="Fox::FXRadioButton#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_p'>p</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>3rd choice</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='const'>FXDataTarget</span><span class='op'>::</span><span class='const'>ID_OPTION</span> <span class='op'>+</span> <span class='int'>2</span><span class='rparen'>)</span>
125125 </code></pre>
126126
127 <p>Note that if you&#39;d like the data target to “forward” its <code>SEL_COMMAND</code> or <code>SEL_CHANGED</code> to some other target object after it has updated the data target value, you can do that just as you would for any other widget. For example, continuing the previous code snippet:</p>
127 <p>Note that if you’d like the data target to “forward” its <code>SEL_COMMAND</code> or <code>SEL_CHANGED</code> to some other target object after it has updated the data target value, you can do that just as you would for any other widget. For example, continuing the previous code snippet:</p>
128128
129129 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_connect'>connect</span><span class='lparen'>(</span><span class='const'>SEL_COMMAND</span><span class='rparen'>)</span> <span class='lbrace'>{</span>
130130 <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The new data target value is </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
148148 <p>Causes the FXDataTarget to ask sender for value</p>
149149 </dd><dt><code>ID_OPTION</code>
150150 <dd>
151 <p><code>ID_OPTION</code>+<em>i</em> will set the value to <em>i</em>, where -10000 &lt;= <em>i</em> &lt;= 10000</p>
151 <p><code>ID_OPTION+</code><em>i</em> will set the value to <em>i</em>, where -10000 &lt;= <em>i</em> &lt;= 10000</p>
152152 </dd></dl>
153153
154154
239239
240240
241241 <span class="summary_desc"><div class='inline'>
242 <p>The data target&#39;s current value [Object].</p>
242 <p>The data target’s current value [Object].</p>
243243 </div></span>
244244
245245 </li>
302302
303303
304304 <span class="summary_desc"><div class='inline'>
305 <p>Returns the stringified representation of this data target&#39;s value.</p>
305 <p>Returns the stringified representation of this data target’s value.</p>
306306 </div></span>
307307
308308 </li>
480480 </h3><div class="docstring">
481481 <div class="discussion">
482482
483 <p>The data target&#39;s current value [Object]</p>
483 <p>The data target’s current value [Object]</p>
484484
485485
486486 </div>
528528 </h3><div class="docstring">
529529 <div class="discussion">
530530
531 <p>Returns the stringified representation of this data target&#39;s value.</p>
531 <p>Returns the stringified representation of this data target’s value.</p>
532532
533533
534534 </div>
562562 </div>
563563
564564 <div id="footer">
565 Generated on Fri Nov 27 21:11:15 2020 by
566 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
567 0.9.24 (ruby-2.7.2).
565 Generated on Mon Jan 2 11:48:01 2023 by
566 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
567 0.9.28 (ruby-3.1.2).
568568 </div>
569569
570570 </div>
294294 </div>
295295
296296 <div id="footer">
297 Generated on Fri Nov 27 21:11:22 2020 by
298 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
299 0.9.24 (ruby-2.7.2).
297 Generated on Mon Jan 2 11:48:07 2023 by
298 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
299 0.9.28 (ruby-3.1.2).
300300 </div>
301301
302302 </div>
294294 </div>
295295
296296 <div id="footer">
297 Generated on Fri Nov 27 21:11:01 2020 by
298 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
299 0.9.24 (ruby-2.7.2).
297 Generated on Mon Jan 2 11:47:48 2023 by
298 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
299 0.9.28 (ruby-3.1.2).
300300 </div>
301301
302302 </div>
130130 <p>sent when the left mouse button goes up; the message data is an FXEvent instance.</p>
131131 </dd><dt><code>SEL_CHANGED</code>
132132 <dd>
133 <p>sent when the dial&#39;s value changes; the message data is the new value (an integer).</p>
133 <p>sent when the dial’s value changes; the message data is the new value (an integer).</p>
134134 </dd><dt><code>SEL_COMMAND</code>
135135 <dd>
136 <p>sent when the user stops changing the dial&#39;s value and releases the mouse button; the message data is the new value (an integer).</p>
136 <p>sent when the user stops changing the dial’s value and releases the mouse button; the message data is the new value (an integer).</p>
137137 </dd></dl>
138138
139139 <h3 id="label-Dial+style+options">Dial style options</h3>
487487
488488
489489 <span class="summary_desc"><div class='inline'>
490 <p>Set the dial&#39;s range.</p>
490 <p>Set the dial’s range.</p>
491491 </div></span>
492492
493493 </li>
10551055 </h3><div class="docstring">
10561056 <div class="discussion">
10571057
1058 <p>Set the dial&#39;s range. If <em>notify</em> is <code>true</code>, and the range modification causes the dial&#39;s value to change, a <code>SEL_COMMAND</code> message is sent to the dial&#39;s message target after the value is changed.</p>
1058 <p>Set the dial’s range. If <em>notify</em> is <code>true</code>, and the range modification causes the dial’s value to change, a <code>SEL_COMMAND</code> message is sent to the dial’s message target after the value is changed.</p>
10591059
10601060
10611061 </div>
10921092 </h3><div class="docstring">
10931093 <div class="discussion">
10941094
1095 <p>Set the dial value. If <em>notify</em> is <code>true</code>, a <code>SEL_COMMAND</code> message is sent to the dial&#39;s message target after the value is changed.</p>
1095 <p>Set the dial value. If <em>notify</em> is <code>true</code>, a <code>SEL_COMMAND</code> message is sent to the dial’s message target after the value is changed.</p>
10961096
10971097
10981098 </div>
11221122 </div>
11231123
11241124 <div id="footer">
1125 Generated on Fri Nov 27 21:10:35 2020 by
1126 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1127 0.9.24 (ruby-2.7.2).
1125 Generated on Mon Jan 2 11:47:23 2023 by
1126 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1127 0.9.28 (ruby-3.1.2).
11281128 </div>
11291129
11301130 </div>
119119
120120 <p>When a dialog box receives a <code>SEL_COMMAND</code> message with identifier <code>ID_CANCEL</code> or <code>ID_ACCEPT</code>, the dialog box breaks out of the modal loop and returns a completion code of either 0 or 1, respectively.</p>
121121
122 <p>To close a dialog box when it&#39;s not running modally, simply call <span class='object_link'><a href="FXWindow.html#hide-instance_method" title="Fox::FXWindow#hide (method)">Fox::FXWindow#hide</a></span> (or send it the <code>ID_HIDE</code> command message).</p>
122 <p>To close a dialog box when it’s not running modally, simply call <span class='object_link'><a href="FXWindow.html#hide-instance_method" title="Fox::FXWindow#hide (method)">Fox::FXWindow#hide</a></span> (or send it the <code>ID_HIDE</code> command message).</p>
123123
124124 <h3 id="label-Message+identifiers">Message identifiers</h3>
125125 <dl class="rdoc-list note-list"><dt><code>ID_CANCEL</code>
402402 </div>
403403
404404 <div id="footer">
405 Generated on Fri Nov 27 21:11:01 2020 by
406 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
407 0.9.24 (ruby-2.7.2).
405 Generated on Mon Jan 2 11:47:48 2023 by
406 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
407 0.9.28 (ruby-3.1.2).
408408 </div>
409409
410410 </div>
10521052 </div>
10531053
10541054 <div id="footer">
1055 Generated on Fri Nov 27 21:10:35 2020 by
1056 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1057 0.9.24 (ruby-2.7.2).
1055 Generated on Mon Jan 2 11:47:23 2023 by
1056 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1057 0.9.28 (ruby-3.1.2).
10581058 </div>
10591059
10601060 </div>
741741 </div>
742742
743743 <div id="footer">
744 Generated on Fri Nov 27 21:10:42 2020 by
745 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
746 0.9.24 (ruby-2.7.2).
744 Generated on Mon Jan 2 11:47:29 2023 by
745 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
746 0.9.28 (ruby-3.1.2).
747747 </div>
748748
749749 </div>
345345
346346
347347 <span class="summary_desc"><div class='inline'>
348 <p>If <em>state</em> is <code>true</code>, the directory list will show hidden files and directories; otherwise, it won&#39;t.</p>
348 <p>If <em>state</em> is <code>true</code>, the directory list will show hidden files and directories; otherwise, it won’t.</p>
349349 </div></span>
350350
351351 </li>
823823 </h3><div class="docstring">
824824 <div class="discussion">
825825
826 <p>If <em>state</em> is <code>true</code>, the directory list will show hidden files and directories; otherwise, it won&#39;t.</p>
826 <p>If <em>state</em> is <code>true</code>, the directory list will show hidden files and directories; otherwise, it won’t.</p>
827827
828828
829829 </div>
903903 </div>
904904
905905 <div id="footer">
906 Generated on Fri Nov 27 21:11:02 2020 by
907 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
908 0.9.24 (ruby-2.7.2).
906 Generated on Mon Jan 2 11:47:49 2023 by
907 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
908 0.9.28 (ruby-3.1.2).
909909 </div>
910910
911911 </div>
978978 </div>
979979
980980 <div id="footer">
981 Generated on Fri Nov 27 21:10:46 2020 by
982 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
983 0.9.24 (ruby-2.7.2).
981 Generated on Mon Jan 2 11:47:33 2023 by
982 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
983 0.9.28 (ruby-3.1.2).
984984 </div>
985985
986986 </div>
420420
421421
422422 <span class="summary_desc"><div class='inline'>
423 <p>If <em>state</em> is <code>true</code>, the directory list will show hidden files and directories; otherwise, it won&#39;t.</p>
423 <p>If <em>state</em> is <code>true</code>, the directory list will show hidden files and directories; otherwise, it won’t.</p>
424424 </div></span>
425425
426426 </li>
11281128 </h3><div class="docstring">
11291129 <div class="discussion">
11301130
1131 <p>If <em>state</em> is <code>true</code>, the directory list will show hidden files and directories; otherwise, it won&#39;t.</p>
1131 <p>If <em>state</em> is <code>true</code>, the directory list will show hidden files and directories; otherwise, it won’t.</p>
11321132
11331133
11341134 </div>
14761476 </h3><div class="docstring">
14771477 <div class="discussion">
14781478
1479 <p>Set current file. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the list&#39;s message target to indicate that the current item has changed.</p>
1479 <p>Set current file. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the list’s message target to indicate that the current item has changed.</p>
14801480
14811481
14821482 </div>
15131513 </h3><div class="docstring">
15141514 <div class="discussion">
15151515
1516 <p>Set current directory. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the list&#39;s message target to indicate that the current item has changed.</p>
1516 <p>Set current directory. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the list’s message target to indicate that the current item has changed.</p>
15171517
15181518
15191519 </div>
15431543 </div>
15441544
15451545 <div id="footer">
1546 Generated on Fri Nov 27 21:10:46 2020 by
1547 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1548 0.9.24 (ruby-2.7.2).
1546 Generated on Mon Jan 2 11:47:34 2023 by
1547 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1548 0.9.28 (ruby-3.1.2).
15491549 </div>
15501550
15511551 </div>
405405
406406
407407 <span class="summary_desc"><div class='inline'>
408 <p>If <em>state</em> is <code>true</code>, the directory selector will show hidden files and directories; otherwise, it won&#39;t.</p>
408 <p>If <em>state</em> is <code>true</code>, the directory selector will show hidden files and directories; otherwise, it won’t.</p>
409409 </div></span>
410410
411411 </li>
904904 </h3><div class="docstring">
905905 <div class="discussion">
906906
907 <p>If <em>state</em> is <code>true</code>, the directory selector will show hidden files and directories; otherwise, it won&#39;t.</p>
907 <p>If <em>state</em> is <code>true</code>, the directory selector will show hidden files and directories; otherwise, it won’t.</p>
908908
909909
910910 </div>
984984 </div>
985985
986986 <div id="footer">
987 Generated on Fri Nov 27 21:11:22 2020 by
988 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
989 0.9.24 (ruby-2.7.2).
987 Generated on Mon Jan 2 11:48:08 2023 by
988 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
989 0.9.28 (ruby-3.1.2).
990990 </div>
991991
992992 </div>
131131 <h3 id="label-Dock+Bar+Options">Dock Bar Options</h3>
132132 <dl class="rdoc-list note-list"><dt><code>ALLOW_NOWHERE</code>
133133 <dd>
134 <p>Don&#39;t allow docking anywhere</p>
134 <p>Don’t allow docking anywhere</p>
135135 </dd><dt><code>ALLOW_TOP</code>
136136 <dd>
137137 <p>Docking at the top only</p>
370370
371371
372372 <span class="summary_desc"><div class='inline'>
373 <p>Dock the bar against the given side, near the given position relative to the toolbar dock&#39;s origin.</p>
373 <p>Dock the bar against the given side, near the given position relative to the toolbar dock’s origin.</p>
374374 </div></span>
375375
376376 </li>
10511051 </h3><div class="docstring">
10521052 <div class="discussion">
10531053
1054 <p>Dock the bar against the given side, near the given position relative to the toolbar dock&#39;s origin.</p>
1054 <p>Dock the bar against the given side, near the given position relative to the toolbar dock’s origin.</p>
10551055
10561056
10571057 </div>
14401440 </div>
14411441
14421442 <div id="footer">
1443 Generated on Fri Nov 27 21:10:47 2020 by
1444 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1445 0.9.24 (ruby-2.7.2).
1443 Generated on Mon Jan 2 11:47:34 2023 by
1444 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1445 0.9.28 (ruby-3.1.2).
14461446 </div>
14471447
14481448 </div>
457457 </div>
458458
459459 <div id="footer">
460 Generated on Fri Nov 27 21:11:22 2020 by
461 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
462 0.9.24 (ruby-2.7.2).
460 Generated on Mon Jan 2 11:48:08 2023 by
461 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
462 0.9.28 (ruby-3.1.2).
463463 </div>
464464
465465 </div>
305305
306306
307307 <span class="summary_desc"><div class='inline'>
308 <p>Return <code>true</code> if the <code>DOCKSITE_WRAP</code> option is set, indicating that dockbars will be wrapped to another galley if there&#39;s not enough space on current galley.</p>
308 <p>Return <code>true</code> if the <code>DOCKSITE_WRAP</code> option is set, indicating that dockbars will be wrapped to another galley if there’s not enough space on current galley.</p>
309309 </div></span>
310310
311311 </li>
501501 <h4 id="label-Parameters-3A">Parameters:</h4>
502502 <dl class="rdoc-list note-list"><dt><code>bar</code>
503503 <dd>
504 <p>a reference to the dockbar that&#39;s being dragged <span class='object_link'><a href="FXDockBar.html" title="Fox::FXDockBar (class)">Fox::FXDockBar</a></span></p>
504 <p>a reference to the dockbar that’s being dragged <span class='object_link'><a href="FXDockBar.html" title="Fox::FXDockBar (class)">Fox::FXDockBar</a></span></p>
505505 </dd><dt><code>barx</code>
506506 <dd>
507507 <p>current x-coordinate of the dockbar [Integer]</p>
624624 </h3><div class="docstring">
625625 <div class="discussion">
626626
627 <p>Return <code>true</code> if the <code>DOCKSITE_WRAP</code> option is set, indicating that dockbars will be wrapped to another galley if there&#39;s not enough space on current galley.</p>
627 <p>Return <code>true</code> if the <code>DOCKSITE_WRAP</code> option is set, indicating that dockbars will be wrapped to another galley if there’s not enough space on current galley.</p>
628628
629629
630630 </div>
667667 </div>
668668
669669 <div id="footer">
670 Generated on Fri Nov 27 21:10:53 2020 by
671 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
672 0.9.24 (ruby-2.7.2).
670 Generated on Mon Jan 2 11:47:40 2023 by
671 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
672 0.9.28 (ruby-3.1.2).
673673 </div>
674674
675675 </div>
595595 </div>
596596
597597 <div id="footer">
598 Generated on Fri Nov 27 21:11:02 2020 by
599 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
600 0.9.24 (ruby-2.7.2).
598 Generated on Mon Jan 2 11:47:49 2023 by
599 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
600 0.9.28 (ruby-3.1.2).
601601 </div>
602602
603603 </div>
525525 </div>
526526
527527 <div id="footer">
528 Generated on Fri Nov 27 21:10:53 2020 by
529 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
530 0.9.24 (ruby-2.7.2).
528 Generated on Mon Jan 2 11:47:40 2023 by
529 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
530 0.9.28 (ruby-3.1.2).
531531 </div>
532532
533533 </div>
429429 </div>
430430
431431 <div id="footer">
432 Generated on Fri Nov 27 21:11:15 2020 by
433 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
434 0.9.24 (ruby-2.7.2).
432 Generated on Mon Jan 2 11:48:01 2023 by
433 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
434 0.9.28 (ruby-3.1.2).
435435 </div>
436436
437437 </div>
467467 </div>
468468
469469 <div id="footer">
470 Generated on Fri Nov 27 21:10:53 2020 by
471 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
472 0.9.24 (ruby-2.7.2).
470 Generated on Mon Jan 2 11:47:40 2023 by
471 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
472 0.9.28 (ruby-3.1.2).
473473 </div>
474474
475475 </div>
735735 </div>
736736
737737 <div id="footer">
738 Generated on Fri Nov 27 21:10:53 2020 by
739 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
740 0.9.24 (ruby-2.7.2).
738 Generated on Mon Jan 2 11:47:40 2023 by
739 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
740 0.9.28 (ruby-3.1.2).
741741 </div>
742742
743743 </div>
17251725 </div>
17261726
17271727 <div id="footer">
1728 Generated on Fri Nov 27 21:10:35 2020 by
1729 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1730 0.9.24 (ruby-2.7.2).
1728 Generated on Mon Jan 2 11:47:22 2023 by
1729 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1730 0.9.28 (ruby-3.1.2).
17311731 </div>
17321732
17331733 </div>
484484
485485
486486 <span class="summary_desc"><div class='inline'>
487 <p>Return <code>true</code> if this extent&#39;s bounds overlap with <em>other</em> extent&#39;s bounds.</p>
487 <p>Return <code>true</code> if this extent’s bounds overlap with <em>other</em> extent’s bounds.</p>
488488 </div></span>
489489
490490 </li>
11721172 </h3><div class="docstring">
11731173 <div class="discussion">
11741174
1175 <p>Return <code>true</code> if this extent&#39;s bounds overlap with <em>other</em> extent&#39;s bounds.</p>
1175 <p>Return <code>true</code> if this extent’s bounds overlap with <em>other</em> extent’s bounds.</p>
11761176
11771177
11781178 </div>
13631363 </div>
13641364
13651365 <div id="footer">
1366 Generated on Fri Nov 27 21:10:47 2020 by
1367 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1368 0.9.24 (ruby-2.7.2).
1366 Generated on Mon Jan 2 11:47:34 2023 by
1367 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1368 0.9.28 (ruby-3.1.2).
13691369 </div>
13701370
13711371 </div>
484484
485485
486486 <span class="summary_desc"><div class='inline'>
487 <p>Return <code>true</code> if this extent&#39;s bounds overlap with <em>other</em> extent&#39;s bounds.</p>
487 <p>Return <code>true</code> if this extent’s bounds overlap with <em>other</em> extent’s bounds.</p>
488488 </div></span>
489489
490490 </li>
11721172 </h3><div class="docstring">
11731173 <div class="discussion">
11741174
1175 <p>Return <code>true</code> if this extent&#39;s bounds overlap with <em>other</em> extent&#39;s bounds.</p>
1175 <p>Return <code>true</code> if this extent’s bounds overlap with <em>other</em> extent’s bounds.</p>
11761176
11771177
11781178 </div>
13631363 </div>
13641364
13651365 <div id="footer">
1366 Generated on Fri Nov 27 21:10:47 2020 by
1367 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1368 0.9.24 (ruby-2.7.2).
1366 Generated on Mon Jan 2 11:47:34 2023 by
1367 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1368 0.9.28 (ruby-3.1.2).
13691369 </div>
13701370
13711371 </div>
839839 </div>
840840
841841 <div id="footer">
842 Generated on Fri Nov 27 21:10:53 2020 by
843 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
844 0.9.24 (ruby-2.7.2).
842 Generated on Mon Jan 2 11:47:40 2023 by
843 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
844 0.9.28 (ruby-3.1.2).
845845 </div>
846846
847847 </div>
145145 <p>No wildcard can ever match “/” (or “&quot;,”/“ under Windows).</p>
146146 </dd><dt><code>FILEMATCH_NOESCAPE</code>
147147 <dd>
148 <p>Backslashes don&#39;t quote special chars (“&quot; is treated as ”&quot;).</p>
148 <p>Backslashes don’t quote special chars (“&quot; is treated as ”&quot;).</p>
149149 </dd><dt><code>FILEMATCH_PERIOD</code>
150150 <dd>
151151 <p>Leading “.” is matched only explicitly (Useful to match hidden files on Unix).</p>
744744
745745
746746 <span class="summary_desc"><div class='inline'>
747 <p>If <em>state</em> is <code>true</code>, the file dialog will show hidden files and directories; otherwise, it won&#39;t.</p>
747 <p>If <em>state</em> is <code>true</code>, the file dialog will show hidden files and directories; otherwise, it won’t.</p>
748748 </div></span>
749749
750750 </li>
792792
793793
794794 <span class="summary_desc"><div class='inline'>
795 <p>If <em>shown</em> is <code>true</code>, the file dialog will show preview images; otherwise it won&#39;t.</p>
795 <p>If <em>shown</em> is <code>true</code>, the file dialog will show preview images; otherwise it won’t.</p>
796796 </div></span>
797797
798798 </li>
21202120 </h3><div class="docstring">
21212121 <div class="discussion">
21222122
2123 <p>If <em>state</em> is <code>true</code>, the file dialog will show hidden files and directories; otherwise, it won&#39;t.</p>
2123 <p>If <em>state</em> is <code>true</code>, the file dialog will show hidden files and directories; otherwise, it won’t.</p>
21242124
21252125
21262126 </div>
22072207 </h3><div class="docstring">
22082208 <div class="discussion">
22092209
2210 <p>If <em>shown</em> is <code>true</code>, the file dialog will show preview images; otherwise it won&#39;t.</p>
2210 <p>If <em>shown</em> is <code>true</code>, the file dialog will show preview images; otherwise it won’t.</p>
22112211
22122212
22132213 </div>
26772677 </div>
26782678
26792679 <div id="footer">
2680 Generated on Fri Nov 27 21:11:16 2020 by
2681 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2682 0.9.24 (ruby-2.7.2).
2680 Generated on Mon Jan 2 11:48:02 2023 by
2681 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2682 0.9.28 (ruby-3.1.2).
26832683 </div>
26842684
26852685 </div>
10471047 </div>
10481048
10491049 <div id="footer">
1050 Generated on Fri Nov 27 21:10:53 2020 by
1051 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1052 0.9.24 (ruby-2.7.2).
1050 Generated on Mon Jan 2 11:47:40 2023 by
1051 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1052 0.9.28 (ruby-3.1.2).
10531053 </div>
10541054
10551055 </div>
11301130 </div>
11311131
11321132 <div id="footer">
1133 Generated on Fri Nov 27 21:10:53 2020 by
1134 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1135 0.9.24 (ruby-2.7.2).
1133 Generated on Mon Jan 2 11:47:41 2023 by
1134 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1135 0.9.28 (ruby-3.1.2).
11361136 </div>
11371137
11381138 </div>
137137 <p>Do not create associations for files</p>
138138 </dd><dt><code>FILELIST_NO_PARENT</code>
139139 <dd>
140 <p>Suppress display of &#39;.&#39; and &#39;..&#39;</p>
140 <p>Suppress display of ‘.’ and ‘..’</p>
141141 </dd></dl>
142142
143143 <h3 id="label-Message+identifiers">Message identifiers</h3>
497497
498498
499499 <span class="summary_desc"><div class='inline'>
500 <p>If <em>shown</em> is <code>true</code>, the file list will show preview images; otherwise it won&#39;t.</p>
500 <p>If <em>shown</em> is <code>true</code>, the file list will show preview images; otherwise it won’t.</p>
501501 </div></span>
502502
503503 </li>
14811481 </h3><div class="docstring">
14821482 <div class="discussion">
14831483
1484 <p>If <em>shown</em> is <code>true</code>, the file list will show preview images; otherwise it won&#39;t.</p>
1484 <p>If <em>shown</em> is <code>true</code>, the file list will show preview images; otherwise it won’t.</p>
14851485
14861486
14871487 </div>
21772177 </h3><div class="docstring">
21782178 <div class="discussion">
21792179
2180 <p>Set the current file to <em>filename</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the file list&#39;s message target after the current item has changed. If this change causes the selected item(s) to change (because the file list is operating in browse-select mode), <code>SEL_SELECTED</code> and <code>SEL_DESELECTED</code> may be sent to the message target as well.</p>
2180 <p>Set the current file to <em>filename</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the file list’s message target after the current item has changed. If this change causes the selected item(s) to change (because the file list is operating in browse-select mode), <code>SEL_SELECTED</code> and <code>SEL_DESELECTED</code> may be sent to the message target as well.</p>
21812181
21822182
21832183 </div>
22482248 </div>
22492249
22502250 <div id="footer">
2251 Generated on Fri Nov 27 21:10:54 2020 by
2252 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2253 0.9.24 (ruby-2.7.2).
2251 Generated on Mon Jan 2 11:47:41 2023 by
2252 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2253 0.9.28 (ruby-3.1.2).
22542254 </div>
22552255
22562256 </div>
129129 <p>Multiple existing files</p>
130130 </dd><dt><code>SELECTFILE_MULTIPLE_ALL</code>
131131 <dd>
132 <p>Multiple existing files or directories, but not &#39;.&#39; and &#39;..&#39;</p>
132 <p>Multiple existing files or directories, but not ‘.’ and ‘..’</p>
133133 </dd><dt><code>SELECTFILE_DIRECTORY</code>
134134 <dd>
135 <p>Existing directory, including &#39;.&#39; or &#39;..&#39;</p>
135 <p>Existing directory, including ‘.’ or ‘..’</p>
136136 </dd></dl>
137137
138138 <h3 id="label-Wildcard+matching+modes">Wildcard matching modes</h3>
141141 <p>No wildcard can ever match “/” (or “&quot;,”/“ under Windows).</p>
142142 </dd><dt><code>FILEMATCH_NOESCAPE</code>
143143 <dd>
144 <p>Backslashes don&#39;t quote special chars (“&quot; is treated as ”&quot;).</p>
144 <p>Backslashes don’t quote special chars (“&quot; is treated as ”&quot;).</p>
145145 </dd><dt><code>FILEMATCH_PERIOD</code>
146146 <dd>
147147 <p>Leading “.” is matched only explicitly (Useful to match hidden files on Unix).</p>
754754
755755
756756 <span class="summary_desc"><div class='inline'>
757 <p>If <em>state</em> is <code>true</code>, the file selector will show hidden files and directories; otherwise, it won&#39;t.</p>
757 <p>If <em>state</em> is <code>true</code>, the file selector will show hidden files and directories; otherwise, it won’t.</p>
758758 </div></span>
759759
760760 </li>
802802
803803
804804 <span class="summary_desc"><div class='inline'>
805 <p>If <em>shown</em> is <code>true</code>, the file selector will show preview images; otherwise it won&#39;t.</p>
805 <p>If <em>shown</em> is <code>true</code>, the file selector will show preview images; otherwise it won’t.</p>
806806 </div></span>
807807
808808 </li>
16881688 </h3><div class="docstring">
16891689 <div class="discussion">
16901690
1691 <p>Given a pattern of the form “<strong>.gif,</strong>.GIF”, return the first extension of the pattern, i.e. “gif” in this example. Returns empty string if it doesn&#39;t work out.</p>
1691 <p>Given a pattern of the form “<strong>.gif,</strong>.GIF”, return the first extension of the pattern, i.e. “gif” in this example. Returns empty string if it doesn’t work out.</p>
16921692
16931693
16941694 </div>
19611961 </h3><div class="docstring">
19621962 <div class="discussion">
19631963
1964 <p>If <em>state</em> is <code>true</code>, the file selector will show hidden files and directories; otherwise, it won&#39;t.</p>
1964 <p>If <em>state</em> is <code>true</code>, the file selector will show hidden files and directories; otherwise, it won’t.</p>
19651965
19661966
19671967 </div>
20482048 </h3><div class="docstring">
20492049 <div class="discussion">
20502050
2051 <p>If <em>shown</em> is <code>true</code>, the file selector will show preview images; otherwise it won&#39;t.</p>
2051 <p>If <em>shown</em> is <code>true</code>, the file selector will show preview images; otherwise it won’t.</p>
20522052
20532053
20542054 </div>
25182518 </div>
25192519
25202520 <div id="footer">
2521 Generated on Fri Nov 27 21:11:28 2020 by
2522 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2523 0.9.24 (ruby-2.7.2).
2521 Generated on Mon Jan 2 11:48:13 2023 by
2522 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2523 0.9.28 (ruby-3.1.2).
25242524 </div>
25252525
25262526 </div>
492492 </div>
493493
494494 <div id="footer">
495 Generated on Fri Nov 27 21:11:16 2020 by
496 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
497 0.9.24 (ruby-2.7.2).
495 Generated on Mon Jan 2 11:48:02 2023 by
496 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
497 0.9.28 (ruby-3.1.2).
498498 </div>
499499
500500 </div>
11231123
11241124
11251125 <span class="summary_desc"><div class='inline'>
1126 <p>Returns the item&#39;s text.</p>
1126 <p>Returns the item’s text.</p>
11271127 </div></span>
11281128
11291129 </li>
27772777 </h3><div class="docstring">
27782778 <div class="discussion">
27792779
2780 <p>Returns the item&#39;s text</p>
2780 <p>Returns the item’s text</p>
27812781
27822782
27832783 </div>
28112811 </div>
28122812
28132813 <div id="footer">
2814 Generated on Fri Nov 27 21:11:22 2020 by
2815 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2816 0.9.24 (ruby-2.7.2).
2814 Generated on Mon Jan 2 11:48:08 2023 by
2815 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2816 0.9.28 (ruby-3.1.2).
28172817 </div>
28182818
28192819 </div>
120120 <h2>Overview</h2><div class="docstring">
121121 <div class="discussion">
122122
123 <p>An FXFoldingList widget resembles an FXTreeList, but it supports a header control to provide each item with multiple columns of text. Subtrees can be collapsed or expanded by double-clicking on an item or by clicking on the optional plus button in front of the item. Each item may have a text and optional open-icon as well as a closed-icon. The items may be connected by optional lines to show the hierarchical relationship. When an item&#39;s selected state changes, the folding list emits a <code>SEL_SELECTED</code> or <code>SEL_DESELECTED</code> message. If an item is opened or closed, a message of type <code>SEL_OPENED</code> or <code>SEL_CLOSED</code> is sent. When the subtree under an item is expanded, a <code>SEL_EXPANDED</code> or <code>SEL_COLLAPSED</code> message is issued. A change of the current item is signified by the <code>SEL_CHANGED</code> message. In addition, the folding list sends <code>SEL_COMMAND</code> messages when the user clicks on an item, and <code>SEL_CLICKED</code>, <code>SEL_DOUBLECLICKED</code>, and <code>SEL_TRIPLECLICKED</code> when the user clicks once, twice, or thrice, respectively. When items are added or removed, the folding list sends messages of the type <code>SEL_INSERTED</code> or <code>SEL_DELETED</code>. In each of these cases, a pointer to the item, if any, is passed in the 3rd argument of the message.</p>
123 <p>An FXFoldingList widget resembles an FXTreeList, but it supports a header control to provide each item with multiple columns of text. Subtrees can be collapsed or expanded by double-clicking on an item or by clicking on the optional plus button in front of the item. Each item may have a text and optional open-icon as well as a closed-icon. The items may be connected by optional lines to show the hierarchical relationship. When an item’s selected state changes, the folding list emits a <code>SEL_SELECTED</code> or <code>SEL_DESELECTED</code> message. If an item is opened or closed, a message of type <code>SEL_OPENED</code> or <code>SEL_CLOSED</code> is sent. When the subtree under an item is expanded, a <code>SEL_EXPANDED</code> or <code>SEL_COLLAPSED</code> message is issued. A change of the current item is signified by the <code>SEL_CHANGED</code> message. In addition, the folding list sends <code>SEL_COMMAND</code> messages when the user clicks on an item, and <code>SEL_CLICKED</code>, <code>SEL_DOUBLECLICKED</code>, and <code>SEL_TRIPLECLICKED</code> when the user clicks once, twice, or thrice, respectively. When items are added or removed, the folding list sends messages of the type <code>SEL_INSERTED</code> or <code>SEL_DELETED</code>. In each of these cases, a pointer to the item, if any, is passed in the 3rd argument of the message.</p>
124124
125125 <h3 id="label-Events">Events</h3>
126126
11811181
11821182
11831183 <span class="summary_desc"><div class='inline'>
1184 <p>Return item&#39;s closed icon.</p>
1184 <p>Return item’s closed icon.</p>
11851185 </div></span>
11861186
11871187 </li>
12051205
12061206
12071207 <span class="summary_desc"><div class='inline'>
1208 <p>Return item&#39;s user data.</p>
1208 <p>Return item’s user data.</p>
12091209 </div></span>
12101210
12111211 </li>
12531253
12541254
12551255 <span class="summary_desc"><div class='inline'>
1256 <p>Return item&#39;s open icon.</p>
1256 <p>Return item’s open icon.</p>
12571257 </div></span>
12581258
12591259 </li>
12771277
12781278
12791279 <span class="summary_desc"><div class='inline'>
1280 <p>Return item&#39;s text.</p>
1280 <p>Return item’s text.</p>
12811281 </div></span>
12821282
12831283 </li>
19031903
19041904
19051905 <span class="summary_desc"><div class='inline'>
1906 <p>Change item&#39;s closed icon, deleting old icon if it was owned.</p>
1906 <p>Change item’s closed icon, deleting old icon if it was owned.</p>
19071907 </div></span>
19081908
19091909 </li>
19271927
19281928
19291929 <span class="summary_desc"><div class='inline'>
1930 <p>Change item&#39;s user data.</p>
1930 <p>Change item’s user data.</p>
19311931 </div></span>
19321932
19331933 </li>
19511951
19521952
19531953 <span class="summary_desc"><div class='inline'>
1954 <p>Change item&#39;s open icon, deleting old icon if it was owned.</p>
1954 <p>Change item’s open icon, deleting old icon if it was owned.</p>
19551955 </div></span>
19561956
19571957 </li>
19751975
19761976
19771977 <span class="summary_desc"><div class='inline'>
1978 <p>Change item&#39;s text.</p>
1978 <p>Change item’s text.</p>
19791979 </div></span>
19801980
19811981 </li>
30433043 </h3><div class="docstring">
30443044 <div class="discussion">
30453045
3046 <p>Append a new item with given <em>text</em> and optional <em>openIcon</em>, <em>closedIcon</em> and user <em>data</em> as last child of <em>father</em>. Returns a reference to the newly added item (an FXFoldingItem instance). If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list&#39;s message target after the item is added.</p>
3046 <p>Append a new item with given <em>text</em> and optional <em>openIcon</em>, <em>closedIcon</em> and user <em>data</em> as last child of <em>father</em>. Returns a reference to the newly added item (an FXFoldingItem instance). If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list’s message target after the item is added.</p>
30473047
30483048
30493049 </div>
30803080 </h3><div class="docstring">
30813081 <div class="discussion">
30823082
3083 <p>Remove all items from the list. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list&#39;s message target before each item is removed.</p>
3083 <p>Remove all items from the list. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list’s message target before each item is removed.</p>
30843084
30853085
30863086 </div>
31173117 </h3><div class="docstring">
31183118 <div class="discussion">
31193119
3120 <p>Close item. If <em>notify</em> is <code>true</code>, a <code>SEL_CLOSED</code> message is sent to the list&#39;s message target after the item is closed.</p>
3120 <p>Close item. If <em>notify</em> is <code>true</code>, a <code>SEL_CLOSED</code> message is sent to the list’s message target after the item is closed.</p>
31213121
31223122
31233123 </div>
31543154 </h3><div class="docstring">
31553155 <div class="discussion">
31563156
3157 <p>Collapse sub-tree rooted at <em>tree</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_COLLAPSED</code> message is sent to the list&#39;s message target after the sub-tree is collapsed.</p>
3157 <p>Collapse sub-tree rooted at <em>tree</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_COLLAPSED</code> message is sent to the list’s message target after the sub-tree is collapsed.</p>
31583158
31593159
31603160 </div>
31913191 </h3><div class="docstring">
31923192 <div class="discussion">
31933193
3194 <p>Deselect item. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the list&#39;s message target after the item is deselected.</p>
3194 <p>Deselect item. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the list’s message target after the item is deselected.</p>
31953195
31963196
31973197 </div>
33553355 </h3><div class="docstring">
33563356 <div class="discussion">
33573357
3358 <p>Expand sub-tree rooted at <em>tree</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_EXPANDED</code> message is sent to the list&#39;s message target after the sub-tree is expanded.</p>
3358 <p>Expand sub-tree rooted at <em>tree</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_EXPANDED</code> message is sent to the list’s message target after the sub-tree is expanded.</p>
33593359
33603360
33613361 </div>
33923392 </h3><div class="docstring">
33933393 <div class="discussion">
33943394
3395 <p>Extend selection from anchor item to <em>item</em>. If <em>notify</em> is <code>true</code>, a series of <code>SEL_SELECTED</code> and <code>SEL_DESELECTED</code> messages may be sent to the list&#39;s message target, indicating the changes.</p>
3395 <p>Extend selection from anchor item to <em>item</em>. If <em>notify</em> is <code>true</code>, a series of <code>SEL_SELECTED</code> and <code>SEL_DESELECTED</code> messages may be sent to the list’s message target, indicating the changes.</p>
33963396
33973397
33983398 </div>
34293429 </h3><div class="docstring">
34303430 <div class="discussion">
34313431
3432 <p>Extract item and return a reference to it (without destroying it). If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message may be sent to the folding list&#39;s message target if the current item changes. If the selection changes, <code>SEL_SELECTED</code> and <code>SEL_DESELECTED</code> messages may also be sent to the message target.</p>
3432 <p>Extract item and return a reference to it (without destroying it). If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message may be sent to the folding list’s message target if the current item changes. If the selection changes, <code>SEL_SELECTED</code> and <code>SEL_DESELECTED</code> messages may also be sent to the message target.</p>
34333433
34343434
34353435 </div>
34663466 </h3><div class="docstring">
34673467 <div class="discussion">
34683468
3469 <p>Fill list by appending items from array of strings and return the number of items created. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list&#39;s message target after each item is added.</p>
3469 <p>Fill list by appending items from array of strings and return the number of items created. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list’s message target after each item is added.</p>
34703470
34713471
34723472 </div>
36883688 </h3><div class="docstring">
36893689 <div class="discussion">
36903690
3691 <p>Return item&#39;s closed icon</p>
3691 <p>Return item’s closed icon</p>
36923692
36933693
36943694 </div>
37253725 </h3><div class="docstring">
37263726 <div class="discussion">
37273727
3728 <p>Return item&#39;s user data</p>
3728 <p>Return item’s user data</p>
37293729
37303730
37313731 </div>
37993799 </h3><div class="docstring">
38003800 <div class="discussion">
38013801
3802 <p>Return item&#39;s open icon</p>
3802 <p>Return item’s open icon</p>
38033803
38043804
38053805 </div>
38363836 </h3><div class="docstring">
38373837 <div class="discussion">
38383838
3839 <p>Return item&#39;s text</p>
3839 <p>Return item’s text</p>
38403840
38413841
38423842 </div>
39473947 </h3><div class="docstring">
39483948 <div class="discussion">
39493949
3950 <p>Insert item with given text and optional icons, and user-data pointer under <em>father</em> before <em>other</em> item.. Returns a reference to the newly added item (an FXFoldingItem instance). If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list&#39;s message target after the item is added.</p>
3950 <p>Insert item with given text and optional icons, and user-data pointer under <em>father</em> before <em>other</em> item.. Returns a reference to the newly added item (an FXFoldingItem instance). If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list’s message target after the item is added.</p>
39513951
39523952
39533953 </div>
43344334 </h3><div class="docstring">
43354335 <div class="discussion">
43364336
4337 <p>Deselect all items. If <em>notify</em> is <code>true</code>, <code>SEL_DESELECTED</code> messages will be sent to the list&#39;s message target indicating the affected items.</p>
4337 <p>Deselect all items. If <em>notify</em> is <code>true</code>, <code>SEL_DESELECTED</code> messages will be sent to the list’s message target indicating the affected items.</p>
43384338
43394339
43404340 </div>
44454445 </h3><div class="docstring">
44464446 <div class="discussion">
44474447
4448 <p>Open item. If <em>notify</em> is <code>true</code>, a <code>SEL_OPENED</code> message is sent to the list&#39;s message target after the item is opened.</p>
4448 <p>Open item. If <em>notify</em> is <code>true</code>, a <code>SEL_OPENED</code> message is sent to the list’s message target after the item is opened.</p>
44494449
44504450
44514451 </div>
44824482 </h3><div class="docstring">
44834483 <div class="discussion">
44844484
4485 <p>Prepend a new item with given <em>text</em> and optional icons and user data as first child of <em>father</em>. Returns a reference to the newly added item (an FXFoldingItem instance). If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list&#39;s message target after the item is added.</p>
4485 <p>Prepend a new item with given <em>text</em> and optional icons and user data as first child of <em>father</em>. Returns a reference to the newly added item (an FXFoldingItem instance). If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list’s message target after the item is added.</p>
44864486
44874487
44884488 </div>
45564556 </h3><div class="docstring">
45574557 <div class="discussion">
45584558
4559 <p>Remove item. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list&#39;s message target before the item is removed.</p>
4559 <p>Remove item. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list’s message target before the item is removed.</p>
45604560
45614561
45624562 </div>
45934593 </h3><div class="docstring">
45944594 <div class="discussion">
45954595
4596 <p>Remove items in range [<em>fromItem</em>, <em>toItem</em>] inclusively. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list&#39;s message target before each item is removed.</p>
4596 <p>Remove items in range [<em>fromItem</em>, <em>toItem</em>] inclusively. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list’s message target before each item is removed.</p>
45974597
45984598
45994599 </div>
46304630 </h3><div class="docstring">
46314631 <div class="discussion">
46324632
4633 <p>Select item. If <em>notify</em> is <code>true</code>, a <code>SEL_SELECTED</code> message is sent to the list&#39;s message target after the item is selected.</p>
4633 <p>Select item. If <em>notify</em> is <code>true</code>, a <code>SEL_SELECTED</code> message is sent to the list’s message target after the item is selected.</p>
46344634
46354635
46364636 </div>
46674667 </h3><div class="docstring">
46684668 <div class="discussion">
46694669
4670 <p>Change current item. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the list&#39;s message target after the current item changes.</p>
4670 <p>Change current item. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the list’s message target after the current item changes.</p>
46714671
46724672
46734673 </div>
48524852 </h3><div class="docstring">
48534853 <div class="discussion">
48544854
4855 <p>Change item&#39;s closed icon, deleting old icon if it was owned. If <em>owned</em> is <code>true</code>, mark <em>icn</em> as owned by this folding item.</p>
4855 <p>Change item’s closed icon, deleting old icon if it was owned. If <em>owned</em> is <code>true</code>, mark <em>icn</em> as owned by this folding item.</p>
48564856
48574857
48584858 </div>
48894889 </h3><div class="docstring">
48904890 <div class="discussion">
48914891
4892 <p>Change item&#39;s user data</p>
4892 <p>Change item’s user data</p>
48934893
48944894
48954895 </div>
49264926 </h3><div class="docstring">
49274927 <div class="discussion">
49284928
4929 <p>Change item&#39;s open icon, deleting old icon if it was owned. If <em>owned</em> is <code>true</code>, mark <em>icn</em> as owned by this folding item.</p>
4929 <p>Change item’s open icon, deleting old icon if it was owned. If <em>owned</em> is <code>true</code>, mark <em>icn</em> as owned by this folding item.</p>
49304930
49314931
49324932 </div>
49634963 </h3><div class="docstring">
49644964 <div class="discussion">
49654965
4966 <p>Change item&#39;s text</p>
4966 <p>Change item’s text</p>
49674967
49684968
49694969 </div>
51115111 </h3><div class="docstring">
51125112 <div class="discussion">
51135113
5114 <p>Toggle item selection. If <em>notify</em> is <code>true</code>, a <code>SEL_SELECTED</code> or <code>SEL_DESELECTED</code> message is sent to the list&#39;s message target to indicate the change.</p>
5114 <p>Toggle item selection. If <em>notify</em> is <code>true</code>, a <code>SEL_SELECTED</code> or <code>SEL_DESELECTED</code> message is sent to the list’s message target to indicate the change.</p>
51155115
51165116
51175117 </div>
51785178 </div>
51795179
51805180 <div id="footer">
5181 Generated on Fri Nov 27 21:11:23 2020 by
5182 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
5183 0.9.24 (ruby-2.7.2).
5181 Generated on Mon Jan 2 11:48:09 2023 by
5182 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
5183 0.9.28 (ruby-3.1.2).
51845184 </div>
51855185
51865186 </div>
230230 <h3 id="label-Font+character+set+encoding">Font character set encoding</h3>
231231 <dl class="rdoc-list note-list"><dt><code>FONTENCODING_DEFAULT</code>
232232 <dd>
233 <p>Don&#39;t care character encoding</p>
233 <p>Don’t care character encoding</p>
234234 </dd><dt><code>FONTENCODING_ISO_8859_1</code>
235235 <dd>
236236 <p>West European (Latin1)</p>
29872987 </div>
29882988
29892989 <div id="footer">
2990 Generated on Fri Nov 27 21:10:36 2020 by
2991 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2992 0.9.24 (ruby-2.7.2).
2990 Generated on Mon Jan 2 11:47:23 2023 by
2991 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2992 0.9.28 (ruby-3.1.2).
29932993 </div>
29942994
29952995 </div>
699699 </div>
700700
701701 <div id="footer">
702 Generated on Fri Nov 27 21:10:35 2020 by
703 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
704 0.9.24 (ruby-2.7.2).
702 Generated on Mon Jan 2 11:47:23 2023 by
703 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
704 0.9.28 (ruby-3.1.2).
705705 </div>
706706
707707 </div>
409409 </div>
410410
411411 <div id="footer">
412 Generated on Fri Nov 27 21:11:16 2020 by
413 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
414 0.9.24 (ruby-2.7.2).
412 Generated on Mon Jan 2 11:48:03 2023 by
413 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
414 0.9.28 (ruby-3.1.2).
415415 </div>
416416
417417 </div>
565565 </div>
566566
567567 <div id="footer">
568 Generated on Fri Nov 27 21:11:28 2020 by
569 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
570 0.9.24 (ruby-2.7.2).
568 Generated on Mon Jan 2 11:48:13 2023 by
569 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
570 0.9.28 (ruby-3.1.2).
571571 </div>
572572
573573 </div>
10011001 </div>
10021002
10031003 <div id="footer">
1004 Generated on Fri Nov 27 21:10:37 2020 by
1005 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1006 0.9.24 (ruby-2.7.2).
1004 Generated on Mon Jan 2 11:47:25 2023 by
1005 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1006 0.9.28 (ruby-3.1.2).
10071007 </div>
10081008
10091009 </div>
326326 </div>
327327
328328 <div id="footer">
329 Generated on Fri Nov 27 21:11:02 2020 by
330 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
331 0.9.24 (ruby-2.7.2).
329 Generated on Mon Jan 2 11:47:49 2023 by
330 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
331 0.9.28 (ruby-3.1.2).
332332 </div>
333333
334334 </div>
439439 </div>
440440
441441 <div id="footer">
442 Generated on Fri Nov 27 21:10:47 2020 by
443 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
444 0.9.24 (ruby-2.7.2).
442 Generated on Mon Jan 2 11:47:34 2023 by
443 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
444 0.9.28 (ruby-3.1.2).
445445 </div>
446446
447447 </div>
423423 </div>
424424
425425 <div id="footer">
426 Generated on Fri Nov 27 21:10:54 2020 by
427 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
428 0.9.24 (ruby-2.7.2).
426 Generated on Mon Jan 2 11:47:41 2023 by
427 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
428 0.9.28 (ruby-3.1.2).
429429 </div>
430430
431431 </div>
195195
196196
197197 <span class="summary_desc"><div class='inline'>
198 <p>Return <code>true</code> if this canvas&#39; context is the current context.</p>
198 <p>Return <code>true</code> if this canvas’ context is the current context.</p>
199199 </div></span>
200200
201201 </li>
485485 </h3><div class="docstring">
486486 <div class="discussion">
487487
488 <p>Return <code>true</code> if this canvas&#39; context is the current context.</p>
488 <p>Return <code>true</code> if this canvas’ context is the current context.</p>
489489
490490
491491 </div>
689689 </div>
690690
691691 <div id="footer">
692 Generated on Fri Nov 27 21:10:54 2020 by
693 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
694 0.9.24 (ruby-2.7.2).
692 Generated on Mon Jan 2 11:47:41 2023 by
693 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
694 0.9.28 (ruby-3.1.2).
695695 </div>
696696
697697 </div>
774774 </div>
775775
776776 <div id="footer">
777 Generated on Fri Nov 27 21:11:36 2020 by
778 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
779 0.9.24 (ruby-2.7.2).
777 Generated on Mon Jan 2 11:48:21 2023 by
778 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
779 0.9.28 (ruby-3.1.2).
780780 </div>
781781
782782 </div>
638638 </div>
639639
640640 <div id="footer">
641 Generated on Fri Nov 27 21:11:02 2020 by
642 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
643 0.9.24 (ruby-2.7.2).
641 Generated on Mon Jan 2 11:47:49 2023 by
642 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
643 0.9.28 (ruby-3.1.2).
644644 </div>
645645
646646 </div>
692692 </div>
693693
694694 <div id="footer">
695 Generated on Fri Nov 27 21:11:36 2020 by
696 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
697 0.9.24 (ruby-2.7.2).
695 Generated on Mon Jan 2 11:48:21 2023 by
696 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
697 0.9.28 (ruby-3.1.2).
698698 </div>
699699
700700 </div>
780780 </div>
781781
782782 <div id="footer">
783 Generated on Fri Nov 27 21:11:36 2020 by
784 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
785 0.9.24 (ruby-2.7.2).
783 Generated on Mon Jan 2 11:48:21 2023 by
784 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
785 0.9.28 (ruby-3.1.2).
786786 </div>
787787
788788 </div>
13741374 </div>
13751375
13761376 <div id="footer">
1377 Generated on Fri Nov 27 21:11:35 2020 by
1378 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1379 0.9.24 (ruby-2.7.2).
1377 Generated on Mon Jan 2 11:48:20 2023 by
1378 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1379 0.9.28 (ruby-3.1.2).
13801380 </div>
13811381
13821382 </div>
642642 </div>
643643
644644 <div id="footer">
645 Generated on Fri Nov 27 21:11:36 2020 by
646 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
647 0.9.24 (ruby-2.7.2).
645 Generated on Mon Jan 2 11:48:21 2023 by
646 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
647 0.9.28 (ruby-3.1.2).
648648 </div>
649649
650650 </div>
576576 <h4 id="label-Parameters-3A">Parameters:</h4>
577577 <dl class="rdoc-list note-list"><dt><code>viewer</code>
578578 <dd>
579 <p>the viewer window in which we&#39;re dragging <span class='object_link'><a href="FXGLViewer.html" title="Fox::FXGLViewer (class)">Fox::FXGLViewer</a></span></p>
579 <p>the viewer window in which we’re dragging <span class='object_link'><a href="FXGLViewer.html" title="Fox::FXGLViewer (class)">Fox::FXGLViewer</a></span></p>
580580 </dd><dt><code>fx</code>
581581 <dd>
582 <p>x-coordinate for position we&#39;re dragging from [Integer]</p>
582 <p>x-coordinate for position we’re dragging from [Integer]</p>
583583 </dd><dt><code>fy</code>
584584 <dd>
585 <p>y-coordinate for position we&#39;re dragging from [Integer]</p>
585 <p>y-coordinate for position we’re dragging from [Integer]</p>
586586 </dd><dt><code>tx</code>
587587 <dd>
588 <p>x-coordinate for position we&#39;re dragging to [Integer]</p>
588 <p>x-coordinate for position we’re dragging to [Integer]</p>
589589 </dd><dt><code>ty</code>
590590 <dd>
591 <p>y-coordinate for position we&#39;re dragging to [Integer]</p>
591 <p>y-coordinate for position we’re dragging to [Integer]</p>
592592 </dd></dl>
593593
594594
631631 <h4 id="label-Parameters-3A">Parameters:</h4>
632632 <dl class="rdoc-list note-list"><dt><code>viewer</code>
633633 <dd>
634 <p>the viewer window into which we&#39;re drawing <span class='object_link'><a href="FXGLViewer.html" title="Fox::FXGLViewer (class)">Fox::FXGLViewer</a></span></p>
634 <p>the viewer window into which we’re drawing <span class='object_link'><a href="FXGLViewer.html" title="Fox::FXGLViewer (class)">Fox::FXGLViewer</a></span></p>
635635 </dd></dl>
636636
637637
674674 <h4 id="label-Parameters-3A">Parameters:</h4>
675675 <dl class="rdoc-list note-list"><dt><code>viewer</code>
676676 <dd>
677 <p>the viewer window into which we&#39;re drawing <span class='object_link'><a href="FXGLViewer.html" title="Fox::FXGLViewer (class)">Fox::FXGLViewer</a></span></p>
677 <p>the viewer window into which we’re drawing <span class='object_link'><a href="FXGLViewer.html" title="Fox::FXGLViewer (class)">Fox::FXGLViewer</a></span></p>
678678 </dd></dl>
679679
680680
748748 </div>
749749
750750 <div id="footer">
751 Generated on Fri Nov 27 21:10:54 2020 by
752 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
753 0.9.24 (ruby-2.7.2).
751 Generated on Mon Jan 2 11:47:42 2023 by
752 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
753 0.9.28 (ruby-3.1.2).
754754 </div>
755755
756756 </div>
550550 </div>
551551
552552 <div id="footer">
553 Generated on Fri Nov 27 21:11:36 2020 by
554 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
555 0.9.24 (ruby-2.7.2).
553 Generated on Mon Jan 2 11:48:21 2023 by
554 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
555 0.9.28 (ruby-3.1.2).
556556 </div>
557557
558558 </div>
703703 </div>
704704
705705 <div id="footer">
706 Generated on Fri Nov 27 21:10:47 2020 by
707 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
708 0.9.24 (ruby-2.7.2).
706 Generated on Mon Jan 2 11:47:34 2023 by
707 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
708 0.9.28 (ruby-3.1.2).
709709 </div>
710710
711711 </div>
615615 </div>
616616
617617 <div id="footer">
618 Generated on Fri Nov 27 21:11:36 2020 by
619 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
620 0.9.24 (ruby-2.7.2).
618 Generated on Mon Jan 2 11:48:21 2023 by
619 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
620 0.9.28 (ruby-3.1.2).
621621 </div>
622622
623623 </div>
34953495 </div>
34963496
34973497 <div id="footer">
3498 Generated on Fri Nov 27 21:10:55 2020 by
3499 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
3500 0.9.24 (ruby-2.7.2).
3498 Generated on Mon Jan 2 11:47:42 2023 by
3499 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
3500 0.9.28 (ruby-3.1.2).
35013501 </div>
35023502
35033503 </div>
21362136 </div>
21372137
21382138 <div id="footer">
2139 Generated on Fri Nov 27 21:10:55 2020 by
2140 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2141 0.9.24 (ruby-2.7.2).
2139 Generated on Mon Jan 2 11:47:42 2023 by
2140 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2141 0.9.28 (ruby-3.1.2).
21422142 </div>
21432143
21442144 </div>
551551 </div>
552552
553553 <div id="footer">
554 Generated on Fri Nov 27 21:11:23 2020 by
555 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
556 0.9.24 (ruby-2.7.2).
554 Generated on Mon Jan 2 11:48:09 2023 by
555 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
556 0.9.28 (ruby-3.1.2).
557557 </div>
558558
559559 </div>
10571057
10581058
10591059 <span class="summary_desc"><div class='inline'>
1060 <p>Split segment at the midpoint If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar&#39;s message target after this change is completed.</p>
1060 <p>Split segment at the midpoint If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar’s message target after this change is completed.</p>
10611061 </div></span>
10621062
10631063 </li>
14631463 </h3><div class="docstring">
14641464 <div class="discussion">
14651465
1466 <p>Set the blend mode for segments <em>sglo</em> through <em>sghi</em> to <em>blend</em>, where <em>blend</em> is one of <code>GRADIENT_BLEND_LINEAR</code>, <code>GRADIENT_BLEND_POWER</code>, <code>GRADIENT_BLEND_SINE</code>, <code>GRADIENT_BLEND_INCREASING</code> or <code>GRADIENT_BLEND_DECREASING</code>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar&#39;s message target after this change is completed.</p>
1466 <p>Set the blend mode for segments <em>sglo</em> through <em>sghi</em> to <em>blend</em>, where <em>blend</em> is one of <code>GRADIENT_BLEND_LINEAR</code>, <code>GRADIENT_BLEND_POWER</code>, <code>GRADIENT_BLEND_SINE</code>, <code>GRADIENT_BLEND_INCREASING</code> or <code>GRADIENT_BLEND_DECREASING</code>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar’s message target after this change is completed.</p>
14671467
14681468
14691469 </div>
15001500 </h3><div class="docstring">
15011501 <div class="discussion">
15021502
1503 <p>Deselect all segments, and return <code>true</code> if there was a previously selected range. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the gradient bar&#39;s message target after the current selection is deselected.</p>
1503 <p>Deselect all segments, and return <code>true</code> if there was a previously selected range. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the gradient bar’s message target after the current selection is deselected.</p>
15041504
15051505
15061506 </div>
19811981 </h3><div class="docstring">
19821982 <div class="discussion">
19831983
1984 <p>Merge segments. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar&#39;s message target after this change is completed.</p>
1984 <p>Merge segments. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar’s message target after this change is completed.</p>
19851985
19861986
19871987 </div>
20182018 </h3><div class="docstring">
20192019 <div class="discussion">
20202020
2021 <p>Move lower point of segment <em>seg</em> to <em>val</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar&#39;s message target after the segment&#39;s lower value is changed. Raises IndexError if <em>seg</em> is out of bounds.</p>
2021 <p>Move lower point of segment <em>seg</em> to <em>val</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar’s message target after the segment’s lower value is changed. Raises IndexError if <em>seg</em> is out of bounds.</p>
20222022
20232023
20242024 </div>
20552055 </h3><div class="docstring">
20562056 <div class="discussion">
20572057
2058 <p>Move middle point of segment <em>seg</em> to <em>val</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar&#39;s message target after the segment&#39;s middle value is changed. Raises IndexError if <em>seg</em> is out of bounds.</p>
2058 <p>Move middle point of segment <em>seg</em> to <em>val</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar’s message target after the segment’s middle value is changed. Raises IndexError if <em>seg</em> is out of bounds.</p>
20592059
20602060
20612061 </div>
20922092 </h3><div class="docstring">
20932093 <div class="discussion">
20942094
2095 <p>Move segments <em>sglo</em> to <em>sghi</em> to new position <em>val</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar&#39;s message target after the segments&#39; values are changed.</p>
2095 <p>Move segments <em>sglo</em> to <em>sghi</em> to new position <em>val</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar’s message target after the segments’ values are changed.</p>
20962096
20972097
20982098 </div>
21292129 </h3><div class="docstring">
21302130 <div class="discussion">
21312131
2132 <p>Move upper point of segment <em>seg</em> to <em>val</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar&#39;s message target after the segment&#39;s upper value is changed. Raises IndexError if <em>seg</em> is out of bounds.</p>
2132 <p>Move upper point of segment <em>seg</em> to <em>val</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar’s message target after the segment’s upper value is changed. Raises IndexError if <em>seg</em> is out of bounds.</p>
21332133
21342134
21352135 </div>
22532253 </h3><div class="docstring">
22542254 <div class="discussion">
22552255
2256 <p>Select segment(s) <em>fm</em> through <em>to</em> and return <code>true</code> if the selected range is different than it was. If <em>notify</em> is <code>true</code>, a <code>SEL_SELECTED</code> message is sent to the gradient bar&#39;s message target after the current segment is changed. Raises ArgumentError if <em>fm</em> is greater than <em>to</em>, and IndexError if either <em>fm</em> or <em>to</em> is out of bounds.</p>
2256 <p>Select segment(s) <em>fm</em> through <em>to</em> and return <code>true</code> if the selected range is different than it was. If <em>notify</em> is <code>true</code>, a <code>SEL_SELECTED</code> message is sent to the gradient bar’s message target after the current segment is changed. Raises ArgumentError if <em>fm</em> is greater than <em>to</em>, and IndexError if either <em>fm</em> or <em>to</em> is out of bounds.</p>
22572257
22582258
22592259 </div>
22902290 </h3><div class="docstring">
22912291 <div class="discussion">
22922292
2293 <p>Change current segment to <em>index</em>. Use an <em>index</em> of -1 to indicate that there is no current segment. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar&#39;s message target after the current segment is changed. Raises IndexError if <em>index</em> is out of bounds.</p>
2293 <p>Change current segment to <em>index</em>. Use an <em>index</em> of -1 to indicate that there is no current segment. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar’s message target after the current segment is changed. Raises IndexError if <em>index</em> is out of bounds.</p>
22942294
22952295
22962296 </div>
23272327 </h3><div class="docstring">
23282328 <div class="discussion">
23292329
2330 <p>Set lower color of the segment with index <em>seg</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar&#39;s message target after the segment&#39;s lower color is changed. Raises IndexError if <em>seg</em> is out of bounds.</p>
2330 <p>Set lower color of the segment with index <em>seg</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar’s message target after the segment’s lower color is changed. Raises IndexError if <em>seg</em> is out of bounds.</p>
23312331
23322332
23332333 </div>
23642364 </h3><div class="docstring">
23652365 <div class="discussion">
23662366
2367 <p>Set upper color of the segment with index <em>seg</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar&#39;s message target after the segment&#39;s upper color is changed. Raises IndexError if <em>seg</em> is out of bounds.</p>
2367 <p>Set upper color of the segment with index <em>seg</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar’s message target after the segment’s upper color is changed. Raises IndexError if <em>seg</em> is out of bounds.</p>
23682368
23692369
23702370 </div>
24012401 </h3><div class="docstring">
24022402 <div class="discussion">
24032403
2404 <p>Split segment at the midpoint If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar&#39;s message target after this change is completed.</p>
2404 <p>Split segment at the midpoint If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar’s message target after this change is completed.</p>
24052405
24062406
24072407 </div>
24382438 </h3><div class="docstring">
24392439 <div class="discussion">
24402440
2441 <p>Make segments uniformly distributed. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar&#39;s message target after this change is completed.</p>
2441 <p>Make segments uniformly distributed. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the gradient bar’s message target after this change is completed.</p>
24422442
24432443
24442444 </div>
24682468 </div>
24692469
24702470 <div id="footer">
2471 Generated on Fri Nov 27 21:11:23 2020 by
2472 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2473 0.9.24 (ruby-2.7.2).
2471 Generated on Mon Jan 2 11:48:09 2023 by
2472 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2473 0.9.28 (ruby-3.1.2).
24742474 </div>
24752475
24762476 </div>
328328
329329
330330 <span class="summary_desc"><div class='inline'>
331 <p>Return the group box&#39;s title text.</p>
331 <p>Return the group box’s title text.</p>
332332 </div></span>
333333
334334 </li>
647647 </h3><div class="docstring">
648648 <div class="discussion">
649649
650 <p>Return the group box&#39;s title text</p>
650 <p>Return the group box’s title text</p>
651651
652652
653653 </div>
677677 </div>
678678
679679 <div id="footer">
680 Generated on Fri Nov 27 21:10:55 2020 by
681 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
682 0.9.24 (ruby-2.7.2).
680 Generated on Mon Jan 2 11:47:43 2023 by
681 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
682 0.9.28 (ruby-3.1.2).
683683 </div>
684684
685685 </div>
457457
458458
459459 <span class="summary_desc"><div class='inline'>
460 <p>Returns true if the specified header item&#39;s arrow points down.</p>
460 <p>Returns true if the specified header item’s arrow points down.</p>
461461 </div></span>
462462
463463 </li>
505505
506506
507507 <span class="summary_desc"><div class='inline'>
508 <p>Returns true if the specified header item&#39;s arrow points up.</p>
508 <p>Returns true if the specified header item’s arrow points up.</p>
509509 </div></span>
510510
511511 </li>
11791179
11801180
11811181 <span class="summary_desc"><div class='inline'>
1182 <p>Changed button item&#39;s pressed state.</p>
1182 <p>Changed button item’s pressed state.</p>
11831183 </div></span>
11841184
11851185 </li>
16891689 </h3><div class="docstring">
16901690 <div class="discussion">
16911691
1692 <p>Append a new item with the specified text, icon, size and user data object, and return the index of the appended item. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the header&#39;s message target after the item is appended.</p>
1692 <p>Append a new item with the specified text, icon, size and user data object, and return the index of the appended item. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the header’s message target after the item is appended.</p>
16931693
16941694
16951695 </div>
17261726 </h3><div class="docstring">
17271727 <div class="discussion">
17281728
1729 <p>Returns true if the specified header item&#39;s arrow points down. Raises IndexError if <em>index</em> is out of bounds.</p>
1729 <p>Returns true if the specified header item’s arrow points down. Raises IndexError if <em>index</em> is out of bounds.</p>
17301730
17311731
17321732 </div>
18501850 </h3><div class="docstring">
18511851 <div class="discussion">
18521852
1853 <p>Returns true if the specified header item&#39;s arrow points up. Raises IndexError if <em>index</em> is out of bounds.</p>
1853 <p>Returns true if the specified header item’s arrow points up. Raises IndexError if <em>index</em> is out of bounds.</p>
18541854
18551855
18561856 </div>
19121912 </h3><div class="docstring">
19131913 <div class="discussion">
19141914
1915 <p>Remove all items from this header. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the header&#39;s message target before each item is removed.</p>
1915 <p>Remove all items from this header. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the header’s message target before each item is removed.</p>
19161916
19171917
19181918 </div>
19961996 </h3><div class="docstring">
19971997 <div class="discussion">
19981998
1999 <p>Extract item from list and return a reference to the item. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the header&#39;s message target before the item is extracted from the list. Raises IndexError if <em>index</em> is out of bounds.</p>
1999 <p>Extract item from list and return a reference to the item. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the header’s message target before the item is extracted from the list. Raises IndexError if <em>index</em> is out of bounds.</p>
20002000
20012001
20022002 </div>
23702370 </h3><div class="docstring">
23712371 <div class="discussion">
23722372
2373 <p>Return the offset (in pixels) of the left side of the item at index. (If it&#39;s a vertical header, return the offset of the top side of the item). Raises IndexError if <em>index</em> is out of bounds.</p>
2373 <p>Return the offset (in pixels) of the left side of the item at index. (If it’s a vertical header, return the offset of the top side of the item). Raises IndexError if <em>index</em> is out of bounds.</p>
23742374
23752375
23762376 </div>
24812481 </h3><div class="docstring">
24822482 <div class="discussion">
24832483
2484 <p>Insert a new item at the specified <em>index</em> with the specified text, icon, size and user data object, and return the index of the inserted item. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the header&#39;s message target after the item is inserted. Raises IndexError if <em>index</em> is out of bounds.</p>
2484 <p>Insert a new item at the specified <em>index</em> with the specified text, icon, size and user data object, and return the index of the inserted item. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the header’s message target after the item is inserted. Raises IndexError if <em>index</em> is out of bounds.</p>
24852485
24862486
24872487 </div>
25922592 </h3><div class="docstring">
25932593 <div class="discussion">
25942594
2595 <p>Prepend a new item with the specified text, icon, size and user data object, and return the index of the appended item. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the header&#39;s message target after the item is appended.</p>
2595 <p>Prepend a new item with the specified text, icon, size and user data object, and return the index of the appended item. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the header’s message target after the item is appended.</p>
25962596
25972597
25982598 </div>
26292629 </h3><div class="docstring">
26302630 <div class="discussion">
26312631
2632 <p>Remove the item at the specified index from this header. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the header&#39;s message target before the item is removed. Raises IndexError if <em>index</em> is out of bounds.</p>
2632 <p>Remove the item at the specified index from this header. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the header’s message target before the item is removed. Raises IndexError if <em>index</em> is out of bounds.</p>
26332633
26342634
26352635 </div>
27032703 </h3><div class="docstring">
27042704 <div class="discussion">
27052705
2706 <p>Replace the item at <em>index</em> with a new item with the specified text, icon, size and user data object, and return the index of the replaced item. If <em>notify</em> is <code>true</code>, a <code>SEL_REPLACED</code> message is sent to the header&#39;s message target before the item is replaced. Raises IndexError if <em>index</em> is out of bounds.</p>
2706 <p>Replace the item at <em>index</em> with a new item with the specified text, icon, size and user data object, and return the index of the replaced item. If <em>notify</em> is <code>true</code>, a <code>SEL_REPLACED</code> message is sent to the header’s message target before the item is replaced. Raises IndexError if <em>index</em> is out of bounds.</p>
27072707
27082708
27092709 </div>
28882888 </h3><div class="docstring">
28892889 <div class="discussion">
28902890
2891 <p>Changed button item&#39;s pressed state. Raises IndexError if <em>index</em> is out of bounds.</p>
2891 <p>Changed button item’s pressed state. Raises IndexError if <em>index</em> is out of bounds.</p>
28922892
28932893
28942894 </div>
30293029 </div>
30303030
30313031 <div id="footer">
3032 Generated on Fri Nov 27 21:10:42 2020 by
3033 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
3034 0.9.24 (ruby-2.7.2).
3032 Generated on Mon Jan 2 11:47:30 2023 by
3033 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
3034 0.9.28 (ruby-3.1.2).
30353035 </div>
30363036
30373037 </div>
217217
218218
219219 <span class="summary_desc"><div class='inline'>
220 <p>Item&#39;s user data [Object].</p>
220 <p>Item’s user data [Object].</p>
221221 </div></span>
222222
223223 </li>
244244
245245
246246 <span class="summary_desc"><div class='inline'>
247 <p>Item&#39;s icon <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">FXIcon</a></span>.</p>
247 <p>Item’s icon <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">FXIcon</a></span>.</p>
248248 </div></span>
249249
250250 </li>
379379
380380
381381 <span class="summary_desc"><div class='inline'>
382 <p>Item&#39;s text label [String].</p>
382 <p>Item’s text label [String].</p>
383383 </div></span>
384384
385385 </li>
488488
489489
490490 <span class="summary_desc"><div class='inline'>
491 <p>Return the item&#39;s content height in the header.</p>
491 <p>Return the item’s content height in the header.</p>
492492 </div></span>
493493
494494 </li>
512512
513513
514514 <span class="summary_desc"><div class='inline'>
515 <p>Return the item&#39;s content width in the header.</p>
515 <p>Return the item’s content width in the header.</p>
516516 </div></span>
517517
518518 </li>
610610
611611
612612 <span class="summary_desc"><div class='inline'>
613 <p>Return the header item&#39;s text label.</p>
613 <p>Return the header item’s text label.</p>
614614 </div></span>
615615
616616 </li>
734734 </h3><div class="docstring">
735735 <div class="discussion">
736736
737 <p>Item&#39;s user data [Object]</p>
737 <p>Item’s user data [Object]</p>
738738
739739
740740 </div>
777777 </h3><div class="docstring">
778778 <div class="discussion">
779779
780 <p>Item&#39;s icon <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">Fox::FXIcon</a></span></p>
780 <p>Item’s icon <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">Fox::FXIcon</a></span></p>
781781
782782
783783 </div>
992992 </h3><div class="docstring">
993993 <div class="discussion">
994994
995 <p>Item&#39;s text label [String]</p>
995 <p>Item’s text label [String]</p>
996996
997997
998998 </div>
11511151 </h3><div class="docstring">
11521152 <div class="discussion">
11531153
1154 <p>Return the item&#39;s content height in the header.</p>
1154 <p>Return the item’s content height in the header.</p>
11551155
11561156
11571157 </div>
11881188 </h3><div class="docstring">
11891189 <div class="discussion">
11901190
1191 <p>Return the item&#39;s content width in the header.</p>
1191 <p>Return the item’s content width in the header.</p>
11921192
11931193
11941194 </div>
13121312 </h3><div class="docstring">
13131313 <div class="discussion">
13141314
1315 <p>Return the header item&#39;s text label</p>
1315 <p>Return the header item’s text label</p>
13161316
13171317
13181318 </div>
13421342 </div>
13431343
13441344 <div id="footer">
1345 Generated on Fri Nov 27 21:10:42 2020 by
1346 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1347 0.9.24 (ruby-2.7.2).
1345 Generated on Mon Jan 2 11:47:29 2023 by
1346 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1347 0.9.28 (ruby-3.1.2).
13481348 </div>
13491349
13501350 </div>
793793 </div>
794794
795795 <div id="footer">
796 Generated on Fri Nov 27 21:10:36 2020 by
797 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
798 0.9.24 (ruby-2.7.2).
796 Generated on Mon Jan 2 11:47:24 2023 by
797 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
798 0.9.28 (ruby-3.1.2).
799799 </div>
800800
801801 </div>
113113 <h2>Overview</h2><div class="docstring">
114114 <div class="discussion">
115115
116 <p>The horizontal frame layout manager widget is used to automatically place child-windows horizontally from left-to-right, or right-to-left, depending on the child windows&#39; layout hints.</p>
116 <p>The horizontal frame layout manager widget is used to automatically place child-windows horizontally from left-to-right, or right-to-left, depending on the child windows’ layout hints.</p>
117117
118118
119119 </div>
348348 </div>
349349
350350 <div id="footer">
351 Generated on Fri Nov 27 21:11:33 2020 by
352 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
353 0.9.24 (ruby-2.7.2).
351 Generated on Mon Jan 2 11:48:18 2023 by
352 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
353 0.9.28 (ruby-3.1.2).
354354 </div>
355355
356356 </div>
338338 </div>
339339
340340 <div id="footer">
341 Generated on Fri Nov 27 21:11:13 2020 by
342 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
343 0.9.24 (ruby-2.7.2).
341 Generated on Mon Jan 2 11:47:59 2023 by
342 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
343 0.9.28 (ruby-3.1.2).
344344 </div>
345345
346346 </div>
439439 </div>
440440
441441 <div id="footer">
442 Generated on Fri Nov 27 21:10:47 2020 by
443 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
444 0.9.24 (ruby-2.7.2).
442 Generated on Mon Jan 2 11:47:34 2023 by
443 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
444 0.9.28 (ruby-3.1.2).
445445 </div>
446446
447447 </div>
423423 </div>
424424
425425 <div id="footer">
426 Generated on Fri Nov 27 21:10:55 2020 by
427 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
428 0.9.24 (ruby-2.7.2).
426 Generated on Mon Jan 2 11:47:43 2023 by
427 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
428 0.9.28 (ruby-3.1.2).
429429 </div>
430430
431431 </div>
373373 </div>
374374
375375 <div id="footer">
376 Generated on Fri Nov 27 21:10:36 2020 by
377 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
378 0.9.24 (ruby-2.7.2).
376 Generated on Mon Jan 2 11:47:23 2023 by
377 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
378 0.9.28 (ruby-3.1.2).
379379 </div>
380380
381381 </div>
741741 </div>
742742
743743 <div id="footer">
744 Generated on Fri Nov 27 21:10:55 2020 by
745 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
746 0.9.24 (ruby-2.7.2).
744 Generated on Mon Jan 2 11:47:43 2023 by
745 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
746 0.9.28 (ruby-3.1.2).
747747 </div>
748748
749749 </div>
638638
639639
640640 <span class="summary_desc"><div class='inline'>
641 <p>Return the icon item&#39;s text.</p>
641 <p>Return the icon item’s text.</p>
642642 </div></span>
643643
644644 </li>
14771477 </h3><div class="docstring">
14781478 <div class="discussion">
14791479
1480 <p>Return the icon item&#39;s text</p>
1480 <p>Return the icon item’s text</p>
14811481
14821482
14831483 </div>
15071507 </div>
15081508
15091509 <div id="footer">
1510 Generated on Fri Nov 27 21:10:56 2020 by
1511 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1512 0.9.24 (ruby-2.7.2).
1510 Generated on Mon Jan 2 11:47:43 2023 by
1511 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1512 0.9.28 (ruby-3.1.2).
15131513 </div>
15141514
15151515 </div>
120120 <h2>Overview</h2><div class="docstring">
121121 <div class="discussion">
122122
123 <p>A Icon List Widget displays a list of items, each with a text and optional icon. Icon List can display its items in essentially three different ways; in big-icon mode, the bigger of the two icons is used for each item, and the text is placed underneath the icon. In mini- icon mode, the icons are listed in rows and columns, with the smaller icon preceding the text. Finally, in detail mode the icons are listed in a single column, and all fields of the text are shown under a header control with one button for each subfield. When an item&#39;s selected state changes, the icon list sends a <code>SEL_SELECTED</code> or <code>SEL_DESELECTED</code> message. A change of the current item is signified by the <code>SEL_CHANGED</code> message. The icon list sends <code>SEL_COMMAND</code> messages when the user clicks on an item, and <code>SEL_CLICKED</code>, <code>SEL_DOUBLECLICKED</code>, and <code>SEL_TRIPLECLICKED</code> when the user clicks once, twice, or thrice, respectively. When items are added, replaced, or removed, the icon list sends messages of the type <code>SEL_INSERTED</code>, <code>SEL_REPLACED</code>, or <code>SEL_DELETED</code>. In each of these cases, the index to the item, if any, is passed in the 3rd argument of the message.</p>
123 <p>A Icon List Widget displays a list of items, each with a text and optional icon. Icon List can display its items in essentially three different ways; in big-icon mode, the bigger of the two icons is used for each item, and the text is placed underneath the icon. In mini- icon mode, the icons are listed in rows and columns, with the smaller icon preceding the text. Finally, in detail mode the icons are listed in a single column, and all fields of the text are shown under a header control with one button for each subfield. When an item’s selected state changes, the icon list sends a <code>SEL_SELECTED</code> or <code>SEL_DESELECTED</code> message. A change of the current item is signified by the <code>SEL_CHANGED</code> message. The icon list sends <code>SEL_COMMAND</code> messages when the user clicks on an item, and <code>SEL_CLICKED</code>, <code>SEL_DOUBLECLICKED</code>, and <code>SEL_TRIPLECLICKED</code> when the user clicks once, twice, or thrice, respectively. When items are added, replaced, or removed, the icon list sends messages of the type <code>SEL_INSERTED</code>, <code>SEL_REPLACED</code>, or <code>SEL_DELETED</code>. In each of these cases, the index to the item, if any, is passed in the 3rd argument of the message.</p>
124124
125125 <h3 id="label-Events">Events</h3>
126126
28712871 </h3><div class="docstring">
28722872 <div class="discussion">
28732873
2874 <p>Append a new item with given <em>text</em> and optional <em>bigIcon</em>, <em>miniIcon</em> and user <em>data</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list&#39;s message target after the item is appended.</p>
2874 <p>Append a new item with given <em>text</em> and optional <em>bigIcon</em>, <em>miniIcon</em> and user <em>data</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list’s message target after the item is appended.</p>
28752875
28762876
28772877 </div>
29082908 </h3><div class="docstring">
29092909 <div class="discussion">
29102910
2911 <p>Remove all items from list. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list&#39;s message target before each item is removed.</p>
2911 <p>Remove all items from list. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list’s message target before each item is removed.</p>
29122912
29132913
29142914 </div>
29452945 </h3><div class="docstring">
29462946 <div class="discussion">
29472947
2948 <p>Deselect item at <em>index</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the list&#39;s message target after the item is deselected. Raises IndexError if <em>index</em> is out of bounds.</p>
2948 <p>Deselect item at <em>index</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the list’s message target after the item is deselected. Raises IndexError if <em>index</em> is out of bounds.</p>
29492949
29502950
29512951 </div>
31033103 </h3><div class="docstring">
31043104 <div class="discussion">
31053105
3106 <p>Extend selection from anchor index to <em>index</em>. If <em>notify</em> is <code>true</code>, a series of <code>SEL_SELECTED</code> and <code>SEL_DESELECTED</code> messages are sent to the list&#39;s message target as the selected-state of different items changes. Raises IndexError if <em>index</em> is out of bounds.</p>
3106 <p>Extend selection from anchor index to <em>index</em>. If <em>notify</em> is <code>true</code>, a series of <code>SEL_SELECTED</code> and <code>SEL_DESELECTED</code> messages are sent to the list’s message target as the selected-state of different items changes. Raises IndexError if <em>index</em> is out of bounds.</p>
31073107
31083108
31093109 </div>
31403140 </h3><div class="docstring">
31413141 <div class="discussion">
31423142
3143 <p>Extract item from list and return a reference to the item. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list&#39;s message target before the item is extracted from the list. Raises IndexError if <em>index</em> is out of bounds.</p>
3143 <p>Extract item from list and return a reference to the item. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list’s message target before the item is extracted from the list. Raises IndexError if <em>index</em> is out of bounds.</p>
31443144
31453145
31463146 </div>
36583658 </h3><div class="docstring">
36593659 <div class="discussion">
36603660
3661 <p>Insert item at <em>index</em> with given <em>text</em>, <em>bigIcon</em>, <em>miniIcon</em> and user <em>data</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list&#39;s message target after the item is inserted. Raises IndexError if <em>index</em> is out of bounds.</p>
3661 <p>Insert item at <em>index</em> with given <em>text</em>, <em>bigIcon</em>, <em>miniIcon</em> and user <em>data</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list’s message target after the item is inserted. Raises IndexError if <em>index</em> is out of bounds.</p>
36623662
36633663
36643664 </div>
38953895 </h3><div class="docstring">
38963896 <div class="discussion">
38973897
3898 <p>Deselect all items. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the list&#39;s message target for all the items that were selected before killSelection was called.</p>
3898 <p>Deselect all items. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the list’s message target for all the items that were selected before killSelection was called.</p>
38993899
39003900
39013901 </div>
39693969 </h3><div class="docstring">
39703970 <div class="discussion">
39713971
3972 <p>Move item from <em>oldIndex</em> to <em>newIndex</em> and return the new index of the item.. If <em>notify</em> is <code>true</code> and this move causes the current item to change, a <code>SEL_CHANGED</code> message is sent to the list&#39;s message target to indicate this change in the current item. Raises IndexError if either <em>oldIndex</em> or <em>newIndex</em> is out of bounds.</p>
3972 <p>Move item from <em>oldIndex</em> to <em>newIndex</em> and return the new index of the item.. If <em>notify</em> is <code>true</code> and this move causes the current item to change, a <code>SEL_CHANGED</code> message is sent to the list’s message target to indicate this change in the current item. Raises IndexError if either <em>oldIndex</em> or <em>newIndex</em> is out of bounds.</p>
39733973
39743974
39753975 </div>
40064006 </h3><div class="docstring">
40074007 <div class="discussion">
40084008
4009 <p>Prepend a new item with given <em>text</em> and optional <em>bigIcon</em>, <em>miniIcon</em> and user <em>data</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list&#39;s message target after the item is prepended.</p>
4009 <p>Prepend a new item with given <em>text</em> and optional <em>bigIcon</em>, <em>miniIcon</em> and user <em>data</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list’s message target after the item is prepended.</p>
40104010
40114011
40124012 </div>
40804080 </h3><div class="docstring">
40814081 <div class="discussion">
40824082
4083 <p>Remove item at <em>index</em> from the list. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list&#39;s message target before the item is removed. Raises IndexError if <em>index</em> is out of bounds.</p>
4083 <p>Remove item at <em>index</em> from the list. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list’s message target before the item is removed. Raises IndexError if <em>index</em> is out of bounds.</p>
40844084
40854085
40864086 </div>
41174117 </h3><div class="docstring">
41184118 <div class="discussion">
41194119
4120 <p>Select items in rectangle. If <em>notify</em> is <code>true</code>, a <code>SEL_SELECTED</code> message is sent to the list&#39;s message target after each previously unselected item is selected.</p>
4120 <p>Select items in rectangle. If <em>notify</em> is <code>true</code>, a <code>SEL_SELECTED</code> message is sent to the list’s message target after each previously unselected item is selected.</p>
41214121
41224122
41234123 </div>
41544154 </h3><div class="docstring">
41554155 <div class="discussion">
41564156
4157 <p>Select item at <em>index</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_SELECTED</code> message is sent to the list&#39;s message target after the item is selected. Raises IndexError if <em>index</em> is out of bounds.</p>
4157 <p>Select item at <em>index</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_SELECTED</code> message is sent to the list’s message target after the item is selected. Raises IndexError if <em>index</em> is out of bounds.</p>
41584158
41594159
41604160 </div>
41914191 </h3><div class="docstring">
41924192 <div class="discussion">
41934193
4194 <p>Change current item index. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the list&#39;s message target after the current item changes. Raises IndexError if <em>index</em> is out of bounds.</p>
4194 <p>Change current item index. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the list’s message target after the current item changes. Raises IndexError if <em>index</em> is out of bounds.</p>
41954195
41964196
41974197 </div>
43764376 </h3><div class="docstring">
43774377 <div class="discussion">
43784378
4379 <p>Replace item <em>text</em>, <em>bigIcon</em>, <em>miniIcon</em> and user <em>data</em> for the item at <em>index</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_REPLACED</code> message is sent to the list&#39;s message target before the item is replaced. Raises IndexError if <em>index</em> is out of bounds.</p>
4379 <p>Replace item <em>text</em>, <em>bigIcon</em>, <em>miniIcon</em> and user <em>data</em> for the item at <em>index</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_REPLACED</code> message is sent to the list’s message target before the item is replaced. Raises IndexError if <em>index</em> is out of bounds.</p>
43804380
43814381
43824382 </div>
45984598 </h3><div class="docstring">
45994599 <div class="discussion">
46004600
4601 <p>Toggle item at <em>index</em>. If <em>notify</em> is <code>true</code>, either a <code>SEL_SELECTED</code> or <code>SEL_DESELECTED</code> message is sent to the list&#39;s message target to indicate the item&#39;s new state. Raises IndexError if <em>index</em> is out of bounds.</p>
4601 <p>Toggle item at <em>index</em>. If <em>notify</em> is <code>true</code>, either a <code>SEL_SELECTED</code> or <code>SEL_DESELECTED</code> message is sent to the list’s message target to indicate the item’s new state. Raises IndexError if <em>index</em> is out of bounds.</p>
46024602
46034603
46044604 </div>
46654665 </div>
46664666
46674667 <div id="footer">
4668 Generated on Fri Nov 27 21:10:56 2020 by
4669 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
4670 0.9.24 (ruby-2.7.2).
4668 Generated on Mon Jan 2 11:47:43 2023 by
4669 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
4670 0.9.28 (ruby-3.1.2).
46714671 </div>
46724672
46734673 </div>
515515 </h3><div class="docstring">
516516 <div class="discussion">
517517
518 <p>Load an icon of a given type (e.g. “gif”) from reswrapped data. Returns <code>nil</code> if there&#39;s some error loading the icon. (The optional <em>type</em> parameter is actually mandatory at the time of this writing; future versions will attempt to inspect the first few bytes of the stream to divine the icon format if the parameter is omitted). Returns a reference to the icon.</p>
518 <p>Load an icon of a given type (e.g. “gif”) from reswrapped data. Returns <code>nil</code> if there’s some error loading the icon. (The optional <em>type</em> parameter is actually mandatory at the time of this writing; future versions will attempt to inspect the first few bytes of the stream to divine the icon format if the parameter is omitted). Returns a reference to the icon.</p>
519519
520520
521521 </div>
589589 </h3><div class="docstring">
590590 <div class="discussion">
591591
592 <p>Load an icon of a given type (e.g. “gif”) from an already open stream. Returns <code>nil</code> if there&#39;s some error loading the icon. (The optional <em>type</em> parameter is actually mandatory at the time of this writing; future versions will attempt to inspect the first few bytes of the stream to divine the icon format if the parameter is omitted). Returns a reference to the icon.</p>
592 <p>Load an icon of a given type (e.g. “gif”) from an already open stream. Returns <code>nil</code> if there’s some error loading the icon. (The optional <em>type</em> parameter is actually mandatory at the time of this writing; future versions will attempt to inspect the first few bytes of the stream to divine the icon format if the parameter is omitted). Returns a reference to the icon.</p>
593593
594594
595595 </div>
626626 </h3><div class="docstring">
627627 <div class="discussion">
628628
629 <p>Load an image of a given type (e.g. “gif”) from reswrapped data. Returns <code>nil</code> if there&#39;s some error loading the icon. (The optional parameter is actually mandatory at the time of this writing; future versions will attempt to inspect the first few bytes of the stream to divine the icon format if the parameter is omitted).</p>
629 <p>Load an image of a given type (e.g. “gif”) from reswrapped data. Returns <code>nil</code> if there’s some error loading the icon. (The optional parameter is actually mandatory at the time of this writing; future versions will attempt to inspect the first few bytes of the stream to divine the icon format if the parameter is omitted).</p>
630630
631631
632632 </div>
700700 </h3><div class="docstring">
701701 <div class="discussion">
702702
703 <p>Load an image of a given type (e.g. “gif”) from an already open stream. Returns <code>nil</code> if there&#39;s some error loading the image. (The optional parameter is actually mandatory at the time of this writing; future versions will attempt to inspect the first few bytes of the stream to divine the image format if the parameter is omitted).</p>
703 <p>Load an image of a given type (e.g. “gif”) from an already open stream. Returns <code>nil</code> if there’s some error loading the image. (The optional parameter is actually mandatory at the time of this writing; future versions will attempt to inspect the first few bytes of the stream to divine the image format if the parameter is omitted).</p>
704704
705705
706706 </div>
952952 </div>
953953
954954 <div id="footer">
955 Generated on Fri Nov 27 21:11:16 2020 by
956 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
957 0.9.24 (ruby-2.7.2).
955 Generated on Mon Jan 2 11:48:03 2023 by
956 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
957 0.9.28 (ruby-3.1.2).
958958 </div>
959959
960960 </div>
701701 </div>
702702
703703 <div id="footer">
704 Generated on Fri Nov 27 21:10:35 2020 by
705 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
706 0.9.24 (ruby-2.7.2).
704 Generated on Mon Jan 2 11:47:22 2023 by
705 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
706 0.9.28 (ruby-3.1.2).
707707 </div>
708708
709709 </div>
457457
458458
459459 <span class="summary_desc"><div class='inline'>
460 <p>Scan the image and return <code>false</code> if it&#39;s fully opaque.</p>
460 <p>Scan the image and return <code>false</code> if it’s fully opaque.</p>
461461 </div></span>
462462
463463 </li>
14721472 </h3><div class="docstring">
14731473 <div class="discussion">
14741474
1475 <p>Scan the image and return <code>false</code> if it&#39;s fully opaque.</p>
1475 <p>Scan the image and return <code>false</code> if it’s fully opaque.</p>
14761476
14771477
14781478 </div>
19741974 </h3><div class="docstring">
19751975 <div class="discussion">
19761976
1977 <p>Rescale pixels image to the specified width and height and then re-render the server-side image from the client-side pixel buffer. Note that this serves a slightly different purpose than the base class resize() method, which simply resizes the client-side pixel data buffer but doesn&#39;t transform the image.</p>
1977 <p>Rescale pixels image to the specified width and height and then re-render the server-side image from the client-side pixel buffer. Note that this serves a slightly different purpose than the base class resize() method, which simply resizes the client-side pixel data buffer but doesn’t transform the image.</p>
19781978
19791979 <p>The optional third argument specifies the <em>quality</em> of the scaling algorithm used. By default, <span class='object_link'><a href="#scale-instance_method" title="Fox::FXImage#scale (method)">#scale</a></span> uses a fast (but low quality) nearest-neighbor algorithm for scaling the image to its new size. To use the higher-quality scaling algorithm from FOX 1.0, you should pass in a value of 1 as the third argument to <span class='object_link'><a href="#scale-instance_method" title="Fox::FXImage#scale (method)">#scale</a></span>.</p>
19801980
23172317 </div>
23182318
23192319 <div id="footer">
2320 Generated on Fri Nov 27 21:10:38 2020 by
2321 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2322 0.9.24 (ruby-2.7.2).
2320 Generated on Mon Jan 2 11:47:25 2023 by
2321 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2322 0.9.28 (ruby-3.1.2).
23232323 </div>
23242324
23252325 </div>
478478 </div>
479479
480480 <div id="footer">
481 Generated on Fri Nov 27 21:11:17 2020 by
482 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
483 0.9.24 (ruby-2.7.2).
481 Generated on Mon Jan 2 11:48:03 2023 by
482 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
483 0.9.28 (ruby-3.1.2).
484484 </div>
485485
486486 </div>
493493 </div>
494494
495495 <div id="footer">
496 Generated on Fri Nov 27 21:11:02 2020 by
497 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
498 0.9.24 (ruby-2.7.2).
496 Generated on Mon Jan 2 11:47:49 2023 by
497 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
498 0.9.28 (ruby-3.1.2).
499499 </div>
500500
501501 </div>
407407
408408
409409 <span class="summary_desc"><div class='inline'>
410 <p>Return the input dialog&#39;s input string text.</p>
410 <p>Return the input dialog’s input string text.</p>
411411 </div></span>
412412
413413 </li>
853853 </h3><div class="docstring">
854854 <div class="discussion">
855855
856 <p>Return the input dialog&#39;s input string text</p>
856 <p>Return the input dialog’s input string text</p>
857857
858858
859859 </div>
883883 </div>
884884
885885 <div id="footer">
886 Generated on Fri Nov 27 21:11:24 2020 by
887 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
888 0.9.24 (ruby-2.7.2).
886 Generated on Mon Jan 2 11:48:10 2023 by
887 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
888 0.9.28 (ruby-3.1.2).
889889 </div>
890890
891891 </div>
693693
694694 <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span>
695695 <span class='kw'>super</span>
696 <span class='id identifier rubyid_setFocus'>setFocus</span> <span class='comment'># IRB initialization
697 </span>
698 <span class='ivar'>@redir</span> <span class='op'>=</span> <span class='const'>Redirect</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
696 <span class='id identifier rubyid_setFocus'>setFocus</span>
697 <span class='comment'># IRB initialization
698 </span> <span class='ivar'>@redir</span> <span class='op'>=</span> <span class='const'>Redirect</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
699699 <span class='ivar'>@input</span> <span class='op'>=</span> <span class='const'>IO</span><span class='period'>.</span><span class='id identifier rubyid_pipe'>pipe</span>
700700 <span class='ivar'>@irb</span> <span class='op'>=</span> <span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span>
701701 <span class='const'><span class='object_link'><a href="../IRB.html" title="IRB (module)">IRB</a></span></span><span class='period'>.</span><span class='id identifier rubyid_start_in_fxirb'><span class='object_link'><a href="../IRB.html#start_in_fxirb-class_method" title="IRB.start_in_fxirb (method)">start_in_fxirb</a></span></span><span class='lparen'>(</span><span class='ivar'>@redir</span><span class='rparen'>)</span>
931931 </div>
932932
933933 <div id="footer">
934 Generated on Fri Nov 27 21:11:34 2020 by
935 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
936 0.9.24 (ruby-2.7.2).
934 Generated on Mon Jan 2 11:48:19 2023 by
935 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
936 0.9.28 (ruby-3.1.2).
937937 </div>
938938
939939 </div>
596596 </div>
597597
598598 <div id="footer">
599 Generated on Fri Nov 27 21:10:47 2020 by
600 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
601 0.9.24 (ruby-2.7.2).
599 Generated on Mon Jan 2 11:47:34 2023 by
600 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
601 0.9.28 (ruby-3.1.2).
602602 </div>
603603
604604 </div>
580580 </div>
581581
582582 <div id="footer">
583 Generated on Fri Nov 27 21:10:56 2020 by
584 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
585 0.9.24 (ruby-2.7.2).
583 Generated on Mon Jan 2 11:47:43 2023 by
584 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
585 0.9.28 (ruby-3.1.2).
586586 </div>
587587
588588 </div>
440440
441441
442442 <span class="summary_desc"><div class='inline'>
443 <p>Return the knob&#39;s current limits as a two-element array.</p>
443 <p>Return the knob’s current limits as a two-element array.</p>
444444 </div></span>
445445
446446 </li>
490490
491491
492492 <span class="summary_desc"><div class='inline'>
493 <p>Change the knob&#39;s movement limits (start and ending angles) Accept values in degrees from 0 (south) to 360.</p>
493 <p>Change the knob’s movement limits (start and ending angles) Accept values in degrees from 0 (south) to 360.</p>
494494 </div></span>
495495
496496 </li>
970970 </h3><div class="docstring">
971971 <div class="discussion">
972972
973 <p>Return the knob&#39;s current limits as a two-element array.</p>
973 <p>Return the knob’s current limits as a two-element array.</p>
974974
975975
976976 </div>
10071007 </h3><div class="docstring">
10081008 <div class="discussion">
10091009
1010 <p>Change the knob&#39;s movement limits (start and ending angles) Accept values in degrees from 0 (south) to 360.</p>
1010 <p>Change the knob’s movement limits (start and ending angles) Accept values in degrees from 0 (south) to 360.</p>
10111011
10121012
10131013 </div>
10371037 </div>
10381038
10391039 <div id="footer">
1040 Generated on Fri Nov 27 21:10:36 2020 by
1041 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1042 0.9.24 (ruby-2.7.2).
1040 Generated on Mon Jan 2 11:47:23 2023 by
1041 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1042 0.9.28 (ruby-3.1.2).
10431043 </div>
10441044
10451045 </div>
492492
493493
494494 <span class="summary_desc"><div class='inline'>
495 <p>Return the label&#39;s text.</p>
495 <p>Return the label’s text.</p>
496496 </div></span>
497497
498498 </li>
972972 </h3><div class="docstring">
973973 <div class="discussion">
974974
975 <p>Return the label&#39;s text</p>
975 <p>Return the label’s text</p>
976976
977977
978978 </div>
10021002 </div>
10031003
10041004 <div id="footer">
1005 Generated on Fri Nov 27 21:10:38 2020 by
1006 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1007 0.9.24 (ruby-2.7.2).
1005 Generated on Mon Jan 2 11:47:25 2023 by
1006 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1007 0.9.28 (ruby-3.1.2).
10081008 </div>
10091009
10101010 </div>
909909 </div>
910910
911911 <div id="footer">
912 Generated on Fri Nov 27 21:10:54 2020 by
913 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
914 0.9.24 (ruby-2.7.2).
912 Generated on Mon Jan 2 11:47:42 2023 by
913 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
914 0.9.28 (ruby-3.1.2).
915915 </div>
916916
917917 </div>
120120 <h2>Overview</h2><div class="docstring">
121121 <div class="discussion">
122122
123 <p>A List Widget displays a list of items, each with a text and optional icon. When an item&#39;s selected state changes, the list sends a <code>SEL_SELECTED</code> or <code>SEL_DESELECTED</code> message. A change of the current item is signified by the <code>SEL_CHANGED</code> message. The list sends <code>SEL_COMMAND</code> messages when the user clicks on an item, and <code>SEL_CLICKED</code>, <code>SEL_DOUBLECLICKED</code>, and <code>SEL_TRIPLECLICKED</code> when the user clicks once, twice, or thrice, respectively. When items are added, replaced, or removed, the list sends messages of the type <code>SEL_INSERTED</code>, <code>SEL_REPLACED</code>, or <code>SEL_DELETED</code>. In each of these cases, the index to the item, if any, is passed in the 3rd argument of the message.</p>
123 <p>A List Widget displays a list of items, each with a text and optional icon. When an item’s selected state changes, the list sends a <code>SEL_SELECTED</code> or <code>SEL_DESELECTED</code> message. A change of the current item is signified by the <code>SEL_CHANGED</code> message. The list sends <code>SEL_COMMAND</code> messages when the user clicks on an item, and <code>SEL_CLICKED</code>, <code>SEL_DOUBLECLICKED</code>, and <code>SEL_TRIPLECLICKED</code> when the user clicks once, twice, or thrice, respectively. When items are added, replaced, or removed, the list sends messages of the type <code>SEL_INSERTED</code>, <code>SEL_REPLACED</code>, or <code>SEL_DELETED</code>. In each of these cases, the index to the item, if any, is passed in the 3rd argument of the message.</p>
124124
125125 <h3 id="label-Events">Events</h3>
126126
598598
599599
600600 <span class="summary_desc"><div class='inline'>
601 <p>Remove all items from the list If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list&#39;s message target before each item is removed.</p>
601 <p>Remove all items from the list If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list’s message target before each item is removed.</p>
602602 </div></span>
603603
604604 </li>
14161416
14171417
14181418 <span class="summary_desc"><div class='inline'>
1419 <p>Change item icon and mark the list&#39;s layout as dirty; this is equivalent to:.</p>
1419 <p>Change item icon and mark the list’s layout as dirty; this is equivalent to:.</p>
14201420 </div></span>
14211421
14221422 </li>
14401440
14411441
14421442 <span class="summary_desc"><div class='inline'>
1443 <p>Change item text and mark the list&#39;s layout as dirty; this is equivalent to:.</p>
1443 <p>Change item text and mark the list’s layout as dirty; this is equivalent to:.</p>
14441444 </div></span>
14451445
14461446 </li>
21472147 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='id identifier rubyid_appendItem'>appendItem</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>pinky</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
21482148 </code></pre>
21492149
2150 <p>If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list&#39;s message target after the item is appended. Returns the integer index of the newly appended item.</p>
2150 <p>If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list’s message target after the item is appended. Returns the integer index of the newly appended item.</p>
21512151
21522152
21532153 </div>
21842184 </h3><div class="docstring">
21852185 <div class="discussion">
21862186
2187 <p>Remove all items from the list If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list&#39;s message target before each item is removed.</p>
2187 <p>Remove all items from the list If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list’s message target before each item is removed.</p>
21882188
21892189
21902190 </div>
22212221 </h3><div class="docstring">
22222222 <div class="discussion">
22232223
2224 <p>Deselect item. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the list&#39;s message target after the item is deselected. Raises IndexError if <em>index</em> is out of bounds.</p>
2224 <p>Deselect item. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the list’s message target after the item is deselected. Raises IndexError if <em>index</em> is out of bounds.</p>
22252225
22262226
22272227 </div>
23792379 </h3><div class="docstring">
23802380 <div class="discussion">
23812381
2382 <p>Extend selection from anchor item to <em>index</em>. If <em>notify</em> is <code>true</code>, a series of <code>SEL_SELECTED</code> and <code>SEL_DESELECTED</code> messages are sent to the list&#39;s message target as the selected-state of different items changes. Raises IndexError if <em>index</em> is out of bounds.</p>
2382 <p>Extend selection from anchor item to <em>index</em>. If <em>notify</em> is <code>true</code>, a series of <code>SEL_SELECTED</code> and <code>SEL_DESELECTED</code> messages are sent to the list’s message target as the selected-state of different items changes. Raises IndexError if <em>index</em> is out of bounds.</p>
23832383
23842384
23852385 </div>
24162416 </h3><div class="docstring">
24172417 <div class="discussion">
24182418
2419 <p>Extract item from list and return a reference to the item. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list&#39;s message target before the item is extracted from the list. Raises IndexError if <em>index</em> is out of bounds.</p>
2419 <p>Extract item from list and return a reference to the item. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list’s message target before the item is extracted from the list. Raises IndexError if <em>index</em> is out of bounds.</p>
24202420
24212421
24222422 </div>
24532453 </h3><div class="docstring">
24542454 <div class="discussion">
24552455
2456 <p>Fill list by appending items from array of strings, and return the number items added. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list&#39;s message target after the item is added.</p>
2456 <p>Fill list by appending items from array of strings, and return the number items added. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list’s message target after the item is added.</p>
24572457
24582458
24592459 </div>
29212921 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='id identifier rubyid_insertItem'>insertItem</span><span class='lparen'>(</span><span class='int'>1</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>blinky</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
29222922 </code></pre>
29232923
2924 <p>If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list&#39;s message target after the item is inserted. Raises IndexError if <em>index</em> is out of bounds. Returns the integer index of the inserted item.</p>
2924 <p>If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list’s message target after the item is inserted. Raises IndexError if <em>index</em> is out of bounds. Returns the integer index of the inserted item.</p>
29252925
29262926
29272927 </div>
31683168 </h3><div class="docstring">
31693169 <div class="discussion">
31703170
3171 <p>Deselect all items. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the list&#39;s message target for all the items that were selected before killSelection was called.</p>
3171 <p>Deselect all items. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the list’s message target for all the items that were selected before killSelection was called.</p>
31723172
31733173
31743174 </div>
32423242 </h3><div class="docstring">
32433243 <div class="discussion">
32443244
3245 <p>Move item from <em>oldIndex</em> to <em>newIndex</em> and return the new index of the item.. If <em>notify</em> is <code>true</code> and this move causes the current item to change, a <code>SEL_CHANGED</code> message is sent to the list&#39;s message target to indicate this change in the current item. Raises IndexError if either <em>oldIndex</em> or <em>newIndex</em> is out of bounds.</p>
3245 <p>Move item from <em>oldIndex</em> to <em>newIndex</em> and return the new index of the item.. If <em>notify</em> is <code>true</code> and this move causes the current item to change, a <code>SEL_CHANGED</code> message is sent to the list’s message target to indicate this change in the current item. Raises IndexError if either <em>oldIndex</em> or <em>newIndex</em> is out of bounds.</p>
32463246
32473247
32483248 </div>
32843284 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='id identifier rubyid_prependItem'>prependItem</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>clyde</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
32853285 </code></pre>
32863286
3287 <p>If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list&#39;s message target after the item is prepended. Returns the integer index of the newly prepended item (which should always be zero, by definition).</p>
3287 <p>If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list’s message target after the item is prepended. Returns the integer index of the newly prepended item (which should always be zero, by definition).</p>
32883288
32893289
32903290 </div>
33213321 </h3><div class="docstring">
33223322 <div class="discussion">
33233323
3324 <p>Remove item at <em>index</em> from list. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list&#39;s message target before the item is removed. Raises IndexError if <em>index</em> is out of bounds.</p>
3324 <p>Remove item at <em>index</em> from list. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list’s message target before the item is removed. Raises IndexError if <em>index</em> is out of bounds.</p>
33253325
33263326
33273327 </div>
33583358 </h3><div class="docstring">
33593359 <div class="discussion">
33603360
3361 <p>Select item. If <em>notify</em> is <code>true</code>, a <code>SEL_SELECTED</code> message is sent to the list&#39;s message target after the item is selected. Raises IndexError if <em>index</em> is out of bounds.</p>
3361 <p>Select item. If <em>notify</em> is <code>true</code>, a <code>SEL_SELECTED</code> message is sent to the list’s message target after the item is selected. Raises IndexError if <em>index</em> is out of bounds.</p>
33623362
33633363
33643364 </div>
33953395 </h3><div class="docstring">
33963396 <div class="discussion">
33973397
3398 <p>Change current item. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the list&#39;s message target after the current item changes. Raises IndexError if <em>index</em> is out of bounds.</p>
3398 <p>Change current item. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the list’s message target after the current item changes. Raises IndexError if <em>index</em> is out of bounds.</p>
33993399
34003400
34013401 </div>
34373437 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='id identifier rubyid_setItem'>setItem</span><span class='lparen'>(</span><span class='int'>0</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>inky</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
34383438 </code></pre>
34393439
3440 <p>If <em>notify</em> is <code>true</code>, a <code>SEL_REPLACED</code> message is sent to the list&#39;s message target before the item is replaced. Raises IndexError if <em>index</em> is out of bounds. Returns the integer index of the replaced item.</p>
3440 <p>If <em>notify</em> is <code>true</code>, a <code>SEL_REPLACED</code> message is sent to the list’s message target before the item is replaced. Raises IndexError if <em>index</em> is out of bounds. Returns the integer index of the replaced item.</p>
34413441
34423442
34433443 </div>
35163516 </h3><div class="docstring">
35173517 <div class="discussion">
35183518
3519 <p>Change item icon and mark the list&#39;s layout as dirty; this is equivalent to:</p>
3519 <p>Change item icon and mark the list’s layout as dirty; this is equivalent to:</p>
35203520
35213521 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_getItem'>getItem</span><span class='lparen'>(</span><span class='id identifier rubyid_index'>index</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_icon'>icon</span> <span class='op'>=</span> <span class='id identifier rubyid_icon'>icon</span>
35223522 <span class='id identifier rubyid_recalc'>recalc</span>
35593559 </h3><div class="docstring">
35603560 <div class="discussion">
35613561
3562 <p>Change item text and mark the list&#39;s layout as dirty; this is equivalent to:</p>
3562 <p>Change item text and mark the list’s layout as dirty; this is equivalent to:</p>
35633563
35643564 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_getItem'>getItem</span><span class='lparen'>(</span><span class='id identifier rubyid_index'>index</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_text'>text</span> <span class='op'>=</span> <span class='id identifier rubyid_text'>text</span>
35653565 <span class='id identifier rubyid_recalc'>recalc</span>
36393639 </h3><div class="docstring">
36403640 <div class="discussion">
36413641
3642 <p>Toggle item selection state. If <em>notify</em> is <code>true</code>, either a <code>SEL_SELECTED</code> or <code>SEL_DESELECTED</code> message is sent to the list&#39;s message target to indicate the item&#39;s new state. Raises IndexError if <em>index</em> is out of bounds.</p>
3642 <p>Toggle item selection state. If <em>notify</em> is <code>true</code>, either a <code>SEL_SELECTED</code> or <code>SEL_DESELECTED</code> message is sent to the list’s message target to indicate the item’s new state. Raises IndexError if <em>index</em> is out of bounds.</p>
36433643
36443644
36453645 </div>
37063706 </div>
37073707
37083708 <div id="footer">
3709 Generated on Fri Nov 27 21:10:36 2020 by
3710 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
3711 0.9.24 (ruby-2.7.2).
3709 Generated on Mon Jan 2 11:47:24 2023 by
3710 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
3711 0.9.28 (ruby-3.1.2).
37123712 </div>
37133713
37143714 </div>
210210
211211
212212 <span class="summary_desc"><div class='inline'>
213 <p>Current item&#39;s index, or -1 if no current item [Integer].</p>
213 <p>Current item’s index, or -1 if no current item [Integer].</p>
214214 </div></span>
215215
216216 </li>
535535
536536
537537 <span class="summary_desc"><div class='inline'>
538 <p>Calls block once for each item in the list, passing the item&#39;s text, icon and user data as parameters.</p>
538 <p>Calls block once for each item in the list, passing the item’s text, icon and user data as parameters.</p>
539539 </div></span>
540540
541541 </li>
12271227 </h3><div class="docstring">
12281228 <div class="discussion">
12291229
1230 <p>Current item&#39;s index, or -1 if no current item [Integer]</p>
1230 <p>Current item’s index, or -1 if no current item [Integer]</p>
12311231
12321232
12331233 </div>
16971697 </h3><div class="docstring">
16981698 <div class="discussion">
16991699
1700 <p>Calls block once for each item in the list, passing the item&#39;s text, icon and user data as parameters.</p>
1700 <p>Calls block once for each item in the list, passing the item’s text, icon and user data as parameters.</p>
17011701
17021702
17031703 </div>
25072507 </div>
25082508
25092509 <div id="footer">
2510 Generated on Fri Nov 27 21:10:48 2020 by
2511 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2512 0.9.24 (ruby-2.7.2).
2510 Generated on Mon Jan 2 11:47:35 2023 by
2511 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2512 0.9.28 (ruby-3.1.2).
25132513 </div>
25142514
25152515 </div>
616616
617617
618618 <span class="summary_desc"><div class='inline'>
619 <p>Return the list item&#39;s text.</p>
619 <p>Return the list item’s text.</p>
620620 </div></span>
621621
622622 </li>
14181418 </h3><div class="docstring">
14191419 <div class="discussion">
14201420
1421 <p>Return the list item&#39;s text</p>
1421 <p>Return the list item’s text</p>
14221422
14231423
14241424 </div>
14481448 </div>
14491449
14501450 <div id="footer">
1451 Generated on Fri Nov 27 21:10:36 2020 by
1452 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1453 0.9.24 (ruby-2.7.2).
1451 Generated on Mon Jan 2 11:47:23 2023 by
1452 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1453 0.9.28 (ruby-3.1.2).
14541454 </div>
14551455
14561456 </div>
111111 <h2>Overview</h2><div class="docstring">
112112 <div class="discussion">
113113
114 <p>The MDI child window contains the application work area in a Multiple Document Interface application. GUI Controls are connected to the MDI child via delegation through the MDI client, which forwards messages it receives to the active MDI child. The MDI child itself tries to further delegate messages to its single content window, and if not handled there, to its target object. When the MDI child is maximized, it sends a SEL_MAXIMIZE message; when the MDI child is minimized, it sends a SEL_MINIMIZE message. When it is restored, it sends a SEL_RESTORE message to its target. The MDI child also notifies its target when it becomes the active MDI child, via the SEL_SELECTED message. The void* in the SEL_SELECTED message refers to the previously active MDI child, if any. When an MDI child ceases to be the active one, a SEL_DESELECTED message is sent. The void* in the SEL_DESELECTED message refers to the newly activated MDI child, if any. Thus, interception of SEL_SELECTED and SEL_DESELECTED allows the target object to determine whether the user switched between MDI windows of the same document (target) or between MDI windows belonging to the same document. When the MDI child is closed, it sends a SEL_CLOSE message to its target. The target has an opportunity to object to the closing; if the MDI child should not be closed, it should return 1 (objection). If the MDI child should be closed, the target can either just return 0 or simply not handle the SEL_CLOSE message. The SEL_UPDATE message can be used to modify the MDI child&#39;s title (via ID_SETSTRINGVALUE), and window icon (via ID_SETICONVALUE).</p>
114 <p>The MDI child window contains the application work area in a Multiple Document Interface application. GUI Controls are connected to the MDI child via delegation through the MDI client, which forwards messages it receives to the active MDI child. The MDI child itself tries to further delegate messages to its single content window, and if not handled there, to its target object. When the MDI child is maximized, it sends a SEL_MAXIMIZE message; when the MDI child is minimized, it sends a SEL_MINIMIZE message. When it is restored, it sends a SEL_RESTORE message to its target. The MDI child also notifies its target when it becomes the active MDI child, via the SEL_SELECTED message. The void* in the SEL_SELECTED message refers to the previously active MDI child, if any. When an MDI child ceases to be the active one, a SEL_DESELECTED message is sent. The void* in the SEL_DESELECTED message refers to the newly activated MDI child, if any. Thus, interception of SEL_SELECTED and SEL_DESELECTED allows the target object to determine whether the user switched between MDI windows of the same document (target) or between MDI windows belonging to the same document. When the MDI child is closed, it sends a SEL_CLOSE message to its target. The target has an opportunity to object to the closing; if the MDI child should not be closed, it should return 1 (objection). If the MDI child should be closed, the target can either just return 0 or simply not handle the SEL_CLOSE message. The SEL_UPDATE message can be used to modify the MDI child’s title (via ID_SETSTRINGVALUE), and window icon (via ID_SETICONVALUE).</p>
115115
116116 <h3 id="label-Events">Events</h3>
117117
136136 <p>sent when the right mouse button goes up; the message data is an FXEvent instance.</p>
137137 </dd><dt><code>SEL_SELECTED</code>
138138 <dd>
139 <p>sent when the window is selected; the message data is a reference to the MDI client&#39;s previous active child window, or <code>nil</code> if there was no active child window.</p>
139 <p>sent when the window is selected; the message data is a reference to the MDI client’s previous active child window, or <code>nil</code> if there was no active child window.</p>
140140 </dd><dt><code>SEL_DESELECTED</code>
141141 <dd>
142 <p>sent when the window is deselected; the message data is a reference to the MDI client&#39;s new active child window, or <code>nil</code> if there is no active child window.</p>
142 <p>sent when the window is deselected; the message data is a reference to the MDI client’s new active child window, or <code>nil</code> if there is no active child window.</p>
143143 </dd><dt><code>SEL_MAXIMIZE</code>
144144 <dd>
145145 <p>sent when the window is maximized</p>
21642164 </div>
21652165
21662166 <div id="footer">
2167 Generated on Fri Nov 27 21:10:57 2020 by
2168 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2169 0.9.24 (ruby-2.7.2).
2167 Generated on Mon Jan 2 11:47:44 2023 by
2168 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2169 0.9.28 (ruby-3.1.2).
21702170 </div>
21712171
21722172 </div>
111111 <h2>Overview</h2><div class="docstring">
112112 <div class="discussion">
113113
114 <p>The MDI client window manages a number of MDI child windows in a multiple-document interface (MDI) application. MDI child windows usually receive messages from the GUI controls by delegation via the MDI client. This is accomplished by making the MDI client window the target for most GUI controls. The MDI client filters out messages intented for itself, and delegates the remaining messages to its currently active MDI child, if any. If you use the auto-gray or auto-hide feature available in some GUI controls, these controls can be automatically grayed out or hidden when there is no active MDI child. When delegating messages via MDI client to MDI child windows of different types, care should be taken that message ID&#39;s do not overlap, so that all message ID&#39;s only map to the intented handlers no matter which MDI child window type is active. The MDI client sends a SEL_CHANGED message to its target when the active MDI child is switched, with the void # pointer refering to the new MDI child. A MDI Window selection dialog can be brought up through the ID_MDI_OVER_X messages; a menu button connected to the MDI client with the ID_MDI_OVER_X message will be automatically grayed out if there are less than X MDI child windows.</p>
114 <p>The MDI client window manages a number of MDI child windows in a multiple-document interface (MDI) application. MDI child windows usually receive messages from the GUI controls by delegation via the MDI client. This is accomplished by making the MDI client window the target for most GUI controls. The MDI client filters out messages intented for itself, and delegates the remaining messages to its currently active MDI child, if any. If you use the auto-gray or auto-hide feature available in some GUI controls, these controls can be automatically grayed out or hidden when there is no active MDI child. When delegating messages via MDI client to MDI child windows of different types, care should be taken that message ID’s do not overlap, so that all message ID’s only map to the intented handlers no matter which MDI child window type is active. The MDI client sends a SEL_CHANGED message to its target when the active MDI child is switched, with the void # pointer refering to the new MDI child. A MDI Window selection dialog can be brought up through the ID_MDI_OVER_X messages; a menu button connected to the MDI client with the ID_MDI_OVER_X message will be automatically grayed out if there are less than X MDI child windows.</p>
115115
116116 <h3 id="label-Events">Events</h3>
117117
770770 </div>
771771
772772 <div id="footer">
773 Generated on Fri Nov 27 21:11:06 2020 by
774 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
775 0.9.24 (ruby-2.7.2).
773 Generated on Mon Jan 2 11:47:52 2023 by
774 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
775 0.9.28 (ruby-3.1.2).
776776 </div>
777777
778778 </div>
323323 </div>
324324
325325 <div id="footer">
326 Generated on Fri Nov 27 21:11:03 2020 by
327 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
328 0.9.24 (ruby-2.7.2).
326 Generated on Mon Jan 2 11:47:50 2023 by
327 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
328 0.9.28 (ruby-3.1.2).
329329 </div>
330330
331331 </div>
323323 </div>
324324
325325 <div id="footer">
326 Generated on Fri Nov 27 21:11:04 2020 by
327 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
328 0.9.24 (ruby-2.7.2).
326 Generated on Mon Jan 2 11:47:50 2023 by
327 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
328 0.9.28 (ruby-3.1.2).
329329 </div>
330330
331331 </div>
324324 </div>
325325
326326 <div id="footer">
327 Generated on Fri Nov 27 21:11:05 2020 by
328 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
329 0.9.24 (ruby-2.7.2).
327 Generated on Mon Jan 2 11:47:52 2023 by
328 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
329 0.9.28 (ruby-3.1.2).
330330 </div>
331331
332332 </div>
323323 </div>
324324
325325 <div id="footer">
326 Generated on Fri Nov 27 21:11:04 2020 by
327 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
328 0.9.24 (ruby-2.7.2).
326 Generated on Mon Jan 2 11:47:51 2023 by
327 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
328 0.9.28 (ruby-3.1.2).
329329 </div>
330330
331331 </div>
323323 </div>
324324
325325 <div id="footer">
326 Generated on Fri Nov 27 21:11:03 2020 by
327 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
328 0.9.24 (ruby-2.7.2).
326 Generated on Mon Jan 2 11:47:50 2023 by
327 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
328 0.9.28 (ruby-3.1.2).
329329 </div>
330330
331331 </div>
323323 </div>
324324
325325 <div id="footer">
326 Generated on Fri Nov 27 21:11:05 2020 by
327 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
328 0.9.24 (ruby-2.7.2).
326 Generated on Mon Jan 2 11:47:51 2023 by
327 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
328 0.9.28 (ruby-3.1.2).
329329 </div>
330330
331331 </div>
326326 </div>
327327
328328 <div id="footer">
329 Generated on Fri Nov 27 21:11:17 2020 by
330 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
331 0.9.24 (ruby-2.7.2).
329 Generated on Mon Jan 2 11:48:03 2023 by
330 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
331 0.9.28 (ruby-3.1.2).
332332 </div>
333333
334334 </div>
559559 </div>
560560
561561 <div id="footer">
562 Generated on Fri Nov 27 21:10:55 2020 by
563 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
564 0.9.24 (ruby-2.7.2).
562 Generated on Mon Jan 2 11:47:42 2023 by
563 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
564 0.9.28 (ruby-3.1.2).
565565 </div>
566566
567567 </div>
723723 </div>
724724
725725 <div id="footer">
726 Generated on Fri Nov 27 21:10:42 2020 by
727 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
728 0.9.24 (ruby-2.7.2).
726 Generated on Mon Jan 2 11:47:30 2023 by
727 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
728 0.9.28 (ruby-3.1.2).
729729 </div>
730730
731731 </div>
461461 </div>
462462
463463 <div id="footer">
464 Generated on Fri Nov 27 21:11:28 2020 by
465 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
466 0.9.24 (ruby-2.7.2).
464 Generated on Mon Jan 2 11:48:13 2023 by
465 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
466 0.9.28 (ruby-3.1.2).
467467 </div>
468468
469469 </div>
621621 </div>
622622
623623 <div id="footer">
624 Generated on Fri Nov 27 21:11:28 2020 by
625 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
626 0.9.24 (ruby-2.7.2).
624 Generated on Mon Jan 2 11:48:13 2023 by
625 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
626 0.9.28 (ruby-3.1.2).
627627 </div>
628628
629629 </div>
336336 </div>
337337
338338 <div id="footer">
339 Generated on Fri Nov 27 21:10:48 2020 by
340 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
341 0.9.24 (ruby-2.7.2).
339 Generated on Mon Jan 2 11:47:36 2023 by
340 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
341 0.9.28 (ruby-3.1.2).
342342 </div>
343343
344344 </div>
113113 <h2>Overview</h2><div class="docstring">
114114 <div class="discussion">
115115
116 <p>An FXMenuButton posts a popup menu when clicked. There are many ways to control the placement where the popup will appear; first, the popup may be placed on either of the four sides relative to the menu button; this is controlled by the flags <code>MENUBUTTON_DOWN</code>, etc. Next, there are several attachment modes; the popup&#39;s left/bottom edge may attach to the menu button&#39;s left/top edge, or the popup&#39;s right/top edge may attach to the menu button&#39;s right/bottom edge, or both. Also, the popup may appear centered relative to the menu button. Finally, a small offset may be specified to displace the location of the popup by a few pixels so as to account for borders and so on. Normally, the menu button shows an arrow pointing to the direction where the popup is set to appear; this can be turned off by passing the option <code>MENUBUTTON_NOARROWS</code>.</p>
116 <p>An FXMenuButton posts a popup menu when clicked. There are many ways to control the placement where the popup will appear; first, the popup may be placed on either of the four sides relative to the menu button; this is controlled by the flags <code>MENUBUTTON_DOWN</code>, etc. Next, there are several attachment modes; the popup’s left/bottom edge may attach to the menu button’s left/top edge, or the popup’s right/top edge may attach to the menu button’s right/bottom edge, or both. Also, the popup may appear centered relative to the menu button. Finally, a small offset may be specified to displace the location of the popup by a few pixels so as to account for borders and so on. Normally, the menu button shows an arrow pointing to the direction where the popup is set to appear; this can be turned off by passing the option <code>MENUBUTTON_NOARROWS</code>.</p>
117117
118118 <h3 id="label-Events">Events</h3>
119119
151151
152152 <h3 id="label-Menu+Button+Popup+Style">Menu Button Popup Style</h3>
153153
154 <p>Any one of the following options can be assigned as the menu button&#39;s popup style.</p>
154 <p>Any one of the following options can be assigned as the menu button’s popup style.</p>
155155 <dl class="rdoc-list note-list"><dt><code>MENUBUTTON_DOWN</code>
156156 <dd>
157157 <p>Popup window appears below menu button</p>
168168
169169 <h3 id="label-Menu+Button+Attachment">Menu Button Attachment</h3>
170170
171 <p>Any combination of the following flags can be assigned as the menu button&#39;s attachment flags.</p>
171 <p>Any combination of the following flags can be assigned as the menu button’s attachment flags.</p>
172172 <dl class="rdoc-list note-list"><dt><code>MENUBUTTON_ATTACH_LEFT</code>
173173 <dd>
174174 <p>Popup attaches to the left side of the menu button</p>
818818 </div>
819819
820820 <div id="footer">
821 Generated on Fri Nov 27 21:11:17 2020 by
822 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
823 0.9.24 (ruby-2.7.2).
821 Generated on Mon Jan 2 11:48:03 2023 by
822 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
823 0.9.28 (ruby-3.1.2).
824824 </div>
825825
826826 </div>
479479
480480
481481 <span class="summary_desc"><div class='inline'>
482 <p>Return the menu caption&#39;s text.</p>
482 <p>Return the menu caption’s text.</p>
483483 </div></span>
484484
485485 </li>
10391039 </h3><div class="docstring">
10401040 <div class="discussion">
10411041
1042 <p>Return the menu caption&#39;s text</p>
1042 <p>Return the menu caption’s text</p>
10431043
10441044
10451045 </div>
10691069 </div>
10701070
10711071 <div id="footer">
1072 Generated on Fri Nov 27 21:11:24 2020 by
1073 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1074 0.9.24 (ruby-2.7.2).
1072 Generated on Mon Jan 2 11:48:10 2023 by
1073 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1074 0.9.28 (ruby-3.1.2).
10751075 </div>
10761076
10771077 </div>
377377 </div>
378378
379379 <div id="footer">
380 Generated on Fri Nov 27 21:11:24 2020 by
381 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
382 0.9.24 (ruby-2.7.2).
380 Generated on Mon Jan 2 11:48:10 2023 by
381 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
382 0.9.28 (ruby-3.1.2).
383383 </div>
384384
385385 </div>
710710 </div>
711711
712712 <div id="footer">
713 Generated on Fri Nov 27 21:11:06 2020 by
714 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
715 0.9.24 (ruby-2.7.2).
713 Generated on Mon Jan 2 11:47:52 2023 by
714 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
715 0.9.28 (ruby-3.1.2).
716716 </div>
717717
718718 </div>
389389 </div>
390390
391391 <div id="footer">
392 Generated on Fri Nov 27 21:11:25 2020 by
393 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
394 0.9.24 (ruby-2.7.2).
392 Generated on Mon Jan 2 11:48:10 2023 by
393 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
394 0.9.28 (ruby-3.1.2).
395395 </div>
396396
397397 </div>
322322 </div>
323323
324324 <div id="footer">
325 Generated on Fri Nov 27 21:10:57 2020 by
326 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
327 0.9.24 (ruby-2.7.2).
325 Generated on Mon Jan 2 11:47:44 2023 by
326 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
327 0.9.28 (ruby-3.1.2).
328328 </div>
329329
330330 </div>
710710 </div>
711711
712712 <div id="footer">
713 Generated on Fri Nov 27 21:11:06 2020 by
714 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
715 0.9.24 (ruby-2.7.2).
713 Generated on Mon Jan 2 11:47:52 2023 by
714 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
715 0.9.28 (ruby-3.1.2).
716716 </div>
717717
718718 </div>
429429 </div>
430430
431431 <div id="footer">
432 Generated on Fri Nov 27 21:11:31 2020 by
433 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
434 0.9.24 (ruby-2.7.2).
432 Generated on Mon Jan 2 11:48:16 2023 by
433 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
434 0.9.28 (ruby-3.1.2).
435435 </div>
436436
437437 </div>
394394 </div>
395395
396396 <div id="footer">
397 Generated on Fri Nov 27 21:11:06 2020 by
398 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
399 0.9.24 (ruby-2.7.2).
397 Generated on Mon Jan 2 11:47:53 2023 by
398 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
399 0.9.28 (ruby-3.1.2).
400400 </div>
401401
402402 </div>
143143 <p>Message box has <strong>Skip</strong>, *Skip All* and <strong>Cancel</strong> buttons</p>
144144 </dd><dt><code>MBOX_SAVE_CANCEL_DONTSAVE</code>
145145 <dd>
146 <p>Message box has *Don&#39;t Save*, <strong>Cancel</strong> and <strong>Save</strong> buttons</p>
146 <p>Message box has *Don’t Save*, <strong>Cancel</strong> and <strong>Save</strong> buttons</p>
147147 </dd></dl>
148148
149149 <h3 id="label-Return+values">Return values</h3>
173173 <p>The *Skip All* button was clicked</p>
174174 </dd><dt><code>MBOX_CLICKED_DONTSAVE</code>
175175 <dd>
176 <p>The *Don&#39;t Save* button was clicked (same as <code>MBOX_CLICKED_NO</code>)</p>
176 <p>The *Don’t Save* button was clicked (same as <code>MBOX_CLICKED_NO</code>)</p>
177177 </dd></dl>
178178
179179
647647 </div>
648648
649649 <div id="footer">
650 Generated on Fri Nov 27 21:11:18 2020 by
651 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
652 0.9.24 (ruby-2.7.2).
650 Generated on Mon Jan 2 11:48:04 2023 by
651 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
652 0.9.28 (ruby-3.1.2).
653653 </div>
654654
655655 </div>
103103 <h2>Overview</h2><div class="docstring">
104104 <div class="discussion">
105105
106 <p>FXObject is the base class for all objects in FOX; in order to receive messages from the user interface, your class must derive from FXObject. The FXObject class also provides serialization facilities, with which you can save and restore the object&#39;s state. If you&#39;ve subclassed from FXObject, you can save your subclasses&#39; state by overloading the save() and load() functions and use the stream API to serialize its member data.</p>
106 <p>FXObject is the base class for all objects in FOX; in order to receive messages from the user interface, your class must derive from FXObject. The FXObject class also provides serialization facilities, with which you can save and restore the object’s state. If you’ve subclassed from FXObject, you can save your subclasses’ state by overloading the save() and load() functions and use the stream API to serialize its member data.</p>
107107
108108
109109 </div>
534534 </div>
535535
536536 <div id="footer">
537 Generated on Fri Nov 27 21:10:42 2020 by
538 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
539 0.9.24 (ruby-2.7.2).
537 Generated on Mon Jan 2 11:47:30 2023 by
538 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
539 0.9.28 (ruby-3.1.2).
540540 </div>
541541
542542 </div>
480480 </div>
481481
482482 <div id="footer">
483 Generated on Fri Nov 27 21:11:18 2020 by
484 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
485 0.9.24 (ruby-2.7.2).
483 Generated on Mon Jan 2 11:48:04 2023 by
484 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
485 0.9.28 (ruby-3.1.2).
486486 </div>
487487
488488 </div>
874874 </div>
875875
876876 <div id="footer">
877 Generated on Fri Nov 27 21:11:19 2020 by
878 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
879 0.9.24 (ruby-2.7.2).
877 Generated on Mon Jan 2 11:48:05 2023 by
878 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
879 0.9.28 (ruby-3.1.2).
880880 </div>
881881
882882 </div>
439439 </div>
440440
441441 <div id="footer">
442 Generated on Fri Nov 27 21:10:48 2020 by
443 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
444 0.9.24 (ruby-2.7.2).
442 Generated on Mon Jan 2 11:47:36 2023 by
443 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
444 0.9.28 (ruby-3.1.2).
445445 </div>
446446
447447 </div>
423423 </div>
424424
425425 <div id="footer">
426 Generated on Fri Nov 27 21:10:57 2020 by
427 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
428 0.9.24 (ruby-2.7.2).
426 Generated on Mon Jan 2 11:47:44 2023 by
427 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
428 0.9.28 (ruby-3.1.2).
429429 </div>
430430
431431 </div>
513513 </div>
514514
515515 <div id="footer">
516 Generated on Fri Nov 27 21:10:48 2020 by
517 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
518 0.9.24 (ruby-2.7.2).
516 Generated on Mon Jan 2 11:47:36 2023 by
517 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
518 0.9.28 (ruby-3.1.2).
519519 </div>
520520
521521 </div>
497497 </div>
498498
499499 <div id="footer">
500 Generated on Fri Nov 27 21:10:57 2020 by
501 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
502 0.9.24 (ruby-2.7.2).
500 Generated on Mon Jan 2 11:47:44 2023 by
501 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
502 0.9.28 (ruby-3.1.2).
503503 </div>
504504
505505 </div>
439439 </div>
440440
441441 <div id="footer">
442 Generated on Fri Nov 27 21:10:49 2020 by
443 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
444 0.9.24 (ruby-2.7.2).
442 Generated on Mon Jan 2 11:47:36 2023 by
443 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
444 0.9.28 (ruby-3.1.2).
445445 </div>
446446
447447 </div>
362362 </div>
363363
364364 <div id="footer">
365 Generated on Fri Nov 27 21:10:57 2020 by
366 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
367 0.9.24 (ruby-2.7.2).
365 Generated on Mon Jan 2 11:47:44 2023 by
366 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
367 0.9.28 (ruby-3.1.2).
368368 </div>
369369
370370 </div>
489489 </div>
490490
491491 <div id="footer">
492 Generated on Fri Nov 27 21:10:46 2020 by
493 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
494 0.9.24 (ruby-2.7.2).
492 Generated on Mon Jan 2 11:47:33 2023 by
493 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
494 0.9.28 (ruby-3.1.2).
495495 </div>
496496
497497 </div>
12181218 </div>
12191219
12201220 <div id="footer">
1221 Generated on Fri Nov 27 21:10:43 2020 by
1222 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1223 0.9.24 (ruby-2.7.2).
1221 Generated on Mon Jan 2 11:47:30 2023 by
1222 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1223 0.9.28 (ruby-3.1.2).
12241224 </div>
12251225
12261226 </div>
334334 </div>
335335
336336 <div id="footer">
337 Generated on Fri Nov 27 21:10:43 2020 by
338 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
339 0.9.24 (ruby-2.7.2).
337 Generated on Mon Jan 2 11:47:30 2023 by
338 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
339 0.9.28 (ruby-3.1.2).
340340 </div>
341341
342342 </div>
10881088 </div>
10891089
10901090 <div id="footer">
1091 Generated on Fri Nov 27 21:10:38 2020 by
1092 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1093 0.9.24 (ruby-2.7.2).
1091 Generated on Mon Jan 2 11:47:26 2023 by
1092 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1093 0.9.28 (ruby-3.1.2).
10941094 </div>
10951095
10961096 </div>
474474 </div>
475475
476476 <div id="footer">
477 Generated on Fri Nov 27 21:11:25 2020 by
478 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
479 0.9.24 (ruby-2.7.2).
477 Generated on Mon Jan 2 11:48:11 2023 by
478 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
479 0.9.28 (ruby-3.1.2).
480480 </div>
481481
482482 </div>
13191319 </div>
13201320
13211321 <div id="footer">
1322 Generated on Fri Nov 27 21:10:46 2020 by
1323 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1324 0.9.24 (ruby-2.7.2).
1322 Generated on Mon Jan 2 11:47:33 2023 by
1323 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1324 0.9.28 (ruby-3.1.2).
13251325 </div>
13261326
13271327 </div>
11391139 </div>
11401140
11411141 <div id="footer">
1142 Generated on Fri Nov 27 21:11:26 2020 by
1143 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1144 0.9.24 (ruby-2.7.2).
1142 Generated on Mon Jan 2 11:48:11 2023 by
1143 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1144 0.9.28 (ruby-3.1.2).
11451145 </div>
11461146
11471147 </div>
704704 </div>
705705
706706 <div id="footer">
707 Generated on Fri Nov 27 21:11:33 2020 by
708 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
709 0.9.24 (ruby-2.7.2).
707 Generated on Mon Jan 2 11:48:18 2023 by
708 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
709 0.9.28 (ruby-3.1.2).
710710 </div>
711711
712712 </div>
417417 </div>
418418
419419 <div id="footer">
420 Generated on Fri Nov 27 21:11:37 2020 by
421 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
422 0.9.24 (ruby-2.7.2).
420 Generated on Mon Jan 2 11:48:22 2023 by
421 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
422 0.9.28 (ruby-3.1.2).
423423 </div>
424424
425425 </div>
789789 </div>
790790
791791 <div id="footer">
792 Generated on Fri Nov 27 21:11:37 2020 by
793 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
794 0.9.24 (ruby-2.7.2).
792 Generated on Mon Jan 2 11:48:22 2023 by
793 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
794 0.9.28 (ruby-3.1.2).
795795 </div>
796796
797797 </div>
461461 </div>
462462
463463 <div id="footer">
464 Generated on Fri Nov 27 21:11:36 2020 by
465 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
466 0.9.24 (ruby-2.7.2).
464 Generated on Mon Jan 2 11:48:21 2023 by
465 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
466 0.9.28 (ruby-3.1.2).
467467 </div>
468468
469469 </div>
13661366 </div>
13671367
13681368 <div id="footer">
1369 Generated on Fri Nov 27 21:10:38 2020 by
1370 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1371 0.9.24 (ruby-2.7.2).
1369 Generated on Mon Jan 2 11:47:26 2023 by
1370 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1371 0.9.28 (ruby-3.1.2).
13721372 </div>
13731373
13741374 </div>
13811381 </div>
13821382
13831383 <div id="footer">
1384 Generated on Fri Nov 27 21:10:38 2020 by
1385 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1386 0.9.24 (ruby-2.7.2).
1384 Generated on Mon Jan 2 11:47:26 2023 by
1385 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1386 0.9.28 (ruby-3.1.2).
13871387 </div>
13881388
13891389 </div>
439439 </div>
440440
441441 <div id="footer">
442 Generated on Fri Nov 27 21:10:49 2020 by
443 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
444 0.9.24 (ruby-2.7.2).
442 Generated on Mon Jan 2 11:47:36 2023 by
443 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
444 0.9.28 (ruby-3.1.2).
445445 </div>
446446
447447 </div>
423423 </div>
424424
425425 <div id="footer">
426 Generated on Fri Nov 27 21:10:57 2020 by
427 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
428 0.9.24 (ruby-2.7.2).
426 Generated on Mon Jan 2 11:47:44 2023 by
427 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
428 0.9.28 (ruby-3.1.2).
429429 </div>
430430
431431 </div>
874874 </div>
875875
876876 <div id="footer">
877 Generated on Fri Nov 27 21:11:26 2020 by
878 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
879 0.9.24 (ruby-2.7.2).
877 Generated on Mon Jan 2 11:48:11 2023 by
878 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
879 0.9.28 (ruby-3.1.2).
880880 </div>
881881
882882 </div>
15111511 </div>
15121512
15131513 <div id="footer">
1514 Generated on Fri Nov 27 21:10:43 2020 by
1515 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1516 0.9.24 (ruby-2.7.2).
1514 Generated on Mon Jan 2 11:47:31 2023 by
1515 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1516 0.9.28 (ruby-3.1.2).
15171517 </div>
15181518
15191519 </div>
15111511 </div>
15121512
15131513 <div id="footer">
1514 Generated on Fri Nov 27 21:10:43 2020 by
1515 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1516 0.9.24 (ruby-2.7.2).
1514 Generated on Mon Jan 2 11:47:31 2023 by
1515 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1516 0.9.28 (ruby-3.1.2).
15171517 </div>
15181518
15191519 </div>
11761176 </div>
11771177
11781178 <div id="footer">
1179 Generated on Fri Nov 27 21:11:19 2020 by
1180 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1181 0.9.24 (ruby-2.7.2).
1179 Generated on Mon Jan 2 11:48:05 2023 by
1180 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1181 0.9.28 (ruby-3.1.2).
11821182 </div>
11831183
11841184 </div>
126126 <p>sent when a key goes up; the message data is an FXEvent instance.</p>
127127 </dd><dt><code>SEL_COMMAND</code>
128128 <dd>
129 <p>sent whenever the spinner&#39;s value changes; the message data is a Float indicating the new spinner value.</p>
129 <p>sent whenever the spinner’s value changes; the message data is a Float indicating the new spinner value.</p>
130130 </dd><dt><code>SEL_CHANGED</code>
131131 <dd>
132 <p>sent whenever the text in the spinner&#39;s text field changes; the message data is a Float indicating the new spinner value.</p>
132 <p>sent whenever the text in the spinner’s text field changes; the message data is a Float indicating the new spinner value.</p>
133133 </dd></dl>
134134
135135 <h3 id="label-Spinner+options">Spinner options</h3>
334334
335335
336336 <span class="summary_desc"><div class='inline'>
337 <p>Number of columns (i.e. width of spinner&#39;s text field, in terms of number of columns of &#39;m&#39;) [Integer].</p>
337 <p>Number of columns (i.e. width of spinner’s text field, in terms of number of columns of ‘m’) [Integer].</p>
338338 </div></span>
339339
340340 </li>
703703
704704
705705 <span class="summary_desc"><div class='inline'>
706 <p>Set the “editability” of this spinner&#39;s text field.</p>
706 <p>Set the “editability” of this spinner’s text field.</p>
707707 </div></span>
708708
709709 </li>
727727
728728
729729 <span class="summary_desc"><div class='inline'>
730 <p>Return <code>true</code> if the spinner&#39;s text field is editable.</p>
730 <p>Return <code>true</code> if the spinner’s text field is editable.</p>
731731 </div></span>
732732
733733 </li>
873873
874874
875875 <span class="summary_desc"><div class='inline'>
876 <p>Set the visibility of this spinner&#39;s text field.</p>
876 <p>Set the visibility of this spinner’s text field.</p>
877877 </div></span>
878878
879879 </li>
897897
898898
899899 <span class="summary_desc"><div class='inline'>
900 <p>Return <code>true</code> if this spinner&#39;s text field is visible.</p>
900 <p>Return <code>true</code> if this spinner’s text field is visible.</p>
901901 </div></span>
902902
903903 </li>
12961296 </h3><div class="docstring">
12971297 <div class="discussion">
12981298
1299 <p>Number of columns (i.e. width of spinner&#39;s text field, in terms of number of columns of &#39;m&#39;) [Integer]</p>
1299 <p>Number of columns (i.e. width of spinner’s text field, in terms of number of columns of ‘m’) [Integer]</p>
13001300
13011301
13021302 </div>
18491849 </h3><div class="docstring">
18501850 <div class="discussion">
18511851
1852 <p>Set the “editability” of this spinner&#39;s text field.</p>
1852 <p>Set the “editability” of this spinner’s text field.</p>
18531853
18541854
18551855 </div>
18861886 </h3><div class="docstring">
18871887 <div class="discussion">
18881888
1889 <p>Return <code>true</code> if the spinner&#39;s text field is editable.</p>
1889 <p>Return <code>true</code> if the spinner’s text field is editable.</p>
18901890
18911891
18921892 </div>
20472047 </h3><div class="docstring">
20482048 <div class="discussion">
20492049
2050 <p>Change the spinner increment value, i.e. the amount by which the spinner&#39;s value increases when the up arrow is clicked.</p>
2050 <p>Change the spinner increment value, i.e. the amount by which the spinner’s value increases when the up arrow is clicked.</p>
20512051
20522052
20532053 </div>
20842084 </h3><div class="docstring">
20852085 <div class="discussion">
20862086
2087 <p>Set the visibility of this spinner&#39;s text field.</p>
2087 <p>Set the visibility of this spinner’s text field.</p>
20882088
20892089
20902090 </div>
21212121 </h3><div class="docstring">
21222122 <div class="discussion">
21232123
2124 <p>Return <code>true</code> if this spinner&#39;s text field is visible.</p>
2124 <p>Return <code>true</code> if this spinner’s text field is visible.</p>
21252125
21262126
21272127 </div>
21642164 </div>
21652165
21662166 <div id="footer">
2167 Generated on Fri Nov 27 21:11:26 2020 by
2168 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2169 0.9.24 (ruby-2.7.2).
2167 Generated on Mon Jan 2 11:48:12 2023 by
2168 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2169 0.9.28 (ruby-3.1.2).
21702170 </div>
21712171
21722172 </div>
830830 </div>
831831
832832 <div id="footer">
833 Generated on Fri Nov 27 21:11:26 2020 by
834 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
835 0.9.24 (ruby-2.7.2).
833 Generated on Mon Jan 2 11:48:12 2023 by
834 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
835 0.9.28 (ruby-3.1.2).
836836 </div>
837837
838838 </div>
191191
192192
193193 <span class="summary_desc"><div class='inline'>
194 <p>Upper left corner&#39;s x-coordinate [Integer].</p>
194 <p>Upper left corner’s x-coordinate [Integer].</p>
195195 </div></span>
196196
197197 </li>
218218
219219
220220 <span class="summary_desc"><div class='inline'>
221 <p>Upper left corner&#39;s y-coordinate [Integer].</p>
221 <p>Upper left corner’s y-coordinate [Integer].</p>
222222 </div></span>
223223
224224 </li>
329329
330330
331331 <span class="summary_desc"><div class='inline'>
332 <p>Shift each of the rectangle&#39;s corners by the amount (<em>dx</em>, <em>dy</em>) and return a reference to the rectangle.</p>
332 <p>Shift each of the rectangle’s corners by the amount (<em>dx</em>, <em>dy</em>) and return a reference to the rectangle.</p>
333333 </div></span>
334334
335335 </li>
382382 <h4 id="label-Parameters-3A">Parameters:</h4>
383383 <dl class="rdoc-list note-list"><dt><code>topleft</code>
384384 <dd>
385 <p>upper left corner&#39;s initial position FXPoint</p>
385 <p>upper left corner’s initial position FXPoint</p>
386386 </dd><dt><code>bottomright</code>
387387 <dd>
388 <p>bottom right corner&#39;s initial position FXPoint</p>
388 <p>bottom right corner’s initial position FXPoint</p>
389389 </dd></dl>
390390
391391
516516 </h3><div class="docstring">
517517 <div class="discussion">
518518
519 <p>Upper left corner&#39;s x-coordinate [Integer]</p>
519 <p>Upper left corner’s x-coordinate [Integer]</p>
520520
521521
522522 </div>
559559 </h3><div class="docstring">
560560 <div class="discussion">
561561
562 <p>Upper left corner&#39;s y-coordinate [Integer]</p>
562 <p>Upper left corner’s y-coordinate [Integer]</p>
563563
564564
565565 </div>
709709 </h3><div class="docstring">
710710 <div class="discussion">
711711
712 <p>Shift each of the rectangle&#39;s corners by the amount (<em>dx</em>, <em>dy</em>) and return a reference to the rectangle.</p>
712 <p>Shift each of the rectangle’s corners by the amount (<em>dx</em>, <em>dy</em>) and return a reference to the rectangle.</p>
713713
714714
715715 </div>
791791 </div>
792792
793793 <div id="footer">
794 Generated on Fri Nov 27 21:11:06 2020 by
795 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
796 0.9.24 (ruby-2.7.2).
794 Generated on Mon Jan 2 11:47:53 2023 by
795 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
796 0.9.28 (ruby-3.1.2).
797797 </div>
798798
799799 </div>
830830 </div>
831831
832832 <div id="footer">
833 Generated on Fri Nov 27 21:10:43 2020 by
834 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
835 0.9.24 (ruby-2.7.2).
833 Generated on Mon Jan 2 11:47:31 2023 by
834 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
835 0.9.28 (ruby-3.1.2).
836836 </div>
837837
838838 </div>
245245
246246
247247 <span class="summary_desc"><div class='inline'>
248 <p>Return <code>true</code> if we&#39;re using a file-based registry mechanism instead of the Windows Registry (only relevant on Windows systems).</p>
248 <p>Return <code>true</code> if we’re using a file-based registry mechanism instead of the Windows Registry (only relevant on Windows systems).</p>
249249 </div></span>
250250
251251 </li>
554554 </h3><div class="docstring">
555555 <div class="discussion">
556556
557 <p>Return <code>true</code> if we&#39;re using a file-based registry mechanism instead of the Windows Registry (only relevant on Windows systems).</p>
557 <p>Return <code>true</code> if we’re using a file-based registry mechanism instead of the Windows Registry (only relevant on Windows systems).</p>
558558
559559
560560 </div>
671671 </div>
672672
673673 <div id="footer">
674 Generated on Fri Nov 27 21:10:57 2020 by
675 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
676 0.9.24 (ruby-2.7.2).
674 Generated on Mon Jan 2 11:47:44 2023 by
675 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
676 0.9.28 (ruby-3.1.2).
677677 </div>
678678
679679 </div>
637637 </div>
638638
639639 <div id="footer">
640 Generated on Fri Nov 27 21:11:32 2020 by
641 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
642 0.9.24 (ruby-2.7.2).
640 Generated on Mon Jan 2 11:48:17 2023 by
641 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
642 0.9.28 (ruby-3.1.2).
643643 </div>
644644
645645 </div>
301301 </div>
302302
303303 <div id="footer">
304 Generated on Fri Nov 27 21:11:19 2020 by
305 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
306 0.9.24 (ruby-2.7.2).
304 Generated on Mon Jan 2 11:48:05 2023 by
305 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
306 0.9.28 (ruby-3.1.2).
307307 </div>
308308
309309 </div>
19891989 </div>
19901990
19911991 <div id="footer">
1992 Generated on Fri Nov 27 21:10:38 2020 by
1993 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1994 0.9.24 (ruby-2.7.2).
1992 Generated on Mon Jan 2 11:47:26 2023 by
1993 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1994 0.9.28 (ruby-3.1.2).
19951995 </div>
19961996
19971997 </div>
13201320
13211321
13221322 <span class="summary_desc"><div class='inline'>
1323 <p>Set horizontal pixels per tick spacing If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler&#39;s target after the spacing is changed.</p>
1323 <p>Set horizontal pixels per tick spacing If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler’s target after the spacing is changed.</p>
13241324 </div></span>
13251325
13261326 </li>
15601560
15611561
15621562 <span class="summary_desc"><div class='inline'>
1563 <p>Set vertical pixels per tick spacing If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler&#39;s target after the spacing is changed.</p>
1563 <p>Set vertical pixels per tick spacing If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler’s target after the spacing is changed.</p>
15641564 </div></span>
15651565
15661566 </li>
32163216 </h3><div class="docstring">
32173217 <div class="discussion">
32183218
3219 <p>Set document width (in pixels). If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler&#39;s target after the document size is changed.</p>
3219 <p>Set document width (in pixels). If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler’s target after the document size is changed.</p>
32203220
32213221
32223222 </div>
32533253 </h3><div class="docstring">
32543254 <div class="discussion">
32553255
3256 <p>Set horizontal alignment; the default is <code>RULER_ALIGN_NORMAL</code>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler&#39;s target after the alignment is changed.</p>
3256 <p>Set horizontal alignment; the default is <code>RULER_ALIGN_NORMAL</code>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler’s target after the alignment is changed.</p>
32573257
32583258
32593259 </div>
32903290 </h3><div class="docstring">
32913291 <div class="discussion">
32923292
3293 <p>Set horizontal edge spacing around document (in pixels). If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler&#39;s target after the edge spacing is changed.</p>
3293 <p>Set horizontal edge spacing around document (in pixels). If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler’s target after the edge spacing is changed.</p>
32943294
32953295
32963296 </div>
33273327 </h3><div class="docstring">
33283328 <div class="discussion">
33293329
3330 <p>Set number of horizontal major ticks. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler&#39;s target after the number of ticks is changed.</p>
3330 <p>Set number of horizontal major ticks. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler’s target after the number of ticks is changed.</p>
33313331
33323332
33333333 </div>
33643364 </h3><div class="docstring">
33653365 <div class="discussion">
33663366
3367 <p>Set horizontal lower margin (in pixels). If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler&#39;s target after the margin is changed.</p>
3367 <p>Set horizontal lower margin (in pixels). If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler’s target after the margin is changed.</p>
33683368
33693369
33703370 </div>
34013401 </h3><div class="docstring">
34023402 <div class="discussion">
34033403
3404 <p>Set horizontal upper margin (in pixels). If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler&#39;s target after the margin is changed.</p>
3404 <p>Set horizontal upper margin (in pixels). If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler’s target after the margin is changed.</p>
34053405
34063406
34073407 </div>
34383438 </h3><div class="docstring">
34393439 <div class="discussion">
34403440
3441 <p>Set number of horizontal medium ticks. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler&#39;s target after the number of ticks is changed.</p>
3441 <p>Set number of horizontal medium ticks. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler’s target after the number of ticks is changed.</p>
34423442
34433443
34443444 </div>
34753475 </h3><div class="docstring">
34763476 <div class="discussion">
34773477
3478 <p>Set number of horizontal “number” ticks. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler&#39;s target after the number of ticks is changed.</p>
3478 <p>Set number of horizontal “number” ticks. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler’s target after the number of ticks is changed.</p>
34793479
34803480
34813481 </div>
35123512 </h3><div class="docstring">
35133513 <div class="discussion">
35143514
3515 <p>Set horizontal pixels per tick spacing If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler&#39;s target after the spacing is changed.</p>
3515 <p>Set horizontal pixels per tick spacing If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler’s target after the spacing is changed.</p>
35163516
35173517
35183518 </div>
35493549 </h3><div class="docstring">
35503550 <div class="discussion">
35513551
3552 <p>Set horizontal ruler font. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler&#39;s target after the font is changed.</p>
3552 <p>Set horizontal ruler font. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler’s target after the font is changed.</p>
35533553
35543554
35553555 </div>
35863586 </h3><div class="docstring">
35873587 <div class="discussion">
35883588
3589 <p>Set number of horizontal tiny ticks. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler&#39;s target after the number of ticks is changed.</p>
3589 <p>Set number of horizontal tiny ticks. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the horizontal ruler’s target after the number of ticks is changed.</p>
35903590
35913591
35923592 </div>
36233623 </h3><div class="docstring">
36243624 <div class="discussion">
36253625
3626 <p>Set vertical alignment; the default is <code>RULER_ALIGN_NORMAL</code>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler&#39;s target after the alignment is changed.</p>
3626 <p>Set vertical alignment; the default is <code>RULER_ALIGN_NORMAL</code>. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler’s target after the alignment is changed.</p>
36273627
36283628
36293629 </div>
36603660 </h3><div class="docstring">
36613661 <div class="discussion">
36623662
3663 <p>Set vertical edge spacing around document (in pixels). If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler&#39;s target after the edge spacing is changed.</p>
3663 <p>Set vertical edge spacing around document (in pixels). If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler’s target after the edge spacing is changed.</p>
36643664
36653665
36663666 </div>
36973697 </h3><div class="docstring">
36983698 <div class="discussion">
36993699
3700 <p>Set number of vertical major ticks. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler&#39;s target after the number of ticks is changed.</p>
3700 <p>Set number of vertical major ticks. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler’s target after the number of ticks is changed.</p>
37013701
37023702
37033703 </div>
37343734 </h3><div class="docstring">
37353735 <div class="discussion">
37363736
3737 <p>Set vertical lower margin (in pixels). If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler&#39;s target after the margin is changed.</p>
3737 <p>Set vertical lower margin (in pixels). If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler’s target after the margin is changed.</p>
37383738
37393739
37403740 </div>
37713771 </h3><div class="docstring">
37723772 <div class="discussion">
37733773
3774 <p>Set vertical upper margin (in pixels). If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler&#39;s target after the margin is changed.</p>
3774 <p>Set vertical upper margin (in pixels). If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler’s target after the margin is changed.</p>
37753775
37763776
37773777 </div>
38083808 </h3><div class="docstring">
38093809 <div class="discussion">
38103810
3811 <p>Set number of vertical medium ticks. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler&#39;s target after the number of ticks is changed.</p>
3811 <p>Set number of vertical medium ticks. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler’s target after the number of ticks is changed.</p>
38123812
38133813
38143814 </div>
38453845 </h3><div class="docstring">
38463846 <div class="discussion">
38473847
3848 <p>Set number of vertical “number” ticks. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler&#39;s target after the number of ticks is changed.</p>
3848 <p>Set number of vertical “number” ticks. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler’s target after the number of ticks is changed.</p>
38493849
38503850
38513851 </div>
38823882 </h3><div class="docstring">
38833883 <div class="discussion">
38843884
3885 <p>Set vertical pixels per tick spacing If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler&#39;s target after the spacing is changed.</p>
3885 <p>Set vertical pixels per tick spacing If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler’s target after the spacing is changed.</p>
38863886
38873887
38883888 </div>
39193919 </h3><div class="docstring">
39203920 <div class="discussion">
39213921
3922 <p>Set vertical ruler font. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler&#39;s target after the font is changed.</p>
3922 <p>Set vertical ruler font. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler’s target after the font is changed.</p>
39233923
39243924
39253925 </div>
39563956 </h3><div class="docstring">
39573957 <div class="discussion">
39583958
3959 <p>Set number of vertical tiny ticks. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler&#39;s target after the number of ticks is changed.</p>
3959 <p>Set number of vertical tiny ticks. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the vertical ruler’s target after the number of ticks is changed.</p>
39603960
39613961
39623962 </div>
39863986 </div>
39873987
39883988 <div id="footer">
3989 Generated on Fri Nov 27 21:11:07 2020 by
3990 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
3991 0.9.24 (ruby-2.7.2).
3989 Generated on Mon Jan 2 11:47:53 2023 by
3990 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
3991 0.9.28 (ruby-3.1.2).
39923992 </div>
39933993
39943994 </div>
115115 <h2>Overview</h2><div class="docstring">
116116 <div class="discussion">
117117
118 <p>FXScintilla is a FOX widget, developed by Gilles Filippini, that provides an interface to Neil Hodgson&#39;s Scintilla (<a href="http://www.scintilla.org">www.scintilla.org</a>) source code editing component. The Scintilla component is a very complicated beast, and for best results you should read the very fine documentation at <a href="http://www.scintilla.org/ScintillaDoc.html">www.scintilla.org/ScintillaDoc.html</a>.</p>
118 <p>FXScintilla is a FOX widget, developed by Gilles Filippini, that provides an interface to Neil Hodgson’s Scintilla (<a href="http://www.scintilla.org">www.scintilla.org</a>) source code editing component. The Scintilla component is a very complicated beast, and for best results you should read the very fine documentation at <a href="http://www.scintilla.org/ScintillaDoc.html">www.scintilla.org/ScintillaDoc.html</a>.</p>
119119
120120 <h3 id="label-Events">Events</h3>
121121
160160
161161 </div>
162162 </dt>
163 <dd><pre class="code"><span class='op'>-</span><span class='int'>1</span><span class='comment'># Define start of Scintilla messages to be greater than all Windows edit (EM_*) messages
164 </span><span class='comment'># as many EM_ messages can be used although that use is deprecated.</span>
165 </pre></dd>
163 <dd><pre class="code"><span class='op'>-</span><span class='int'>1</span>
164 <span class='comment'># Define start of Scintilla messages to be greater than all Windows edit (EM_*) messages
165 </span><span class='comment'># as many EM_ messages can be used although that use is deprecated.</span></pre></dd>
166166
167167 <dt id="SCI_START-constant" class="">SCI_START =
168168 <div class="docstring">
1257812578
1257912579
1258012580 <span class="summary_desc"><div class='inline'>
12581 <p>Retrieve a &#39;n&#39; separated list of descriptions of the keyword sets understood by the current lexer.</p>
12581 <p>Retrieve a ‘n’ separated list of descriptions of the keyword sets understood by the current lexer.</p>
1258212582 </div></span>
1258312583
1258412584 </li>
1843418434
1843518435
1843618436 <span class="summary_desc"><div class='inline'>
18437 <p>Move the caret inside current view if it&#39;s not there already.</p>
18437 <p>Move the caret inside current view if it’s not there already.</p>
1843818438 </div></span>
1843918439
1844018440 </li>
1900419004
1900519005
1900619006 <span class="summary_desc"><div class='inline'>
19007 <p>Retrieve a &#39;n&#39; separated list of properties understood by the current lexer.</p>
19007 <p>Retrieve a ‘n’ separated list of properties understood by the current lexer.</p>
1900819008 </div></span>
1900919009
1901019010 </li>
2061020610
2061120611
2061220612 <span class="summary_desc"><div class='inline'>
20613 <p>Limit hotspots to single line so hotspots on two lines don&#39;t merge.</p>
20613 <p>Limit hotspots to single line so hotspots on two lines don’t merge.</p>
2061420614 </div></span>
2061520615
2061620616 </li>
2163421634
2163521635
2163621636 <span class="summary_desc"><div class='inline'>
21637 <p>Set the identifier for this widget&#39;s embedded Scintilla component.</p>
21637 <p>Set the identifier for this widget’s embedded Scintilla component.</p>
2163821638 </div></span>
2163921639
2164021640 </li>
2234622346
2234722347
2234822348 <span class="summary_desc"><div class='inline'>
22349 <p>In palette mode, Scintilla uses the environment&#39;s palette calls to display more colours.</p>
22349 <p>In palette mode, Scintilla uses the environment’s palette calls to display more colours.</p>
2235022350 </div></span>
2235122351
2235222352 </li>
2654826548 </h3><div class="docstring">
2654926549 <div class="discussion">
2655026550
26551 <p>Change the type-separator character in the string setting up an auto-completion list. Default is &#39;?&#39; but can be changed if items contain &#39;?&#39;.</p>
26551 <p>Change the type-separator character in the string setting up an auto-completion list. Default is ‘?’ but can be changed if items contain ‘?’.</p>
2655226552
2655326553
2655426554 </div>
2884428844 </h3><div class="docstring">
2884528845 <div class="discussion">
2884628846
28847 <p>Retrieve a &#39;n&#39; separated list of descriptions of the keyword sets understood by the current lexer.</p>
28847 <p>Retrieve a ‘n’ separated list of descriptions of the keyword sets understood by the current lexer.</p>
2884828848
2884928849
2885028850 </div>
3874538745 </h3><div class="docstring">
3874638746 <div class="discussion">
3874738747
38748 <p>Move the caret inside current view if it&#39;s not there already.</p>
38748 <p>Move the caret inside current view if it’s not there already.</p>
3874938749
3875038750
3875138751 </div>
3969639696 </h3><div class="docstring">
3969739697 <div class="discussion">
3969839698
39699 <p>Retrieve a &#39;n&#39; separated list of properties understood by the current lexer.</p>
39699 <p>Retrieve a ‘n’ separated list of properties understood by the current lexer.</p>
3970039700
3970139701
3970239702 </div>
4059840598 </h3><div class="docstring">
4059940599 <div class="discussion">
4060040600
40601 <p>Send a message (<em>iMsg</em>) to the Scintilla control, with optional <em>wParam</em> and <em>lParam</em> values. Note that in most cases, it will be easier to use one of the convenience methods defined in the &#39;scintilla&#39; library module.</p>
40601 <p>Send a message (<em>iMsg</em>) to the Scintilla control, with optional <em>wParam</em> and <em>lParam</em> values. Note that in most cases, it will be easier to use one of the convenience methods defined in the ‘scintilla’ library module.</p>
4060240602
4060340603
4060440604 </div>
4242842428 </h3><div class="docstring">
4242942429 <div class="discussion">
4243042430
42431 <p>Limit hotspots to single line so hotspots on two lines don&#39;t merge.</p>
42431 <p>Limit hotspots to single line so hotspots on two lines don’t merge.</p>
4243242432
4243342433
4243442434 </div>
4414744147 </h3><div class="docstring">
4414844148 <div class="discussion">
4414944149
44150 <p>Set the identifier for this widget&#39;s embedded Scintilla component.</p>
44150 <p>Set the identifier for this widget’s embedded Scintilla component.</p>
4415144151
4415244152
4415344153 </div>
4532945329 </h3><div class="docstring">
4533045330 <div class="discussion">
4533145331
45332 <p>In palette mode, Scintilla uses the environment&#39;s palette calls to display more colours. This may lead to ugly displays.</p>
45332 <p>In palette mode, Scintilla uses the environment’s palette calls to display more colours. This may lead to ugly displays.</p>
4533345333
4533445334
4533545335 </div>
4910649106 </div>
4910749107
4910849108 <div id="footer">
49109 Generated on Fri Nov 27 21:11:12 2020 by
49110 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
49111 0.9.24 (ruby-2.7.2).
49109 Generated on Mon Jan 2 11:47:59 2023 by
49110 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
49111 0.9.28 (ruby-3.1.2).
4911249112 </div>
4911349113
4911449114 </div>
113113 <h2>Overview</h2><div class="docstring">
114114 <div class="discussion">
115115
116 <p>The scroll area widget manages a content area and a viewport area through which the content is viewed. When the content area becomes larger than the viewport area, scrollbars are placed to permit viewing of the entire content by scrolling the content. Depending on the mode, scrollbars may be displayed on an as-needed basis, always, or never. Normally, the scroll area&#39;s size and the content&#39;s size are independent; however, it is possible to disable scrolling in the horizontal (vertical) direction. In this case, the content width (height) will influence the width (height) of the scroll area widget. For content which is time-consuming to repaint, continuous scrolling may be turned off.</p>
116 <p>The scroll area widget manages a content area and a viewport area through which the content is viewed. When the content area becomes larger than the viewport area, scrollbars are placed to permit viewing of the entire content by scrolling the content. Depending on the mode, scrollbars may be displayed on an as-needed basis, always, or never. Normally, the scroll area’s size and the content’s size are independent; however, it is possible to disable scrolling in the horizontal (vertical) direction. In this case, the content width (height) will influence the width (height) of the scroll area widget. For content which is time-consuming to repaint, continuous scrolling may be turned off.</p>
117117
118118 <h3 id="label-Scrollbar+options">Scrollbar options</h3>
119119 <dl class="rdoc-list note-list"><dt><code>SCROLLERS_NORMAL</code>
148148 <p>Scrollers track continuously for smooth scrolling</p>
149149 </dd><dt><code>SCROLLERS_DONT_TRACK</code>
150150 <dd>
151 <p>Scrollers don&#39;t track continuously</p>
151 <p>Scrollers don’t track continuously</p>
152152 </dd></dl>
153153
154154
13521352 </div>
13531353
13541354 <div id="footer">
1355 Generated on Fri Nov 27 21:11:19 2020 by
1356 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1357 0.9.24 (ruby-2.7.2).
1355 Generated on Mon Jan 2 11:48:05 2023 by
1356 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1357 0.9.28 (ruby-3.1.2).
13581358 </div>
13591359
13601360 </div>
10081008 </div>
10091009
10101010 <div id="footer">
1011 Generated on Fri Nov 27 21:11:12 2020 by
1012 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1013 0.9.24 (ruby-2.7.2).
1011 Generated on Mon Jan 2 11:47:59 2023 by
1012 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1013 0.9.28 (ruby-3.1.2).
10141014 </div>
10151015
10161016 </div>
279279 </div>
280280
281281 <div id="footer">
282 Generated on Fri Nov 27 21:11:12 2020 by
283 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
284 0.9.24 (ruby-2.7.2).
282 Generated on Mon Jan 2 11:47:59 2023 by
283 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
284 0.9.28 (ruby-3.1.2).
285285 </div>
286286
287287 </div>
488488 </div>
489489
490490 <div id="footer">
491 Generated on Fri Nov 27 21:11:20 2020 by
492 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
493 0.9.24 (ruby-2.7.2).
491 Generated on Mon Jan 2 11:48:06 2023 by
492 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
493 0.9.28 (ruby-3.1.2).
494494 </div>
495495
496496 </div>
113113 <h2>Overview</h2><div class="docstring">
114114 <div class="discussion">
115115
116 <p>The FXScrollWindow widget scrolls an arbitrary child window. Use the scroll window when parts of the user interface itself need to be scrolled, for example when applications need to run on small screens. The scroll window observes some layout hints of its content-window; it observes <code>LAYOUT_FIX_WIDTH</code>, <code>LAYOUT_FIX_HEIGHT</code> at all times. The hints <code>LAYOUT_FILL_X</code>, <code>LAYOUT_LEFT</code>, <code>LAYOUT_RIGHT</code>, <code>LAYOUT_CENTER_X</code>, as well as <code>LAYOUT_FILL_Y</code>, <code>LAYOUT_TOP</code>, <code>LAYOUT_BOTTOM</code>, <code>LAYOUT_CENTER_Y</code> are however only interpreted if the content size is smaller than the viewport size, because if the content size is larger than the viewport size, then content must be scrolled. Note that this means that the content window&#39;s position is not necessarily equal to the scroll position of the scroll window!</p>
116 <p>The FXScrollWindow widget scrolls an arbitrary child window. Use the scroll window when parts of the user interface itself need to be scrolled, for example when applications need to run on small screens. The scroll window observes some layout hints of its content-window; it observes <code>LAYOUT_FIX_WIDTH</code>, <code>LAYOUT_FIX_HEIGHT</code> at all times. The hints <code>LAYOUT_FILL_X</code>, <code>LAYOUT_LEFT</code>, <code>LAYOUT_RIGHT</code>, <code>LAYOUT_CENTER_X</code>, as well as <code>LAYOUT_FILL_Y</code>, <code>LAYOUT_TOP</code>, <code>LAYOUT_BOTTOM</code>, <code>LAYOUT_CENTER_Y</code> are however only interpreted if the content size is smaller than the viewport size, because if the content size is larger than the viewport size, then content must be scrolled. Note that this means that the content window’s position is not necessarily equal to the scroll position of the scroll window!</p>
117117
118118
119119 </div>
398398 </div>
399399
400400 <div id="footer">
401 Generated on Fri Nov 27 21:11:28 2020 by
402 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
403 0.9.24 (ruby-2.7.2).
401 Generated on Mon Jan 2 11:48:13 2023 by
402 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
403 0.9.28 (ruby-3.1.2).
404404 </div>
405405
406406 </div>
371371 </div>
372372
373373 <div id="footer">
374 Generated on Fri Nov 27 21:11:30 2020 by
375 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
376 0.9.24 (ruby-2.7.2).
374 Generated on Mon Jan 2 11:48:15 2023 by
375 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
376 0.9.28 (ruby-3.1.2).
377377 </div>
378378
379379 </div>
411411 </div>
412412
413413 <div id="footer">
414 Generated on Fri Nov 27 21:10:34 2020 by
415 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
416 0.9.24 (ruby-2.7.2).
414 Generated on Mon Jan 2 11:47:22 2023 by
415 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
416 0.9.28 (ruby-3.1.2).
417417 </div>
418418
419419 </div>
111111 <h2>Overview</h2><div class="docstring">
112112 <div class="discussion">
113113
114 <p>A Separator widget is used to draw a horizontal or vertical divider between groups of controls. It is purely decorative. The separator may be drawn in various styles as determined by the SEPARATOR_NONE, SEPARATOR_GROOVE, SEPARATOR_RIDGE, and SEPARATOR_LINE options. Since its derived from Frame, it can also have the frame&#39;s border styles.</p>
114 <p>A Separator widget is used to draw a horizontal or vertical divider between groups of controls. It is purely decorative. The separator may be drawn in various styles as determined by the SEPARATOR_NONE, SEPARATOR_GROOVE, SEPARATOR_RIDGE, and SEPARATOR_LINE options. Since its derived from Frame, it can also have the frame’s border styles.</p>
115115
116116 <h3 id="label-Separator+options">Separator options</h3>
117117 <dl class="rdoc-list note-list"><dt><code>SEPARATOR_NONE</code>
391391 </div>
392392
393393 <div id="footer">
394 Generated on Fri Nov 27 21:11:12 2020 by
395 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
396 0.9.24 (ruby-2.7.2).
394 Generated on Mon Jan 2 11:47:59 2023 by
395 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
396 0.9.28 (ruby-3.1.2).
397397 </div>
398398
399399 </div>
18501850 </div>
18511851
18521852 <div id="footer">
1853 Generated on Fri Nov 27 21:10:57 2020 by
1854 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1855 0.9.24 (ruby-2.7.2).
1853 Generated on Mon Jan 2 11:47:44 2023 by
1854 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1855 0.9.28 (ruby-3.1.2).
18561856 </div>
18571857
18581858 </div>
222222 </div>
223223
224224 <div id="footer">
225 Generated on Fri Nov 27 21:10:38 2020 by
226 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
227 0.9.24 (ruby-2.7.2).
225 Generated on Mon Jan 2 11:47:26 2023 by
226 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
227 0.9.28 (ruby-3.1.2).
228228 </div>
229229
230230 </div>
115115 <h2>Overview</h2><div class="docstring">
116116 <div class="discussion">
117117
118 <p>The Shutter widget provides a set of foldable sub panels. Each subpanel consists of a Shutter Item which contains a button and some contents. A sub panel can be unfolded by pressing on that panel&#39;s button.</p>
118 <p>The Shutter widget provides a set of foldable sub panels. Each subpanel consists of a Shutter Item which contains a button and some contents. A sub panel can be unfolded by pressing on that panel’s button.</p>
119119
120120 <h3 id="label-Events">Events</h3>
121121
461461 </div>
462462
463463 <div id="footer">
464 Generated on Fri Nov 27 21:10:49 2020 by
465 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
466 0.9.24 (ruby-2.7.2).
464 Generated on Mon Jan 2 11:47:37 2023 by
465 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
466 0.9.28 (ruby-3.1.2).
467467 </div>
468468
469469 </div>
658658 </div>
659659
660660 <div id="footer">
661 Generated on Fri Nov 27 21:10:49 2020 by
662 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
663 0.9.24 (ruby-2.7.2).
661 Generated on Mon Jan 2 11:47:36 2023 by
662 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
663 0.9.28 (ruby-3.1.2).
664664 </div>
665665
666666 </div>
581581 </div>
582582
583583 <div id="footer">
584 Generated on Fri Nov 27 21:10:36 2020 by
585 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
586 0.9.24 (ruby-2.7.2).
584 Generated on Mon Jan 2 11:47:24 2023 by
585 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
586 0.9.28 (ruby-3.1.2).
587587 </div>
588588
589589 </div>
11181118 </div>
11191119
11201120 <div id="footer">
1121 Generated on Fri Nov 27 21:10:43 2020 by
1122 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1123 0.9.24 (ruby-2.7.2).
1121 Generated on Mon Jan 2 11:47:31 2023 by
1122 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1123 0.9.28 (ruby-3.1.2).
11241124 </div>
11251125
11261126 </div>
895895 </div>
896896
897897 <div id="footer">
898 Generated on Fri Nov 27 21:10:49 2020 by
899 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
900 0.9.24 (ruby-2.7.2).
898 Generated on Mon Jan 2 11:47:37 2023 by
899 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
900 0.9.28 (ruby-3.1.2).
901901 </div>
902902
903903 </div>
895895 </div>
896896
897897 <div id="footer">
898 Generated on Fri Nov 27 21:10:50 2020 by
899 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
900 0.9.24 (ruby-2.7.2).
898 Generated on Mon Jan 2 11:47:37 2023 by
899 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
900 0.9.28 (ruby-3.1.2).
901901 </div>
902902
903903 </div>
126126 <p>sent when a key goes up; the message data is an FXEvent instance.</p>
127127 </dd><dt><code>SEL_COMMAND</code>
128128 <dd>
129 <p>sent whenever the spinner&#39;s value changes; the message data is an integer indicating the new spinner value.</p>
129 <p>sent whenever the spinner’s value changes; the message data is an integer indicating the new spinner value.</p>
130130 </dd><dt><code>SEL_CHANGED</code>
131131 <dd>
132 <p>sent whenever the text in the spinner&#39;s text field changes; the message data is an integer indicating the new spinner value.</p>
132 <p>sent whenever the text in the spinner’s text field changes; the message data is an integer indicating the new spinner value.</p>
133133 </dd></dl>
134134
135135 <h3 id="label-Spinner+options">Spinner options</h3>
304304
305305
306306 <span class="summary_desc"><div class='inline'>
307 <p>Number of columns (i.e. width of spinner&#39;s text field, in terms of number of columns of &#39;m&#39;) [Integer].</p>
307 <p>Number of columns (i.e. width of spinner’s text field, in terms of number of columns of ‘m’) [Integer].</p>
308308 </div></span>
309309
310310 </li>
673673
674674
675675 <span class="summary_desc"><div class='inline'>
676 <p>Set the “editability” of this spinner&#39;s text field.</p>
676 <p>Set the “editability” of this spinner’s text field.</p>
677677 </div></span>
678678
679679 </li>
697697
698698
699699 <span class="summary_desc"><div class='inline'>
700 <p>Return <code>true</code> if the spinner&#39;s text field is editable.</p>
700 <p>Return <code>true</code> if the spinner’s text field is editable.</p>
701701 </div></span>
702702
703703 </li>
843843
844844
845845 <span class="summary_desc"><div class='inline'>
846 <p>Set the visibility of this spinner&#39;s text field.</p>
846 <p>Set the visibility of this spinner’s text field.</p>
847847 </div></span>
848848
849849 </li>
867867
868868
869869 <span class="summary_desc"><div class='inline'>
870 <p>Return <code>true</code> if this spinner&#39;s text field is visible.</p>
870 <p>Return <code>true</code> if this spinner’s text field is visible.</p>
871871 </div></span>
872872
873873 </li>
12231223 </h3><div class="docstring">
12241224 <div class="discussion">
12251225
1226 <p>Number of columns (i.e. width of spinner&#39;s text field, in terms of number of columns of &#39;m&#39;) [Integer]</p>
1226 <p>Number of columns (i.e. width of spinner’s text field, in terms of number of columns of ‘m’) [Integer]</p>
12271227
12281228
12291229 </div>
17761776 </h3><div class="docstring">
17771777 <div class="discussion">
17781778
1779 <p>Set the “editability” of this spinner&#39;s text field.</p>
1779 <p>Set the “editability” of this spinner’s text field.</p>
17801780
17811781
17821782 </div>
18131813 </h3><div class="docstring">
18141814 <div class="discussion">
18151815
1816 <p>Return <code>true</code> if the spinner&#39;s text field is editable.</p>
1816 <p>Return <code>true</code> if the spinner’s text field is editable.</p>
18171817
18181818
18191819 </div>
19741974 </h3><div class="docstring">
19751975 <div class="discussion">
19761976
1977 <p>Change the spinner increment value, i.e. the amount by which the spinner&#39;s value increases when the up arrow is clicked.</p>
1977 <p>Change the spinner increment value, i.e. the amount by which the spinner’s value increases when the up arrow is clicked.</p>
19781978
19791979
19801980 </div>
20112011 </h3><div class="docstring">
20122012 <div class="discussion">
20132013
2014 <p>Set the visibility of this spinner&#39;s text field.</p>
2014 <p>Set the visibility of this spinner’s text field.</p>
20152015
20162016
20172017 </div>
20482048 </h3><div class="docstring">
20492049 <div class="discussion">
20502050
2051 <p>Return <code>true</code> if this spinner&#39;s text field is visible.</p>
2051 <p>Return <code>true</code> if this spinner’s text field is visible.</p>
20522052
20532053
20542054 </div>
20912091 </div>
20922092
20932093 <div id="footer">
2094 Generated on Fri Nov 27 21:10:50 2020 by
2095 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2096 0.9.24 (ruby-2.7.2).
2094 Generated on Mon Jan 2 11:47:37 2023 by
2095 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2096 0.9.28 (ruby-3.1.2).
20972097 </div>
20982098
20992099 </div>
486486 </div>
487487
488488 <div id="footer">
489 Generated on Fri Nov 27 21:11:37 2020 by
490 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
491 0.9.24 (ruby-2.7.2).
489 Generated on Mon Jan 2 11:48:22 2023 by
490 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
491 0.9.28 (ruby-3.1.2).
492492 </div>
493493
494494 </div>
193193
194194
195195 <span class="summary_desc"><div class='inline'>
196 <p>The splash window&#39;s icon <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">FXIcon</a></span>.</p>
196 <p>The splash window’s icon <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">FXIcon</a></span>.</p>
197197 </div></span>
198198
199199 </li>
448448 </h3><div class="docstring">
449449 <div class="discussion">
450450
451 <p>The splash window&#39;s icon <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">Fox::FXIcon</a></span></p>
451 <p>The splash window’s icon <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">Fox::FXIcon</a></span></p>
452452
453453
454454 </div>
483483 </div>
484484
485485 <div id="footer">
486 Generated on Fri Nov 27 21:11:30 2020 by
487 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
488 0.9.24 (ruby-2.7.2).
486 Generated on Mon Jan 2 11:48:15 2023 by
487 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
488 0.9.28 (ruby-3.1.2).
489489 </div>
490490
491491 </div>
632632 </div>
633633
634634 <div id="footer">
635 Generated on Fri Nov 27 21:10:57 2020 by
636 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
637 0.9.24 (ruby-2.7.2).
635 Generated on Mon Jan 2 11:47:44 2023 by
636 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
637 0.9.28 (ruby-3.1.2).
638638 </div>
639639
640640 </div>
506506 </div>
507507
508508 <div id="footer">
509 Generated on Fri Nov 27 21:10:44 2020 by
510 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
511 0.9.24 (ruby-2.7.2).
509 Generated on Mon Jan 2 11:47:31 2023 by
510 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
511 0.9.28 (ruby-3.1.2).
512512 </div>
513513
514514 </div>
582582 </div>
583583
584584 <div id="footer">
585 Generated on Fri Nov 27 21:11:13 2020 by
586 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
587 0.9.24 (ruby-2.7.2).
585 Generated on Mon Jan 2 11:48:00 2023 by
586 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
587 0.9.28 (ruby-3.1.2).
588588 </div>
589589
590590 </div>
118118 <p>The following messages are sent by FXStatusLine to its target:</p>
119119 <dl class="rdoc-list note-list"><dt><code>SEL_UPDATE</code>
120120 <dd>
121 <p>Sent when the widget currently under the mouse cursor doesn&#39;t respond to a <code>SEL_UPDATE</code> message with identifier <code>ID_QUERY_HELP</code>, as described above.</p>
121 <p>Sent when the widget currently under the mouse cursor doesn’t respond to a <code>SEL_UPDATE</code> message with identifier <code>ID_QUERY_HELP</code>, as described above.</p>
122122 </dd></dl>
123123
124124
743743 </div>
744744
745745 <div id="footer">
746 Generated on Fri Nov 27 21:11:20 2020 by
747 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
748 0.9.24 (ruby-2.7.2).
746 Generated on Mon Jan 2 11:48:06 2023 by
747 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
748 0.9.28 (ruby-3.1.2).
749749 </div>
750750
751751 </div>
103103 <h2>Overview</h2><div class="docstring">
104104 <div class="discussion">
105105
106 <p>A stream is a way to serialize data and objects into a byte stream. Each item of data that is saved or loaded from the stream may be byte-swapped, thus allowing little-endian machines to read data produced on big endian ones and vice-versa. Data is serialized exactly as-is. There are no tags or other markers inserted into the stream; thus, the stream may be used to save or load arbitrary binary data. Objects derived from FXObjects may be serialized also; whenever a reference to an object is serialized, a table is consulted to determine if the same object has been encountered previously; if not, the object is added to the table and then its contents are serialized. If the object has been encountered before, only a reference to the object is serialized. When loading back a serialized object, new instances are constructed using the default constructor, and subsequently the object&#39;s contents are loaded. A special container object may be passed in which is placed in the table as if it had been encountered before; this will cause only references to this object to be saved. The container object is typically the top-level document object which manages all objects contained by it. Additional objects may be added using addObject(); these will not be actually saved or loaded.</p>
106 <p>A stream is a way to serialize data and objects into a byte stream. Each item of data that is saved or loaded from the stream may be byte-swapped, thus allowing little-endian machines to read data produced on big endian ones and vice-versa. Data is serialized exactly as-is. There are no tags or other markers inserted into the stream; thus, the stream may be used to save or load arbitrary binary data. Objects derived from FXObjects may be serialized also; whenever a reference to an object is serialized, a table is consulted to determine if the same object has been encountered previously; if not, the object is added to the table and then its contents are serialized. If the object has been encountered before, only a reference to the object is serialized. When loading back a serialized object, new instances are constructed using the default constructor, and subsequently the object’s contents are loaded. A special container object may be passed in which is placed in the table as if it had been encountered before; this will cause only references to this object to be saved. The container object is typically the top-level document object which manages all objects contained by it. Additional objects may be added using addObject(); these will not be actually saved or loaded.</p>
107107
108108 <h3 id="label-Stream+status+codes">Stream status codes</h3>
109109 <dl class="rdoc-list note-list"><dt><code>FXStreamOK</code>
13611361 </div>
13621362
13631363 <div id="footer">
1364 Generated on Fri Nov 27 21:10:44 2020 by
1365 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1366 0.9.24 (ruby-2.7.2).
1364 Generated on Mon Jan 2 11:47:31 2023 by
1365 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1366 0.9.28 (ruby-3.1.2).
13671367 </div>
13681368
13691369 </div>
137137 </div>
138138
139139 <div id="footer">
140 Generated on Fri Nov 27 21:11:34 2020 by
141 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
142 0.9.24 (ruby-2.7.2).
140 Generated on Mon Jan 2 11:48:19 2023 by
141 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
142 0.9.28 (ruby-3.1.2).
143143 </div>
144144
145145 </div>
137137 </div>
138138
139139 <div id="footer">
140 Generated on Fri Nov 27 21:11:34 2020 by
141 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
142 0.9.24 (ruby-2.7.2).
140 Generated on Mon Jan 2 11:48:19 2023 by
141 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
142 0.9.28 (ruby-3.1.2).
143143 </div>
144144
145145 </div>
248248 </div>
249249
250250 <div id="footer">
251 Generated on Fri Nov 27 21:11:34 2020 by
252 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
253 0.9.24 (ruby-2.7.2).
251 Generated on Mon Jan 2 11:48:19 2023 by
252 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
253 0.9.28 (ruby-3.1.2).
254254 </div>
255255
256256 </div>
137137 </div>
138138
139139 <div id="footer">
140 Generated on Fri Nov 27 21:11:34 2020 by
141 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
142 0.9.24 (ruby-2.7.2).
140 Generated on Mon Jan 2 11:48:19 2023 by
141 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
142 0.9.28 (ruby-3.1.2).
143143 </div>
144144
145145 </div>
137137 </div>
138138
139139 <div id="footer">
140 Generated on Fri Nov 27 21:11:34 2020 by
141 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
142 0.9.24 (ruby-2.7.2).
140 Generated on Mon Jan 2 11:48:19 2023 by
141 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
142 0.9.28 (ruby-3.1.2).
143143 </div>
144144
145145 </div>
105105 <h2>Overview</h2><div class="docstring">
106106 <div class="discussion">
107107
108 <p>Filled up a stream&#39;s internal buffer, or the disk is full</p>
108 <p>Filled up a stream’s internal buffer, or the disk is full</p>
109109
110110
111111 </div>
137137 </div>
138138
139139 <div id="footer">
140 Generated on Fri Nov 27 21:11:34 2020 by
141 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
142 0.9.24 (ruby-2.7.2).
140 Generated on Mon Jan 2 11:48:19 2023 by
141 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
142 0.9.28 (ruby-3.1.2).
143143 </div>
144144
145145 </div>
137137 </div>
138138
139139 <div id="footer">
140 Generated on Fri Nov 27 21:11:34 2020 by
141 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
142 0.9.24 (ruby-2.7.2).
140 Generated on Mon Jan 2 11:48:19 2023 by
141 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
142 0.9.28 (ruby-3.1.2).
143143 </div>
144144
145145 </div>
137137 </div>
138138
139139 <div id="footer">
140 Generated on Fri Nov 27 21:11:34 2020 by
141 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
142 0.9.24 (ruby-2.7.2).
140 Generated on Mon Jan 2 11:48:19 2023 by
141 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
142 0.9.28 (ruby-3.1.2).
143143 </div>
144144
145145 </div>
137137 </div>
138138
139139 <div id="footer">
140 Generated on Fri Nov 27 21:11:34 2020 by
141 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
142 0.9.24 (ruby-2.7.2).
140 Generated on Mon Jan 2 11:48:19 2023 by
141 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
142 0.9.28 (ruby-3.1.2).
143143 </div>
144144
145145 </div>
105105 <h2>Overview</h2><div class="docstring">
106106 <div class="discussion">
107107
108 <p>An FXStringDict (string dictionary) object maps one string to another string. The inserted strings are copied when they&#39;re inserted.</p>
108 <p>An FXStringDict (string dictionary) object maps one string to another string. The inserted strings are copied when they’re inserted.</p>
109109
110110
111111 </div>
541541 </div>
542542
543543 <div id="footer">
544 Generated on Fri Nov 27 21:11:20 2020 by
545 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
546 0.9.24 (ruby-2.7.2).
544 Generated on Mon Jan 2 11:48:06 2023 by
545 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
546 0.9.28 (ruby-3.1.2).
547547 </div>
548548
549549 </div>
113113 <h2>Overview</h2><div class="docstring">
114114 <div class="discussion">
115115
116 <p>The FXSwitcher layout manager automatically arranges its child windows such that one of them is placed on top; all other child windows are hidden. Switcher provides a convenient method to conserve screen real-estate by arranging several GUI panels to appear in the same space, depending on context. Switcher ignores all layout hints from its children; all children are stretched according to the switcher layout managers own size. When the <code>SWITCHER_HCOLLAPSE</code> or <code>SWITCHER_VCOLLAPSE</code> options are used, the switcher&#39;s default size is based on the width or height of the current child, instead of the maximum width or height of all of the children.</p>
116 <p>The FXSwitcher layout manager automatically arranges its child windows such that one of them is placed on top; all other child windows are hidden. Switcher provides a convenient method to conserve screen real-estate by arranging several GUI panels to appear in the same space, depending on context. Switcher ignores all layout hints from its children; all children are stretched according to the switcher layout managers own size. When the <code>SWITCHER_HCOLLAPSE</code> or <code>SWITCHER_VCOLLAPSE</code> options are used, the switcher’s default size is based on the width or height of the current child, instead of the maximum width or height of all of the children.</p>
117117
118118 <h3 id="label-Events">Events</h3>
119119
120120 <p>The following messages are sent by FXSwitcher to its target:</p>
121121 <dl class="rdoc-list note-list"><dt><code>SEL_COMMAND</code>
122122 <dd>
123 <p>sent whenever the current (topmost) child window changes; the message data is an integer indicating the new current window&#39;s index.</p>
123 <p>sent whenever the current (topmost) child window changes; the message data is an integer indicating the new current window’s index.</p>
124124 </dd></dl>
125125
126126 <h3 id="label-Switcher+options">Switcher options</h3>
202202
203203
204204 <span class="summary_desc"><div class='inline'>
205 <p>Current child window&#39;s index [Integer].</p>
205 <p>Current child window’s index [Integer].</p>
206206 </div></span>
207207
208208 </li>
487487 </h3><div class="docstring">
488488 <div class="discussion">
489489
490 <p>Current child window&#39;s index [Integer]</p>
490 <p>Current child window’s index [Integer]</p>
491491
492492
493493 </div>
578578 </h3><div class="docstring">
579579 <div class="discussion">
580580
581 <p>Raise the child window at <em>index</em> to the top of the stack. If <em>notify</em> is <code>true</code>, a <code>SEL_COMMAND</code> message is sent to the switcher&#39;s message target Raises IndexError if <em>index</em> is out of bounds.</p>
581 <p>Raise the child window at <em>index</em> to the top of the stack. If <em>notify</em> is <code>true</code>, a <code>SEL_COMMAND</code> message is sent to the switcher’s message target Raises IndexError if <em>index</em> is out of bounds.</p>
582582
583583
584584 </div>
608608 </div>
609609
610610 <div id="footer">
611 Generated on Fri Nov 27 21:10:58 2020 by
612 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
613 0.9.24 (ruby-2.7.2).
611 Generated on Mon Jan 2 11:47:45 2023 by
612 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
613 0.9.28 (ruby-3.1.2).
614614 </div>
615615
616616 </div>
439439 </div>
440440
441441 <div id="footer">
442 Generated on Fri Nov 27 21:10:50 2020 by
443 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
444 0.9.24 (ruby-2.7.2).
442 Generated on Mon Jan 2 11:47:37 2023 by
443 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
444 0.9.28 (ruby-3.1.2).
445445 </div>
446446
447447 </div>
423423 </div>
424424
425425 <div id="footer">
426 Generated on Fri Nov 27 21:10:58 2020 by
427 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
428 0.9.24 (ruby-2.7.2).
426 Generated on Mon Jan 2 11:47:45 2023 by
427 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
428 0.9.28 (ruby-3.1.2).
429429 </div>
430430
431431 </div>
593593 </div>
594594
595595 <div id="footer">
596 Generated on Fri Nov 27 21:10:50 2020 by
597 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
598 0.9.24 (ruby-2.7.2).
596 Generated on Mon Jan 2 11:47:37 2023 by
597 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
598 0.9.28 (ruby-3.1.2).
599599 </div>
600600
601601 </div>
577577 </div>
578578
579579 <div id="footer">
580 Generated on Fri Nov 27 21:10:58 2020 by
581 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
582 0.9.24 (ruby-2.7.2).
580 Generated on Mon Jan 2 11:47:45 2023 by
581 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
582 0.9.28 (ruby-3.1.2).
583583 </div>
584584
585585 </div>
113113 <h2>Overview</h2><div class="docstring">
114114 <div class="discussion">
115115
116 <p>The FXTabBar layout manager arranges tab items side by side, and raises the active tab item above the neighboring tab items. In a the horizontal arrangement, the tab bar can have the tab items on the top or on the bottom. In the vertical arrangement, the tabs can be on the left or on the right. When one of the tab items is pressed, the tab bar&#39;s <span class='object_link'><a href="#setCurrent-instance_method" title="Fox::FXTabBar#setCurrent (method)">#setCurrent</a></span>() method is called with <em>notify</em> of <code>true</code>. This in turn causes the tab bar to send a <code>SEL_COMMAND</code> message to its target.</p>
116 <p>The FXTabBar layout manager arranges tab items side by side, and raises the active tab item above the neighboring tab items. In a the horizontal arrangement, the tab bar can have the tab items on the top or on the bottom. In the vertical arrangement, the tabs can be on the left or on the right. When one of the tab items is pressed, the tab bar’s <span class='object_link'><a href="#setCurrent-instance_method" title="Fox::FXTabBar#setCurrent (method)">#setCurrent</a></span>() method is called with <em>notify</em> of <code>true</code>. This in turn causes the tab bar to send a <code>SEL_COMMAND</code> message to its target.</p>
117117
118118 <h3 id="label-Events">Events</h3>
119119
120120 <p>The following messages are sent by FXTabBar to its target:</p>
121121 <dl class="rdoc-list note-list"><dt><code>SEL_COMMAND</code>
122122 <dd>
123 <p>sent whenever the current tab item changes; the message data is an integer indicating the new current tab item&#39;s index.</p>
123 <p>sent whenever the current tab item changes; the message data is an integer indicating the new current tab item’s index.</p>
124124 </dd></dl>
125125
126126 <h3 id="label-Tab+book+options">Tab book options</h3>
221221
222222
223223 <span class="summary_desc"><div class='inline'>
224 <p>Currently active tab item&#39;s index [Integer].</p>
224 <p>Currently active tab item’s index [Integer].</p>
225225 </div></span>
226226
227227 </li>
512512 </h3><div class="docstring">
513513 <div class="discussion">
514514
515 <p>Currently active tab item&#39;s index [Integer]</p>
515 <p>Currently active tab item’s index [Integer]</p>
516516
517517
518518 </div>
603603 </h3><div class="docstring">
604604 <div class="discussion">
605605
606 <p>Change currently active tab item; this raises the active tab item slightly above the neighboring tab items. If <em>notify</em> is <code>true</code>, a <code>SEL_COMMAND</code> message is sent to the tab bar&#39;s message target</p>
606 <p>Change currently active tab item; this raises the active tab item slightly above the neighboring tab items. If <em>notify</em> is <code>true</code>, a <code>SEL_COMMAND</code> message is sent to the tab bar’s message target</p>
607607
608608
609609 </div>
633633 </div>
634634
635635 <div id="footer">
636 Generated on Fri Nov 27 21:10:44 2020 by
637 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
638 0.9.24 (ruby-2.7.2).
636 Generated on Mon Jan 2 11:47:31 2023 by
637 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
638 0.9.28 (ruby-3.1.2).
639639 </div>
640640
641641 </div>
115115 <h2>Overview</h2><div class="docstring">
116116 <div class="discussion">
117117
118 <p>The tab book layout manager arranges pairs of children; the even numbered children (0,2,4,…) are usually tab items, and are placed on the top. The odd numbered children are usually layout managers, and are placed below; all the odd numbered children are placed on top of each other, similar to the switcher widget. When the user presses one of the tab items, the tab item is raised above the neighboring tabs, and the corresponding panel is raised to the top. Thus, a tab book can be used to present many GUI controls in a small space by placing several panels on top of each other and using tab items to select the desired panel. When one of the tab items is pressed, the tab book&#39;s <span class='object_link'><a href="FXTabBar.html#setCurrent-instance_method" title="Fox::FXTabBar#setCurrent (method)">Fox::FXTabBar#setCurrent</a></span> method is called with _notify+=true. This causes the tab book to send a <code>SEL_COMMAND</code> message to its target.</p>
118 <p>The tab book layout manager arranges pairs of children; the even numbered children (0,2,4,…) are usually tab items, and are placed on the top. The odd numbered children are usually layout managers, and are placed below; all the odd numbered children are placed on top of each other, similar to the switcher widget. When the user presses one of the tab items, the tab item is raised above the neighboring tabs, and the corresponding panel is raised to the top. Thus, a tab book can be used to present many GUI controls in a small space by placing several panels on top of each other and using tab items to select the desired panel. When one of the tab items is pressed, the tab book’s <span class='object_link'><a href="FXTabBar.html#setCurrent-instance_method" title="Fox::FXTabBar#setCurrent (method)">Fox::FXTabBar#setCurrent</a></span> method is called with _notify+=true. This causes the tab book to send a <code>SEL_COMMAND</code> message to its target.</p>
119119
120120
121121 </div>
362362 </div>
363363
364364 <div id="footer">
365 Generated on Fri Nov 27 21:10:50 2020 by
366 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
367 0.9.24 (ruby-2.7.2).
365 Generated on Mon Jan 2 11:47:38 2023 by
366 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
367 0.9.28 (ruby-3.1.2).
368368 </div>
369369
370370 </div>
467467 </div>
468468
469469 <div id="footer">
470 Generated on Fri Nov 27 21:10:51 2020 by
471 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
472 0.9.24 (ruby-2.7.2).
470 Generated on Mon Jan 2 11:47:38 2023 by
471 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
472 0.9.28 (ruby-3.1.2).
473473 </div>
474474
475475 </div>
41114111 </h3><div class="docstring">
41124112 <div class="discussion">
41134113
4114 <p>Construct a new FXTable instance. The table is initially empty, and reports a default size based on the scroll areas&#39;s scrollbar placement policy.</p>
4114 <p>Construct a new FXTable instance. The table is initially empty, and reports a default size based on the scroll areas’s scrollbar placement policy.</p>
41154115
41164116 <h4 id="label-Parameters-3A">Parameters:</h4>
41174117 <dl class="rdoc-list note-list"><dt><code>p</code>
62506250 </h3><div class="docstring">
62516251 <div class="discussion">
62526252
6253 <p>Remove all items from table. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the table&#39;s message target before the cells are removed.</p>
6253 <p>Remove all items from table. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the table’s message target before the cells are removed.</p>
62546254
62556255
62566256 </div>
68846884 </h3><div class="docstring">
68856885 <div class="discussion">
68866886
6887 <p>Extend selection. If <em>notify</em> is <code>true</code>, a series of <code>SEL_SELECTED</code> and <code>SEL_DESELECTED</code> messages are sent to the table&#39;s message target after each affected item is selected or deselected. Raises IndexError if either <em>row</em> or <em>column</em> is out of bounds.</p>
6887 <p>Extend selection. If <em>notify</em> is <code>true</code>, a series of <code>SEL_SELECTED</code> and <code>SEL_DESELECTED</code> messages are sent to the table’s message target after each affected item is selected or deselected. Raises IndexError if either <em>row</em> or <em>column</em> is out of bounds.</p>
68886888
68896889
68906890 </div>
69216921 </h3><div class="docstring">
69226922 <div class="discussion">
69236923
6924 <p>Extract item from table and return a reference to it. If <em>notify</em> is <code>true</code>, a <code>SEL_REPLACED</code> message is sent to the table&#39;s message target before this cell is removed. Raises IndexError if either <em>row</em> or <em>col</em> is out of bounds.</p>
6924 <p>Extract item from table and return a reference to it. If <em>notify</em> is <code>true</code>, a <code>SEL_REPLACED</code> message is sent to the table’s message target before this cell is removed. Raises IndexError if either <em>row</em> or <em>col</em> is out of bounds.</p>
69256925
69266926
69276927 </div>
69586958 </h3><div class="docstring">
69596959 <div class="discussion">
69606960
6961 <p>Extract the text from all the cells in the specified range and return the result as a string. Within the result string, each column&#39;s text is delimited by the string specified by <em>cs</em>, and each row is delimited by the string specified by <em>rs</em>. To reverse this operation (i.e. set the table cells&#39; text from a string), see <span class='object_link'><a href="#overlayText-instance_method" title="Fox::FXTable#overlayText (method)">#overlayText</a></span>. Raises IndexError if any of <em>startrow</em>, <em>endrow</em>, <em>startcol</em> or <em>endcol</em> is out of bounds.</p>
6961 <p>Extract the text from all the cells in the specified range and return the result as a string. Within the result string, each column’s text is delimited by the string specified by <em>cs</em>, and each row is delimited by the string specified by <em>rs</em>. To reverse this operation (i.e. set the table cells’ text from a string), see <span class='object_link'><a href="#overlayText-instance_method" title="Fox::FXTable#overlayText (method)">#overlayText</a></span>. Raises IndexError if any of <em>startrow</em>, <em>endrow</em>, <em>startcol</em> or <em>endcol</em> is out of bounds.</p>
69626962
69636963 <h4 id="label-Parameters-3A">Parameters:</h4>
69646964 <dl class="rdoc-list note-list"><dt><code>startrow</code>
79957995 </h3><div class="docstring">
79967996 <div class="discussion">
79977997
7998 <p>Insert <em>numColumns</em> columns beginning at the specified <em>column</em> number. If <em>column</em> is equal to the number of columns in the table, the new columns are added to the right of the table. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the table&#39;s message target for each cell that is inserted. Raises IndexError if <em>column</em> is out of bounds.</p>
7998 <p>Insert <em>numColumns</em> columns beginning at the specified <em>column</em> number. If <em>column</em> is equal to the number of columns in the table, the new columns are added to the right of the table. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the table’s message target for each cell that is inserted. Raises IndexError if <em>column</em> is out of bounds.</p>
79997999
80008000
80018001 </div>
80328032 </h3><div class="docstring">
80338033 <div class="discussion">
80348034
8035 <p>Insert <em>numRows</em> rows beginning at the specified <em>row</em> number. If <em>row</em> is equal to the number of rows in the table, the new rows are added to the bottom of the table. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the table&#39;s message target for each cell that is inserted. Raises IndexError if <em>row</em> is out of bounds.</p>
8035 <p>Insert <em>numRows</em> rows beginning at the specified <em>row</em> number. If <em>row</em> is equal to the number of rows in the table, the new rows are added to the bottom of the table. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the table’s message target for each cell that is inserted. Raises IndexError if <em>row</em> is out of bounds.</p>
80368036
80378037
80388038 </div>
83198319 </h3><div class="docstring">
83208320 <div class="discussion">
83218321
8322 <p>Kill selection. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the table&#39;s message target for each cell that was previously selected.</p>
8322 <p>Kill selection. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the table’s message target for each cell that was previously selected.</p>
83238323
83248324
83258325 </div>
84678467 </h3><div class="docstring">
84688468 <div class="discussion">
84698469
8470 <p>Overlay the text for the cells in the specified range with the fields specified in <em>text</em>. Within the <em>text</em> string, each column&#39;s text should delimited by the character specified by <em>cs</em>, and each row should be delimited by the character specified by <em>rs</em>. To reverse this operation (i.e. extract the table cells&#39; text into a string), see <span class='object_link'><a href="#extractText-instance_method" title="Fox::FXTable#extractText (method)">#extractText</a></span>. Raises IndexError if any of <em>startrow</em>, <em>endrow</em>, <em>startcol</em> or <em>endcol</em> is out of bounds.</p>
8470 <p>Overlay the text for the cells in the specified range with the fields specified in <em>text</em>. Within the <em>text</em> string, each column’s text should delimited by the character specified by <em>cs</em>, and each row should be delimited by the character specified by <em>rs</em>. To reverse this operation (i.e. extract the table cells’ text into a string), see <span class='object_link'><a href="#extractText-instance_method" title="Fox::FXTable#extractText (method)">#extractText</a></span>. Raises IndexError if any of <em>startrow</em>, <em>endrow</em>, <em>startcol</em> or <em>endcol</em> is out of bounds.</p>
84718471
84728472 <h4 id="label-Parameters-3A">Parameters:</h4>
84738473 <dl class="rdoc-list note-list"><dt><code>startrow</code>
85288528 </h3><div class="docstring">
85298529 <div class="discussion">
85308530
8531 <p>Remove the <em>nc</em> columns starting at the specified <em>column</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the table&#39;s message target for each cell that is removed. Raises IndexError if <em>column</em> is less than zero, or if <em>column</em> + <em>nc</em> is greater than the current number of table columns.</p>
8531 <p>Remove the <em>nc</em> columns starting at the specified <em>column</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the table’s message target for each cell that is removed. Raises IndexError if <em>column</em> is less than zero, or if <em>column</em> + <em>nc</em> is greater than the current number of table columns.</p>
85328532
85338533
85348534 </div>
85658565 </h3><div class="docstring">
85668566 <div class="discussion">
85678567
8568 <p>Remove item at (<em>row</em>, <em>col</em>), replacing it with <code>nil</code>. If <em>notify</em> is <code>true</code>, a <code>SEL_REPLACED</code> message is sent to the table&#39;s message target before this cell is removed. Raises IndexError if either <em>row</em> or <em>col</em> is out of bounds.</p>
8568 <p>Remove item at (<em>row</em>, <em>col</em>), replacing it with <code>nil</code>. If <em>notify</em> is <code>true</code>, a <code>SEL_REPLACED</code> message is sent to the table’s message target before this cell is removed. Raises IndexError if either <em>row</em> or <em>col</em> is out of bounds.</p>
85698569
85708570
85718571 </div>
86028602 </h3><div class="docstring">
86038603 <div class="discussion">
86048604
8605 <p>Remove all cells in the specified range of rows and columns. If <em>notify</em> is <code>true</code>, a <code>SEL_REPLACED</code> message is sent to the table&#39;s message target before each cell is removed. Raises IndexError if <em>startrow</em>, <em>endrow</em>, <em>startcol</em> or <em>endcol</em> is out of bounds.</p>
8605 <p>Remove all cells in the specified range of rows and columns. If <em>notify</em> is <code>true</code>, a <code>SEL_REPLACED</code> message is sent to the table’s message target before each cell is removed. Raises IndexError if <em>startrow</em>, <em>endrow</em>, <em>startcol</em> or <em>endcol</em> is out of bounds.</p>
86068606
86078607
86088608 </div>
86398639 </h3><div class="docstring">
86408640 <div class="discussion">
86418641
8642 <p>Remove the <em>nr</em> rows starting at the specified <em>row</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the table&#39;s message target for each cell that is removed. Raises IndexError if <em>row</em> is less than zero, or if <em>row</em> + <em>nr</em> is greater than the current number of table rows.</p>
8642 <p>Remove the <em>nr</em> rows starting at the specified <em>row</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the table’s message target for each cell that is removed. Raises IndexError if <em>row</em> is less than zero, or if <em>row</em> + <em>nr</em> is greater than the current number of table rows.</p>
86438643
86448644
86458645 </div>
88508850 </h3><div class="docstring">
88518851 <div class="discussion">
88528852
8853 <p>Select a column of cells. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the table&#39;s message target for each previously selected cell that becomes deselected as a result of this operation. Likewise, a <code>SEL_SELECTED</code> message is sent to the table&#39;s message target for each newly-selected cell. Raises IndexError if <em>col</em> is out of bounds.</p>
8853 <p>Select a column of cells. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the table’s message target for each previously selected cell that becomes deselected as a result of this operation. Likewise, a <code>SEL_SELECTED</code> message is sent to the table’s message target for each newly-selected cell. Raises IndexError if <em>col</em> is out of bounds.</p>
88548854
88558855
88568856 </div>
88878887 </h3><div class="docstring">
88888888 <div class="discussion">
88898889
8890 <p>Select cell at (<em>row</em>, <em>col</em>). If <em>notify</em> is <code>true</code>, a <code>SEL_SELECTED</code> message is sent to the table&#39;s message target after the item is selected. Raises IndexError if either <em>row</em> or <em>col</em> is out of bounds.</p>
8890 <p>Select cell at (<em>row</em>, <em>col</em>). If <em>notify</em> is <code>true</code>, a <code>SEL_SELECTED</code> message is sent to the table’s message target after the item is selected. Raises IndexError if either <em>row</em> or <em>col</em> is out of bounds.</p>
88918891
88928892
88938893 </div>
89288928 </h3><div class="docstring">
89298929 <div class="discussion">
89308930
8931 <p>Select range. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the table&#39;s message target for each previously selected cell that becomes deselected as a result of this operation. Likewise, a <code>SEL_SELECTED</code> message is sent to the table&#39;s message target for each newly-selected cell. Raises IndexError if <em>startRow</em>, <em>endRow</em>, <em>startColumn</em> or <em>endColumn</em> is out of bounds.</p>
8931 <p>Select range. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the table’s message target for each previously selected cell that becomes deselected as a result of this operation. Likewise, a <code>SEL_SELECTED</code> message is sent to the table’s message target for each newly-selected cell. Raises IndexError if <em>startRow</em>, <em>endRow</em>, <em>startColumn</em> or <em>endColumn</em> is out of bounds.</p>
89328932
89338933
89348934 </div>
89658965 </h3><div class="docstring">
89668966 <div class="discussion">
89678967
8968 <p>Select a row of cells. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the table&#39;s message target for each previously selected cell that becomes deselected as a result of this operation. Likewise, a <code>SEL_SELECTED</code> message is sent to the table&#39;s message target for each newly-selected cell. Raises IndexError if <em>row</em> is out of bounds.</p>
8968 <p>Select a row of cells. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the table’s message target for each previously selected cell that becomes deselected as a result of this operation. Likewise, a <code>SEL_SELECTED</code> message is sent to the table’s message target for each newly-selected cell. Raises IndexError if <em>row</em> is out of bounds.</p>
89698969
89708970
89718971 </div>
92619261 </h3><div class="docstring">
92629262 <div class="discussion">
92639263
9264 <p>Change current cell. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the table&#39;s message target after the current item changes. Raises IndexError if either <em>row</em> or <em>column</em> is out of bounds.</p>
9264 <p>Change current cell. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the table’s message target after the current item changes. Raises IndexError if either <em>row</em> or <em>column</em> is out of bounds.</p>
92659265
92669266
92679267 </div>
94119411 </h3><div class="docstring">
94129412 <div class="discussion">
94139413
9414 <p>Modify cell icon, deleting the old icon if it was owned. If <em>notify</em> is <code>true</code>, a <code>SEL_REPLACED</code> message is sent to the table&#39;s message target before the item&#39;s icon is changed.. Raises IndexError if either <em>row</em> or <em>col</em> is out of bounds.</p>
9414 <p>Modify cell icon, deleting the old icon if it was owned. If <em>notify</em> is <code>true</code>, a <code>SEL_REPLACED</code> message is sent to the table’s message target before the item’s icon is changed.. Raises IndexError if either <em>row</em> or <em>col</em> is out of bounds.</p>
94159415
94169416
94179417 </div>
95639563 </h3><div class="docstring">
95649564 <div class="discussion">
95659565
9566 <p>Modify cell text for item at specified <em>row</em> and <em>col</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_REPLACED</code> message is sent to the table&#39;s message target before the item&#39;s text is changed.. Raises IndexError if either <em>row</em> or <em>col</em> is out of bounds.</p>
9566 <p>Modify cell text for item at specified <em>row</em> and <em>col</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_REPLACED</code> message is sent to the table’s message target before the item’s text is changed.. Raises IndexError if either <em>row</em> or <em>col</em> is out of bounds.</p>
95679567
95689568
95699569 </div>
97879787
97889788 <p>Resize the table content to <em>numRows</em> rows and <em>numCols</em> columns. Note that all existing items in the table will be destroyed and new items will be constructed. If <em>notify</em> is <code>true</code>, then</p>
97899789 <ul><li>
9790 <p>a <code>SEL_DELETED</code> message will be sent to the table&#39;s message target indicating which cells (if any) are about to be destroyed as a result of the resize;</p>
9790 <p>a <code>SEL_DELETED</code> message will be sent to the table’s message target indicating which cells (if any) are about to be destroyed as a result of the resize;</p>
97919791 </li><li>
9792 <p>a <code>SEL_INSERTED</code> message will be sent to the table&#39;s message target indicating which cells (if any) were added as a result of the resize; and,</p>
9792 <p>a <code>SEL_INSERTED</code> message will be sent to the table’s message target indicating which cells (if any) were added as a result of the resize; and,</p>
97939793 </li><li>
9794 <p>a <code>SEL_CHANGED</code> message will be sent to the table&#39;s message target indicating the new current cell.</p>
9794 <p>a <code>SEL_CHANGED</code> message will be sent to the table’s message target indicating the new current cell.</p>
97959795 </li></ul>
97969796
97979797 <p>Raises ArgError if either <em>numRows</em> or <em>numCols</em> is less than zero.</p>
99059905 </h3><div class="docstring">
99069906 <div class="discussion">
99079907
9908 <p>Start input mode for the cell at the given position. An input control is created which is used to edit the cell; it is filled by the original item&#39;s contents if the cell contained an item. You can enter input mode also by sending the table an <code>ID_START_INPUT</code> message.</p>
9908 <p>Start input mode for the cell at the given position. An input control is created which is used to edit the cell; it is filled by the original item’s contents if the cell contained an item. You can enter input mode also by sending the table an <code>ID_START_INPUT</code> message.</p>
99099909
99109910
99119911 </div>
1009610096 </div>
1009710097
1009810098 <div id="footer">
10099 Generated on Fri Nov 27 21:10:40 2020 by
10100 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
10101 0.9.24 (ruby-2.7.2).
10099 Generated on Mon Jan 2 11:47:28 2023 by
10100 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
10101 0.9.28 (ruby-3.1.2).
1010210102 </div>
1010310103
1010410104 </div>
311311
312312
313313 <span class="summary_desc"><div class='inline'>
314 <p>The icon&#39;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>
314 <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>
315315 </div></span>
316316
317317 </li>
12411241 </h3><div class="docstring">
12421242 <div class="discussion">
12431243
1244 <p>The icon&#39;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>
1244 <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>
12451245
12461246
12471247 </div>
21842184 </div>
21852185
21862186 <div id="footer">
2187 Generated on Fri Nov 27 21:10:39 2020 by
2188 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2189 0.9.24 (ruby-2.7.2).
2187 Generated on Mon Jan 2 11:47:26 2023 by
2188 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2189 0.9.28 (ruby-3.1.2).
21902190 </div>
21912191
21922192 </div>
349349 </div>
350350
351351 <div id="footer">
352 Generated on Fri Nov 27 21:10:39 2020 by
353 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
354 0.9.24 (ruby-2.7.2).
352 Generated on Mon Jan 2 11:47:26 2023 by
353 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
354 0.9.28 (ruby-3.1.2).
355355 </div>
356356
357357 </div>
349349 </div>
350350
351351 <div id="footer">
352 Generated on Fri Nov 27 21:10:39 2020 by
353 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
354 0.9.24 (ruby-2.7.2).
352 Generated on Mon Jan 2 11:47:26 2023 by
353 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
354 0.9.28 (ruby-3.1.2).
355355 </div>
356356
357357 </div>
22742274
22752275
22762276 <span class="summary_desc"><div class='inline'>
2277 <p>Remove <em>n</em> characters of text at position <em>pos</em> in the buffer If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the text widget&#39;s message target before the text is removed and a <code>SEL_CHANGED</code> message is sent after the change occurs.</p>
2277 <p>Remove <em>n</em> characters of text at position <em>pos</em> in the buffer If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the text widget’s message target before the text is removed and a <code>SEL_CHANGED</code> message is sent after the change occurs.</p>
22782278 </div></span>
22792279
22802280 </li>
26102610
26112611
26122612 <span class="summary_desc"><div class='inline'>
2613 <p>Change the text in the buffer to new text If <em>notify</em> is <code>true</code>, <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> messages are sent to the text widget&#39;s message target after the new text is set.</p>
2613 <p>Change the text in the buffer to new text If <em>notify</em> is <code>true</code>, <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> messages are sent to the text widget’s message target after the new text is set.</p>
26142614 </div></span>
26152615
26162616 </li>
26342634
26352635
26362636 <span class="summary_desc"><div class='inline'>
2637 <p>Change the text If <em>notify</em> is <code>true</code>, <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> messages are sent to the text widget&#39;s message target after the new text is set.</p>
2637 <p>Change the text If <em>notify</em> is <code>true</code>, <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> messages are sent to the text widget’s message target after the new text is set.</p>
26382638 </div></span>
26392639
26402640 </li>
27302730
27312731
27322732 <span class="summary_desc"><div class='inline'>
2733 <p>Return the text buffer&#39;s value.</p>
2733 <p>Return the text buffer’s value.</p>
27342734 </div></span>
27352735
27362736 </li>
45294529 </h3><div class="docstring">
45304530 <div class="discussion">
45314531
4532 <p>Append <em>text</em> to the end of the text buffer. If <em>notify</em> is <code>true</code>, <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> messages are sent to the text widget&#39;s message target after the new text is added.</p>
4532 <p>Append <em>text</em> to the end of the text buffer. If <em>notify</em> is <code>true</code>, <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> messages are sent to the text widget’s message target after the new text is added.</p>
45334533
45344534
45354535 </div>
45664566 </h3><div class="docstring">
45674567 <div class="discussion">
45684568
4569 <p>Append <em>text</em> to the end of the text buffer. If <em>notify</em> is <code>true</code>, <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> messages are sent to the text widget&#39;s message target after the new text is added.</p>
4569 <p>Append <em>text</em> to the end of the text buffer. If <em>notify</em> is <code>true</code>, <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> messages are sent to the text widget’s message target after the new text is added.</p>
45704570
45714571
45724572 </div>
48384838 </h3><div class="docstring">
48394839 <div class="discussion">
48404840
4841 <p>Extend selection to <em>pos</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the text widget&#39;s message target before any previously selected text is deselected, then a <code>SEL_SELECTED</code> message is sent after the new text is selected.</p>
4841 <p>Extend selection to <em>pos</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the text widget’s message target before any previously selected text is deselected, then a <code>SEL_SELECTED</code> message is sent after the new text is selected.</p>
48424842
48434843
48444844 </div>
52845284 </h3><div class="docstring">
52855285 <div class="discussion">
52865286
5287 <p>Insert <em>text</em> at position <em>pos</em> in the text buffer. If <em>notify</em> is <code>true</code>, <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> messages are sent to the text widget&#39;s message target after the new text is inserted.</p>
5287 <p>Insert <em>text</em> at position <em>pos</em> in the text buffer. If <em>notify</em> is <code>true</code>, <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> messages are sent to the text widget’s message target after the new text is inserted.</p>
52885288
52895289
52905290 </div>
53215321 </h3><div class="docstring">
53225322 <div class="discussion">
53235323
5324 <p>Insert <em>text</em> at position <em>pos</em> in the text buffer. If <em>notify</em> is <code>true</code>, <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> messages are sent to the text widget&#39;s message target after the new text is inserted.</p>
5324 <p>Insert <em>text</em> at position <em>pos</em> in the text buffer. If <em>notify</em> is <code>true</code>, <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> messages are sent to the text widget’s message target after the new text is inserted.</p>
53255325
53265326
53275327 </div>
53955395 </h3><div class="docstring">
53965396 <div class="discussion">
53975397
5398 <p>Kill the selection. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the text widget&#39;s message target before the text is deselected.</p>
5398 <p>Kill the selection. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the text widget’s message target before the text is deselected.</p>
53995399
54005400
54015401 </div>
60026002 </h3><div class="docstring">
60036003 <div class="discussion">
60046004
6005 <p>Remove <em>n</em> characters of text at position <em>pos</em> in the buffer If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the text widget&#39;s message target before the text is removed and a <code>SEL_CHANGED</code> message is sent after the change occurs.</p>
6005 <p>Remove <em>n</em> characters of text at position <em>pos</em> in the buffer If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the text widget’s message target before the text is removed and a <code>SEL_CHANGED</code> message is sent after the change occurs.</p>
60066006
60076007
60086008 </div>
60396039 </h3><div class="docstring">
60406040 <div class="discussion">
60416041
6042 <p>Replace the <em>m</em> characters at <em>pos</em> with <em>text</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the text widget&#39;s message target before the old text is removed, and a <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> message is sent after the new text is inserted.</p>
6042 <p>Replace the <em>m</em> characters at <em>pos</em> with <em>text</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the text widget’s message target before the old text is removed, and a <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> message is sent after the new text is inserted.</p>
60436043
60446044
60456045 </div>
60766076 </h3><div class="docstring">
60776077 <div class="discussion">
60786078
6079 <p>Replace the <em>m</em> characters at <em>pos</em> with <em>text</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the text widget&#39;s message target before the old text is removed, and a <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> message is sent after the new text is inserted.</p>
6079 <p>Replace the <em>m</em> characters at <em>pos</em> with <em>text</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the text widget’s message target before the old text is removed, and a <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> message is sent after the new text is inserted.</p>
60806080
60816081
60826082 </div>
62246224 </h3><div class="docstring">
62256225 <div class="discussion">
62266226
6227 <p>Select all text. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the text widget&#39;s message target before any previously selected text is deselected, then a <code>SEL_SELECTED</code> message is sent after the new text is selected.</p>
6227 <p>Select all text. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the text widget’s message target before any previously selected text is deselected, then a <code>SEL_SELECTED</code> message is sent after the new text is selected.</p>
62286228
62296229
62306230 </div>
63356335 </h3><div class="docstring">
63366336 <div class="discussion">
63376337
6338 <p>Set cursor column. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the text widget&#39;s message target after the change occurs.</p>
6338 <p>Set cursor column. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the text widget’s message target after the change occurs.</p>
63396339
63406340
63416341 </div>
63726372 </h3><div class="docstring">
63736373 <div class="discussion">
63746374
6375 <p>Set cursor position. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the text widget&#39;s message target after the change occurs.</p>
6375 <p>Set cursor position. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the text widget’s message target after the change occurs.</p>
63766376
63776377
63786378 </div>
64096409 </h3><div class="docstring">
64106410 <div class="discussion">
64116411
6412 <p>Set cursor row. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the text widget&#39;s message target after the change occurs.</p>
6412 <p>Set cursor row. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the text widget’s message target after the change occurs.</p>
64136413
64146414
64156415 </div>
64836483 </h3><div class="docstring">
64846484 <div class="discussion">
64856485
6486 <p>Select <em>len</em> characters starting at position <em>pos</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the text widget&#39;s message target before any previously selected text is deselected, then a <code>SEL_SELECTED</code> message is sent after the new text is selected.</p>
6486 <p>Select <em>len</em> characters starting at position <em>pos</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the text widget’s message target before any previously selected text is deselected, then a <code>SEL_SELECTED</code> message is sent after the new text is selected.</p>
64876487
64886488
64896489 </div>
65206520 </h3><div class="docstring">
65216521 <div class="discussion">
65226522
6523 <p>Change the text in the buffer to new text If <em>notify</em> is <code>true</code>, <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> messages are sent to the text widget&#39;s message target after the new text is set.</p>
6523 <p>Change the text in the buffer to new text If <em>notify</em> is <code>true</code>, <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> messages are sent to the text widget’s message target after the new text is set.</p>
65246524
65256525
65266526 </div>
65576557 </h3><div class="docstring">
65586558 <div class="discussion">
65596559
6560 <p>Change the text If <em>notify</em> is <code>true</code>, <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> messages are sent to the text widget&#39;s message target after the new text is set.</p>
6560 <p>Change the text If <em>notify</em> is <code>true</code>, <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> messages are sent to the text widget’s message target after the new text is set.</p>
65616561
65626562
65636563 </div>
66316631 </h3><div class="docstring">
66326632 <div class="discussion">
66336633
6634 <p>Shift block of lines from position <em>startPos</em> up to <em>endPos</em> by given <em>amount</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the text widget&#39;s message target before the old text is removed, and a <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> message is sent after the new text is inserted.</p>
6634 <p>Shift block of lines from position <em>startPos</em> up to <em>endPos</em> by given <em>amount</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the text widget’s message target before the old text is removed, and a <code>SEL_INSERTED</code> and <code>SEL_CHANGED</code> message is sent after the new text is inserted.</p>
66356635
66366636
66376637 </div>
67186718 </h3><div class="docstring">
67196719 <div class="discussion">
67206720
6721 <p>Return the text buffer&#39;s value</p>
6721 <p>Return the text buffer’s value</p>
67226722
67236723
67246724 </div>
68596859 </div>
68606860
68616861 <div id="footer">
6862 Generated on Fri Nov 27 21:10:37 2020 by
6863 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
6864 0.9.24 (ruby-2.7.2).
6862 Generated on Mon Jan 2 11:47:25 2023 by
6863 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
6864 0.9.28 (ruby-3.1.2).
68656865 </div>
68666866
68676867 </div>
481481 </div>
482482
483483 <div id="footer">
484 Generated on Fri Nov 27 21:10:36 2020 by
485 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
486 0.9.24 (ruby-2.7.2).
484 Generated on Mon Jan 2 11:47:24 2023 by
485 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
486 0.9.28 (ruby-3.1.2).
487487 </div>
488488
489489 </div>
392392
393393
394394 <span class="summary_desc"><div class='inline'>
395 <p>Default width of this text field, in terms of a number of columns times the width of the numeral &#39;8&#39; [Integer].</p>
395 <p>Default width of this text field, in terms of a number of columns times the width of the numeral ‘8’ [Integer].</p>
396396 </div></span>
397397
398398 </li>
12841284 </h3><div class="docstring">
12851285 <div class="discussion">
12861286
1287 <p>Default width of this text field, in terms of a number of columns times the width of the numeral &#39;8&#39; [Integer]</p>
1287 <p>Default width of this text field, in terms of a number of columns times the width of the numeral ‘8’ [Integer]</p>
12881288
12891289
12901290 </div>
20052005 </div>
20062006
20072007 <div id="footer">
2008 Generated on Fri Nov 27 21:11:14 2020 by
2009 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2010 0.9.24 (ruby-2.7.2).
2008 Generated on Mon Jan 2 11:48:00 2023 by
2009 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2010 0.9.28 (ruby-3.1.2).
20112011 </div>
20122012
20132013 </div>
494494 <p>the parent window for this toggle button <span class='object_link'><a href="FXComposite.html" title="Fox::FXComposite (class)">Fox::FXComposite</a></span></p>
495495 </dd><dt><code>text1</code>
496496 <dd>
497 <p>the text for this toggle button&#39;s first state [String]</p>
497 <p>the text for this toggle button’s first state [String]</p>
498498 </dd><dt><code>text2</code>
499499 <dd>
500 <p>the text for this toggle button&#39;s second state [String]</p>
500 <p>the text for this toggle button’s second state [String]</p>
501501 </dd><dt><code>icon1</code>
502502 <dd>
503 <p>the icon, if any, for this toggle button&#39;s first state <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">Fox::FXIcon</a></span></p>
503 <p>the icon, if any, for this toggle button’s first state <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">Fox::FXIcon</a></span></p>
504504 </dd><dt><code>icon2</code>
505505 <dd>
506 <p>the icon, if any, for this toggle button&#39;s second state <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">Fox::FXIcon</a></span></p>
506 <p>the icon, if any, for this toggle button’s second state <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">Fox::FXIcon</a></span></p>
507507 </dd><dt><code>target</code>
508508 <dd>
509509 <p>the message target, if any, for this toggle button <span class='object_link'><a href="FXObject.html" title="Fox::FXObject (class)">Fox::FXObject</a></span></p>
833833 </div>
834834
835835 <div id="footer">
836 Generated on Fri Nov 27 21:11:30 2020 by
837 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
838 0.9.24 (ruby-2.7.2).
836 Generated on Mon Jan 2 11:48:15 2023 by
837 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
838 0.9.28 (ruby-3.1.2).
839839 </div>
840840
841841 </div>
441441 </div>
442442
443443 <div id="footer">
444 Generated on Fri Nov 27 21:10:51 2020 by
445 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
446 0.9.24 (ruby-2.7.2).
444 Generated on Mon Jan 2 11:47:38 2023 by
445 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
446 0.9.28 (ruby-3.1.2).
447447 </div>
448448
449449 </div>
573573 </div>
574574
575575 <div id="footer">
576 Generated on Fri Nov 27 21:11:27 2020 by
577 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
578 0.9.24 (ruby-2.7.2).
576 Generated on Mon Jan 2 11:48:12 2023 by
577 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
578 0.9.28 (ruby-3.1.2).
579579 </div>
580580
581581 </div>
777777 </div>
778778
779779 <div id="footer">
780 Generated on Fri Nov 27 21:11:31 2020 by
781 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
782 0.9.24 (ruby-2.7.2).
780 Generated on Mon Jan 2 11:48:16 2023 by
781 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
782 0.9.28 (ruby-3.1.2).
783783 </div>
784784
785785 </div>
130130 <p>Sent when a key goes up; the message data is an FXEvent instance.</p>
131131 </dd><dt><code>SEL_COMMAND</code>
132132 <dd>
133 <p>Sent after the toolbar tab is collapsed (or uncollapsed). The message data indicates the new collapsed state (i.e. it&#39;s <code>true</code> if the toolbar tab is now collapsed, <code>false</code> if it is now uncollapsed).</p>
133 <p>Sent after the toolbar tab is collapsed (or uncollapsed). The message data indicates the new collapsed state (i.e. it’s <code>true</code> if the toolbar tab is now collapsed, <code>false</code> if it is now uncollapsed).</p>
134134 </dd></dl>
135135
136136 <h3 id="label-Toolbar+tab+styles">Toolbar tab styles</h3>
638638 </h3><div class="docstring">
639639 <div class="discussion">
640640
641 <p>Collapse (if <em>fold</em> is <code>true</code>) or uncollapse the toolbar. If <em>notify</em> is <code>true</code>, a <code>SEL_COMMAND</code> message is sent to the toolbar tab&#39;s message target after the toolbar tab is collapsed (or uncollapsed).</p>
641 <p>Collapse (if <em>fold</em> is <code>true</code>) or uncollapse the toolbar. If <em>notify</em> is <code>true</code>, a <code>SEL_COMMAND</code> message is sent to the toolbar tab’s message target after the toolbar tab is collapsed (or uncollapsed).</p>
642642
643643
644644 </div>
718718 </div>
719719
720720 <div id="footer">
721 Generated on Fri Nov 27 21:11:20 2020 by
722 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
723 0.9.24 (ruby-2.7.2).
721 Generated on Mon Jan 2 11:48:06 2023 by
722 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
723 0.9.28 (ruby-3.1.2).
724724 </div>
725725
726726 </div>
358358
359359
360360 <span class="summary_desc"><div class='inline'>
361 <p>Return the tool tip&#39;s text.</p>
361 <p>Return the tool tip’s text.</p>
362362 </div></span>
363363
364364 </li>
720720 </h3><div class="docstring">
721721 <div class="discussion">
722722
723 <p>Return the tool tip&#39;s text</p>
723 <p>Return the tool tip’s text</p>
724724
725725
726726 </div>
750750 </div>
751751
752752 <div id="footer">
753 Generated on Fri Nov 27 21:10:51 2020 by
754 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
755 0.9.24 (ruby-2.7.2).
753 Generated on Mon Jan 2 11:47:39 2023 by
754 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
755 0.9.28 (ruby-3.1.2).
756756 </div>
757757
758758 </div>
115115
116116 <p>Abstract base class for all top-level windows.</p>
117117
118 <p>TopWindows are usually managed by a Window Manager under X11 and therefore borders and window-menus and other decorations like resize- handles are subject to the Window Manager&#39;s interpretation of the decoration hints. When a TopWindow is closed, it sends a SEL_CLOSE message to its target. The target should return 0 in response to this message if there is no objection to proceed with the closing of the window, and return 1 otherwise. After the SEL_CLOSE message has been sent and no objection was raised, the window will delete itself. When the session is closed, the window will send a SEL_SESSION_NOTIFY message to its target, allowing the application to write any unsaved data to the disk. If the target returns 0, then the system will proceed to close the session. Subsequently a SEL_SESSION_CLOSED will be received which causes the window to be closed with prejudice by calling the function close(FALSE). When receiving a SEL_UPDATE, the target can update the title string of the window, so that the title of the window reflects the name of the document, for example. For convenience, TopWindow provides the same layout behavior as the Packer widget, as well as docking and undocking of toolbars. TopWindows can be owned by other windows, or be free-floating. Owned TopWindows will usually remain stacked on top of the owner windows. The lifetime of an owned window should not exceed that of the owner.</p>
118 <p>TopWindows are usually managed by a Window Manager under X11 and therefore borders and window-menus and other decorations like resize- handles are subject to the Window Manager’s interpretation of the decoration hints. When a TopWindow is closed, it sends a SEL_CLOSE message to its target. The target should return 0 in response to this message if there is no objection to proceed with the closing of the window, and return 1 otherwise. After the SEL_CLOSE message has been sent and no objection was raised, the window will delete itself. When the session is closed, the window will send a SEL_SESSION_NOTIFY message to its target, allowing the application to write any unsaved data to the disk. If the target returns 0, then the system will proceed to close the session. Subsequently a SEL_SESSION_CLOSED will be received which causes the window to be closed with prejudice by calling the function close(FALSE). When receiving a SEL_UPDATE, the target can update the title string of the window, so that the title of the window reflects the name of the document, for example. For convenience, TopWindow provides the same layout behavior as the Packer widget, as well as docking and undocking of toolbars. TopWindows can be owned by other windows, or be free-floating. Owned TopWindows will usually remain stacked on top of the owner windows. The lifetime of an owned window should not exceed that of the owner.</p>
119119
120120 <h3 id="label-Events">Events</h3>
121121
17051705 </div>
17061706
17071707 <div id="footer">
1708 Generated on Fri Nov 27 21:11:14 2020 by
1709 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1710 0.9.24 (ruby-2.7.2).
1708 Generated on Mon Jan 2 11:48:00 2023 by
1709 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1710 0.9.28 (ruby-3.1.2).
17111711 </div>
17121712
17131713 </div>
470470 </div>
471471
472472 <div id="footer">
473 Generated on Fri Nov 27 21:11:20 2020 by
474 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
475 0.9.24 (ruby-2.7.2).
473 Generated on Mon Jan 2 11:48:06 2023 by
474 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
475 0.9.28 (ruby-3.1.2).
476476 </div>
477477
478478 </div>
395395
396396
397397 <span class="summary_desc"><div class='inline'>
398 <p>Set this item&#39;s “draggable” state to <code>true</code> or <code>false</code>.</p>
398 <p>Set this item’s “draggable” state to <code>true</code> or <code>false</code>.</p>
399399 </div></span>
400400
401401 </li>
467467
468468
469469 <span class="summary_desc"><div class='inline'>
470 <p>Set this item&#39;s enabled state to <code>true</code> or <code>false</code>.</p>
470 <p>Set this item’s enabled state to <code>true</code> or <code>false</code>.</p>
471471 </div></span>
472472
473473 </li>
515515
516516
517517 <span class="summary_desc"><div class='inline'>
518 <p>Set this item&#39;s expanded state to <code>true</code> or <code>false</code>.</p>
518 <p>Set this item’s expanded state to <code>true</code> or <code>false</code>.</p>
519519 </div></span>
520520
521521 </li>
757757
758758
759759 <span class="summary_desc"><div class='inline'>
760 <p>Return a reference to the next sibling item for this tree item, or <code>nil</code> if this is the last item in the parent item&#39;s list of child items.</p>
760 <p>Return a reference to the next sibling item for this tree item, or <code>nil</code> if this is the last item in the parent item’s list of child items.</p>
761761 </div></span>
762762
763763 </li>
805805
806806
807807 <span class="summary_desc"><div class='inline'>
808 <p>Set this item&#39;s “opened” state to <code>true</code> or <code>false</code>.</p>
808 <p>Set this item’s “opened” state to <code>true</code> or <code>false</code>.</p>
809809 </div></span>
810810
811811 </li>
925925
926926
927927 <span class="summary_desc"><div class='inline'>
928 <p>Return a reference to the previous sibling item for this tree item, or <code>nil</code> if this is the first item in the parent item&#39;s list of child items.</p>
928 <p>Return a reference to the previous sibling item for this tree item, or <code>nil</code> if this is the first item in the parent item’s list of child items.</p>
929929 </div></span>
930930
931931 </li>
949949
950950
951951 <span class="summary_desc"><div class='inline'>
952 <p>Set this item&#39;s selected state to <code>true</code> or <code>false</code>.</p>
952 <p>Set this item’s selected state to <code>true</code> or <code>false</code>.</p>
953953 </div></span>
954954
955955 </li>
11171117
11181118
11191119 <span class="summary_desc"><div class='inline'>
1120 <p>Returns the item&#39;s text.</p>
1120 <p>Returns the item’s text.</p>
11211121 </div></span>
11221122
11231123 </li>
15751575 </h3><div class="docstring">
15761576 <div class="discussion">
15771577
1578 <p>Set this item&#39;s “draggable” state to <code>true</code> or <code>false</code>.</p>
1578 <p>Set this item’s “draggable” state to <code>true</code> or <code>false</code>.</p>
15791579
15801580
15811581 </div>
17151715 </h3><div class="docstring">
17161716 <div class="discussion">
17171717
1718 <p>Set this item&#39;s enabled state to <code>true</code> or <code>false</code>.</p>
1718 <p>Set this item’s enabled state to <code>true</code> or <code>false</code>.</p>
17191719
17201720
17211721 </div>
18021802 </h3><div class="docstring">
18031803 <div class="discussion">
18041804
1805 <p>Set this item&#39;s expanded state to <code>true</code> or <code>false</code>.</p>
1805 <p>Set this item’s expanded state to <code>true</code> or <code>false</code>.</p>
18061806
18071807
18081808 </div>
21742174 </h3><div class="docstring">
21752175 <div class="discussion">
21762176
2177 <p>Return a reference to the next sibling item for this tree item, or <code>nil</code> if this is the last item in the parent item&#39;s list of child items.</p>
2177 <p>Return a reference to the next sibling item for this tree item, or <code>nil</code> if this is the last item in the parent item’s list of child items.</p>
21782178
21792179
21802180 </div>
22482248 </h3><div class="docstring">
22492249 <div class="discussion">
22502250
2251 <p>Set this item&#39;s “opened” state to <code>true</code> or <code>false</code>.</p>
2251 <p>Set this item’s “opened” state to <code>true</code> or <code>false</code>.</p>
22522252
22532253
22542254 </div>
24592459 </h3><div class="docstring">
24602460 <div class="discussion">
24612461
2462 <p>Return a reference to the previous sibling item for this tree item, or <code>nil</code> if this is the first item in the parent item&#39;s list of child items.</p>
2462 <p>Return a reference to the previous sibling item for this tree item, or <code>nil</code> if this is the first item in the parent item’s list of child items.</p>
24632463
24642464
24652465 </div>
24962496 </h3><div class="docstring">
24972497 <div class="discussion">
24982498
2499 <p>Set this item&#39;s selected state to <code>true</code> or <code>false</code>.</p>
2499 <p>Set this item’s selected state to <code>true</code> or <code>false</code>.</p>
25002500
25012501
25022502 </div>
27682768 </h3><div class="docstring">
27692769 <div class="discussion">
27702770
2771 <p>Returns the item&#39;s text</p>
2771 <p>Returns the item’s text</p>
27722772
27732773
27742774 </div>
28022802 </div>
28032803
28042804 <div id="footer">
2805 Generated on Fri Nov 27 21:10:58 2020 by
2806 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2807 0.9.24 (ruby-2.7.2).
2805 Generated on Mon Jan 2 11:47:45 2023 by
2806 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2807 0.9.28 (ruby-3.1.2).
28082808 </div>
28092809
28102810 </div>
120120 <h2>Overview</h2><div class="docstring">
121121 <div class="discussion">
122122
123 <p>A Tree List Widget organizes items in a hierarchical, tree-like fashion. Subtrees can be collapsed or expanded by double-clicking on an item or by clicking on the optional plus button in front of the item. Each item may have a text and optional open-icon as well as a closed-icon. The items may be connected by optional lines to show the hierarchical relationship. When an item&#39;s selected state changes, the treelist emits a SEL_SELECTED or SEL_DESELECTED message. If an item is opened or closed, a message of type SEL_OPENED or SEL_CLOSED is sent. When the subtree under an item is expanded, a SEL_EXPANDED or SEL_COLLAPSED message is issued. A change of the current item is signified by the SEL_CHANGED message. In addition, the tree list sends SEL_COMMAND messages when the user clicks on an item, and SEL_CLICKED, SEL_DOUBLECLICKED, and SEL_TRIPLECLICKED when the user clicks once, twice, or thrice, respectively. When items are added or removed, the tree list sends messages of the type SEL_INSERTED or SEL_DELETED. In each of these cases, a pointer to the item, if any, is passed in the 3rd argument of the message.</p>
123 <p>A Tree List Widget organizes items in a hierarchical, tree-like fashion. Subtrees can be collapsed or expanded by double-clicking on an item or by clicking on the optional plus button in front of the item. Each item may have a text and optional open-icon as well as a closed-icon. The items may be connected by optional lines to show the hierarchical relationship. When an item’s selected state changes, the treelist emits a SEL_SELECTED or SEL_DESELECTED message. If an item is opened or closed, a message of type SEL_OPENED or SEL_CLOSED is sent. When the subtree under an item is expanded, a SEL_EXPANDED or SEL_COLLAPSED message is issued. A change of the current item is signified by the SEL_CHANGED message. In addition, the tree list sends SEL_COMMAND messages when the user clicks on an item, and SEL_CLICKED, SEL_DOUBLECLICKED, and SEL_TRIPLECLICKED when the user clicks once, twice, or thrice, respectively. When items are added or removed, the tree list sends messages of the type SEL_INSERTED or SEL_DELETED. In each of these cases, a pointer to the item, if any, is passed in the 3rd argument of the message.</p>
124124
125125 <h3 id="label-Events">Events</h3>
126126
839839
840840
841841 <span class="summary_desc"><div class='inline'>
842 <p>Set this item&#39;s state to closed.</p>
842 <p>Set this item’s state to closed.</p>
843843 </div></span>
844844
845845 </li>
11751175
11761176
11771177 <span class="summary_desc"><div class='inline'>
1178 <p>Return item&#39;s closed icon.</p>
1178 <p>Return item’s closed icon.</p>
11791179 </div></span>
11801180
11811181 </li>
11991199
12001200
12011201 <span class="summary_desc"><div class='inline'>
1202 <p>Return item&#39;s user data.</p>
1202 <p>Return item’s user data.</p>
12031203 </div></span>
12041204
12051205 </li>
12471247
12481248
12491249 <span class="summary_desc"><div class='inline'>
1250 <p>Return item&#39;s open icon.</p>
1250 <p>Return item’s open icon.</p>
12511251 </div></span>
12521252
12531253 </li>
12711271
12721272
12731273 <span class="summary_desc"><div class='inline'>
1274 <p>Return item&#39;s text.</p>
1274 <p>Return item’s text.</p>
12751275 </div></span>
12761276
12771277 </li>
16811681
16821682
16831683 <span class="summary_desc"><div class='inline'>
1684 <p>Set this item&#39;s state to opened.</p>
1684 <p>Set this item’s state to opened.</p>
16851685 </div></span>
16861686
16871687 </li>
18491849
18501850
18511851 <span class="summary_desc"><div class='inline'>
1852 <p>Change item&#39;s closed icon, deleting the old icon if it&#39;s owned.</p>
1852 <p>Change item’s closed icon, deleting the old icon if it’s owned.</p>
18531853 </div></span>
18541854
18551855 </li>
18731873
18741874
18751875 <span class="summary_desc"><div class='inline'>
1876 <p>Change item&#39;s user data.</p>
1876 <p>Change item’s user data.</p>
18771877 </div></span>
18781878
18791879 </li>
18971897
18981898
18991899 <span class="summary_desc"><div class='inline'>
1900 <p>Change item&#39;s open icon, deleting the old icon if it&#39;s owned.</p>
1900 <p>Change item’s open icon, deleting the old icon if it’s owned.</p>
19011901 </div></span>
19021902
19031903 </li>
19211921
19221922
19231923 <span class="summary_desc"><div class='inline'>
1924 <p>Change item&#39;s text.</p>
1924 <p>Change item’s text.</p>
19251925 </div></span>
19261926
19271927 </li>
30383038 </h3><div class="docstring">
30393039 <div class="discussion">
30403040
3041 <p>Append item with given text and optional icons, and user-data pointer as last child of <em>father</em>. Returns a reference to the newly added item (an FXTreeItem instance). If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list&#39;s message target after the item is added.</p>
3041 <p>Append item with given text and optional icons, and user-data pointer as last child of <em>father</em>. Returns a reference to the newly added item (an FXTreeItem instance). If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list’s message target after the item is added.</p>
30423042
30433043
30443044 </div>
30753075 </h3><div class="docstring">
30763076 <div class="discussion">
30773077
3078 <p>Remove all items from the list. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list&#39;s message target before each item is removed.</p>
3078 <p>Remove all items from the list. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list’s message target before each item is removed.</p>
30793079
30803080
30813081 </div>
31123112 </h3><div class="docstring">
31133113 <div class="discussion">
31143114
3115 <p>Set this item&#39;s state to closed. The primary result of this change is that the item&#39;s icon will change to its “closed” icon. This is different from the <span class='object_link'><a href="#collapseTree-instance_method" title="Fox::FXTreeList#collapseTree (method)">#collapseTree</a></span> method, which actually collapses part of the tree list, making some items invisible. If <em>notify</em> is <code>true</code>, a <code>SEL_CLOSED</code> message is sent to the list&#39;s message target after the item is closed.</p>
3115 <p>Set this item’s state to closed. The primary result of this change is that the item’s icon will change to its “closed” icon. This is different from the <span class='object_link'><a href="#collapseTree-instance_method" title="Fox::FXTreeList#collapseTree (method)">#collapseTree</a></span> method, which actually collapses part of the tree list, making some items invisible. If <em>notify</em> is <code>true</code>, a <code>SEL_CLOSED</code> message is sent to the list’s message target after the item is closed.</p>
31163116
31173117
31183118 </div>
31493149 </h3><div class="docstring">
31503150 <div class="discussion">
31513151
3152 <p>Collapse sub-tree rooted at <em>tree</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_COLLAPSED</code> message is sent to the list&#39;s message target after the sub-tree is collapsed.</p>
3152 <p>Collapse sub-tree rooted at <em>tree</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_COLLAPSED</code> message is sent to the list’s message target after the sub-tree is collapsed.</p>
31533153
31543154
31553155 </div>
31863186 </h3><div class="docstring">
31873187 <div class="discussion">
31883188
3189 <p>Deselect item. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the list&#39;s message target after the item is deselected.</p>
3189 <p>Deselect item. If <em>notify</em> is <code>true</code>, a <code>SEL_DESELECTED</code> message is sent to the list’s message target after the item is deselected.</p>
31903190
31913191
31923192 </div>
33503350 </h3><div class="docstring">
33513351 <div class="discussion">
33523352
3353 <p>Expand sub-tree rooted at <em>tree</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_EXPANDED</code> message is sent to the list&#39;s message target after the sub-tree is expanded.</p>
3353 <p>Expand sub-tree rooted at <em>tree</em>. If <em>notify</em> is <code>true</code>, a <code>SEL_EXPANDED</code> message is sent to the list’s message target after the sub-tree is expanded.</p>
33543354
33553355
33563356 </div>
33873387 </h3><div class="docstring">
33883388 <div class="discussion">
33893389
3390 <p>Extend selection from anchor item to <em>item</em>. If <em>notify</em> is <code>true</code>, a series of <code>SEL_SELECTED</code> and <code>SEL_DESELECTED</code> messages may be sent to the list&#39;s message target, indicating the changes.</p>
3390 <p>Extend selection from anchor item to <em>item</em>. If <em>notify</em> is <code>true</code>, a series of <code>SEL_SELECTED</code> and <code>SEL_DESELECTED</code> messages may be sent to the list’s message target, indicating the changes.</p>
33913391
33923392
33933393 </div>
34243424 </h3><div class="docstring">
34253425 <div class="discussion">
34263426
3427 <p>Extract item from list and return a reference to the item. If <em>notify</em> is <code>true</code> and the extraction causes the list&#39;s current item to change, a <code>SEL_CHANGED</code> message is sent to the list&#39;s message target before the item is extracted from the list.</p>
3427 <p>Extract item from list and return a reference to the item. If <em>notify</em> is <code>true</code> and the extraction causes the list’s current item to change, a <code>SEL_CHANGED</code> message is sent to the list’s message target before the item is extracted from the list.</p>
34283428
34293429
34303430 </div>
34613461 </h3><div class="docstring">
34623462 <div class="discussion">
34633463
3464 <p>Fill tree list by appending items from array of strings and return the number of items added. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list&#39;s message target after each item is added.</p>
3464 <p>Fill tree list by appending items from array of strings and return the number of items added. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list’s message target after each item is added.</p>
34653465
34663466
34673467 </div>
36503650 </h3><div class="docstring">
36513651 <div class="discussion">
36523652
3653 <p>Return item&#39;s closed icon</p>
3653 <p>Return item’s closed icon</p>
36543654
36553655
36563656 </div>
36873687 </h3><div class="docstring">
36883688 <div class="discussion">
36893689
3690 <p>Return item&#39;s user data</p>
3690 <p>Return item’s user data</p>
36913691
36923692
36933693 </div>
37613761 </h3><div class="docstring">
37623762 <div class="discussion">
37633763
3764 <p>Return item&#39;s open icon</p>
3764 <p>Return item’s open icon</p>
37653765
37663766
37673767 </div>
37983798 </h3><div class="docstring">
37993799 <div class="discussion">
38003800
3801 <p>Return item&#39;s text</p>
3801 <p>Return item’s text</p>
38023802
38033803
38043804 </div>
39093909 </h3><div class="docstring">
39103910 <div class="discussion">
39113911
3912 <p>Insert item with given text and optional icons, and user-data pointer under <em>father</em> before <em>other</em> item. Returns a reference to the newly added item (an FXTreeItem instance). If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list&#39;s message target after the item is added.</p>
3912 <p>Insert item with given text and optional icons, and user-data pointer under <em>father</em> before <em>other</em> item. Returns a reference to the newly added item (an FXTreeItem instance). If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list’s message target after the item is added.</p>
39133913
39143914
39153915 </div>
42964296 </h3><div class="docstring">
42974297 <div class="discussion">
42984298
4299 <p>Deselect all items. If <em>notify</em> is <code>true</code>, <code>SEL_DESELECTED</code> messages will be sent to the list&#39;s message target indicating the affected items.</p>
4299 <p>Deselect all items. If <em>notify</em> is <code>true</code>, <code>SEL_DESELECTED</code> messages will be sent to the list’s message target indicating the affected items.</p>
43004300
43014301
43024302 </div>
44934493 </h3><div class="docstring">
44944494 <div class="discussion">
44954495
4496 <p>Set this item&#39;s state to opened. The primary result of this change is that the item&#39;s icon will change to its “open” icon. This is different from the <span class='object_link'><a href="#expandTree-instance_method" title="Fox::FXTreeList#expandTree (method)">#expandTree</a></span> method, which actually collapses part of the tree list, making some items invisible. If <em>notify</em> is <code>true</code>, a <code>SEL_OPENED</code> message is sent to the list&#39;s message target after the item is opened.</p>
4496 <p>Set this item’s state to opened. The primary result of this change is that the item’s icon will change to its “open” icon. This is different from the <span class='object_link'><a href="#expandTree-instance_method" title="Fox::FXTreeList#expandTree (method)">#expandTree</a></span> method, which actually collapses part of the tree list, making some items invisible. If <em>notify</em> is <code>true</code>, a <code>SEL_OPENED</code> message is sent to the list’s message target after the item is opened.</p>
44974497
44984498
44994499 </div>
45304530 </h3><div class="docstring">
45314531 <div class="discussion">
45324532
4533 <p>Prepend item with given text and optional icons, and user-data pointer as first child of <em>father</em>. Returns a reference to the newly added item (an FXTreeItem instance). If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list&#39;s message target after the item is added.</p>
4533 <p>Prepend item with given text and optional icons, and user-data pointer as first child of <em>father</em>. Returns a reference to the newly added item (an FXTreeItem instance). If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list’s message target after the item is added.</p>
45344534
45354535
45364536 </div>
45674567 </h3><div class="docstring">
45684568 <div class="discussion">
45694569
4570 <p>Remove item. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list&#39;s message target before the item is removed.</p>
4570 <p>Remove item. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list’s message target before the item is removed.</p>
45714571
45724572
45734573 </div>
46044604 </h3><div class="docstring">
46054605 <div class="discussion">
46064606
4607 <p>Remove items in range [<em>fromItem</em>, <em>toItem</em>] inclusively. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list&#39;s message target before each item is removed.</p>
4607 <p>Remove items in range [<em>fromItem</em>, <em>toItem</em>] inclusively. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list’s message target before each item is removed.</p>
46084608
46094609
46104610 </div>
46844684 </h3><div class="docstring">
46854685 <div class="discussion">
46864686
4687 <p>Select item. If <em>notify</em> is <code>true</code>, a <code>SEL_SELECTED</code> message is sent to the list&#39;s message target after the item is selected.</p>
4687 <p>Select item. If <em>notify</em> is <code>true</code>, a <code>SEL_SELECTED</code> message is sent to the list’s message target after the item is selected.</p>
46884688
46894689
46904690 </div>
47214721 </h3><div class="docstring">
47224722 <div class="discussion">
47234723
4724 <p>Change current item. If there is already a current item, that item is first closed. After <em>item</em> is set as the tree list&#39;s current item, it is opened and selected. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the list&#39;s message target after the current item changes.</p>
4724 <p>Change current item. If there is already a current item, that item is first closed. After <em>item</em> is set as the tree list’s current item, it is opened and selected. If <em>notify</em> is <code>true</code>, a <code>SEL_CHANGED</code> message is sent to the list’s message target after the current item changes.</p>
47254725
47264726
47274727 </div>
47584758 </h3><div class="docstring">
47594759 <div class="discussion">
47604760
4761 <p>Change item&#39;s closed icon, deleting the old icon if it&#39;s owned</p>
4761 <p>Change item’s closed icon, deleting the old icon if it’s owned</p>
47624762
47634763
47644764 </div>
47954795 </h3><div class="docstring">
47964796 <div class="discussion">
47974797
4798 <p>Change item&#39;s user data</p>
4798 <p>Change item’s user data</p>
47994799
48004800
48014801 </div>
48324832 </h3><div class="docstring">
48334833 <div class="discussion">
48344834
4835 <p>Change item&#39;s open icon, deleting the old icon if it&#39;s owned</p>
4835 <p>Change item’s open icon, deleting the old icon if it’s owned</p>
48364836
48374837
48384838 </div>
48694869 </h3><div class="docstring">
48704870 <div class="discussion">
48714871
4872 <p>Change item&#39;s text</p>
4872 <p>Change item’s text</p>
48734873
48744874
48754875 </div>
50175017 </h3><div class="docstring">
50185018 <div class="discussion">
50195019
5020 <p>Toggle item selection. If <em>notify</em> is <code>true</code>, a <code>SEL_SELECTED</code> or <code>SEL_DESELECTED</code> message is sent to the list&#39;s message target to indicate the change.</p>
5020 <p>Toggle item selection. If <em>notify</em> is <code>true</code>, a <code>SEL_SELECTED</code> or <code>SEL_DESELECTED</code> message is sent to the list’s message target to indicate the change.</p>
50215021
50225022
50235023 </div>
50845084 </div>
50855085
50865086 <div id="footer">
5087 Generated on Fri Nov 27 21:10:59 2020 by
5088 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
5089 0.9.24 (ruby-2.7.2).
5087 Generated on Mon Jan 2 11:47:46 2023 by
5088 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
5089 0.9.28 (ruby-3.1.2).
50905090 </div>
50915091
50925092 </div>
753753
754754
755755 <span class="summary_desc"><div class='inline'>
756 <p>Return item&#39;s closed icon.</p>
756 <p>Return item’s closed icon.</p>
757757 </div></span>
758758
759759 </li>
777777
778778
779779 <span class="summary_desc"><div class='inline'>
780 <p>Return item&#39;s user data.</p>
780 <p>Return item’s user data.</p>
781781 </div></span>
782782
783783 </li>
801801
802802
803803 <span class="summary_desc"><div class='inline'>
804 <p>Return item&#39;s open icon.</p>
804 <p>Return item’s open icon.</p>
805805 </div></span>
806806
807807 </li>
825825
826826
827827 <span class="summary_desc"><div class='inline'>
828 <p>Return item&#39;s text.</p>
828 <p>Return item’s text.</p>
829829 </div></span>
830830
831831 </li>
10911091
10921092
10931093 <span class="summary_desc"><div class='inline'>
1094 <p>Change item&#39;s closed icon.</p>
1094 <p>Change item’s closed icon.</p>
10951095 </div></span>
10961096
10971097 </li>
11151115
11161116
11171117 <span class="summary_desc"><div class='inline'>
1118 <p>Change item&#39;s user data.</p>
1118 <p>Change item’s user data.</p>
11191119 </div></span>
11201120
11211121 </li>
11391139
11401140
11411141 <span class="summary_desc"><div class='inline'>
1142 <p>Change item&#39;s open icon.</p>
1142 <p>Change item’s open icon.</p>
11431143 </div></span>
11441144
11451145 </li>
11631163
11641164
11651165 <span class="summary_desc"><div class='inline'>
1166 <p>Change item&#39;s text.</p>
1166 <p>Change item’s text.</p>
11671167 </div></span>
11681168
11691169 </li>
19811981 </h3><div class="docstring">
19821982 <div class="discussion">
19831983
1984 <p>Append item with given text and optional icons, and user-data pointer as last child of <em>father</em>. Returns a reference to the newly added item (an FXTreeItem instance). If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list&#39;s message target after the item is added.</p>
1984 <p>Append item with given text and optional icons, and user-data pointer as last child of <em>father</em>. Returns a reference to the newly added item (an FXTreeItem instance). If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list’s message target after the item is added.</p>
19851985
19861986
19871987 </div>
20182018 </h3><div class="docstring">
20192019 <div class="discussion">
20202020
2021 <p>Remove all items from the list. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list&#39;s message target before each item is removed.</p>
2021 <p>Remove all items from the list. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list’s message target before each item is removed.</p>
20222022
20232023
20242024 </div>
21452145 </h3><div class="docstring">
21462146 <div class="discussion">
21472147
2148 <p>Fill tree list box by appending items from array of strings and return the number of items added. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list box&#39;s message target after each item is added.</p>
2148 <p>Fill tree list box by appending items from array of strings and return the number of items added. If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list box’s message target after each item is added.</p>
21492149
21502150
21512151 </div>
22972297 </h3><div class="docstring">
22982298 <div class="discussion">
22992299
2300 <p>Return item&#39;s closed icon</p>
2300 <p>Return item’s closed icon</p>
23012301
23022302
23032303 </div>
23342334 </h3><div class="docstring">
23352335 <div class="discussion">
23362336
2337 <p>Return item&#39;s user data</p>
2337 <p>Return item’s user data</p>
23382338
23392339
23402340 </div>
23712371 </h3><div class="docstring">
23722372 <div class="discussion">
23732373
2374 <p>Return item&#39;s open icon</p>
2374 <p>Return item’s open icon</p>
23752375
23762376
23772377 </div>
24082408 </h3><div class="docstring">
24092409 <div class="discussion">
24102410
2411 <p>Return item&#39;s text</p>
2411 <p>Return item’s text</p>
24122412
24132413
24142414 </div>
24452445 </h3><div class="docstring">
24462446 <div class="discussion">
24472447
2448 <p>Insert item with given text and optional icons, and user-data pointer under <em>father</em> before <em>other</em> item. Returns a reference to the newly added item (an FXTreeItem instance). If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list&#39;s message target after the item is added.</p>
2448 <p>Insert item with given text and optional icons, and user-data pointer under <em>father</em> before <em>other</em> item. Returns a reference to the newly added item (an FXTreeItem instance). If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list’s message target after the item is added.</p>
24492449
24502450
24512451 </div>
26692669 </h3><div class="docstring">
26702670 <div class="discussion">
26712671
2672 <p>Prepend item with given text and optional icons, and user-data pointer as first child of <em>father</em>. Returns a reference to the newly added item (an FXTreeItem instance). If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list&#39;s message target after the item is added.</p>
2672 <p>Prepend item with given text and optional icons, and user-data pointer as first child of <em>father</em>. Returns a reference to the newly added item (an FXTreeItem instance). If <em>notify</em> is <code>true</code>, a <code>SEL_INSERTED</code> message is sent to the list’s message target after the item is added.</p>
26732673
26742674
26752675 </div>
27062706 </h3><div class="docstring">
27072707 <div class="discussion">
27082708
2709 <p>Remove item. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list&#39;s message target before the item is removed.</p>
2709 <p>Remove item. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list’s message target before the item is removed.</p>
27102710
27112711
27122712 </div>
27432743 </h3><div class="docstring">
27442744 <div class="discussion">
27452745
2746 <p>Remove items in range [<em>fromItem</em>, <em>toItem</em>] inclusively. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list&#39;s message target before each item is removed.</p>
2746 <p>Remove items in range [<em>fromItem</em>, <em>toItem</em>] inclusively. If <em>notify</em> is <code>true</code>, a <code>SEL_DELETED</code> message is sent to the list’s message target before each item is removed.</p>
27472747
27482748
27492749 </div>
27802780 </h3><div class="docstring">
27812781 <div class="discussion">
27822782
2783 <p>Change current item. If <em>notify</em> is <code>true</code>, a SEL_CHANGED message is sent to the tree list box&#39;s message target.</p>
2783 <p>Change current item. If <em>notify</em> is <code>true</code>, a SEL_CHANGED message is sent to the tree list box’s message target.</p>
27842784
27852785
27862786 </div>
28172817 </h3><div class="docstring">
28182818 <div class="discussion">
28192819
2820 <p>Change item&#39;s closed icon</p>
2820 <p>Change item’s closed icon</p>
28212821
28222822
28232823 </div>
28542854 </h3><div class="docstring">
28552855 <div class="discussion">
28562856
2857 <p>Change item&#39;s user data</p>
2857 <p>Change item’s user data</p>
28582858
28592859
28602860 </div>
28912891 </h3><div class="docstring">
28922892 <div class="discussion">
28932893
2894 <p>Change item&#39;s open icon</p>
2894 <p>Change item’s open icon</p>
28952895
28962896
28972897 </div>
29282928 </h3><div class="docstring">
29292929 <div class="discussion">
29302930
2931 <p>Change item&#39;s text</p>
2931 <p>Change item’s text</p>
29322932
29332933
29342934 </div>
30693069 </div>
30703070
30713071 <div id="footer">
3072 Generated on Fri Nov 27 21:11:27 2020 by
3073 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
3074 0.9.24 (ruby-2.7.2).
3072 Generated on Mon Jan 2 11:48:13 2023 by
3073 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
3074 0.9.28 (ruby-3.1.2).
30753075 </div>
30763076
30773077 </div>
411411 <p>the parent window for this tri-state button <span class='object_link'><a href="FXComposite.html" title="Fox::FXComposite (class)">Fox::FXComposite</a></span></p>
412412 </dd><dt><code>text1</code>
413413 <dd>
414 <p>the text for this tri-state button&#39;s first state [String]</p>
414 <p>the text for this tri-state button’s first state [String]</p>
415415 </dd><dt><code>text2</code>
416416 <dd>
417 <p>the text for this tri-state button&#39;s second state [String]</p>
417 <p>the text for this tri-state button’s second state [String]</p>
418418 </dd><dt><code>text3</code>
419419 <dd>
420 <p>the text for this tri-state button&#39;s third state [String]</p>
420 <p>the text for this tri-state button’s third state [String]</p>
421421 </dd><dt><code>icon1</code>
422422 <dd>
423 <p>the icon, if any, for this tri-state button&#39;s first state <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">Fox::FXIcon</a></span></p>
423 <p>the icon, if any, for this tri-state button’s first state <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">Fox::FXIcon</a></span></p>
424424 </dd><dt><code>icon2</code>
425425 <dd>
426 <p>the icon, if any, for this tri-state button&#39;s second state <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">Fox::FXIcon</a></span></p>
426 <p>the icon, if any, for this tri-state button’s second state <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">Fox::FXIcon</a></span></p>
427427 </dd><dt><code>icon3</code>
428428 <dd>
429 <p>the icon, if any, for this tri-state button&#39;s third state <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">Fox::FXIcon</a></span></p>
429 <p>the icon, if any, for this tri-state button’s third state <span class='object_link'><a href="FXIcon.html" title="Fox::FXIcon (class)">Fox::FXIcon</a></span></p>
430430 </dd><dt><code>target</code>
431431 <dd>
432432 <p>the message target, if any, for this tri-state button <span class='object_link'><a href="FXObject.html" title="Fox::FXObject (class)">Fox::FXObject</a></span></p>
670670 </div>
671671
672672 <div id="footer">
673 Generated on Fri Nov 27 21:11:33 2020 by
674 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
675 0.9.24 (ruby-2.7.2).
673 Generated on Mon Jan 2 11:48:18 2023 by
674 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
675 0.9.28 (ruby-3.1.2).
676676 </div>
677677
678678 </div>
112112
113113 <h2 id="label-Class+Constants">Class Constants</h2>
114114
115 <p>[FXUndoList::ID_UNDO] Message identifier for the undo method. When a <code>SEL_COMMAND</code> message with this identifier is sent to an undo list, it undoes the last command. FXUndoList also provides a <code>SEL_UPDATE</code> handler for this identifier, that enables or disables the sender depending on whether it&#39;s possible to undo.</p>
115 <p>[FXUndoList::ID_UNDO] Message identifier for the undo method. When a <code>SEL_COMMAND</code> message with this identifier is sent to an undo list, it undoes the last command. FXUndoList also provides a <code>SEL_UPDATE</code> handler for this identifier, that enables or disables the sender depending on whether it’s possible to undo.</p>
116116
117117 <p>[FXUndoList::ID_UNDO_ALL] Message identifier for the “undo all” method. FXUndoList handles both the <code>SEL_COMMAND</code> and <code>SEL_UPDATE</code> messages for this message identifier.</p>
118118
119 <p>[FXUndoList::ID_REDO] Message identifier for the redo method. When a <code>SEL_COMMAND</code> message with this identifier is sent to an undo list, it redoes the last command. FXUndoList also provides a <code>SEL_UPDATE</code> handler for this identifier, that enables or disables the sender depending on whether it&#39;s possible to redo.</p>
119 <p>[FXUndoList::ID_REDO] Message identifier for the redo method. When a <code>SEL_COMMAND</code> message with this identifier is sent to an undo list, it redoes the last command. FXUndoList also provides a <code>SEL_UPDATE</code> handler for this identifier, that enables or disables the sender depending on whether it’s possible to redo.</p>
120120
121121 <p>[FXUndoList::ID_REDO_ALL] Message identifier for the “redo all” method. FXUndoList handles both the <code>SEL_COMMAND</code> and <code>SEL_UPDATE</code> messages for this message identifier.</p>
122122
997997 <td>
998998 <pre class="code"><span class="info file"># File 'lib/fox16/undolist.rb', line 94</span>
999999
1000 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> <span class='comment'># Be sure to call base class initialize
1001 </span>
1002 <span class='kw'>super</span>
1000 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
1001 <span class='comment'># Be sure to call base class initialize
1002 </span> <span class='kw'>super</span>
10031003
10041004 <span class='comment'># Set up the message map for this instance
10051005 </span> <span class='const'><span class='object_link'><a href="../Responder.html#FXMAPFUNC-instance_method" title="Responder#FXMAPFUNC (method)">FXMAPFUNC</a></span></span><span class='lparen'>(</span><span class='const'>SEL_COMMAND</span><span class='comma'>,</span> <span class='const'>ID_CLEAR</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>onCmdClear</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
25492549 </div>
25502550
25512551 <div id="footer">
2552 Generated on Fri Nov 27 21:11:36 2020 by
2553 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2554 0.9.24 (ruby-2.7.2).
2552 Generated on Mon Jan 2 11:48:21 2023 by
2553 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2554 0.9.28 (ruby-3.1.2).
25552555 </div>
25562556
25572557 </div>
192192
193193
194194 <span class="summary_desc"><div class='inline'>
195 <p>Returns a new FXVec2d instance obtained by memberwise multiplication of this vector&#39;s elements by the scalar <em>n</em>.</p>
195 <p>Returns a new FXVec2d instance obtained by memberwise multiplication of this vector’s elements by the scalar <em>n</em>.</p>
196196 </div></span>
197197
198198 </li>
288288
289289
290290 <span class="summary_desc"><div class='inline'>
291 <p>Returns a new FXVec2d instance obtained by memberwise division of this vector&#39;s elements by the scalar <em>n</em>.</p>
291 <p>Returns a new FXVec2d instance obtained by memberwise division of this vector’s elements by the scalar <em>n</em>.</p>
292292 </div></span>
293293
294294 </li>
783783 </h3><div class="docstring">
784784 <div class="discussion">
785785
786 <p>Returns a new FXVec2d instance obtained by memberwise multiplication of this vector&#39;s elements by the scalar <em>n</em>.</p>
786 <p>Returns a new FXVec2d instance obtained by memberwise multiplication of this vector’s elements by the scalar <em>n</em>.</p>
787787
788788
789789 </div>
931931 </h3><div class="docstring">
932932 <div class="discussion">
933933
934 <p>Returns a new FXVec2d instance obtained by memberwise division of this vector&#39;s elements by the scalar <em>n</em>. Raises ZeroDivisionError if <em>n</em> is identically zero.</p>
934 <p>Returns a new FXVec2d instance obtained by memberwise division of this vector’s elements by the scalar <em>n</em>. Raises ZeroDivisionError if <em>n</em> is identically zero.</p>
935935
936936
937937 </div>
14391439 </div>
14401440
14411441 <div id="footer">
1442 Generated on Fri Nov 27 21:10:40 2020 by
1443 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1444 0.9.24 (ruby-2.7.2).
1442 Generated on Mon Jan 2 11:47:28 2023 by
1443 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1444 0.9.28 (ruby-3.1.2).
14451445 </div>
14461446
14471447 </div>
192192
193193
194194 <span class="summary_desc"><div class='inline'>
195 <p>Returns a new FXVec2f instance obtained by memberwise multiplication of this vector&#39;s elements by the scalar <em>n</em>.</p>
195 <p>Returns a new FXVec2f instance obtained by memberwise multiplication of this vector’s elements by the scalar <em>n</em>.</p>
196196 </div></span>
197197
198198 </li>
288288
289289
290290 <span class="summary_desc"><div class='inline'>
291 <p>Returns a new FXVec2f instance obtained by memberwise division of this vector&#39;s elements by the scalar <em>n</em>.</p>
291 <p>Returns a new FXVec2f instance obtained by memberwise division of this vector’s elements by the scalar <em>n</em>.</p>
292292 </div></span>
293293
294294 </li>
783783 </h3><div class="docstring">
784784 <div class="discussion">
785785
786 <p>Returns a new FXVec2f instance obtained by memberwise multiplication of this vector&#39;s elements by the scalar <em>n</em>.</p>
786 <p>Returns a new FXVec2f instance obtained by memberwise multiplication of this vector’s elements by the scalar <em>n</em>.</p>
787787
788788
789789 </div>
931931 </h3><div class="docstring">
932932 <div class="discussion">
933933
934 <p>Returns a new FXVec2f instance obtained by memberwise division of this vector&#39;s elements by the scalar <em>n</em>. Raises ZeroDivisionError if <em>n</em> is identically zero.</p>
934 <p>Returns a new FXVec2f instance obtained by memberwise division of this vector’s elements by the scalar <em>n</em>. Raises ZeroDivisionError if <em>n</em> is identically zero.</p>
935935
936936
937937 </div>
14311431 </div>
14321432
14331433 <div id="footer">
1434 Generated on Fri Nov 27 21:10:40 2020 by
1435 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1436 0.9.24 (ruby-2.7.2).
1434 Generated on Mon Jan 2 11:47:28 2023 by
1435 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1436 0.9.28 (ruby-3.1.2).
14371437 </div>
14381438
14391439 </div>
252252
253253
254254 <span class="summary_desc"><div class='inline'>
255 <p>Returns a new FXVec3d instance obtained by memberwise multiplication of this vector&#39;s elements by the scalar <em>n</em>.</p>
255 <p>Returns a new FXVec3d instance obtained by memberwise multiplication of this vector’s elements by the scalar <em>n</em>.</p>
256256 </div></span>
257257
258258 </li>
348348
349349
350350 <span class="summary_desc"><div class='inline'>
351 <p>Returns a new FXVec3d instance obtained by memberwise division of this vector&#39;s elements by the scalar <em>n</em>.</p>
351 <p>Returns a new FXVec3d instance obtained by memberwise division of this vector’s elements by the scalar <em>n</em>.</p>
352352 </div></span>
353353
354354 </li>
953953 </h3><div class="docstring">
954954 <div class="discussion">
955955
956 <p>Returns a new FXVec3d instance obtained by memberwise multiplication of this vector&#39;s elements by the scalar <em>n</em>.</p>
956 <p>Returns a new FXVec3d instance obtained by memberwise multiplication of this vector’s elements by the scalar <em>n</em>.</p>
957957
958958
959959 </div>
11011101 </h3><div class="docstring">
11021102 <div class="discussion">
11031103
1104 <p>Returns a new FXVec3d instance obtained by memberwise division of this vector&#39;s elements by the scalar <em>n</em>. Raises ZeroDivisionError if <em>n</em> is identically zero.</p>
1104 <p>Returns a new FXVec3d instance obtained by memberwise division of this vector’s elements by the scalar <em>n</em>. Raises ZeroDivisionError if <em>n</em> is identically zero.</p>
11051105
11061106
11071107 </div>
16381638 </div>
16391639
16401640 <div id="footer">
1641 Generated on Fri Nov 27 21:10:40 2020 by
1642 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1643 0.9.24 (ruby-2.7.2).
1641 Generated on Mon Jan 2 11:47:28 2023 by
1642 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1643 0.9.28 (ruby-3.1.2).
16441644 </div>
16451645
16461646 </div>
252252
253253
254254 <span class="summary_desc"><div class='inline'>
255 <p>Returns a new FXVec3f instance obtained by memberwise multiplication of this vector&#39;s elements by the scalar <em>n</em>.</p>
255 <p>Returns a new FXVec3f instance obtained by memberwise multiplication of this vector’s elements by the scalar <em>n</em>.</p>
256256 </div></span>
257257
258258 </li>
348348
349349
350350 <span class="summary_desc"><div class='inline'>
351 <p>Returns a new FXVec3f instance obtained by memberwise division of this vector&#39;s elements by the scalar <em>n</em>.</p>
351 <p>Returns a new FXVec3f instance obtained by memberwise division of this vector’s elements by the scalar <em>n</em>.</p>
352352 </div></span>
353353
354354 </li>
953953 </h3><div class="docstring">
954954 <div class="discussion">
955955
956 <p>Returns a new FXVec3f instance obtained by memberwise multiplication of this vector&#39;s elements by the scalar <em>n</em>.</p>
956 <p>Returns a new FXVec3f instance obtained by memberwise multiplication of this vector’s elements by the scalar <em>n</em>.</p>
957957
958958
959959 </div>
11011101 </h3><div class="docstring">
11021102 <div class="discussion">
11031103
1104 <p>Returns a new FXVec3f instance obtained by memberwise division of this vector&#39;s elements by the scalar <em>n</em>. Raises ZeroDivisionError if <em>n</em> is identically zero.</p>
1104 <p>Returns a new FXVec3f instance obtained by memberwise division of this vector’s elements by the scalar <em>n</em>. Raises ZeroDivisionError if <em>n</em> is identically zero.</p>
11051105
11061106
11071107 </div>
16381638 </div>
16391639
16401640 <div id="footer">
1641 Generated on Fri Nov 27 21:10:40 2020 by
1642 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1643 0.9.24 (ruby-2.7.2).
1641 Generated on Mon Jan 2 11:47:28 2023 by
1642 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1643 0.9.28 (ruby-3.1.2).
16441644 </div>
16451645
16461646 </div>
283283
284284
285285 <span class="summary_desc"><div class='inline'>
286 <p>Returns a new FXVec4d instance obtained by memberwise multiplication of this vector&#39;s elements by the scalar <em>n</em>.</p>
286 <p>Returns a new FXVec4d instance obtained by memberwise multiplication of this vector’s elements by the scalar <em>n</em>.</p>
287287 </div></span>
288288
289289 </li>
379379
380380
381381 <span class="summary_desc"><div class='inline'>
382 <p>Returns a new FXVec4d instance obtained by memberwise division of this vector&#39;s elements by the scalar <em>n</em>.</p>
382 <p>Returns a new FXVec4d instance obtained by memberwise division of this vector’s elements by the scalar <em>n</em>.</p>
383383 </div></span>
384384
385385 </li>
10751075 </h3><div class="docstring">
10761076 <div class="discussion">
10771077
1078 <p>Returns a new FXVec4d instance obtained by memberwise multiplication of this vector&#39;s elements by the scalar <em>n</em>.</p>
1078 <p>Returns a new FXVec4d instance obtained by memberwise multiplication of this vector’s elements by the scalar <em>n</em>.</p>
10791079
10801080
10811081 </div>
12231223 </h3><div class="docstring">
12241224 <div class="discussion">
12251225
1226 <p>Returns a new FXVec4d instance obtained by memberwise division of this vector&#39;s elements by the scalar <em>n</em>. Raises ZeroDivisionError if <em>n</em> is identically zero.</p>
1226 <p>Returns a new FXVec4d instance obtained by memberwise division of this vector’s elements by the scalar <em>n</em>. Raises ZeroDivisionError if <em>n</em> is identically zero.</p>
12271227
12281228
12291229 </div>
18471847 </div>
18481848
18491849 <div id="footer">
1850 Generated on Fri Nov 27 21:10:40 2020 by
1851 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1852 0.9.24 (ruby-2.7.2).
1850 Generated on Mon Jan 2 11:47:28 2023 by
1851 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1852 0.9.28 (ruby-3.1.2).
18531853 </div>
18541854
18551855 </div>
283283
284284
285285 <span class="summary_desc"><div class='inline'>
286 <p>Returns a new FXVec4f instance obtained by memberwise multiplication of this vector&#39;s elements by the scalar <em>n</em>.</p>
286 <p>Returns a new FXVec4f instance obtained by memberwise multiplication of this vector’s elements by the scalar <em>n</em>.</p>
287287 </div></span>
288288
289289 </li>
379379
380380
381381 <span class="summary_desc"><div class='inline'>
382 <p>Returns a new FXVec4f instance obtained by memberwise division of this vector&#39;s elements by the scalar <em>n</em>.</p>
382 <p>Returns a new FXVec4f instance obtained by memberwise division of this vector’s elements by the scalar <em>n</em>.</p>
383383 </div></span>
384384
385385 </li>
10751075 </h3><div class="docstring">
10761076 <div class="discussion">
10771077
1078 <p>Returns a new FXVec4f instance obtained by memberwise multiplication of this vector&#39;s elements by the scalar <em>n</em>.</p>
1078 <p>Returns a new FXVec4f instance obtained by memberwise multiplication of this vector’s elements by the scalar <em>n</em>.</p>
10791079
10801080
10811081 </div>
12231223 </h3><div class="docstring">
12241224 <div class="discussion">
12251225
1226 <p>Returns a new FXVec4f instance obtained by memberwise division of this vector&#39;s elements by the scalar <em>n</em>. Raises ZeroDivisionError if <em>n</em> is identically zero.</p>
1226 <p>Returns a new FXVec4f instance obtained by memberwise division of this vector’s elements by the scalar <em>n</em>. Raises ZeroDivisionError if <em>n</em> is identically zero.</p>
12271227
12281228
12291229 </div>
18471847 </div>
18481848
18491849 <div id="footer">
1850 Generated on Fri Nov 27 21:10:41 2020 by
1851 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1852 0.9.24 (ruby-2.7.2).
1850 Generated on Mon Jan 2 11:47:28 2023 by
1851 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1852 0.9.28 (ruby-3.1.2).
18531853 </div>
18541854
18551855 </div>
113113 <h2>Overview</h2><div class="docstring">
114114 <div class="discussion">
115115
116 <p>Vertical frame layout manager widget is used to automatically place child-windows vertically from top-to-bottom, or bottom-to-top, depending on the child window&#39;s layout hints.</p>
116 <p>Vertical frame layout manager widget is used to automatically place child-windows vertically from top-to-bottom, or bottom-to-top, depending on the child window’s layout hints.</p>
117117
118118
119119 </div>
348348 </div>
349349
350350 <div id="footer">
351 Generated on Fri Nov 27 21:11:32 2020 by
352 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
353 0.9.24 (ruby-2.7.2).
351 Generated on Mon Jan 2 11:48:17 2023 by
352 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
353 0.9.28 (ruby-3.1.2).
354354 </div>
355355
356356 </div>
338338 </div>
339339
340340 <div id="footer">
341 Generated on Fri Nov 27 21:11:13 2020 by
342 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
343 0.9.24 (ruby-2.7.2).
341 Generated on Mon Jan 2 11:47:59 2023 by
342 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
343 0.9.28 (ruby-3.1.2).
344344 </div>
345345
346346 </div>
769769 </div>
770770
771771 <div id="footer">
772 Generated on Fri Nov 27 21:10:54 2020 by
773 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
774 0.9.24 (ruby-2.7.2).
772 Generated on Mon Jan 2 11:47:42 2023 by
773 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
774 0.9.28 (ruby-3.1.2).
775775 </div>
776776
777777 </div>
10121012 </div>
10131013
10141014 <div id="footer">
1015 Generated on Fri Nov 27 21:10:44 2020 by
1016 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1017 0.9.24 (ruby-2.7.2).
1015 Generated on Mon Jan 2 11:47:31 2023 by
1016 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1017 0.9.28 (ruby-3.1.2).
10181018 </div>
10191019
10201020 </div>
127127 <p>sent when the window is unmapped; the message data is an FXEvent instance.</p>
128128 </dd><dt><code>SEL_CONFIGURE</code>
129129 <dd>
130 <p>sent when the window&#39;s size changes; the message data is an FXEvent instance.</p>
130 <p>sent when the window’s size changes; the message data is an FXEvent instance.</p>
131131 </dd><dt><code>SEL_ENTER</code>
132132 <dd>
133133 <p>sent when the mouse cursor enters this window</p>
193193 <p>sent when this window loses the selection</p>
194194 </dd><dt><code>SEL_SELECTION_REQUEST</code>
195195 <dd>
196 <p>sent when this window&#39;s selection is requested</p>
196 <p>sent when this window’s selection is requested</p>
197197 </dd></dl>
198198
199199 <p>For each of the following clipboard-related events, the message data is an FXEvent instance:</p>
205205 <p>sent when this window loses the clipboard</p>
206206 </dd><dt><code>SEL_CLIPBOARD_REQUEST</code>
207207 <dd>
208 <p>sent when this window&#39;s clipboard data is requested</p>
208 <p>sent when this window’s clipboard data is requested</p>
209209 </dd></dl>
210210
211211 <p>For each of the following drag-and-drop events, the message data is an FXEvent instance:</p>
644644
645645
646646 <span class="summary_desc"><div class='inline'>
647 <p>This window&#39;s first child window, if any <span class='object_link'><a href="" title="Fox::FXWindow (class)">FXWindow</a></span>.</p>
647 <p>This window’s first child window, if any <span class='object_link'><a href="" title="Fox::FXWindow (class)">FXWindow</a></span>.</p>
648648 </div></span>
649649
650650 </li>
729729
730730
731731 <span class="summary_desc"><div class='inline'>
732 <p>This window&#39;s last child window, if any <span class='object_link'><a href="" title="Fox::FXWindow (class)">FXWindow</a></span>.</p>
732 <p>This window’s last child window, if any <span class='object_link'><a href="" title="Fox::FXWindow (class)">FXWindow</a></span>.</p>
733733 </div></span>
734734
735735 </li>
843843
844844
845845 <span class="summary_desc"><div class='inline'>
846 <p>This window&#39;s owner window <span class='object_link'><a href="" title="Fox::FXWindow (class)">FXWindow</a></span>.</p>
846 <p>This window’s owner window <span class='object_link'><a href="" title="Fox::FXWindow (class)">FXWindow</a></span>.</p>
847847 </div></span>
848848
849849 </li>
872872
873873
874874 <span class="summary_desc"><div class='inline'>
875 <p>This window&#39;s parent window <span class='object_link'><a href="" title="Fox::FXWindow (class)">FXWindow</a></span>.</p>
875 <p>This window’s parent window <span class='object_link'><a href="" title="Fox::FXWindow (class)">FXWindow</a></span>.</p>
876876 </div></span>
877877
878878 </li>
10401040
10411041
10421042 <span class="summary_desc"><div class='inline'>
1043 <p>This window&#39;s x-coordinate, in the parent&#39;s coordinate system [Integer].</p>
1043 <p>This window’s x-coordinate, in the parent’s coordinate system [Integer].</p>
10441044 </div></span>
10451045
10461046 </li>
10671067
10681068
10691069 <span class="summary_desc"><div class='inline'>
1070 <p>This window&#39;s y-coordinate, in the parent&#39;s coordinate system [Integer].</p>
1070 <p>This window’s y-coordinate, in the parent’s coordinate system [Integer].</p>
10711071 </div></span>
10721072
10731073 </li>
16751675
16761676
16771677 <span class="summary_desc"><div class='inline'>
1678 <p>Add this hot key to the closest ancestor&#39;s accelerator table.</p>
1678 <p>Add this hot key to the closest ancestor’s accelerator table.</p>
16791679 </div></span>
16801680
16811681 </li>
31653165
31663166
31673167 <span class="summary_desc"><div class='inline'>
3168 <p>Relink this window after sibling window <em>other</em>, in the parent&#39;s window list.</p>
3168 <p>Relink this window after sibling window <em>other</em>, in the parent’s window list.</p>
31693169 </div></span>
31703170
31713171 </li>
31893189
31903190
31913191 <span class="summary_desc"><div class='inline'>
3192 <p>Relink this window before sibling window <em>other</em>, in the parent&#39;s window list.</p>
3192 <p>Relink this window before sibling window <em>other</em>, in the parent’s window list.</p>
31933193 </div></span>
31943194
31953195 </li>
32373237
32383238
32393239 <span class="summary_desc"><div class='inline'>
3240 <p>Move the window immediately, in the parent&#39;s coordinate system.</p>
3240 <p>Move the window immediately, in the parent’s coordinate system.</p>
32413241 </div></span>
32423242
32433243 </li>
32853285
32863286
32873287 <span class="summary_desc"><div class='inline'>
3288 <p>Move and resize the window immediately, in the parent&#39;s coordinate system.</p>
3288 <p>Move and resize the window immediately, in the parent’s coordinate system.</p>
32893289 </div></span>
32903290
32913291 </li>
33333333
33343334
33353335 <span class="summary_desc"><div class='inline'>
3336 <p>Mark this window&#39;s layout as dirty.</p>
3336 <p>Mark this window’s layout as dirty.</p>
33373337 </div></span>
33383338
33393339 </li>
34053405
34063406
34073407 <span class="summary_desc"><div class='inline'>
3408 <p>Remove this hot key from the closest ancestor&#39;s accelerator table.</p>
3408 <p>Remove this hot key from the closest ancestor’s accelerator table.</p>
34093409 </div></span>
34103410
34113411 </li>
38153815
38163816
38173817 <span class="summary_desc"><div class='inline'>
3818 <p>Translate coordinates (<em>fromX</em>, <em>fromY</em>) from <em>fromWindow</em>&#39;s coordinate system to this window&#39;s coordinate system.</p>
3818 <p>Translate coordinates (<em>fromX</em>, <em>fromY</em>) from <em>fromWindow</em>’s coordinate system to this window’s coordinate system.</p>
38193819 </div></span>
38203820
38213821 </li>
38393839
38403840
38413841 <span class="summary_desc"><div class='inline'>
3842 <p>Translate coordinates (<em>fromX</em>, <em>fromY</em>) from this window&#39;s coordinate system to <em>toWindow</em>&#39;s coordinate system.</p>
3842 <p>Translate coordinates (<em>fromX</em>, <em>fromY</em>) from this window’s coordinate system to <em>toWindow</em>’s coordinate system.</p>
38433843 </div></span>
38443844
38453845 </li>
43124312 </h3><div class="docstring">
43134313 <div class="discussion">
43144314
4315 <p>This window&#39;s first child window, if any <span class='object_link'><a href="" title="Fox::FXWindow (class)">Fox::FXWindow</a></span></p>
4315 <p>This window’s first child window, if any <span class='object_link'><a href="" title="Fox::FXWindow (class)">Fox::FXWindow</a></span></p>
43164316
43174317
43184318 </div>
44414441 </h3><div class="docstring">
44424442 <div class="discussion">
44434443
4444 <p>This window&#39;s last child window, if any <span class='object_link'><a href="" title="Fox::FXWindow (class)">Fox::FXWindow</a></span></p>
4444 <p>This window’s last child window, if any <span class='object_link'><a href="" title="Fox::FXWindow (class)">Fox::FXWindow</a></span></p>
44454445
44464446
44474447 </div>
46134613 </h3><div class="docstring">
46144614 <div class="discussion">
46154615
4616 <p>This window&#39;s owner window <span class='object_link'><a href="" title="Fox::FXWindow (class)">Fox::FXWindow</a></span></p>
4616 <p>This window’s owner window <span class='object_link'><a href="" title="Fox::FXWindow (class)">Fox::FXWindow</a></span></p>
46174617
46184618
46194619 </div>
46564656 </h3><div class="docstring">
46574657 <div class="discussion">
46584658
4659 <p>This window&#39;s parent window <span class='object_link'><a href="" title="Fox::FXWindow (class)">Fox::FXWindow</a></span></p>
4659 <p>This window’s parent window <span class='object_link'><a href="" title="Fox::FXWindow (class)">Fox::FXWindow</a></span></p>
46604660
46614661
46624662 </div>
49144914 </h3><div class="docstring">
49154915 <div class="discussion">
49164916
4917 <p>This window&#39;s x-coordinate, in the parent&#39;s coordinate system [Integer]</p>
4917 <p>This window’s x-coordinate, in the parent’s coordinate system [Integer]</p>
49184918
49194919
49204920 </div>
49574957 </h3><div class="docstring">
49584958 <div class="discussion">
49594959
4960 <p>This window&#39;s y-coordinate, in the parent&#39;s coordinate system [Integer]</p>
4960 <p>This window’s y-coordinate, in the parent’s coordinate system [Integer]</p>
49614961
49624962
49634963 </div>
59205920 </h3><div class="docstring">
59215921 <div class="discussion">
59225922
5923 <p>Add this hot key to the closest ancestor&#39;s accelerator table.</p>
5923 <p>Add this hot key to the closest ancestor’s accelerator table.</p>
59245924
59255925
59265926 </div>
85188518 </h3><div class="docstring">
85198519 <div class="discussion">
85208520
8521 <p>Relink this window after sibling window <em>other</em>, in the parent&#39;s window list.</p>
8521 <p>Relink this window after sibling window <em>other</em>, in the parent’s window list.</p>
85228522
85238523
85248524 </div>
85598559 </h3><div class="docstring">
85608560 <div class="discussion">
85618561
8562 <p>Relink this window before sibling window <em>other</em>, in the parent&#39;s window list.</p>
8562 <p>Relink this window before sibling window <em>other</em>, in the parent’s window list.</p>
85638563
85648564
85658565 </div>
86378637 </h3><div class="docstring">
86388638 <div class="discussion">
86398639
8640 <p>Move the window immediately, in the parent&#39;s coordinate system. Update the server representation as well if the window is realized. Perform layout of the children when necessary.</p>
8640 <p>Move the window immediately, in the parent’s coordinate system. Update the server representation as well if the window is realized. Perform layout of the children when necessary.</p>
86418641
86428642
86438643 </div>
87248724 </h3><div class="docstring">
87258725 <div class="discussion">
87268726
8727 <p>Move and resize the window immediately, in the parent&#39;s coordinate system. Update the server representation as well if the window is realized. Perform layout of the children when necessary.</p>
8727 <p>Move and resize the window immediately, in the parent’s coordinate system. Update the server representation as well if the window is realized. Perform layout of the children when necessary.</p>
87288728
87298729
87308730 </div>
87988798 </h3><div class="docstring">
87998799 <div class="discussion">
88008800
8801 <p>Mark this window&#39;s layout as dirty</p>
8801 <p>Mark this window’s layout as dirty</p>
88028802
88038803
88048804 </div>
89098909 </h3><div class="docstring">
89108910 <div class="discussion">
89118911
8912 <p>Remove this hot key from the closest ancestor&#39;s accelerator table.</p>
8912 <p>Remove this hot key from the closest ancestor’s accelerator table.</p>
89138913
89148914
89158915 </div>
95869586 </h3><div class="docstring">
95879587 <div class="discussion">
95889588
9589 <p>Translate coordinates (<em>fromX</em>, <em>fromY</em>) from <em>fromWindow</em>&#39;s coordinate system to this window&#39;s coordinate system. Returns a two-element array containing the coordinates in this window&#39;s coordinate system.</p>
9589 <p>Translate coordinates (<em>fromX</em>, <em>fromY</em>) from <em>fromWindow</em>’s coordinate system to this window’s coordinate system. Returns a two-element array containing the coordinates in this window’s coordinate system.</p>
95909590
95919591
95929592 </div>
96239623 </h3><div class="docstring">
96249624 <div class="discussion">
96259625
9626 <p>Translate coordinates (<em>fromX</em>, <em>fromY</em>) from this window&#39;s coordinate system to <em>toWindow</em>&#39;s coordinate system. Returns a two-element array containing the coordinates in <em>toWindow</em>&#39;s coordinate system.</p>
9626 <p>Translate coordinates (<em>fromX</em>, <em>fromY</em>) from this window’s coordinate system to <em>toWindow</em>’s coordinate system. Returns a two-element array containing the coordinates in <em>toWindow</em>’s coordinate system.</p>
96279627
96289628
96299629 </div>
99379937 </div>
99389938
99399939 <div id="footer">
9940 Generated on Fri Nov 27 21:10:45 2020 by
9941 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
9942 0.9.24 (ruby-2.7.2).
9940 Generated on Mon Jan 2 11:47:32 2023 by
9941 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
9942 0.9.28 (ruby-3.1.2).
99439943 </div>
99449944
99459945 </div>
10411041 </div>
10421042
10431043 <div id="footer">
1044 Generated on Fri Nov 27 21:10:45 2020 by
1045 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1046 0.9.24 (ruby-2.7.2).
1044 Generated on Mon Jan 2 11:47:33 2023 by
1045 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1046 0.9.28 (ruby-3.1.2).
10471047 </div>
10481048
10491049 </div>
442442 </div>
443443
444444 <div id="footer">
445 Generated on Fri Nov 27 21:10:51 2020 by
446 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
447 0.9.24 (ruby-2.7.2).
445 Generated on Mon Jan 2 11:47:39 2023 by
446 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
447 0.9.28 (ruby-3.1.2).
448448 </div>
449449
450450 </div>
426426 </div>
427427
428428 <div id="footer">
429 Generated on Fri Nov 27 21:10:59 2020 by
430 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
431 0.9.24 (ruby-2.7.2).
429 Generated on Mon Jan 2 11:47:46 2023 by
430 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
431 0.9.28 (ruby-3.1.2).
432432 </div>
433433
434434 </div>
439439 </div>
440440
441441 <div id="footer">
442 Generated on Fri Nov 27 21:10:51 2020 by
443 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
444 0.9.24 (ruby-2.7.2).
442 Generated on Mon Jan 2 11:47:39 2023 by
443 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
444 0.9.28 (ruby-3.1.2).
445445 </div>
446446
447447 </div>
423423 </div>
424424
425425 <div id="footer">
426 Generated on Fri Nov 27 21:10:59 2020 by
427 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
428 0.9.24 (ruby-2.7.2).
426 Generated on Mon Jan 2 11:47:46 2023 by
427 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
428 0.9.28 (ruby-3.1.2).
429429 </div>
430430
431431 </div>
275275 </div>
276276
277277 <div id="footer">
278 Generated on Fri Nov 27 21:11:07 2020 by
279 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
280 0.9.24 (ruby-2.7.2).
278 Generated on Mon Jan 2 11:47:53 2023 by
279 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
280 0.9.28 (ruby-3.1.2).
281281 </div>
282282
283283 </div>
14271427 </div>
14281428
14291429 <div id="footer">
1430 Generated on Fri Nov 27 21:11:07 2020 by
1431 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1432 0.9.24 (ruby-2.7.2).
1430 Generated on Mon Jan 2 11:47:53 2023 by
1431 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1432 0.9.28 (ruby-3.1.2).
14331433 </div>
14341434
14351435 </div>
270270 </div>
271271
272272 <div id="footer">
273 Generated on Fri Nov 27 21:11:07 2020 by
274 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
275 0.9.24 (ruby-2.7.2).
273 Generated on Mon Jan 2 11:47:53 2023 by
274 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
275 0.9.28 (ruby-3.1.2).
276276 </div>
277277
278278 </div>
91009100 </h3><div class="docstring">
91019101 <div class="discussion">
91029102
9103 <p>The drag-and-drop data used for colors is a sequence of unsigned short integers, in native byte ordering. Here, we use the &#39;S&#39; directive for String#unpack (which treats two successive characters as an unsigned short in native byte order) to decode the R, G, B and A values.</p>
9103 <p>The drag-and-drop data used for colors is a sequence of unsigned short integers, in native byte ordering. Here, we use the ‘S’ directive for String#unpack (which treats two successive characters as an unsigned short in native byte order) to decode the R, G, B and A values.</p>
91049104
91059105
91069106 </div>
91929192 </h3><div class="docstring">
91939193 <div class="discussion">
91949194
9195 <p>The drag-and-drop data used for colors is a sequence of unsigned short integers, in native byte ordering. Here, we use the &#39;S&#39; directive for Array#pack (which treats two successive characters as an unsigned short in native byte order) to encode the R, G, B and A values.</p>
9195 <p>The drag-and-drop data used for colors is a sequence of unsigned short integers, in native byte ordering. Here, we use the ‘S’ directive for Array#pack (which treats two successive characters as an unsigned short in native byte order) to encode the R, G, B and A values.</p>
91969196
91979197
91989198 </div>
98629862 </h3><div class="docstring">
98639863 <div class="discussion">
98649864
9865 <p>Return a “hot key” code value that represents the accelerator key described in the string <em>str</em>. The string can contain some combination of the modifiers <em>Ctrl</em>, <em>Alt</em> and <em>Shift</em>, plus the key of interest. For example, to get the accelerator key for Ctrl+Alt+F7, you&#39;d use:</p>
9865 <p>Return a “hot key” code value that represents the accelerator key described in the string <em>str</em>. The string can contain some combination of the modifiers <em>Ctrl</em>, <em>Alt</em> and <em>Shift</em>, plus the key of interest. For example, to get the accelerator key for Ctrl+Alt+F7, you’d use:</p>
98669866
98679867 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_hotKey'>hotKey</span> <span class='op'>=</span> <span class='id identifier rubyid_fxparseAccel'>fxparseAccel</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Ctrl+Alt+F7</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
98689868 </code></pre>
1014310143 <pre class="code"><span class="info file"># File 'lib/fox16/version.rb', line 2</span>
1014410144
1014510145 <span class='kw'>def</span> <span class='const'><span class='object_link'><a href="" title="Fox (module)">Fox</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fxrubyversion'>fxrubyversion</span>
10146 <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.6.43</span><span class='tstring_end'>&quot;</span></span>
10146 <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.6.45</span><span class='tstring_end'>&quot;</span></span>
1014710147 <span class='kw'>end</span></pre>
1014810148 </td>
1014910149 </tr>
1117311173 </div>
1117411174
1117511175 <div id="footer">
11176 Generated on Fri Nov 27 21:10:34 2020 by
11177 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
11178 0.9.24 (ruby-2.7.2).
11176 Generated on Mon Jan 2 11:47:22 2023 by
11177 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
11178 0.9.28 (ruby-3.1.2).
1117911179 </div>
1118011180
1118111181 </div>
193193 </div>
194194
195195 <div id="footer">
196 Generated on Fri Nov 27 21:10:34 2020 by
197 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
198 0.9.24 (ruby-2.7.2).
196 Generated on Mon Jan 2 11:47:22 2023 by
197 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
198 0.9.28 (ruby-3.1.2).
199199 </div>
200200
201201 </div>
587587 </h3><div class="docstring">
588588 <div class="discussion">
589589
590 <p>Generates identifiers as class constants. Originally submitted by Sean O&#39;Halpin, slightly modified by Lyle.</p>
590 <p>Generates identifiers as class constants. Originally submitted by Sean O’Halpin, slightly modified by Lyle.</p>
591591
592592
593593 </div>
682682 </div>
683683
684684 <div id="footer">
685 Generated on Fri Nov 27 21:10:34 2020 by
686 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
687 0.9.24 (ruby-2.7.2).
685 Generated on Mon Jan 2 11:47:22 2023 by
686 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
687 0.9.28 (ruby-3.1.2).
688688 </div>
689689
690690 </div>
214214 </div>
215215
216216 <div id="footer">
217 Generated on Fri Nov 27 21:10:34 2020 by
218 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
219 0.9.24 (ruby-2.7.2).
217 Generated on Mon Jan 2 11:47:22 2023 by
218 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
219 0.9.28 (ruby-3.1.2).
220220 </div>
221221
222222 </div>
20902090 </div>
20912091
20922092 <div id="footer">
2093 Generated on Fri Nov 27 21:10:27 2020 by
2094 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2095 0.9.24 (ruby-2.7.2).
2093 Generated on Mon Jan 2 11:47:15 2023 by
2094 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2095 0.9.28 (ruby-3.1.2).
20962096 </div>
20972097
20982098 </div>
5151 background: #fff;
5252 padding: 1.2em;
5353 padding-top: 0.2em;
54 box-sizing: border-box;
5455 }
5556
5657 @media (max-width: 920px) {
5757 </div>
5858
5959 <div id="content"><div id='filecontents'>
60 <h2 id="label-1.6.45+-2F+2022-01-14">1.6.45 / 2022-01-14</h2>
61 <ul><li>
62 <p>Add binary gem support for ruby-3.1 on platform x64-mingw-ucrt and drop ruby-2.3.</p>
63 </li><li>
64 <p>Update to libz-1.2.11, libjpeg-turbo-2.1.2, libtiff-4.3.0 for Windows binary gems.</p>
65 </li></ul>
66
67 <h2 id="label-1.6.44+-2F+2020-12-31">1.6.44 / 2020-12-31</h2>
68 <ul><li>
69 <p>Add binary gem support for ruby-3.0. #66</p>
70 </li><li>
71 <p>Drop support for ruby-2.2</p>
72 </li></ul>
73
6074 <h2 id="label-1.6.43+-2F+2020-11-27">1.6.43 / 2020-11-27</h2>
6175 <ul><li>
6276 <p>Make FXRuby compatible to ruby-3.0</p>
183197 <ul><li>
184198 <p>Avoid rb_* calls that are prohibited during GC. Fixes #23</p>
185199 </li><li>
186 <p>Use copy&#39;ing getters for FXVec members in FXMat*, FXMaterial and FXLight. This fixes the TC_FXMaterial#test_bug test case.</p>
200 <p>Use copy’ing getters for FXVec members in FXMat*, FXMaterial and FXLight. This fixes the TC_FXMaterial#test_bug test case.</p>
187201 </li><li>
188202 <p>Fix test suite, so that all tests pass.</p>
189203 </li><li>
196210 </li><li>
197211 <p>Use release mode, unless extconf.rb is called with –enable-debug, so that all FXTRACE() and FXASSERT() calls are skiped, per default.</p>
198212 </li><li>
199 <p>Remove self made GC detection by ruby&#39;s rb_during_gc().</p>
213 <p>Remove self made GC detection by ruby’s rb_during_gc().</p>
200214 </li><li>
201215 <p>Fix Windows binary x86-mingw32.gem for Ruby versions &lt; 2.0</p>
202216 </li></ul>
212226 <ul><li>
213227 <p>Fix crashes in rb_gc_mark(): 0x00000003f54af8 is T_ZOMBIE / T_NONE</p>
214228 </li><li>
215 <p>Release Ruby&#39;s GVL while calls to FXImage#savePixels, #loadPixels and FXApp#run* methods.</p>
229 <p>Release Ruby’s GVL while calls to FXImage#savePixels, #loadPixels and FXApp#run* methods.</p>
216230 </li><li>
217231 <p>Add a working version for FXApp#addInput event handling on Windows. This works for sockets only for now.</p>
218232 </li><li>
227241 </li><li>
228242 <p>Use shared libs for Windows binary gems to reduce gem size.</p>
229243 </li><li>
230 <p>Allow non owned assignment of image data to FXImage derivations without copy&#39;ing pixel data.</p>
244 <p>Allow non owned assignment of image data to FXImage derivations without copy’ing pixel data.</p>
231245 </li><li>
232246 <p>Allow retrival of parts of the pixel data.</p>
233247 </li><li>
234248 <p>Fix namespace specifier for FXRGB in kwargs.rb.</p>
235249 </li><li>
236 <p>Change GC&#39;ing of TreeListBox and FXTreeItem. Fixes #10</p>
250 <p>Change GC’ing of TreeListBox and FXTreeItem. Fixes #10</p>
237251 </li><li>
238252 <p>Update to swig version 2.0 or newer. Fixes #13</p>
239253 </li></ul>
300314 </li><li>
301315 <p>Fix double referenced foxObj when borrowed object registration is triggered from C++</p>
302316 </li><li>
303 <p>Fix Segfault while GC&#39;ing FXWindows</p>
304 </li><li>
305 <p>Fix &#39;object allocation not allowed while garbage collection&#39; bug</p>
317 <p>Fix Segfault while GC’ing FXWindows</p>
318 </li><li>
319 <p>Fix ‘object allocation not allowed while garbage collection’ bug</p>
306320 </li><li>
307321 <p>Fix clipboard handling on windows</p>
308322 </li><li>
325339 </li><li>
326340 <p>Did some work to provide support for MinGW builds.</p>
327341 </li><li>
328 <p>The previous release of FXRuby couldn&#39;t be built from source against Ruby 1.9.1 final due to a change in some of the file-related utility libraries (see RubyForge Bug #23786). This problem has been corrected.</p>
342 <p>The previous release of FXRuby couldn’t be built from source against Ruby 1.9.1 final due to a change in some of the file-related utility libraries (see RubyForge Bug #23786). This problem has been corrected.</p>
329343 </li></ul>
330344
331345 <h2 id="label-Changes+For+Version+1.6.19+-28March+6-2C+2009-29">Changes For Version 1.6.19 (March 6, 2009)</h2>
332346 <ul><li>
333 <p>The previous release of FXRuby couldn&#39;t be built from source against Ruby 1.9.1 final due to a change in some of the file-related utility libraries (see RubyForge Bug #23786). This problem has been corrected.</p>
334 </li><li>
335 <p>The previous release of FXRuby couldn&#39;t be built from source against Ruby versions 1.8.5 or earlier (see RubyForge Bug #23967). This problem has been corrected.</p>
336 </li><li>
337 <p>A change in the return value for Ruby&#39;s <code>instance_variables</code> method broke some of the code related to message handling in FXRuby (see RubyForge Bug #23787). This problem has been corrected.</p>
347 <p>The previous release of FXRuby couldn’t be built from source against Ruby 1.9.1 final due to a change in some of the file-related utility libraries (see RubyForge Bug #23786). This problem has been corrected.</p>
348 </li><li>
349 <p>The previous release of FXRuby couldn’t be built from source against Ruby versions 1.8.5 or earlier (see RubyForge Bug #23967). This problem has been corrected.</p>
350 </li><li>
351 <p>A change in the return value for Ruby’s <code>instance_variables</code> method broke some of the code related to message handling in FXRuby (see RubyForge Bug #23787). This problem has been corrected.</p>
338352 </li><li>
339353 <p>The <code>addAccel</code> method for the <code>FXAccelTable</code> class now accepts lambda functions (or any other objects that respond to <code>call</code>). See the API documentation for <code>FXAccelTable</code> for examples of how this works.</p>
340354 </li></ul>
348362 <ul><li>
349363 <p>The Ruby interpreter was generating a large number of warning messages about redefined methods in the <code>kwargs.rb</code> library (see RubyForge Bug #19231 and elsewhere). This problem has been corrected.</p>
350364 </li><li>
351 <p>Due to recent changes in Ruby&#39;s garbage collection algorithm, FXRuby applications could under some circumstances crash for large numbers of table items (see RubyForge bugs ). This bug has been fixed.</p>
365 <p>Due to recent changes in Ruby's garbage collection algorithm, FXRuby applications could under some circumstances crash for large numbers of table items (see RubyForge bugs ). This bug has been fixed.</p>
352366 </li><li>
353367 <p>The documentation for the <code>FXTable</code> class referred to the non-existent <code>setColumnX</code> and <code>setRowY</code> instance methods (see RubyForge Bug #21987). These entries have been removed from the documentation.</p>
354368 </li><li>
355 <p>A number of instance methods for the <code>FXTable</code> class could crash an application if they were passed out-of-bounds index arguments (see RubyForge Bug #21987). These methods now raise <code>IndexError</code> when they&#39;re passed out-of-bounds indexes.</p>
369 <p>A number of instance methods for the <code>FXTable</code> class could crash an application if they were passed out-of-bounds index arguments (see RubyForge Bug #21987). These methods now raise <code>IndexError</code> when they're passed out-of-bounds indexes.</p>
356370 </li><li>
357371 <p>Due to a change in the URL scheme for the Dilbert web site, the <code>dilbert.rb</code> example program was no longer working properly (see RubyForge Bug #21538). This has been fixed.</p>
358372 </li><li>
359 <p>The <code>lower</code> method for the <code>FXRangef</code> was returning ´self´ instead of an <code>FXVec3f</code> instance for the range&#39;s low bound (see RubyForge Bug #22488). This has been fixed.</p>
373 <p>The <code>lower</code> method for the <code>FXRangef</code> was returning ´self´ instead of an <code>FXVec3f</code> instance for the range’s low bound (see RubyForge Bug #22488). This has been fixed.</p>
360374 </li><li>
361375 <p>Made a number of minor fixes for compatibility with Ruby 1.9.1.</p>
362376 </li></ul>
365379 <ul><li>
366380 <p>Historically, if you called <code>create</code> on a window before its parent window was created, your application would crash (see RubyForge Bug #20702 and elsewhere). Now, the code should raise a ´RuntimeError´ with a message indicating the problem.</p>
367381 </li><li>
368 <p>The message data that the <code>FXPicker</code> widget sends along with its ´SEL_CHANGED´ and ´SEL_COMMAND´ messages wasn&#39;t being handled properly, and as a result, applications using this widget could crash (see RubyForge Bug #20780). This problem has been fixed.</p>
382 <p>The message data that the <code>FXPicker</code> widget sends along with its ´SEL_CHANGED´ and ´SEL_COMMAND´ messages wasn’t being handled properly, and as a result, applications using this widget could crash (see RubyForge Bug #20780). This problem has been fixed.</p>
369383 </li></ul>
370384
371385 <h2 id="label-Changes+For+Version+1.6.15+-28June+4-2C+2008-29">Changes For Version 1.6.15 (June 4, 2008)</h2>
374388 </li><li>
375389 <p>You should only ever construct one <code>FXApp</code> object per application, but there was no protection against doing so in the code (see RubyForge Bug #16275). Now, <code>FXApp.new</code> will raise a <code>RuntimeException</code> if an <code>FXApp</code> object already exists.</p>
376390 </li><li>
377 <p>The <code>babelfish.rb</code> example program, which previously depended on an external web service to perform translation between languages, was broken since that web service no longer exists (see RubyForge Bug #16962). The example has now been updated to use Dr. Nic&#39;s Tranexp library instead.</p>
378 </li><li>
379 <p>The value of the ´MBOX_SAVE_CANCEL_DONTSAVE´ option (for the <code>FXMessageBox</code> class) wasn&#39;t wrapped properly and was unusable (see RubyForge Bug #17094). There was also no constant corresponding to the ´MBOX_CLICKED_DONTSAVE´ return value. Both of these problems have been fixed.</p>
391 <p>The <code>babelfish.rb</code> example program, which previously depended on an external web service to perform translation between languages, was broken since that web service no longer exists (see RubyForge Bug #16962). The example has now been updated to use Dr. Nic's Tranexp library instead.</p>
392 </li><li>
393 <p>The value of the ´MBOX_SAVE_CANCEL_DONTSAVE´ option (for the <code>FXMessageBox</code> class) wasn’t wrapped properly and was unusable (see RubyForge Bug #17094). There was also no constant corresponding to the ´MBOX_CLICKED_DONTSAVE´ return value. Both of these problems have been fixed.</p>
380394 </li><li>
381395 <p>The fields for new <code>FXHiliteStyle</code> objects were uninitialized and as a result sometimes gave unpredictable results (see RubyForge Bug #19637). This has been fixed.</p>
382396 </li><li>
383 <p>The <code>columnHeaderFont</code> and <code>rowHeaderFont</code> attributes for <code>FXTable</code> weren&#39;t implemented properly (see RubyForge Bug #20142). This has been fixed.</p>
397 <p>The <code>columnHeaderFont</code> and <code>rowHeaderFont</code> attributes for <code>FXTable</code> weren't implemented properly (see RubyForge Bug #20142). This has been fixed.</p>
384398 </li><li>
385399 <p>Ruby 1.8.7 adds a new <code>first</code> method to the <code>Enumerable</code> module, and this conflicts with the existing <code>first</code> method defined in the <code>FXWindow</code> base class for a number of FXRuby classes which mix in <code>Enumerable</code> (see RubyForge Bug #20418). This problem has been resolved.</p>
386400 </li><li>
389403
390404 <h2 id="label-Changes+For+Version+1.6.14+-28March+29-2C+2008-29">Changes For Version 1.6.14 (March 29, 2008)</h2>
391405 <ul><li>
392 <p>Updated the documentation for the <code>FXImage</code> class to indicate which methods call <code>render</code> after they&#39;re finished, and which ones do not.</p>
406 <p>Updated the documentation for the <code>FXImage</code> class to indicate which methods call <code>render</code> after they're finished, and which ones do not.</p>
393407 </li><li>
394408 <p>Corrected a little typo in the <code>gembrowser.rb</code> example program.</p>
395409 </li><li>
399413 </li><li>
400414 <p>Made a number of minor fixes to support building FXRuby against Ruby 1.9.</p>
401415 </li><li>
402 <p>Added a binary gem for OS X. This works with the Ruby that&#39;s included with OS X (Leopard).</p>
416 <p>Added a binary gem for OS X. This works with the Ruby that's included with OS X (Leopard).</p>
403417 </li><li>
404418 <p>The binary gem for Windows was built with FOX version 1.6.32 and FXScintilla version 1.71.</p>
405419 </li></ul>
446460 </li><li>
447461 <p>Changes to the <code>iterators</code> library in version 1.6.6 introduced a bug in the <code>each</code> method for the <code>FXFoldingList</code>, <code>FXTreeList</code> and <code>FXTreeListBox</code> classes (see RubyForge Bug #10175). This problem has been fixed.</p>
448462 </li><li>
449 <p>Applied submitted patches for building FXRuby against Ruby 1.9 (see RubyForge Bug #10181). Please note that building FXRuby against the Ruby 1.9 code base is still officially unsupported; however, I&#39;m glad to accept patches that will help make this possible.</p>
463 <p>Applied submitted patches for building FXRuby against Ruby 1.9 (see RubyForge Bug #10181). Please note that building FXRuby against the Ruby 1.9 code base is still officially unsupported; however, I'm glad to accept patches that will help make this possible.</p>
450464 </li><li>
451465 <p>The binary gem for Windows was built with FOX version 1.6.25 and FXScintilla version 1.71.</p>
452466 </li></ul>
488502 </li><li>
489503 <p>Most of the FXRuby example programs have been updated to use the keyword arguments library.</p>
490504 </li><li>
491 <p>Added a new “virtual” keyword argument ´:padding´ that can be used in place of (or in addition to) the ´:padLeft´, ´:padRight´, ´:padTop´ and ´:padBottom´ arguments for a constructor. When a ´:padding´ value is passed in to the arguments hash, that value will be used for any of the four regular padding values that aren&#39;t otherwise specified. See the example programs for, you know, examples.</p>
505 <p>Added a new “virtual” keyword argument ´:padding´ that can be used in place of (or in addition to) the ´:padLeft´, ´:padRight´, ´:padTop´ and ´:padBottom´ arguments for a constructor. When a ´:padding´ value is passed in to the arguments hash, that value will be used for any of the four regular padding values that aren’t otherwise specified. See the example programs for, you know, examples.</p>
492506 </li><li>
493507 <p>The binary gem for Windows was built with FOX version 1.6.20 and FXScintilla version 1.71.</p>
494508 </li></ul>
505519 </li><li>
506520 <p>There was a small typo in the documentation for the <code>FXFoldingList</code> class options (see RubyForge Bug #7981). This has been fixed.</p>
507521 </li><li>
508 <p>Added preliminary support for keyword-style arguments, as described in the "Differences Between FOX and FXRuby" section of the FXRuby User&#39;s Guide.</p>
522 <p>Added preliminary support for keyword-style arguments, as described in the "Differences Between FOX and FXRuby" section of the FXRuby User's Guide.</p>
509523 </li><li>
510524 <p>The binary gem for Windows was built with FOX version 1.6.20 and FXScintilla version 1.71.</p>
511525 </li></ul>
519533
520534 <h2 id="label-Changes+For+Version+1.6.3+-28October+27-2C+2006-29">Changes For Version 1.6.3 (October 27, 2006)</h2>
521535 <ul><li>
522 <p>Widgets of some classes (namely <code>FXTopWindow</code> and <code>FXMDIChild</code>) weren&#39;t properly sending a ´SEL_CLOSE´ message to their message targets (see RubyForge Bug #5498). Thanks to a change in FOX version 1.6.16, this problem has been fixed.</p>
536 <p>Widgets of some classes (namely <code>FXTopWindow</code> and <code>FXMDIChild</code>) weren’t properly sending a ´SEL_CLOSE´ message to their message targets (see RubyForge Bug #5498). Thanks to a change in FOX version 1.6.16, this problem has been fixed.</p>
523537 </li><li>
524538 <p>The <code>getControlFor</code> method for the <code>FXComboTableItem</code> class was coded incorrectly (see RubyForge Bug #5906). This has been fixed.</p>
525539 </li><li>
544558 </li><li>
545559 <p>The <code>FXDockTitle</code> class was not supported (see RubyForge Bug #5632). This has been fixed.</p>
546560 </li><li>
547 <p>The API documentation for the <code>FXGLCanvas</code> class claimed it had a <code>shared?</code> method, but it didn&#39;t (see RubyForge Bug #5591). Now it does.</p>
561 <p>The API documentation for the <code>FXGLCanvas</code> class claimed it had a <code>shared?</code> method, but it didn't (see RubyForge Bug #5591). Now it does.</p>
548562 </li><li>
549563 <p>The <code>FXGradientBar</code> class was not supported (see RubyForge Bug #5746). This has been fixed.</p>
550564 </li><li>
561575 </li><li>
562576 <p>The <code>FXDockTitle</code> class was not supported (see RubyForge Bug #5632). This has been fixed.</p>
563577 </li><li>
564 <p>The API documentation for the <code>FXGLCanvas</code> class claimed it had a <code>shared?</code> method, but it didn&#39;t (see RubyForge Bug #5591). Now it does.</p>
578 <p>The API documentation for the <code>FXGLCanvas</code> class claimed it had a <code>shared?</code> method, but it didn't (see RubyForge Bug #5591). Now it does.</p>
565579 </li><li>
566580 <p>The <code>FXGradientBar</code> class was not supported (see RubyForge Bug #5746). This has been fixed.</p>
567581 </li><li>
572586 <ul><li>
573587 <p>The message data sent along for the ´SEL_INSERTED´, ´SEL_DELETED´ and ´SEL_REPLACED´ messages from an a <code>FXText</code> widget to its target was not being converted properly (see RubyForge Bug #4666). This has been fixed.</p>
574588 </li><li>
575 <p>The code related to the localization of application messages in FOX wasn&#39;t implemented properly in FXRuby, and as a result, constructing certain dialogs (like the color dialog) could cause a program to crash (see RubyForge Bug #5000). This has been fixed.</p>
576 </li><li>
577 <p>The "Stop Spin" button in the gltest.rb example program didn&#39;t stop the cubes from spinning after either the "Spin Timer" or "Spin Chore" option was selected (see RubyForge Bug #5001). This was actually a symptom of a larger problem, that FXRuby wasn&#39;t properly handling timers and chores. These problems have been fixed.</p>
578 </li><li>
579 <p>Setting the current item for an <code>FXComboBox</code> to -1 (to indicate that there&#39;s no current item) would cause FXRuby to erroneously raise an <code>IndexError</code> (see RubyForge Bug #5007). This has been fixed.</p>
589 <p>The code related to the localization of application messages in FOX wasn't implemented properly in FXRuby, and as a result, constructing certain dialogs (like the color dialog) could cause a program to crash (see RubyForge Bug #5000). This has been fixed.</p>
590 </li><li>
591 <p>The "Stop Spin" button in the gltest.rb example program didn't stop the cubes from spinning after either the "Spin Timer" or "Spin Chore" option was selected (see RubyForge Bug #5001). This was actually a symptom of a larger problem, that FXRuby wasn't properly handling timers and chores. These problems have been fixed.</p>
592 </li><li>
593 <p>Setting the current item for an <code>FXComboBox</code> to -1 (to indicate that there's no current item) would cause FXRuby to erroneously raise an <code>IndexError</code> (see RubyForge Bug #5007). This has been fixed.</p>
580594 </li><li>
581595 <p>The documentation for the <code>reparent</code> instance method for the <code>FXWindow</code> class was incorrect (see RubyForge Bug #5035). This has been fixed.</p>
582596 </li><li>
586600 </li><li>
587601 <p>The <code>dilbert.rb</code> example program has been modified to use the RubyfulSoup HTML library instead of the html-parser library.</p>
588602 </li><li>
589 <p>As discussed in various forums (see for example <a href="http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/182827">this post</a>, the <code>autorequire</code> directive for RubyGems specifications is now deprecated. As a result, this has been removed from the FXRuby gem specification. This change will break any code that was using a statement like:´require_gem &#39;fxruby&#39;´as the sole means for loading FXRuby. Such programs should instead use:´require &#39;fox16&#39;´which will work for either gem based or non-gem based installations.</p>
603 <p>As discussed in various forums (see for example <a href="http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/182827">this post</a>, the <code>autorequire</code> directive for RubyGems specifications is now deprecated. As a result, this has been removed from the FXRuby gem specification. This change will break any code that was using a statement like:´require_gem ‘fxruby’´as the sole means for loading FXRuby. Such programs should instead use:´require ‘fox16’´which will work for either gem based or non-gem based installations.</p>
590604 </li><li>
591605 <p>The binary gem for Windows was built with FOX version 1.6.8 and FXScintilla version 1.67 (from CVS).</p>
592606 </li></ul>
616630 </li><li>
617631 <p>The <code>FXSwitcher</code> widget was not sending the appropriate message data to its message target for the ´SEL_COMMAND´ message type (see RubyForge Bug #4157). This error has been corrected. Thanks to Manfred Usselmann for reporting this problem.</p>
618632 </li><li>
619 <p>The <code>FXSeparator</code> class wasn&#39;t implemented properly (see RubyForge Bug #4158). This error has been corrected. Thanks to Gerard Menochet for reporting this problem.</p>
633 <p>The <code>FXSeparator</code> class wasn't implemented properly (see RubyForge Bug #4158). This error has been corrected. Thanks to Gerard Menochet for reporting this problem.</p>
620634 </li><li>
621635 <p>The <code>findItemByData</code> method was implemented incorrectly for the <code>FXComboBox</code>, <code>FXFoldingList</code>, <code>FXIconList</code>, <code>FXList</code> and <code>FXListBox</code> classes (see RubyForge Bug #4172). This error has been corrected. Thanks to Gerard Menochet for reporting this problem.</p>
622636 </li><li>
637651 </li><li>
638652 <p>Due to an error in the SWIG interface files, the <code>FXChoiceBox</code> class was basically unusable (see RubyForge Bug #3676). This error has been corrected. Thanks to Uwe Hartl for reporting this problem.</p>
639653 </li><li>
640 <p>The API documentation for the <code>FXRealSlider</code> and <code>FXRealSpinner</code> classes erroneously claimed that the message data for the ´SEL_COMMAND´ and ´SEL_CHANGED´ messages sent by these widgets to their targets were integers (see RubyForge Bug #3749). Along the same lines, the message data for those widgets wasn&#39;t being converted correctly (see RubyForge Bug #3750). Both of these errors have been corrected. Thanks to Meinrad Recheis (Henon) for reporting these problems.</p>
654 <p>The API documentation for the <code>FXRealSlider</code> and <code>FXRealSpinner</code> classes erroneously claimed that the message data for the ´SEL_COMMAND´ and ´SEL_CHANGED´ messages sent by these widgets to their targets were integers (see RubyForge Bug #3749). Along the same lines, the message data for those widgets wasn’t being converted correctly (see RubyForge Bug #3750). Both of these errors have been corrected. Thanks to Meinrad Recheis (Henon) for reporting these problems.</p>
641655 </li><li>
642656 <p>The API documentation for the Fox module incorrectly listed the names of the <code>FXSELTYPE</code> and <code>FXSELID</code> methods as <code>SELTYPE</code> and <code>SELID</code> (see RubyForge Bug #3940). This error has been corrected. Thanks to Joel VanderWerf for reporting this problem.</p>
643657 </li><li>
644 <p>The <code>FXTableItem</code> constructor was supposed to (optionally) accept a reference to an arbitrary Ruby object as its third argument, but this wasn&#39;t working properly (see RubyForge Bug #4005). This error has been corrected. Thanks to Mark Volkman for reporting this problem.</p>
658 <p>The <code>FXTableItem</code> constructor was supposed to (optionally) accept a reference to an arbitrary Ruby object as its third argument, but this wasn't working properly (see RubyForge Bug #4005). This error has been corrected. Thanks to Mark Volkman for reporting this problem.</p>
645659 </li><li>
646660 <p>The binary gem for Windows was built with FOX version 1.4.29 and FXScintilla version 1.63.</p>
647661 </li></ul>
671685 </li><li>
672686 <p>Due to a bug in the test suite runner script, not all test cases were being exercised (see RubyForge Bug #2565). This bug has been fixed.</p>
673687 </li><li>
674 <p>Calling the <code>getPixel</code> method for the <code>FXImage</code> class when the client-side pixel buffer for the image has already been released would cause a program to crash (see RubyForge Bug #2611). Now, <code>getPixel</code> will raise an exception if it&#39;s called after the pixel buffer has been released. The documentation for <code>getPixel</code> has been updated accordingly. Thanks to Gonzalo Garramuno for reporting this problem.</p>
675 </li><li>
676 <p>The <code>makePositionVisible</code> method for the <code>FXTable</code> class was raising an exception when passed out-of-bounds values for the row or column index (see RubyForge Bug #2660). This could happen, for example, if you were to click in a table area outside of the regular cells (which indirectly triggers a call to <code>makePositionVisible</code>). This was actually inconsistent with standard FOX behavior, which simply ignores out of bounds values for that method&#39;s arguments. This bug has been fixed, and the documentation for <code>makePositionVisible</code> has been updated accordingly. Thanks to Ralf Jonas for reporting this problem.</p>
688 <p>Calling the <code>getPixel</code> method for the <code>FXImage</code> class when the client-side pixel buffer for the image has already been released would cause a program to crash (see RubyForge Bug #2611). Now, <code>getPixel</code> will raise an exception if it's called after the pixel buffer has been released. The documentation for <code>getPixel</code> has been updated accordingly. Thanks to Gonzalo Garramuno for reporting this problem.</p>
689 </li><li>
690 <p>The <code>makePositionVisible</code> method for the <code>FXTable</code> class was raising an exception when passed out-of-bounds values for the row or column index (see RubyForge Bug #2660). This could happen, for example, if you were to click in a table area outside of the regular cells (which indirectly triggers a call to <code>makePositionVisible</code>). This was actually inconsistent with standard FOX behavior, which simply ignores out of bounds values for that method's arguments. This bug has been fixed, and the documentation for <code>makePositionVisible</code> has been updated accordingly. Thanks to Ralf Jonas for reporting this problem.</p>
677691 </li><li>
678692 <p>The binary gem for Windows was built with FOX version 1.4.21 and FXScintilla version 1.63.</p>
679693 </li></ul>
686700 </li><li>
687701 <p>There were a number of bugs in the <code>textedit.rb</code> example program (see RubyForge Bug #1979), and those bugs have been fixed. Thanks to Claude Marinier for reporting these problems.</p>
688702 </li><li>
689 <p>The API documentation for the <code>FXTreeList</code> class&#39; <code>new</code> method still showed the number of visible items (´nvis´) as its second argument (see RubyForge Bug #2171). This problem has been corrected. Thanks to Bill Atkins for reporting this problem.</p>
703 <p>The API documentation for the <code>FXTreeList</code> class’ <code>new</code> method still showed the number of visible items (´nvis´) as its second argument (see RubyForge Bug #2171). This problem has been corrected. Thanks to Bill Atkins for reporting this problem.</p>
690704 </li><li>
691705 <p>The API documentation for the <code>FXTopWindow</code> class had a number of errors (see RubyForge Bug #2269). This problem has been corrected.</p>
692706 </li><li>
719733 <ul><li>
720734 <p>Some additional problems related to calling the <code>setTableSize</code> method for an <code>FXTable</code> were discovered (see RubyForge Bug #1597). This problem has been corrected. Thanks to Joel VanderWerf for reporting this problem.</p>
721735 </li><li>
722 <p>The <code>iconlist.rb</code> example program had a "Sort" pulldown menu filled with a number of commands that didn&#39;t really do anything, including sorting the items (see RubyForge Bug #1654). This pulldown menu has been removed from that example.</p>
736 <p>The <code>iconlist.rb</code> example program had a "Sort" pulldown menu filled with a number of commands that didn't really do anything, including sorting the items (see RubyForge Bug #1654). This pulldown menu has been removed from that example.</p>
723737 </li><li>
724738 <p>The API documentation for the <code>FXDC</code> class erroneously referred to the <code>font</code> attribute as <code>textFont</code> (see RubyForge Bug #1667). This problem has been corrected. Thanks to Meinrad Recheis for reporting this problem.</p>
725739 </li><li>
729743 </li><li>
730744 <p>Some code in the <code>groupbox.rb</code> example program was calling the <code>getRootWindow</code> method, but that method has been renamed to <code>getRoot</code> (see RubyForge Bug #1692). This problem has been corrected. Thanks to Jaroslav Stika for reporting this problem.</p>
731745 </li><li>
732 <p>The <code>hasChar?</code> method for the <code>FXFont</code> class was spelled without a trailing question mark, but it seems more Ruby-like that it should, so we&#39;ve added an alias for that (see RubyForge Bug #1714). This method also now accepts a string of size 1 (i.e. a single character) as its input, as an alternative to an ordinal value. Thanks to Meinrad Recheis for these suggestions.</p>
746 <p>The <code>hasChar?</code> method for the <code>FXFont</code> class was spelled without a trailing question mark, but it seems more Ruby-like that it should, so we've added an alias for that (see RubyForge Bug #1714). This method also now accepts a string of size 1 (i.e. a single character) as its input, as an alternative to an ordinal value. Thanks to Meinrad Recheis for these suggestions.</p>
733747 </li><li>
734748 <p>The API documentation for the <code>FXImage</code> class mistakenly listed ´IMAGE_ALPHA´ as a valid image rendering hint, but this flag is no longer needed since FOX images now always contain an alpha channel (see RubyForge Bug #1715). The documentation has been corrected. Thanks to Meinrad Recheis for reporting this mistake.</p>
735749 </li><li>
742756 <ul><li>
743757 <p>The change made for FXRuby version 1.2.4 regarding garbage collection for table items corrected only one of the problems described in RubyForge Bug #1445; There was still a problem related to the "destructive" effects of the <code>setTableSize</code> method for the <code>FXTable</code> class. This problem has now been corrected as well. Thanks to David Peoples, Jamey Cribbs and Joel VanderWerf for their assistance in helping me to track down this problem.</p>
744758 </li><li>
745 <p>The <code>extractText</code> and <code>overlayText</code> methods for the <code>FXTable</code> class were implemented incorrectly and weren&#39;t listed in the API documentation. These problems have been corrected.</p>
759 <p>The <code>extractText</code> and <code>overlayText</code> methods for the <code>FXTable</code> class were implemented incorrectly and weren't listed in the API documentation. These problems have been corrected.</p>
746760 </li><li>
747761 <p>The checks for out-of-bounds indices in the <code>getColumnX</code>, <code>setColumnX</code>, <code>getRowY</code>, <code>setRowY</code> and <code>updateRange</code> methods for the <code>FXTable</code> class were incorrect. These have been fixed.</p>
748762 </li><li>
750764 </li><li>
751765 <p>A typo in one of the source files was causing the build to fail when compiled against Ruby versions 1.8.1 or earlier (see RubyForge Bug #1551). This error has been corrected. Thanks to Alex McGuire for reporting this problem.</p>
752766 </li><li>
753 <p>The <code>selectItem</code> method for the <code>FXTable</code> class was removed in FOX 1.2, so we&#39;ve added a convenience method for this that just calls the <code>selectRange</code> method under the hood (see RubyForge Bug #1562). Thanks to Joel VanderWerf for this suggestion.</p>
767 <p>The <code>selectItem</code> method for the <code>FXTable</code> class was removed in FOX 1.2, so we've added a convenience method for this that just calls the <code>selectRange</code> method under the hood (see RubyForge Bug #1562). Thanks to Joel VanderWerf for this suggestion.</p>
754768 </li><li>
755769 <p>The binary gem for Windows was built with FOX version 1.2.13 and FXScintilla version 1.62.</p>
756770 </li></ul>
757771
758772 <h2 id="label-Changes+For+Version+1.2.4+-28February+23-2C+2005-29">Changes For Version 1.2.4 (February 23, 2005)</h2>
759773 <ul><li>
760 <p>Due to a change in some of the internal Ruby C APIs, a compile-time error for FXRuby was introduced in some of the Ruby 1.8.2 preview releases (see RubyForge Bug #1039). One should not see any compile-time errors when compiling FXRuby (versions 1.2.3 or later) against the Ruby 1.8.2 final release, but I&#39;ve neverthless made a change to how those internal APIs are used, to avoid any potential problems. Thanks to the many users who pointed out this problem.</p>
774 <p>Due to a change in some of the internal Ruby C APIs, a compile-time error for FXRuby was introduced in some of the Ruby 1.8.2 preview releases (see RubyForge Bug #1039). One should not see any compile-time errors when compiling FXRuby (versions 1.2.3 or later) against the Ruby 1.8.2 final release, but I've neverthless made a change to how those internal APIs are used, to avoid any potential problems. Thanks to the many users who pointed out this problem.</p>
761775 </li><li>
762776 <p>Joel VanderWerf suggested some enhancements to the <code>image.rb</code> example program in order to improve its startup time (see RubyForge Bug #1281). Those changes have been incorporated. Thanks to Joel for this suggestion.</p>
763777 </li><li>
764 <p>One change for the <code>FXImage</code> class between FOX versions 1.0 and 1.2 is the nature of the pixel buffer that&#39;s passed to the <code>FXImage</code> constructor. Previously, this pixel buffer was expected to be a string of bytes; now it&#39;s expected to be an array of ´FXColor´ values. This modification was not implemented correctly for FXRuby versions 1.2.3 and earlier (see RubyForge Bug #1427). This bug has been corrected, and the example program (<code>image.rb</code>) and test cases have been updated as well. Thanks to Oliver Smith and others for reporting this problem.</p>
765 </li><li>
766 <p>A couple of different problems, reported by Patrick Fernie and David Peoples, exposed a flaw in how FXRuby manages the links between FOX objects and their Ruby peers when the FOX objects are destroyed (see RubyForge Bug #1445). Without going into all the gory details, let&#39;s just say that since we have no explicit control over when Ruby&#39;s garbage collector decides to "collect" those Ruby peers that point to C++ objects that have been destroyed, we need to take steps to neutralize those Ruby peer objects so that they can&#39;t cause your application to crash in the meantime; I&#39;ve implemented a fix to take care of this situation. Thanks to Patrick and David for reporting these problems.</p>
778 <p>One change for the <code>FXImage</code> class between FOX versions 1.0 and 1.2 is the nature of the pixel buffer that’s passed to the <code>FXImage</code> constructor. Previously, this pixel buffer was expected to be a string of bytes; now it’s expected to be an array of ´FXColor´ values. This modification was not implemented correctly for FXRuby versions 1.2.3 and earlier (see RubyForge Bug #1427). This bug has been corrected, and the example program (<code>image.rb</code>) and test cases have been updated as well. Thanks to Oliver Smith and others for reporting this problem.</p>
779 </li><li>
780 <p>A couple of different problems, reported by Patrick Fernie and David Peoples, exposed a flaw in how FXRuby manages the links between FOX objects and their Ruby peers when the FOX objects are destroyed (see RubyForge Bug #1445). Without going into all the gory details, let's just say that since we have no explicit control over when Ruby's garbage collector decides to "collect" those Ruby peers that point to C++ objects that have been destroyed, we need to take steps to neutralize those Ruby peer objects so that they can't cause your application to crash in the meantime; I've implemented a fix to take care of this situation. Thanks to Patrick and David for reporting these problems.</p>
767781 </li><li>
768782 <p>The API documentation for FXRuby 1.2 still contained references to the old "spellings" of the <code>fxparseAccel</code> and <code>fxparseHotKey</code> method names, which were all lowercase (i.e. <code>fxparseaccel</code> and <code>fxparsehotkey</code>). (see RubyForge Bug #1470). These errors have been corrected.</p>
769783 </li><li>
811825
812826 <h2 id="label-Changes+For+Version+1.2.2+-28October+1-2C+2004-29">Changes For Version 1.2.2 (October 1, 2004)</h2>
813827 <ul><li>
814 <p>In order to avoid versioning problems when dealing with a mix of applications based on either FXRuby 1.0 or 1.2, the feature name for FXRuby has been changed from “fox” to “fox12”. For most application developers, this means that you will need to modify the source code for applications targeted at FXRuby 1.2 to begin with the line ´require &#39;fox12&#39;´Note that no changes should be required for legacy applications targeted at FXRuby 1.0.</p>
828 <p>In order to avoid versioning problems when dealing with a mix of applications based on either FXRuby 1.0 or 1.2, the feature name for FXRuby has been changed from “fox” to “fox12”. For most application developers, this means that you will need to modify the source code for applications targeted at FXRuby 1.2 to begin with the line ´require ‘fox12’´Note that no changes should be required for legacy applications targeted at FXRuby 1.0.</p>
815829 </li><li>
816830 <p>Made a number of updates to the documentation, to reflect API changes for FXRuby 1.2.</p>
817831 </li><li>
822836 <ul><li>
823837 <p>This is the second "alpha" release of FXRuby 1.2. This release should be compatible with any FOX library version 1.2; it is not compatible with any previous FOX library versions. As this is an alpha release, users should expect a certain amount of instability, bugs, etc.</p>
824838 </li><li>
825 <p>For this release, all of the FOX 1.2 classes are available with the exception of the <code>FXBitmapView</code> class. There is a small problem with how the <code>FXBitmapView</code> class is declared in the FOX 1.2 header files, and I&#39;m trying to decide how best to resolve that problem. The goal is to have this problem resolved by the next alpha release of FXRuby.</p>
839 <p>For this release, all of the FOX 1.2 classes are available with the exception of the <code>FXBitmapView</code> class. There is a small problem with how the <code>FXBitmapView</code> class is declared in the FOX 1.2 header files, and I'm trying to decide how best to resolve that problem. The goal is to have this problem resolved by the next alpha release of FXRuby.</p>
826840 </li><li>
827841 <p>For this release, all of the RDoc-based online documentation has been brought up to date with the new APIs.</p>
828842 </li><li>
829 <p>Portions of the FXRuby User&#39;s Guide were still out of date with respect to the new APIs (see SourceForge Bug #988623). This has been fixed.</p>
843 <p>Portions of the FXRuby User's Guide were still out of date with respect to the new APIs (see SourceForge Bug #988623). This has been fixed.</p>
830844 </li><li>
831845 <p>The <code>mditest.rb</code> example program was not up to date with the new APIs. This has been fixed.</p>
832846 </li><li>
838852 </li><li>
839853 <p>There was a small typo in the table.rb example program (see SourceForge Bug #988152). This has been fixed. Thanks to Jamey Cribbs for reporting this problem and suggesting the fix.</p>
840854 </li><li>
841 <p>Due to an oversight on my part, one of the overloaded constructors for the <code>FXRegion</code> class wasn&#39;t wrapped properly (see SourceForge Bug #986181). This has been fixed. Thanks to Bil Bas for reporting this problem.</p>
855 <p>Due to an oversight on my part, one of the overloaded constructors for the <code>FXRegion</code> class wasn't wrapped properly (see SourceForge Bug #986181). This has been fixed. Thanks to Bil Bas for reporting this problem.</p>
842856 </li><li>
843857 <p>Removed some obsolete aliases for the old leading and trailing rows and columns for the <code>FXTable</code> class (see SourceForge Bug #988038). Thanks to Yuri Leikind for reporting this problem.</p>
844858 </li><li>
845859 <p>Added <code>FXTable</code> instance methods <code>horizontalGridShown=()</code> and <code>verticalGridShown=()</code> to complement the already available <code>horizontalGridShown?</code> and <code>verticalGridShown?</code> methods.</p>
846860 </li><li>
847 <p>The binary gem for the 1.2a1 release on Windows didn&#39;t have PNG or JPEG image support built-in (see SourceForge Bug #986180). This has been fixed. Thanks to Bil Bas for reporting this problem.</p>
861 <p>The binary gem for the 1.2a1 release on Windows didn't have PNG or JPEG image support built-in (see SourceForge Bug #986180). This has been fixed. Thanks to Bil Bas for reporting this problem.</p>
848862 </li><li>
849863 <p>The binary gem for Windows was built with FOX version 1.2.7 and FXScintilla version 1.61.</p>
850864 </li></ul>
851865
852866 <h2 id="label-Changes+For+Version+1.2a1+-28June+28-2C+2004-29">Changes For Version 1.2a1 (June 28, 2004)</h2>
853867 <ul><li>
854 <p>This is the first "alpha" release of FXRuby 1.2. This release should be compatible with any FOX library version 1.2; it is not compatible with any previous FOX library versions. As this is an alpha release, users should expect a certain amount of instability, bugs, etc. The intent of this first alpha release is twofold. The primary intent is allow application developers who have current projects based on FXRuby 1.0 to begin the process of updating their applications for compatibility with FXRuby 1.2. For this release, all of the classes that existed in FXRuby 1.0 have been updated for compatibility with FOX 1.2, and so developers should at least be able to begin to "port" their applications forward now. Note that there have been a number of changes for FOX 1.2 and FXRuby 1.2, both in terms of API changes and less obvious "behavioral" changes. For a detailed summary of these changes, please see "What&#39;s New in FOX 1.2" (also available as a PDF). Note that few, if any, of the new classes introduced in FOX 1.2 are available in this first alpha release of FXRuby 1.2. Support for those new classes should come along quickly in subsequent alpha releases of FXRuby 1.2. The secondary intent of this first alpha release is to introduce the new RubyGems-based packaging of FXRuby and to begin to work out the inevitable kinks in that system.</p>
868 <p>This is the first "alpha" release of FXRuby 1.2. This release should be compatible with any FOX library version 1.2; it is not compatible with any previous FOX library versions. As this is an alpha release, users should expect a certain amount of instability, bugs, etc. The intent of this first alpha release is twofold. The primary intent is allow application developers who have current projects based on FXRuby 1.0 to begin the process of updating their applications for compatibility with FXRuby 1.2. For this release, all of the classes that existed in FXRuby 1.0 have been updated for compatibility with FOX 1.2, and so developers should at least be able to begin to "port" their applications forward now. Note that there have been a number of changes for FOX 1.2 and FXRuby 1.2, both in terms of API changes and less obvious "behavioral" changes. For a detailed summary of these changes, please see "What's New in FOX 1.2" (also available as a PDF). Note that few, if any, of the new classes introduced in FOX 1.2 are available in this first alpha release of FXRuby 1.2. Support for those new classes should come along quickly in subsequent alpha releases of FXRuby 1.2. The secondary intent of this first alpha release is to introduce the new RubyGems-based packaging of FXRuby and to begin to work out the inevitable kinks in that system.</p>
855869 </li><li>
856870 <p>The binary gem for Windows was built with FOX version 1.2.4 and FXScintilla version 1.57.</p>
857871 </li></ul>
858872 </div></div>
859873
860874 <div id="footer">
861 Generated on Fri Nov 27 21:10:33 2020 by
862 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
863 0.9.24 (ruby-2.7.2).
875 Generated on Mon Jan 2 11:47:21 2023 by
876 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
877 0.9.28 (ruby-3.1.2).
864878 </div>
865879
866880 </div>
6969 <p>This section lists the names of all the attributes for this widget. As with all Ruby object “attributes”, these are actually just the names of instance methods for the class, but it is nevertheless natural to think of these as attributes (or <em>properties</em>) of the widget. Most attributes are both readable and writeable, but some are only read-only, so be sure to check the attributes listing within the main class documentation section to be sure.</p>
7070 </dd><dt><strong>Events</strong>
7171 <dd>
72 <p>This section lists the types for all of the messages that this widget might send to its message target, and the circumstances under which those messages are sent. When it&#39;s important, the message data associated with that event is also described.</p>
72 <p>This section lists the types for all of the messages that this widget might send to its message target, and the circumstances under which those messages are sent. When it’s important, the message data associated with that event is also described.</p>
7373 </dd><dt><strong>Options</strong>
7474 <dd>
75 <p>Most widgets have one or more options that affect their appearance or behavior. These options can be passed into the class&#39;s <em>new</em> method when the object is first instantiated. They can usually also be changed after the object exists via some object-specific accessor method. For example, the options for an FXButton can be get or set via the FXButton#buttonStyle accessor methods.</p>
75 <p>Most widgets have one or more options that affect their appearance or behavior. These options can be passed into the class’s <em>new</em> method when the object is first instantiated. They can usually also be changed after the object exists via some object-specific accessor method. For example, the options for an FXButton can be get or set via the FXButton#buttonStyle accessor methods.</p>
7676 </dd></dl>
7777
78 <h1 id="label-Where-27s+the+code-3F">Where&#39;s the code?</h1>
78 <h1 id="label-Where-27s+the+code-3F">Where’s the code?</h1>
7979
80 <p>One difference you may notice from documentation generated for other Ruby extensions is that there&#39;s no source code attached to the instance methods when you click on them (i.e. they will appear to be empty method definitions). That&#39;s because most of these functions are in fact implemented in C++ code (since FXRuby is itself a C++ extension to Ruby).</p>
80 <p>One difference you may notice from documentation generated for other Ruby extensions is that there’s no source code attached to the instance methods when you click on them (i.e. they will appear to be empty method definitions). That’s because most of these functions are in fact implemented in C++ code (since FXRuby is itself a C++ extension to Ruby).</p>
8181
8282 <h1 id="label-TODO">TODO</h1>
8383
9393 </div></div>
9494
9595 <div id="footer">
96 Generated on Fri Nov 27 21:10:33 2020 by
97 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
98 0.9.24 (ruby-2.7.2).
96 Generated on Mon Jan 2 11:47:21 2023 by
97 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
98 0.9.28 (ruby-3.1.2).
9999 </div>
100100
101101 </div>
6565 </li><li>
6666 <p>Latest fxruby <a href="http://badge.fury.io/rb/fxruby"><img src="https://badge.fury.io/rb/fxruby.svg" alt="Gem Version" /></a></p>
6767 </li><li>
68 <p>Status on Linux: <a href="https://travis-ci.com/larskanis/fxruby"><img src="https://travis-ci.com/larskanis/fxruby.svg?branch=1.6" alt="Build Status on Linux" /></a> on Windows: <a href="https://ci.appveyor.com/project/larskanis/fxruby/branch/1.6"><img src="https://ci.appveyor.com/api/projects/status/too7sj4gq643ts8w/branch/1.6?svg=true" alt="Build Status on Windows" /></a></p>
68 <p>CI-Status: <a href="https://github.com/larskanis/fxruby/actions/workflows/ci.yml"><img src="https://github.com/larskanis/fxruby/actions/workflows/ci.yml/badge.svg?branch=1.6" alt="Build Status" /></a> and on Windows: <a href="https://ci.appveyor.com/project/larskanis/fxruby/branch/1.6"><img src="https://ci.appveyor.com/api/projects/status/too7sj4gq643ts8w/branch/1.6?svg=true" alt="Build Status on Windows" /></a></p>
6969 </li></ul>
7070
7171 <h2 id="label-DESCRIPTION-3A">DESCRIPTION:</h2>
9595 <ul><li>
9696 <p>on Debian/Ubuntu: <code>sudo apt-get install g++ libxrandr-dev libfox-1.6-dev</code></p>
9797 </li><li>
98 <p>on Mac: <code>sudo port install rb-fxruby</code> OR <code>brew install fox &amp;&amp; brew install xquartz</code></p>
99 </li><li>
100 <p>on Windows: the binary fxruby gems already contain all required libraries</p>
101 </li><li>
98102 <p>see also detailed installation instructions in the <a href="https://github.com/lylejohnson/fxruby/wiki">Wiki</a></p>
99 </li><li>
100 <p>on Windows: the binary fxruby gems already contain all required libararies</p>
101103 </li></ul>
102104
103105 <p>Then, install the gem:</p>
105107 <p>gem install fxruby</p>
106108 </li></ul>
107109
110 <p>On Mac, before running applications, you must also run: <code>open -a /Applications/Utilities/XQuartz.app</code></p>
111
112 <p>(otherwise, you end up getting this message when running applications on Mac: <code>FXRbApp::openDisplay: unable to open display :0.0</code>)</p>
113
108114 <h2 id="label-DIRECTORIES">DIRECTORIES</h2>
109115
110116 <p>The directory structure is:</p>
126132 <p>Contains a test battery for FXRuby.</p>
127133 </li></ul>
128134
129 <p>If you&#39;re looking at a checkout of the source code from its GIT repository, you might see some additional directories of interest:</p>
135 <p>If you’re looking at a checkout of the source code from its GIT repository, you might see some additional directories of interest:</p>
130136 <ul><li>
131137 <p>fox-includes/</p>
132138
603609 </div></div>
604610
605611 <div id="footer">
606 Generated on Fri Nov 27 21:10:27 2020 by
607 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
608 0.9.24 (ruby-2.7.2).
612 Generated on Mon Jan 2 11:47:15 2023 by
613 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
614 0.9.28 (ruby-3.1.2).
609615 </div>
610616
611617 </div>
203203 </div>
204204
205205 <div id="footer">
206 Generated on Fri Nov 27 21:10:33 2020 by
207 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
208 0.9.24 (ruby-2.7.2).
206 Generated on Mon Jan 2 11:47:21 2023 by
207 <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
208 0.9.28 (ruby-3.1.2).
209209 </div>
210210
211211 </div>
1919 !with_config("fxscintilla", true)
2020 end
2121
22 # Stick at zlib-1.2.7 for compatibility to MSYS1 based RubyInstaller.
23 LIBZ_VERSION = ENV['LIBZ_VERSION'] || '1.2.7.3'
22 LIBZ_VERSION = ENV['LIBZ_VERSION'] || '1.2.11'
2423 LIBZ_SOURCE_URI = "http://zlib.net/fossils/zlib-#{LIBZ_VERSION}.tar.gz"
2524
2625 LIBPNG_VERSION = ENV['LIBPNG_VERSION'] || '1.6.37'
2928 # LIBJPEG_VERSION = ENV['LIBJPEG_VERSION'] || '9b'
3029 # LIBJPEG_SOURCE_URI = "http://www.ijg.org/files/jpegsrc.v#{LIBJPEG_VERSION}.tar.gz"
3130
32 LIBJPEG_VERSION = ENV['LIBJPEG_VERSION'] || '2.0.6'
31 LIBJPEG_VERSION = ENV['LIBJPEG_VERSION'] || '2.1.2'
3332 LIBJPEG_SOURCE_URI = "https://downloads.sourceforge.net/libjpeg-turbo/libjpeg-turbo-#{LIBJPEG_VERSION}.tar.gz"
3433
35 LIBTIFF_VERSION = ENV['LIBTIFF_VERSION'] || '4.1.0'
34 LIBTIFF_VERSION = ENV['LIBTIFF_VERSION'] || '4.3.0'
3635 LIBTIFF_SOURCE_URI = "http://download.osgeo.org/libtiff/tiff-#{LIBTIFF_VERSION}.tar.gz"
3736
3837 LIBFOX_VERSION = ENV['LIBFOX_VERSION'] || '1.6.57'
4948 self.files = files
5049 rootdir = File.expand_path('../../..', __FILE__)
5150 self.target = File.join(rootdir, "ports")
52 self.host = RbConfig::CONFIG["host"]
51 self.host = RbConfig::CONFIG["CC"].match(/(.*)-/)[1]
5352 self.patch_files = Dir[File.join(rootdir, "patches", self.name, self.version, "*.diff")].sort
5453 end
5554
5655 def port_path
57 "#{target}/#{host}"
56 "#{target}/#{RUBY_PLATFORM}"
5857 end
5958
6059 # When using rake-compiler-dock on Windows, the underlying Virtualbox shared
6867 end
6968
7069 def cook_and_activate
71 checkpoint = File.join(self.target, "#{self.name}-#{self.version}-#{self.host}.installed")
70 checkpoint = File.join(self.target, "#{self.name}-#{self.version}-#{RUBY_PLATFORM}.installed")
7271 unless File.exist?(checkpoint)
7372 chdir_for_build do
7473 self.cook
177176 "--without-xft",
178177 "--without-x",
179178 debug ? "--enable-debug" : "--enable-release",
180 "CPPFLAGS=-I#{libjpeg_recipe.path}/include -I#{libpng_recipe.path}/include -I#{libtiff_recipe.path}/include -I#{libz_recipe.path}/include -DUNICODE=1 #{debug ? "-ggdb" : ""}",
179 "CPPFLAGS=-I#{libjpeg_recipe.path}/include -I#{libpng_recipe.path}/include -I#{libtiff_recipe.path}/include -I#{libz_recipe.path}/include -DUNICODE=1 #{debug ? "-ggdb" : ""} -D__USE_MINGW_ANSI_STDIO=1 -DHAVE_VSSCANF",
181180 "LDFLAGS=-L#{libjpeg_recipe.path}/lib -L#{libpng_recipe.path}/lib -L#{libtiff_recipe.path}/lib -L#{libz_recipe.path}/lib #{debug ? "-ggdb" : ""}",
182181 ]
183182 recipe.cook_and_activate
3232 spec.summary = %q{FXRuby is the Ruby binding to the FOX GUI toolkit.}
3333 spec.homepage = "https://github.com/larskanis/fxruby"
3434 spec.license = 'LGPL-2.1'
35 spec.metadata["changelog_uri"] = "https://github.com/larskanis/fxruby/blob/1.6/History.md"
36 spec.metadata["documentation_uri"] = "https://rubydoc.info/gems/fxruby/frames"
3537
3638 spec.files = `git ls-files -z`.split("\x0").reject do |f|
3739 f=~/^fox-includes|^web/
5052 spec.required_ruby_version = [">= 2.3", "< 4"]
5153
5254 spec.add_runtime_dependency 'mini_portile2', '~> 2.1'
55
56 yardopts = File.read(".yardopts")
57 spec.rdoc_options = ["--main", "README.rdoc",
58 "--title", "FXRuby API Documentation"]
59 docfiles = yardopts.lines.map(&:strip).select{|r| r=~/^[^-]/ }
60 spec.extra_rdoc_files = `git ls-files -z #{docfiles.join(" ")}`.split("\x0")
5361 end
00 module Fox
11 def Fox.fxrubyversion
2 "1.6.44"
2 "1.6.45"
33 end
44 end
1717 end
1818 end
1919
20 ruby_plat = RUBY_PLATFORM.gsub("i386", "x86")
2021 # Temporary add this directory for DLL search, so that bundled DLLs can be found.
21 ports_dir = RbConfig::CONFIG["host"].gsub('i686-pc-mingw32') do
22 major_minor < '2.0' ? 'i586-mingw32msvc' : 'i686-w64-mingw32'
23 end
24 ports_bin = File.expand_path("../../ports/#{ports_dir}/bin", __FILE__)
22 ports_bin = File.expand_path("../../ports/#{ruby_plat}/bin", __FILE__)
2523 add_dll_path.call(ports_bin) do
2624 require "#{major_minor}/fox16_c"
2725 end
4444
4545 def assert_same_file_contents(expected, actual)
4646 expected_contents, actual_contents = nil, nil
47 File.open(expected, 'rb') { |f| expected_contents = f.read }
47 File.open(expected, 'rb') { |f| expected_contents = crlf_to_lf(f.read) }
4848 File.open(actual, 'rb') { |f| actual_contents = crlf_to_lf(f.read) }
4949 assert_equal(expected_contents, actual_contents)
5050 end