New upstream snapshot.
Kali Janitor
1 year, 3 months ago
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 | ||
0 | 5 | ## 1.6.44 / 2020-12-31 |
1 | 6 | |
2 | 7 | * Add binary gem support for ruby-3.0. #66 |
2 | 2 | * http://github.com/larskanis/fxruby |
3 | 3 | * Full API-description: http://rubydoc.info/gems/fxruby/frames or https://larskanis.github.io/fxruby/ |
4 | 4 | * 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] | |
8 | 6 | |
9 | 7 | |
10 | 8 | == DESCRIPTION: |
33 | 31 | FXRuby runs on Linux, Windows and OS-X with Ruby-2.2 or newer. Installation on Unix requires |
34 | 32 | FOX development headers and libraries installed: |
35 | 33 | * 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 | |
36 | 36 | * 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 | |
38 | 37 | |
39 | 38 | Then, install the gem: |
40 | 39 | * 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>) | |
41 | 44 | |
42 | 45 | == DIRECTORIES |
43 | 46 | The directory structure is: |
91 | 91 | |
92 | 92 | ext_task = Rake::ExtensionTask.new("fox16_c", gem_spec) do |ext| |
93 | 93 | ext.cross_compile = true |
94 | ext.cross_platform = ['x86-mingw32', 'x64-mingw32'] | |
94 | ext.cross_platform = ['x86-mingw32', 'x64-mingw-ucrt', 'x64-mingw32'] | |
95 | 95 | # Enable FXTRACE and FXASSERT for 'rake compile' |
96 | 96 | ext.config_options << "--enable-debug" |
97 | 97 | |
108 | 108 | |
109 | 109 | platform_host_map = { |
110 | 110 | 'x86-mingw32' => ['i686-w64-mingw32'], |
111 | 'x64-mingw-ucrt' => ['x86_64-w64-mingw32'], | |
111 | 112 | 'x64-mingw32' => ['x86_64-w64-mingw32'], |
112 | 113 | } |
113 | 114 | |
116 | 117 | |
117 | 118 | 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] |
118 | 119 | |
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}") } | |
120 | 121 | dlls += [ |
121 | 122 | "libfxscintilla-20.dll", |
122 | 123 | "libFOX-1.6-0.dll", |
126 | 127 | "zlib1.dll", |
127 | 128 | ] |
128 | 129 | |
129 | spec.files += dlls.map{|dll| "ports/#{host}/bin/#{dll}" } | |
130 | spec.files += dlls.map{|dll| "ports/#{gemplat}/bin/#{dll}" } | |
130 | 131 | |
131 | 132 | unless ENV['FXRUBY_MINGW_DEBUG'] |
132 | 133 | dlls.each do |dll| |
133 | task "ports/#{host}/bin/#{dll}" do |t| | |
134 | task "ports/#{gemplat}/bin/#{dll}" do |t| | |
134 | 135 | sh "#{host}-strip", t.name |
135 | 136 | end |
136 | 137 | end |
152 | 153 | sh "bundle package" |
153 | 154 | end |
154 | 155 | |
156 | desc "Build a binary gem for platform #{plat}" | |
155 | 157 | task plat => ['gem', 'prepare'] do |
156 | 158 | debug = "FXRUBY_MINGW_DEBUG=#{ENV['FXRUBY_MINGW_DEBUG'].inspect}" if ENV['FXRUBY_MINGW_DEBUG'] |
157 | 159 | RakeCompilerDock.sh <<-EOT, platform: plat |
203 | 205 | line.gsub! /rb_ensure\(VALUEFUNC\((.*)\), self, VALUEFUNC\((.*)\), self\);/, 'rb_ensure(RUBY_VALUE_METHOD_FUNC(\\1), self, RUBY_VALUE_METHOD_FUNC(\\2), self);' |
204 | 206 | 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)' |
205 | 207 | |
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 | ||
206 | 223 | line |
207 | 224 | end |
208 | 225 |
0 | image: Visual Studio 2019 | |
0 | image: Visual Studio 2022 | |
1 | 1 | |
2 | 2 | clone_depth: 1 |
3 | 3 | |
4 | 4 | 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% | |
7 | 6 | install: |
8 | 7 | - ps: | |
9 | 8 | if ($env:ruby_version -like "*head*") { |
10 | 9 | $(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 | |
12 | 11 | } |
13 | 12 | - ruby --version |
14 | 13 | - gem --version |
15 | 14 | - 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 | |
21 | 19 | - swig -version |
22 | 20 | - gem install bundler --conservative |
23 | 21 | - bundle config set force_ruby_platform true |
29 | 27 | environment: |
30 | 28 | matrix: |
31 | 29 | - ruby_version: "head-x64" |
32 | MINGW_PACKAGE_PREFIX: "mingw-w64-x86_64" | |
33 | MSYSTEM: "MINGW64" | |
34 | 30 | - ruby_version: "24" |
35 | MINGW_PACKAGE_PREFIX: "mingw-w64-i686" | |
36 | MSYSTEM: "MINGW32" |
0 | ruby-fxruby (1.6.45+git20230116.1.57f414d-0kali1) UNRELEASED; urgency=low | |
1 | ||
2 | * New upstream snapshot. | |
3 | ||
4 | -- Kali Janitor <[email protected]> Sun, 22 Jan 2023 03:45:34 -0000 | |
5 | ||
0 | 6 | ruby-fxruby (1.6.44-0kali2) kali-dev; urgency=medium |
1 | 7 | |
2 | 8 | * Fix build for ruby 3 |
113 | 113 | </div> |
114 | 114 | |
115 | 115 | <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). | |
119 | 119 | </div> |
120 | 120 | |
121 | 121 | </div> |
466 | 466 | </div> |
467 | 467 | |
468 | 468 | <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). | |
472 | 472 | </div> |
473 | 473 | |
474 | 474 | </div> |
466 | 466 | </div> |
467 | 467 | |
468 | 468 | <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). | |
472 | 472 | </div> |
473 | 473 | |
474 | 474 | </div> |
994 | 994 | </div> |
995 | 995 | |
996 | 996 | <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). | |
1000 | 1000 | </div> |
1001 | 1001 | |
1002 | 1002 | </div> |
134 | 134 | </div> |
135 | 135 | |
136 | 136 | <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). | |
140 | 140 | </div> |
141 | 141 | |
142 | 142 | </div> |
428 | 428 | </div> |
429 | 429 | |
430 | 430 | <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). | |
434 | 434 | </div> |
435 | 435 | |
436 | 436 | </div> |
341 | 341 | </div> |
342 | 342 | |
343 | 343 | <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). | |
347 | 347 | </div> |
348 | 348 | |
349 | 349 | </div> |
369 | 369 | |
370 | 370 | |
371 | 371 | <span class="summary_desc"><div class='inline'> |
372 | <p>Set this shape's draggability.</p> | |
372 | <p>Set this shape’s draggability.</p> | |
373 | 373 | </div></span> |
374 | 374 | |
375 | 375 | </li> |
1222 | 1222 | </h3><div class="docstring"> |
1223 | 1223 | <div class="discussion"> |
1224 | 1224 | |
1225 | <p>Set this shape's draggability</p> | |
1225 | <p>Set this shape’s draggability</p> | |
1226 | 1226 | |
1227 | 1227 | |
1228 | 1228 | </div> |
1944 | 1944 | </div> |
1945 | 1945 | |
1946 | 1946 | <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). | |
1950 | 1950 | </div> |
1951 | 1951 | |
1952 | 1952 | </div> |
1721 | 1721 | <span class='kw'>end</span> |
1722 | 1722 | |
1723 | 1723 | <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'>&</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'>&&</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'>&</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'>&&</span> <span class='ivar'>@currentShape</span><span class='period'>.</span><span class='id identifier rubyid_enabled?'>enabled?</span> | |
1727 | 1727 | <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> |
1728 | 1728 | <span class='kw'>end</span> |
1729 | 1729 | |
2020 | 2020 | </div> |
2021 | 2021 | |
2022 | 2022 | <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). | |
2026 | 2026 | </div> |
2027 | 2027 | |
2028 | 2028 | </div> |
516 | 516 | </div> |
517 | 517 | |
518 | 518 | <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). | |
522 | 522 | </div> |
523 | 523 | |
524 | 524 | </div> |
280 | 280 | </div> |
281 | 281 | |
282 | 282 | <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). | |
286 | 286 | </div> |
287 | 287 | |
288 | 288 | </div> |
598 | 598 | </div> |
599 | 599 | |
600 | 600 | <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). | |
604 | 604 | </div> |
605 | 605 | |
606 | 606 | </div> |
85 | 85 | <h2>Overview</h2><div class="docstring"> |
86 | 86 | <div class="discussion"> |
87 | 87 | |
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> | |
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> | |
89 | 89 | |
90 | 90 | <p>Links</p> |
91 | 91 | |
92 | 92 | <h5 id="label-"></h5> |
93 | 93 | |
94 | <p>Tk's Canvas Widget</p> | |
94 | <p>Tk’s Canvas Widget</p> | |
95 | 95 | |
96 | 96 | <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> |
97 | 97 | <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> |
98 | 98 | </code></pre> |
99 | 99 | |
100 | <p>GNOME's Canvas Widget</p> | |
100 | <p>GNOME’s Canvas Widget</p> | |
101 | 101 | |
102 | 102 | <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> |
103 | 103 | </code></pre> |
130 | 130 | </div> |
131 | 131 | |
132 | 132 | <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). | |
136 | 136 | </div> |
137 | 137 | |
138 | 138 | </div> |
539 | 539 | </div> |
540 | 540 | |
541 | 541 | <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). | |
545 | 545 | </div> |
546 | 546 | |
547 | 547 | </div> |
1325 | 1325 | </div> |
1326 | 1326 | |
1327 | 1327 | <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). | |
1331 | 1331 | </div> |
1332 | 1332 | |
1333 | 1333 | </div> |
999 | 999 | </div> |
1000 | 1000 | |
1001 | 1001 | <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). | |
1005 | 1005 | </div> |
1006 | 1006 | |
1007 | 1007 | </div> |
393 | 393 | <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> |
394 | 394 | </code></pre> |
395 | 395 | |
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> | |
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> | |
397 | 397 | |
398 | 398 | <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> |
399 | 399 | </code></pre> |
472 | 472 | <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'>></span> <span class='int'>2</span> |
473 | 473 | <span class='kw'>end</span> |
474 | 474 | <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 | |
476 | 477 | </span> <span class='comment'># private. Therefore FXRbAccelTable::markfunc() doesn't mark them as used. |
477 | 478 | </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'>'</span><span class='tstring_content'>@targets</span><span class='tstring_end'>'</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'>'</span><span class='tstring_content'>@targets</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> | |
480 | 480 | <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> |
481 | 481 | <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> |
482 | 482 | <span class='kw'>end</span></pre> |
704 | 704 | </div> |
705 | 705 | |
706 | 706 | <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). | |
710 | 710 | </div> |
711 | 711 | |
712 | 712 | </div> |
109 | 109 | |
110 | 110 | <h3 id="label-Events">Events</h3> |
111 | 111 | |
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> | |
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> | |
113 | 113 | <dl class="rdoc-list label-list"><dt><strong>Timers</strong> |
114 | 114 | <dd> |
115 | 115 | <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> |
1139 | 1139 | |
1140 | 1140 | |
1141 | 1141 | <span class="summary_desc"><div class='inline'> |
1142 | <p>Amount of time (in milliseconds) to yield to Ruby's thread scheduler [Integer].</p> | |
1142 | <p>Amount of time (in milliseconds) to yield to Ruby’s thread scheduler [Integer].</p> | |
1143 | 1143 | </div></span> |
1144 | 1144 | |
1145 | 1145 | </li> |
1301 | 1301 | |
1302 | 1302 | |
1303 | 1303 | <span class="summary_desc"><div class='inline'> |
1304 | <p>Typing speed used for the FXIconList, FXList and FXTreeList widgets' lookup features, in milliseconds.</p> | |
1304 | <p>Typing speed used for the FXIconList, FXList and FXTreeList widgets’ lookup features, in milliseconds.</p> | |
1305 | 1305 | </div></span> |
1306 | 1306 | |
1307 | 1307 | </li> |
1694 | 1694 | |
1695 | 1695 | |
1696 | 1696 | <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'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> | |
1698 | 1698 | </div></span> |
1699 | 1699 | |
1700 | 1700 | </li> |
1766 | 1766 | |
1767 | 1767 | |
1768 | 1768 | <span class="summary_desc"><div class='inline'> |
1769 | <p>Create application's windows.</p> | |
1769 | <p>Create application’s windows.</p> | |
1770 | 1770 | </div></span> |
1771 | 1771 | |
1772 | 1772 | </li> |
1790 | 1790 | |
1791 | 1791 | |
1792 | 1792 | <span class="summary_desc"><div class='inline'> |
1793 | <p>Destroy application's windows.</p> | |
1793 | <p>Destroy application’s windows.</p> | |
1794 | 1794 | </div></span> |
1795 | 1795 | |
1796 | 1796 | </li> |
1814 | 1814 | |
1815 | 1815 | |
1816 | 1816 | <span class="summary_desc"><div class='inline'> |
1817 | <p>Detach application's windows.</p> | |
1817 | <p>Detach application’s windows.</p> | |
1818 | 1818 | </div></span> |
1819 | 1819 | |
1820 | 1820 | </li> |
2248 | 2248 | |
2249 | 2249 | |
2250 | 2250 | <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'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> | |
2252 | 2252 | </div></span> |
2253 | 2253 | |
2254 | 2254 | </li> |
2272 | 2272 | |
2273 | 2273 | |
2274 | 2274 | <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'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> | |
2276 | 2276 | </div></span> |
2277 | 2277 | |
2278 | 2278 | </li> |
2392 | 2392 | |
2393 | 2393 | |
2394 | 2394 | <span class="summary_desc"><div class='inline'> |
2395 | <p>Peek to determine if there's an event.</p> | |
2395 | <p>Peek to determine if there’s an event.</p> | |
2396 | 2396 | </div></span> |
2397 | 2397 | |
2398 | 2398 | </li> |
3123 | 3123 | </h3><div class="docstring"> |
3124 | 3124 | <div class="discussion"> |
3125 | 3125 | |
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> | |
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> | |
3127 | 3127 | |
3128 | 3128 | |
3129 | 3129 | </div> |
4502 | 4502 | </h3><div class="docstring"> |
4503 | 4503 | <div class="discussion"> |
4504 | 4504 | |
4505 | <p>Amount of time (in milliseconds) to yield to Ruby's thread scheduler [Integer]</p> | |
4505 | <p>Amount of time (in milliseconds) to yield to Ruby’s thread scheduler [Integer]</p> | |
4506 | 4506 | |
4507 | 4507 | |
4508 | 4508 | </div> |
4760 | 4760 | </h3><div class="docstring"> |
4761 | 4761 | <div class="discussion"> |
4762 | 4762 | |
4763 | <p>Typing speed used for the FXIconList, FXList and FXTreeList widgets' 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> | |
4764 | 4764 | |
4765 | 4765 | |
4766 | 4766 | </div> |
5574 | 5574 | </h3><div class="docstring"> |
5575 | 5575 | <div class="discussion"> |
5576 | 5576 | |
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> | |
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> | |
5578 | 5578 | |
5579 | 5579 | <pre class="code ruby"><code class="ruby">getApp().beginWaitCursor() |
5580 | 5580 | ... time-consuming operation ... |
5718 | 5718 | </h3><div class="docstring"> |
5719 | 5719 | <div class="discussion"> |
5720 | 5720 | |
5721 | <p>Create application's windows</p> | |
5721 | <p>Create application’s windows</p> | |
5722 | 5722 | |
5723 | 5723 | |
5724 | 5724 | </div> |
5755 | 5755 | </h3><div class="docstring"> |
5756 | 5756 | <div class="discussion"> |
5757 | 5757 | |
5758 | <p>Destroy application's windows</p> | |
5758 | <p>Destroy application’s windows</p> | |
5759 | 5759 | |
5760 | 5760 | |
5761 | 5761 | </div> |
5792 | 5792 | </h3><div class="docstring"> |
5793 | 5793 | <div class="discussion"> |
5794 | 5794 | |
5795 | <p>Detach application's windows</p> | |
5795 | <p>Detach application’s windows</p> | |
5796 | 5796 | |
5797 | 5797 | |
5798 | 5798 | </div> |
6253 | 6253 | <pre class="code ruby"><code class="ruby">chore = app.addChore { ... } |
6254 | 6254 | </code></pre> |
6255 | 6255 | |
6256 | <p>but decide that you want to “cancel” that chore later (before it'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> | |
6257 | 6257 | |
6258 | 6258 | <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> |
6259 | 6259 | <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> |
6416 | 6416 | <pre class="code ruby"><code class="ruby">timeout = app.addTimeout(10*1000, ...) |
6417 | 6417 | </code></pre> |
6418 | 6418 | |
6419 | <p>but in the meantime, you decide that you want to cancel it if it hasn'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> | |
6420 | 6420 | |
6421 | 6421 | <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> |
6422 | 6422 | <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> |
6559 | 6559 | </h3><div class="docstring"> |
6560 | 6560 | <div class="discussion"> |
6561 | 6561 | |
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> | |
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> | |
6563 | 6563 | |
6564 | 6564 | |
6565 | 6565 | </div> |
6790 | 6790 | </h3><div class="docstring"> |
6791 | 6791 | <div class="discussion"> |
6792 | 6792 | |
6793 | <p>Peek to determine if there's an event.</p> | |
6793 | <p>Peek to determine if there’s an event.</p> | |
6794 | 6794 | |
6795 | 6795 | |
6796 | 6796 | </div> |
7987 | 7987 | </div> |
7988 | 7988 | |
7989 | 7989 | <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). | |
7993 | 7993 | </div> |
7994 | 7994 | |
7995 | 7995 | </div> |
137 | 137 | |
138 | 138 | |
139 | 139 | <span class="summary_desc"><div class='inline'> |
140 | <p>Start of the arc, relative to the three-o'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> | |
141 | 141 | </div></span> |
142 | 142 | |
143 | 143 | </li> |
164 | 164 | |
165 | 165 | |
166 | 166 | <span class="summary_desc"><div class='inline'> |
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> | |
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> | |
168 | 168 | </div></span> |
169 | 169 | |
170 | 170 | </li> |
301 | 301 | </h3><div class="docstring"> |
302 | 302 | <div class="discussion"> |
303 | 303 | |
304 | <p>Start of the arc, relative to the three-o'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> | |
305 | 305 | |
306 | 306 | |
307 | 307 | </div> |
344 | 344 | </h3><div class="docstring"> |
345 | 345 | <div class="discussion"> |
346 | 346 | |
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> | |
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> | |
348 | 348 | |
349 | 349 | |
350 | 350 | </div> |
551 | 551 | </div> |
552 | 552 | |
553 | 553 | <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). | |
557 | 557 | </div> |
558 | 558 | |
559 | 559 | </div> |
854 | 854 | </div> |
855 | 855 | |
856 | 856 | <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). | |
860 | 860 | </div> |
861 | 861 | |
862 | 862 | </div> |
439 | 439 | </div> |
440 | 440 | |
441 | 441 | <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). | |
445 | 445 | </div> |
446 | 446 | |
447 | 447 | </div> |
423 | 423 | </div> |
424 | 424 | |
425 | 425 | <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). | |
429 | 429 | </div> |
430 | 430 | |
431 | 431 | </div> |
1351 | 1351 | </div> |
1352 | 1352 | |
1353 | 1353 | <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). | |
1357 | 1357 | </div> |
1358 | 1358 | |
1359 | 1359 | </div> |
584 | 584 | </div> |
585 | 585 | |
586 | 586 | <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). | |
590 | 590 | </div> |
591 | 591 | |
592 | 592 | </div> |
1440 | 1440 | </div> |
1441 | 1441 | |
1442 | 1442 | <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). | |
1446 | 1446 | </div> |
1447 | 1447 | |
1448 | 1448 | </div> |
523 | 523 | </div> |
524 | 524 | |
525 | 525 | <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). | |
529 | 529 | </div> |
530 | 530 | |
531 | 531 | </div> |
250 | 250 | </div> |
251 | 251 | |
252 | 252 | <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). | |
256 | 256 | </div> |
257 | 257 | |
258 | 258 | </div> |
869 | 869 | </div> |
870 | 870 | |
871 | 871 | <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). | |
875 | 875 | </div> |
876 | 876 | |
877 | 877 | </div> |
300 | 300 | </div> |
301 | 301 | |
302 | 302 | <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). | |
306 | 306 | </div> |
307 | 307 | |
308 | 308 | </div> |
938 | 938 | </div> |
939 | 939 | |
940 | 940 | <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). | |
944 | 944 | </div> |
945 | 945 | |
946 | 946 | </div> |
331 | 331 | </h3><div class="docstring"> |
332 | 332 | <div class="discussion"> |
333 | 333 | |
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> | |
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> | |
335 | 335 | |
336 | 336 | <h4 id="label-Parameters-3A">Parameters:</h4> |
337 | 337 | <dl class="rdoc-list note-list"><dt><code>owner</code> |
461 | 461 | </div> |
462 | 462 | |
463 | 463 | <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). | |
467 | 467 | </div> |
468 | 468 | |
469 | 469 | </div> |
1508 | 1508 | </div> |
1509 | 1509 | |
1510 | 1510 | <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). | |
1514 | 1514 | </div> |
1515 | 1515 | |
1516 | 1516 | </div> |
748 | 748 | </div> |
749 | 749 | |
750 | 750 | <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). | |
754 | 754 | </div> |
755 | 755 | |
756 | 756 | </div> |
124 | 124 | <p>The following messages are sent by FXColorDialog to its target:</p> |
125 | 125 | <dl class="rdoc-list note-list"><dt><code>SEL_CHANGED</code> |
126 | 126 | <dd> |
127 | <p>sent continuously, while the color selector's color is changing</p> | |
127 | <p>sent continuously, while the color selector’s color is changing</p> | |
128 | 128 | </dd><dt><code>SEL_COMMAND</code> |
129 | 129 | <dd> |
130 | 130 | <p>sent when the new color is set</p> |
580 | 580 | </div> |
581 | 581 | |
582 | 582 | <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). | |
586 | 586 | </div> |
587 | 587 | |
588 | 588 | </div> |
312 | 312 | </div> |
313 | 313 | |
314 | 314 | <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). | |
318 | 318 | </div> |
319 | 319 | |
320 | 320 | </div> |
701 | 701 | </div> |
702 | 702 | |
703 | 703 | <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). | |
707 | 707 | </div> |
708 | 708 | |
709 | 709 | </div> |
806 | 806 | </div> |
807 | 807 | |
808 | 808 | <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). | |
812 | 812 | </div> |
813 | 813 | |
814 | 814 | </div> |
785 | 785 | </div> |
786 | 786 | |
787 | 787 | <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). | |
791 | 791 | </div> |
792 | 792 | |
793 | 793 | </div> |
111 | 111 | <h2>Overview</h2><div class="docstring"> |
112 | 112 | <div class="discussion"> |
113 | 113 | |
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> | |
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> | |
115 | 115 | |
116 | 116 | <h3 id="label-Events">Events</h3> |
117 | 117 | |
809 | 809 | </h3><div class="docstring"> |
810 | 810 | <div class="discussion"> |
811 | 811 | |
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> | |
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> | |
813 | 813 | |
814 | 814 | |
815 | 815 | </div> |
839 | 839 | </div> |
840 | 840 | |
841 | 841 | <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). | |
845 | 845 | </div> |
846 | 846 | |
847 | 847 | </div> |
759 | 759 | </div> |
760 | 760 | |
761 | 761 | <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). | |
765 | 765 | </div> |
766 | 766 | |
767 | 767 | </div> |
690 | 690 | |
691 | 691 | |
692 | 692 | <span class="summary_desc"><div class='inline'> |
693 | <p>Calls block once for each item in the list, passing the item'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> | |
694 | 694 | </div></span> |
695 | 695 | |
696 | 696 | </li> |
2105 | 2105 | </h3><div class="docstring"> |
2106 | 2106 | <div class="discussion"> |
2107 | 2107 | |
2108 | <p>Calls block once for each item in the list, passing the item'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> | |
2109 | 2109 | |
2110 | 2110 | |
2111 | 2111 | </div> |
2713 | 2713 | </h3><div class="docstring"> |
2714 | 2714 | <div class="discussion"> |
2715 | 2715 | |
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> | |
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> | |
2717 | 2717 | |
2718 | 2718 | |
2719 | 2719 | </div> |
2928 | 2928 | </div> |
2929 | 2929 | |
2930 | 2930 | <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). | |
2934 | 2934 | </div> |
2935 | 2935 | |
2936 | 2936 | </div> |
533 | 533 | </div> |
534 | 534 | |
535 | 535 | <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). | |
539 | 539 | </div> |
540 | 540 | |
541 | 541 | </div> |
101 | 101 | <h2>Overview</h2><div class="docstring"> |
102 | 102 | <div class="discussion"> |
103 | 103 | |
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> | |
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> | |
105 | 105 | |
106 | 106 | |
107 | 107 | </div> |
515 | 515 | </div> |
516 | 516 | |
517 | 517 | <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). | |
521 | 521 | </div> |
522 | 522 | |
523 | 523 | </div> |
116 | 116 | <p>The following messages are sent from FXComposite to its target:</p> |
117 | 117 | <dl class="rdoc-list note-list"><dt><code>SEL_KEYPRESS</code> |
118 | 118 | <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'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> | |
120 | 120 | </dd><dt><code>SEL_KEYRELEASE</code> |
121 | 121 | <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'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> | |
123 | 123 | </dd></dl> |
124 | 124 | |
125 | 125 | |
422 | 422 | </div> |
423 | 423 | |
424 | 424 | <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). | |
428 | 428 | </div> |
429 | 429 | |
430 | 430 | </div> |
768 | 768 | </div> |
769 | 769 | |
770 | 770 | <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). | |
774 | 774 | </div> |
775 | 775 | |
776 | 776 | </div> |
171 | 171 | <h3 id="label-Line+Cap+Styles">Line Cap Styles</h3> |
172 | 172 | <dl class="rdoc-list note-list"><dt><code>CAP_NOT_LAST</code> |
173 | 173 | <dd> |
174 | <p>Don't include last end cap</p> | |
174 | <p>Don’t include last end cap</p> | |
175 | 175 | </dd><dt><code>CAP_BUTT</code> |
176 | 176 | <dd> |
177 | 177 | <p>Butting line end caps</p> |
3203 | 3203 | </h3><div class="docstring"> |
3204 | 3204 | <div class="discussion"> |
3205 | 3205 | |
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> | |
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> | |
3207 | 3207 | |
3208 | 3208 | <h3 id="label-Parameters-3A">Parameters:</h3> |
3209 | 3209 | <dl class="rdoc-list note-list"><dt><code>x</code> |
3428 | 3428 | |
3429 | 3429 | <h3 id="label-Parameters-3A">Parameters:</h3> |
3430 | 3430 | |
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> | |
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> | |
3432 | 3432 | |
3433 | 3433 | <p>See also #fillCircle.</p> |
3434 | 3434 | |
3916 | 3916 | </h3><div class="docstring"> |
3917 | 3917 | <div class="discussion"> |
3918 | 3918 | |
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> | |
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> | |
3920 | 3920 | |
3921 | 3921 | <h4 id="label-Parameters-3A">Parameters:</h4> |
3922 | 3922 | <dl class="rdoc-list note-list"><dt><code>points</code> |
4004 | 4004 | </h3><div class="docstring"> |
4005 | 4005 | <div class="discussion"> |
4006 | 4006 | |
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> | |
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> | |
4008 | 4008 | |
4009 | 4009 | <h4 id="label-Parameters-3A">Parameters:</h4> |
4010 | 4010 | <dl class="rdoc-list note-list"><dt><code>points</code> |
4550 | 4550 | |
4551 | 4551 | <h3 id="label-Parameters-3A">Parameters:</h3> |
4552 | 4552 | |
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> | |
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> | |
4554 | 4554 | |
4555 | 4555 | <p>See also #drawCircle.</p> |
4556 | 4556 | |
5220 | 5220 | </div> |
5221 | 5221 | |
5222 | 5222 | <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). | |
5226 | 5226 | </div> |
5227 | 5227 | |
5228 | 5228 | </div> |
685 | 685 | </div> |
686 | 686 | |
687 | 687 | <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). | |
691 | 691 | </div> |
692 | 692 | |
693 | 693 | </div> |
347 | 347 | </div> |
348 | 348 | |
349 | 349 | <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). | |
353 | 353 | </div> |
354 | 354 | |
355 | 355 | </div> |
116 | 116 | <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> |
117 | 117 | </code></pre> |
118 | 118 | |
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> | |
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> | |
120 | 120 | |
121 | 121 | <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> |
122 | 122 | <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'>"</span><span class='tstring_content'>1st choice</span><span class='tstring_end'>"</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> |
124 | 124 | <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'>"</span><span class='tstring_content'>3rd choice</span><span class='tstring_end'>"</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> |
125 | 125 | </code></pre> |
126 | 126 | |
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> | |
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> | |
128 | 128 | |
129 | 129 | <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> |
130 | 130 | <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</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'>"</span></span> |
148 | 148 | <p>Causes the FXDataTarget to ask sender for value</p> |
149 | 149 | </dd><dt><code>ID_OPTION</code> |
150 | 150 | <dd> |
151 | <p><code>ID_OPTION</code>+<em>i</em> will set the value to <em>i</em>, where -10000 <= <em>i</em> <= 10000</p> | |
151 | <p><code>ID_OPTION+</code><em>i</em> will set the value to <em>i</em>, where -10000 <= <em>i</em> <= 10000</p> | |
152 | 152 | </dd></dl> |
153 | 153 | |
154 | 154 | |
239 | 239 | |
240 | 240 | |
241 | 241 | <span class="summary_desc"><div class='inline'> |
242 | <p>The data target's current value [Object].</p> | |
242 | <p>The data target’s current value [Object].</p> | |
243 | 243 | </div></span> |
244 | 244 | |
245 | 245 | </li> |
302 | 302 | |
303 | 303 | |
304 | 304 | <span class="summary_desc"><div class='inline'> |
305 | <p>Returns the stringified representation of this data target's value.</p> | |
305 | <p>Returns the stringified representation of this data target’s value.</p> | |
306 | 306 | </div></span> |
307 | 307 | |
308 | 308 | </li> |
480 | 480 | </h3><div class="docstring"> |
481 | 481 | <div class="discussion"> |
482 | 482 | |
483 | <p>The data target's current value [Object]</p> | |
483 | <p>The data target’s current value [Object]</p> | |
484 | 484 | |
485 | 485 | |
486 | 486 | </div> |
528 | 528 | </h3><div class="docstring"> |
529 | 529 | <div class="discussion"> |
530 | 530 | |
531 | <p>Returns the stringified representation of this data target's value.</p> | |
531 | <p>Returns the stringified representation of this data target’s value.</p> | |
532 | 532 | |
533 | 533 | |
534 | 534 | </div> |
562 | 562 | </div> |
563 | 563 | |
564 | 564 | <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). | |
568 | 568 | </div> |
569 | 569 | |
570 | 570 | </div> |
294 | 294 | </div> |
295 | 295 | |
296 | 296 | <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). | |
300 | 300 | </div> |
301 | 301 | |
302 | 302 | </div> |
294 | 294 | </div> |
295 | 295 | |
296 | 296 | <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). | |
300 | 300 | </div> |
301 | 301 | |
302 | 302 | </div> |
130 | 130 | <p>sent when the left mouse button goes up; the message data is an FXEvent instance.</p> |
131 | 131 | </dd><dt><code>SEL_CHANGED</code> |
132 | 132 | <dd> |
133 | <p>sent when the dial'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> | |
134 | 134 | </dd><dt><code>SEL_COMMAND</code> |
135 | 135 | <dd> |
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> | |
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> | |
137 | 137 | </dd></dl> |
138 | 138 | |
139 | 139 | <h3 id="label-Dial+style+options">Dial style options</h3> |
487 | 487 | |
488 | 488 | |
489 | 489 | <span class="summary_desc"><div class='inline'> |
490 | <p>Set the dial's range.</p> | |
490 | <p>Set the dial’s range.</p> | |
491 | 491 | </div></span> |
492 | 492 | |
493 | 493 | </li> |
1055 | 1055 | </h3><div class="docstring"> |
1056 | 1056 | <div class="discussion"> |
1057 | 1057 | |
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> | |
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> | |
1059 | 1059 | |
1060 | 1060 | |
1061 | 1061 | </div> |
1092 | 1092 | </h3><div class="docstring"> |
1093 | 1093 | <div class="discussion"> |
1094 | 1094 | |
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> | |
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> | |
1096 | 1096 | |
1097 | 1097 | |
1098 | 1098 | </div> |
1122 | 1122 | </div> |
1123 | 1123 | |
1124 | 1124 | <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). | |
1128 | 1128 | </div> |
1129 | 1129 | |
1130 | 1130 | </div> |
119 | 119 | |
120 | 120 | <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> |
121 | 121 | |
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> | |
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> | |
123 | 123 | |
124 | 124 | <h3 id="label-Message+identifiers">Message identifiers</h3> |
125 | 125 | <dl class="rdoc-list note-list"><dt><code>ID_CANCEL</code> |
402 | 402 | </div> |
403 | 403 | |
404 | 404 | <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). | |
408 | 408 | </div> |
409 | 409 | |
410 | 410 | </div> |
1052 | 1052 | </div> |
1053 | 1053 | |
1054 | 1054 | <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). | |
1058 | 1058 | </div> |
1059 | 1059 | |
1060 | 1060 | </div> |
741 | 741 | </div> |
742 | 742 | |
743 | 743 | <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). | |
747 | 747 | </div> |
748 | 748 | |
749 | 749 | </div> |
345 | 345 | |
346 | 346 | |
347 | 347 | <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'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> | |
349 | 349 | </div></span> |
350 | 350 | |
351 | 351 | </li> |
823 | 823 | </h3><div class="docstring"> |
824 | 824 | <div class="discussion"> |
825 | 825 | |
826 | <p>If <em>state</em> is <code>true</code>, the directory list will show hidden files and directories; otherwise, it won'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> | |
827 | 827 | |
828 | 828 | |
829 | 829 | </div> |
903 | 903 | </div> |
904 | 904 | |
905 | 905 | <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). | |
909 | 909 | </div> |
910 | 910 | |
911 | 911 | </div> |
978 | 978 | </div> |
979 | 979 | |
980 | 980 | <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). | |
984 | 984 | </div> |
985 | 985 | |
986 | 986 | </div> |
420 | 420 | |
421 | 421 | |
422 | 422 | <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'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> | |
424 | 424 | </div></span> |
425 | 425 | |
426 | 426 | </li> |
1128 | 1128 | </h3><div class="docstring"> |
1129 | 1129 | <div class="discussion"> |
1130 | 1130 | |
1131 | <p>If <em>state</em> is <code>true</code>, the directory list will show hidden files and directories; otherwise, it won'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> | |
1132 | 1132 | |
1133 | 1133 | |
1134 | 1134 | </div> |
1476 | 1476 | </h3><div class="docstring"> |
1477 | 1477 | <div class="discussion"> |
1478 | 1478 | |
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> | |
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> | |
1480 | 1480 | |
1481 | 1481 | |
1482 | 1482 | </div> |
1513 | 1513 | </h3><div class="docstring"> |
1514 | 1514 | <div class="discussion"> |
1515 | 1515 | |
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> | |
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> | |
1517 | 1517 | |
1518 | 1518 | |
1519 | 1519 | </div> |
1543 | 1543 | </div> |
1544 | 1544 | |
1545 | 1545 | <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). | |
1549 | 1549 | </div> |
1550 | 1550 | |
1551 | 1551 | </div> |
405 | 405 | |
406 | 406 | |
407 | 407 | <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'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> | |
409 | 409 | </div></span> |
410 | 410 | |
411 | 411 | </li> |
904 | 904 | </h3><div class="docstring"> |
905 | 905 | <div class="discussion"> |
906 | 906 | |
907 | <p>If <em>state</em> is <code>true</code>, the directory selector will show hidden files and directories; otherwise, it won'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> | |
908 | 908 | |
909 | 909 | |
910 | 910 | </div> |
984 | 984 | </div> |
985 | 985 | |
986 | 986 | <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). | |
990 | 990 | </div> |
991 | 991 | |
992 | 992 | </div> |
131 | 131 | <h3 id="label-Dock+Bar+Options">Dock Bar Options</h3> |
132 | 132 | <dl class="rdoc-list note-list"><dt><code>ALLOW_NOWHERE</code> |
133 | 133 | <dd> |
134 | <p>Don't allow docking anywhere</p> | |
134 | <p>Don’t allow docking anywhere</p> | |
135 | 135 | </dd><dt><code>ALLOW_TOP</code> |
136 | 136 | <dd> |
137 | 137 | <p>Docking at the top only</p> |
370 | 370 | |
371 | 371 | |
372 | 372 | <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's origin.</p> | |
373 | <p>Dock the bar against the given side, near the given position relative to the toolbar dock’s origin.</p> | |
374 | 374 | </div></span> |
375 | 375 | |
376 | 376 | </li> |
1051 | 1051 | </h3><div class="docstring"> |
1052 | 1052 | <div class="discussion"> |
1053 | 1053 | |
1054 | <p>Dock the bar against the given side, near the given position relative to the toolbar dock's origin.</p> | |
1054 | <p>Dock the bar against the given side, near the given position relative to the toolbar dock’s origin.</p> | |
1055 | 1055 | |
1056 | 1056 | |
1057 | 1057 | </div> |
1440 | 1440 | </div> |
1441 | 1441 | |
1442 | 1442 | <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). | |
1446 | 1446 | </div> |
1447 | 1447 | |
1448 | 1448 | </div> |
457 | 457 | </div> |
458 | 458 | |
459 | 459 | <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). | |
463 | 463 | </div> |
464 | 464 | |
465 | 465 | </div> |
305 | 305 | |
306 | 306 | |
307 | 307 | <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'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> | |
309 | 309 | </div></span> |
310 | 310 | |
311 | 311 | </li> |
501 | 501 | <h4 id="label-Parameters-3A">Parameters:</h4> |
502 | 502 | <dl class="rdoc-list note-list"><dt><code>bar</code> |
503 | 503 | <dd> |
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> | |
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> | |
505 | 505 | </dd><dt><code>barx</code> |
506 | 506 | <dd> |
507 | 507 | <p>current x-coordinate of the dockbar [Integer]</p> |
624 | 624 | </h3><div class="docstring"> |
625 | 625 | <div class="discussion"> |
626 | 626 | |
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> | |
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> | |
628 | 628 | |
629 | 629 | |
630 | 630 | </div> |
667 | 667 | </div> |
668 | 668 | |
669 | 669 | <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). | |
673 | 673 | </div> |
674 | 674 | |
675 | 675 | </div> |
595 | 595 | </div> |
596 | 596 | |
597 | 597 | <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). | |
601 | 601 | </div> |
602 | 602 | |
603 | 603 | </div> |
525 | 525 | </div> |
526 | 526 | |
527 | 527 | <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). | |
531 | 531 | </div> |
532 | 532 | |
533 | 533 | </div> |
429 | 429 | </div> |
430 | 430 | |
431 | 431 | <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). | |
435 | 435 | </div> |
436 | 436 | |
437 | 437 | </div> |
467 | 467 | </div> |
468 | 468 | |
469 | 469 | <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). | |
473 | 473 | </div> |
474 | 474 | |
475 | 475 | </div> |
735 | 735 | </div> |
736 | 736 | |
737 | 737 | <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). | |
741 | 741 | </div> |
742 | 742 | |
743 | 743 | </div> |
1725 | 1725 | </div> |
1726 | 1726 | |
1727 | 1727 | <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). | |
1731 | 1731 | </div> |
1732 | 1732 | |
1733 | 1733 | </div> |
484 | 484 | |
485 | 485 | |
486 | 486 | <span class="summary_desc"><div class='inline'> |
487 | <p>Return <code>true</code> if this extent's bounds overlap with <em>other</em> extent's bounds.</p> | |
487 | <p>Return <code>true</code> if this extent’s bounds overlap with <em>other</em> extent’s bounds.</p> | |
488 | 488 | </div></span> |
489 | 489 | |
490 | 490 | </li> |
1172 | 1172 | </h3><div class="docstring"> |
1173 | 1173 | <div class="discussion"> |
1174 | 1174 | |
1175 | <p>Return <code>true</code> if this extent's bounds overlap with <em>other</em> extent's bounds.</p> | |
1175 | <p>Return <code>true</code> if this extent’s bounds overlap with <em>other</em> extent’s bounds.</p> | |
1176 | 1176 | |
1177 | 1177 | |
1178 | 1178 | </div> |
1363 | 1363 | </div> |
1364 | 1364 | |
1365 | 1365 | <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). | |
1369 | 1369 | </div> |
1370 | 1370 | |
1371 | 1371 | </div> |
484 | 484 | |
485 | 485 | |
486 | 486 | <span class="summary_desc"><div class='inline'> |
487 | <p>Return <code>true</code> if this extent's bounds overlap with <em>other</em> extent's bounds.</p> | |
487 | <p>Return <code>true</code> if this extent’s bounds overlap with <em>other</em> extent’s bounds.</p> | |
488 | 488 | </div></span> |
489 | 489 | |
490 | 490 | </li> |
1172 | 1172 | </h3><div class="docstring"> |
1173 | 1173 | <div class="discussion"> |
1174 | 1174 | |
1175 | <p>Return <code>true</code> if this extent's bounds overlap with <em>other</em> extent's bounds.</p> | |
1175 | <p>Return <code>true</code> if this extent’s bounds overlap with <em>other</em> extent’s bounds.</p> | |
1176 | 1176 | |
1177 | 1177 | |
1178 | 1178 | </div> |
1363 | 1363 | </div> |
1364 | 1364 | |
1365 | 1365 | <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). | |
1369 | 1369 | </div> |
1370 | 1370 | |
1371 | 1371 | </div> |
839 | 839 | </div> |
840 | 840 | |
841 | 841 | <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). | |
845 | 845 | </div> |
846 | 846 | |
847 | 847 | </div> |
145 | 145 | <p>No wildcard can ever match “/” (or “",”/“ under Windows).</p> |
146 | 146 | </dd><dt><code>FILEMATCH_NOESCAPE</code> |
147 | 147 | <dd> |
148 | <p>Backslashes don't quote special chars (“" is treated as ”").</p> | |
148 | <p>Backslashes don’t quote special chars (“" is treated as ”").</p> | |
149 | 149 | </dd><dt><code>FILEMATCH_PERIOD</code> |
150 | 150 | <dd> |
151 | 151 | <p>Leading “.” is matched only explicitly (Useful to match hidden files on Unix).</p> |
744 | 744 | |
745 | 745 | |
746 | 746 | <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'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> | |
748 | 748 | </div></span> |
749 | 749 | |
750 | 750 | </li> |
792 | 792 | |
793 | 793 | |
794 | 794 | <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't.</p> | |
795 | <p>If <em>shown</em> is <code>true</code>, the file dialog will show preview images; otherwise it won’t.</p> | |
796 | 796 | </div></span> |
797 | 797 | |
798 | 798 | </li> |
2120 | 2120 | </h3><div class="docstring"> |
2121 | 2121 | <div class="discussion"> |
2122 | 2122 | |
2123 | <p>If <em>state</em> is <code>true</code>, the file dialog will show hidden files and directories; otherwise, it won'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> | |
2124 | 2124 | |
2125 | 2125 | |
2126 | 2126 | </div> |
2207 | 2207 | </h3><div class="docstring"> |
2208 | 2208 | <div class="discussion"> |
2209 | 2209 | |
2210 | <p>If <em>shown</em> is <code>true</code>, the file dialog will show preview images; otherwise it won't.</p> | |
2210 | <p>If <em>shown</em> is <code>true</code>, the file dialog will show preview images; otherwise it won’t.</p> | |
2211 | 2211 | |
2212 | 2212 | |
2213 | 2213 | </div> |
2677 | 2677 | </div> |
2678 | 2678 | |
2679 | 2679 | <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). | |
2683 | 2683 | </div> |
2684 | 2684 | |
2685 | 2685 | </div> |
1047 | 1047 | </div> |
1048 | 1048 | |
1049 | 1049 | <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). | |
1053 | 1053 | </div> |
1054 | 1054 | |
1055 | 1055 | </div> |
1130 | 1130 | </div> |
1131 | 1131 | |
1132 | 1132 | <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). | |
1136 | 1136 | </div> |
1137 | 1137 | |
1138 | 1138 | </div> |
137 | 137 | <p>Do not create associations for files</p> |
138 | 138 | </dd><dt><code>FILELIST_NO_PARENT</code> |
139 | 139 | <dd> |
140 | <p>Suppress display of '.' and '..'</p> | |
140 | <p>Suppress display of ‘.’ and ‘..’</p> | |
141 | 141 | </dd></dl> |
142 | 142 | |
143 | 143 | <h3 id="label-Message+identifiers">Message identifiers</h3> |
497 | 497 | |
498 | 498 | |
499 | 499 | <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't.</p> | |
500 | <p>If <em>shown</em> is <code>true</code>, the file list will show preview images; otherwise it won’t.</p> | |
501 | 501 | </div></span> |
502 | 502 | |
503 | 503 | </li> |
1481 | 1481 | </h3><div class="docstring"> |
1482 | 1482 | <div class="discussion"> |
1483 | 1483 | |
1484 | <p>If <em>shown</em> is <code>true</code>, the file list will show preview images; otherwise it won't.</p> | |
1484 | <p>If <em>shown</em> is <code>true</code>, the file list will show preview images; otherwise it won’t.</p> | |
1485 | 1485 | |
1486 | 1486 | |
1487 | 1487 | </div> |
2177 | 2177 | </h3><div class="docstring"> |
2178 | 2178 | <div class="discussion"> |
2179 | 2179 | |
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> | |
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> | |
2181 | 2181 | |
2182 | 2182 | |
2183 | 2183 | </div> |
2248 | 2248 | </div> |
2249 | 2249 | |
2250 | 2250 | <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). | |
2254 | 2254 | </div> |
2255 | 2255 | |
2256 | 2256 | </div> |
129 | 129 | <p>Multiple existing files</p> |
130 | 130 | </dd><dt><code>SELECTFILE_MULTIPLE_ALL</code> |
131 | 131 | <dd> |
132 | <p>Multiple existing files or directories, but not '.' and '..'</p> | |
132 | <p>Multiple existing files or directories, but not ‘.’ and ‘..’</p> | |
133 | 133 | </dd><dt><code>SELECTFILE_DIRECTORY</code> |
134 | 134 | <dd> |
135 | <p>Existing directory, including '.' or '..'</p> | |
135 | <p>Existing directory, including ‘.’ or ‘..’</p> | |
136 | 136 | </dd></dl> |
137 | 137 | |
138 | 138 | <h3 id="label-Wildcard+matching+modes">Wildcard matching modes</h3> |
141 | 141 | <p>No wildcard can ever match “/” (or “",”/“ under Windows).</p> |
142 | 142 | </dd><dt><code>FILEMATCH_NOESCAPE</code> |
143 | 143 | <dd> |
144 | <p>Backslashes don't quote special chars (“" is treated as ”").</p> | |
144 | <p>Backslashes don’t quote special chars (“" is treated as ”").</p> | |
145 | 145 | </dd><dt><code>FILEMATCH_PERIOD</code> |
146 | 146 | <dd> |
147 | 147 | <p>Leading “.” is matched only explicitly (Useful to match hidden files on Unix).</p> |
754 | 754 | |
755 | 755 | |
756 | 756 | <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'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> | |
758 | 758 | </div></span> |
759 | 759 | |
760 | 760 | </li> |
802 | 802 | |
803 | 803 | |
804 | 804 | <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't.</p> | |
805 | <p>If <em>shown</em> is <code>true</code>, the file selector will show preview images; otherwise it won’t.</p> | |
806 | 806 | </div></span> |
807 | 807 | |
808 | 808 | </li> |
1688 | 1688 | </h3><div class="docstring"> |
1689 | 1689 | <div class="discussion"> |
1690 | 1690 | |
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> | |
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> | |
1692 | 1692 | |
1693 | 1693 | |
1694 | 1694 | </div> |
1961 | 1961 | </h3><div class="docstring"> |
1962 | 1962 | <div class="discussion"> |
1963 | 1963 | |
1964 | <p>If <em>state</em> is <code>true</code>, the file selector will show hidden files and directories; otherwise, it won'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> | |
1965 | 1965 | |
1966 | 1966 | |
1967 | 1967 | </div> |
2048 | 2048 | </h3><div class="docstring"> |
2049 | 2049 | <div class="discussion"> |
2050 | 2050 | |
2051 | <p>If <em>shown</em> is <code>true</code>, the file selector will show preview images; otherwise it won't.</p> | |
2051 | <p>If <em>shown</em> is <code>true</code>, the file selector will show preview images; otherwise it won’t.</p> | |
2052 | 2052 | |
2053 | 2053 | |
2054 | 2054 | </div> |
2518 | 2518 | </div> |
2519 | 2519 | |
2520 | 2520 | <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). | |
2524 | 2524 | </div> |
2525 | 2525 | |
2526 | 2526 | </div> |
492 | 492 | </div> |
493 | 493 | |
494 | 494 | <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). | |
498 | 498 | </div> |
499 | 499 | |
500 | 500 | </div> |
1123 | 1123 | |
1124 | 1124 | |
1125 | 1125 | <span class="summary_desc"><div class='inline'> |
1126 | <p>Returns the item's text.</p> | |
1126 | <p>Returns the item’s text.</p> | |
1127 | 1127 | </div></span> |
1128 | 1128 | |
1129 | 1129 | </li> |
2777 | 2777 | </h3><div class="docstring"> |
2778 | 2778 | <div class="discussion"> |
2779 | 2779 | |
2780 | <p>Returns the item's text</p> | |
2780 | <p>Returns the item’s text</p> | |
2781 | 2781 | |
2782 | 2782 | |
2783 | 2783 | </div> |
2811 | 2811 | </div> |
2812 | 2812 | |
2813 | 2813 | <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). | |
2817 | 2817 | </div> |
2818 | 2818 | |
2819 | 2819 | </div> |
120 | 120 | <h2>Overview</h2><div class="docstring"> |
121 | 121 | <div class="discussion"> |
122 | 122 | |
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> | |
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> | |
124 | 124 | |
125 | 125 | <h3 id="label-Events">Events</h3> |
126 | 126 | |
1181 | 1181 | |
1182 | 1182 | |
1183 | 1183 | <span class="summary_desc"><div class='inline'> |
1184 | <p>Return item's closed icon.</p> | |
1184 | <p>Return item’s closed icon.</p> | |
1185 | 1185 | </div></span> |
1186 | 1186 | |
1187 | 1187 | </li> |
1205 | 1205 | |
1206 | 1206 | |
1207 | 1207 | <span class="summary_desc"><div class='inline'> |
1208 | <p>Return item's user data.</p> | |
1208 | <p>Return item’s user data.</p> | |
1209 | 1209 | </div></span> |
1210 | 1210 | |
1211 | 1211 | </li> |
1253 | 1253 | |
1254 | 1254 | |
1255 | 1255 | <span class="summary_desc"><div class='inline'> |
1256 | <p>Return item's open icon.</p> | |
1256 | <p>Return item’s open icon.</p> | |
1257 | 1257 | </div></span> |
1258 | 1258 | |
1259 | 1259 | </li> |
1277 | 1277 | |
1278 | 1278 | |
1279 | 1279 | <span class="summary_desc"><div class='inline'> |
1280 | <p>Return item's text.</p> | |
1280 | <p>Return item’s text.</p> | |
1281 | 1281 | </div></span> |
1282 | 1282 | |
1283 | 1283 | </li> |
1903 | 1903 | |
1904 | 1904 | |
1905 | 1905 | <span class="summary_desc"><div class='inline'> |
1906 | <p>Change item'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> | |
1907 | 1907 | </div></span> |
1908 | 1908 | |
1909 | 1909 | </li> |
1927 | 1927 | |
1928 | 1928 | |
1929 | 1929 | <span class="summary_desc"><div class='inline'> |
1930 | <p>Change item's user data.</p> | |
1930 | <p>Change item’s user data.</p> | |
1931 | 1931 | </div></span> |
1932 | 1932 | |
1933 | 1933 | </li> |
1951 | 1951 | |
1952 | 1952 | |
1953 | 1953 | <span class="summary_desc"><div class='inline'> |
1954 | <p>Change item'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> | |
1955 | 1955 | </div></span> |
1956 | 1956 | |
1957 | 1957 | </li> |
1975 | 1975 | |
1976 | 1976 | |
1977 | 1977 | <span class="summary_desc"><div class='inline'> |
1978 | <p>Change item's text.</p> | |
1978 | <p>Change item’s text.</p> | |
1979 | 1979 | </div></span> |
1980 | 1980 | |
1981 | 1981 | </li> |
3043 | 3043 | </h3><div class="docstring"> |
3044 | 3044 | <div class="discussion"> |
3045 | 3045 | |
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> | |
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> | |
3047 | 3047 | |
3048 | 3048 | |
3049 | 3049 | </div> |
3080 | 3080 | </h3><div class="docstring"> |
3081 | 3081 | <div class="discussion"> |
3082 | 3082 | |
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> | |
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> | |
3084 | 3084 | |
3085 | 3085 | |
3086 | 3086 | </div> |
3117 | 3117 | </h3><div class="docstring"> |
3118 | 3118 | <div class="discussion"> |
3119 | 3119 | |
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> | |
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> | |
3121 | 3121 | |
3122 | 3122 | |
3123 | 3123 | </div> |
3154 | 3154 | </h3><div class="docstring"> |
3155 | 3155 | <div class="discussion"> |
3156 | 3156 | |
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> | |
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> | |
3158 | 3158 | |
3159 | 3159 | |
3160 | 3160 | </div> |
3191 | 3191 | </h3><div class="docstring"> |
3192 | 3192 | <div class="discussion"> |
3193 | 3193 | |
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> | |
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> | |
3195 | 3195 | |
3196 | 3196 | |
3197 | 3197 | </div> |
3355 | 3355 | </h3><div class="docstring"> |
3356 | 3356 | <div class="discussion"> |
3357 | 3357 | |
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> | |
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> | |
3359 | 3359 | |
3360 | 3360 | |
3361 | 3361 | </div> |
3392 | 3392 | </h3><div class="docstring"> |
3393 | 3393 | <div class="discussion"> |
3394 | 3394 | |
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> | |
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> | |
3396 | 3396 | |
3397 | 3397 | |
3398 | 3398 | </div> |
3429 | 3429 | </h3><div class="docstring"> |
3430 | 3430 | <div class="discussion"> |
3431 | 3431 | |
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> | |
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> | |
3433 | 3433 | |
3434 | 3434 | |
3435 | 3435 | </div> |
3466 | 3466 | </h3><div class="docstring"> |
3467 | 3467 | <div class="discussion"> |
3468 | 3468 | |
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> | |
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> | |
3470 | 3470 | |
3471 | 3471 | |
3472 | 3472 | </div> |
3688 | 3688 | </h3><div class="docstring"> |
3689 | 3689 | <div class="discussion"> |
3690 | 3690 | |
3691 | <p>Return item's closed icon</p> | |
3691 | <p>Return item’s closed icon</p> | |
3692 | 3692 | |
3693 | 3693 | |
3694 | 3694 | </div> |
3725 | 3725 | </h3><div class="docstring"> |
3726 | 3726 | <div class="discussion"> |
3727 | 3727 | |
3728 | <p>Return item's user data</p> | |
3728 | <p>Return item’s user data</p> | |
3729 | 3729 | |
3730 | 3730 | |
3731 | 3731 | </div> |
3799 | 3799 | </h3><div class="docstring"> |
3800 | 3800 | <div class="discussion"> |
3801 | 3801 | |
3802 | <p>Return item's open icon</p> | |
3802 | <p>Return item’s open icon</p> | |
3803 | 3803 | |
3804 | 3804 | |
3805 | 3805 | </div> |
3836 | 3836 | </h3><div class="docstring"> |
3837 | 3837 | <div class="discussion"> |
3838 | 3838 | |
3839 | <p>Return item's text</p> | |
3839 | <p>Return item’s text</p> | |
3840 | 3840 | |
3841 | 3841 | |
3842 | 3842 | </div> |
3947 | 3947 | </h3><div class="docstring"> |
3948 | 3948 | <div class="discussion"> |
3949 | 3949 | |
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> | |
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> | |
3951 | 3951 | |
3952 | 3952 | |
3953 | 3953 | </div> |
4334 | 4334 | </h3><div class="docstring"> |
4335 | 4335 | <div class="discussion"> |
4336 | 4336 | |
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> | |
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> | |
4338 | 4338 | |
4339 | 4339 | |
4340 | 4340 | </div> |
4445 | 4445 | </h3><div class="docstring"> |
4446 | 4446 | <div class="discussion"> |
4447 | 4447 | |
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> | |
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> | |
4449 | 4449 | |
4450 | 4450 | |
4451 | 4451 | </div> |
4482 | 4482 | </h3><div class="docstring"> |
4483 | 4483 | <div class="discussion"> |
4484 | 4484 | |
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> | |
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> | |
4486 | 4486 | |
4487 | 4487 | |
4488 | 4488 | </div> |
4556 | 4556 | </h3><div class="docstring"> |
4557 | 4557 | <div class="discussion"> |
4558 | 4558 | |
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> | |
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> | |
4560 | 4560 | |
4561 | 4561 | |
4562 | 4562 | </div> |
4593 | 4593 | </h3><div class="docstring"> |
4594 | 4594 | <div class="discussion"> |
4595 | 4595 | |
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> | |
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> | |
4597 | 4597 | |
4598 | 4598 | |
4599 | 4599 | </div> |
4630 | 4630 | </h3><div class="docstring"> |
4631 | 4631 | <div class="discussion"> |
4632 | 4632 | |
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> | |
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> | |
4634 | 4634 | |
4635 | 4635 | |
4636 | 4636 | </div> |
4667 | 4667 | </h3><div class="docstring"> |
4668 | 4668 | <div class="discussion"> |
4669 | 4669 | |
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> | |
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> | |
4671 | 4671 | |
4672 | 4672 | |
4673 | 4673 | </div> |
4852 | 4852 | </h3><div class="docstring"> |
4853 | 4853 | <div class="discussion"> |
4854 | 4854 | |
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> | |
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> | |
4856 | 4856 | |
4857 | 4857 | |
4858 | 4858 | </div> |
4889 | 4889 | </h3><div class="docstring"> |
4890 | 4890 | <div class="discussion"> |
4891 | 4891 | |
4892 | <p>Change item's user data</p> | |
4892 | <p>Change item’s user data</p> | |
4893 | 4893 | |
4894 | 4894 | |
4895 | 4895 | </div> |
4926 | 4926 | </h3><div class="docstring"> |
4927 | 4927 | <div class="discussion"> |
4928 | 4928 | |
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> | |
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> | |
4930 | 4930 | |
4931 | 4931 | |
4932 | 4932 | </div> |
4963 | 4963 | </h3><div class="docstring"> |
4964 | 4964 | <div class="discussion"> |
4965 | 4965 | |
4966 | <p>Change item's text</p> | |
4966 | <p>Change item’s text</p> | |
4967 | 4967 | |
4968 | 4968 | |
4969 | 4969 | </div> |
5111 | 5111 | </h3><div class="docstring"> |
5112 | 5112 | <div class="discussion"> |
5113 | 5113 | |
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> | |
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> | |
5115 | 5115 | |
5116 | 5116 | |
5117 | 5117 | </div> |
5178 | 5178 | </div> |
5179 | 5179 | |
5180 | 5180 | <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). | |
5184 | 5184 | </div> |
5185 | 5185 | |
5186 | 5186 | </div> |
230 | 230 | <h3 id="label-Font+character+set+encoding">Font character set encoding</h3> |
231 | 231 | <dl class="rdoc-list note-list"><dt><code>FONTENCODING_DEFAULT</code> |
232 | 232 | <dd> |
233 | <p>Don't care character encoding</p> | |
233 | <p>Don’t care character encoding</p> | |
234 | 234 | </dd><dt><code>FONTENCODING_ISO_8859_1</code> |
235 | 235 | <dd> |
236 | 236 | <p>West European (Latin1)</p> |
2987 | 2987 | </div> |
2988 | 2988 | |
2989 | 2989 | <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). | |
2993 | 2993 | </div> |
2994 | 2994 | |
2995 | 2995 | </div> |
699 | 699 | </div> |
700 | 700 | |
701 | 701 | <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). | |
705 | 705 | </div> |
706 | 706 | |
707 | 707 | </div> |
409 | 409 | </div> |
410 | 410 | |
411 | 411 | <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). | |
415 | 415 | </div> |
416 | 416 | |
417 | 417 | </div> |
565 | 565 | </div> |
566 | 566 | |
567 | 567 | <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). | |
571 | 571 | </div> |
572 | 572 | |
573 | 573 | </div> |
1001 | 1001 | </div> |
1002 | 1002 | |
1003 | 1003 | <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). | |
1007 | 1007 | </div> |
1008 | 1008 | |
1009 | 1009 | </div> |
326 | 326 | </div> |
327 | 327 | |
328 | 328 | <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). | |
332 | 332 | </div> |
333 | 333 | |
334 | 334 | </div> |
439 | 439 | </div> |
440 | 440 | |
441 | 441 | <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). | |
445 | 445 | </div> |
446 | 446 | |
447 | 447 | </div> |
423 | 423 | </div> |
424 | 424 | |
425 | 425 | <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). | |
429 | 429 | </div> |
430 | 430 | |
431 | 431 | </div> |
195 | 195 | |
196 | 196 | |
197 | 197 | <span class="summary_desc"><div class='inline'> |
198 | <p>Return <code>true</code> if this canvas' context is the current context.</p> | |
198 | <p>Return <code>true</code> if this canvas’ context is the current context.</p> | |
199 | 199 | </div></span> |
200 | 200 | |
201 | 201 | </li> |
485 | 485 | </h3><div class="docstring"> |
486 | 486 | <div class="discussion"> |
487 | 487 | |
488 | <p>Return <code>true</code> if this canvas' context is the current context.</p> | |
488 | <p>Return <code>true</code> if this canvas’ context is the current context.</p> | |
489 | 489 | |
490 | 490 | |
491 | 491 | </div> |
689 | 689 | </div> |
690 | 690 | |
691 | 691 | <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). | |
695 | 695 | </div> |
696 | 696 | |
697 | 697 | </div> |
774 | 774 | </div> |
775 | 775 | |
776 | 776 | <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). | |
780 | 780 | </div> |
781 | 781 | |
782 | 782 | </div> |
638 | 638 | </div> |
639 | 639 | |
640 | 640 | <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). | |
644 | 644 | </div> |
645 | 645 | |
646 | 646 | </div> |
692 | 692 | </div> |
693 | 693 | |
694 | 694 | <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). | |
698 | 698 | </div> |
699 | 699 | |
700 | 700 | </div> |
780 | 780 | </div> |
781 | 781 | |
782 | 782 | <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). | |
786 | 786 | </div> |
787 | 787 | |
788 | 788 | </div> |
1374 | 1374 | </div> |
1375 | 1375 | |
1376 | 1376 | <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). | |
1380 | 1380 | </div> |
1381 | 1381 | |
1382 | 1382 | </div> |
642 | 642 | </div> |
643 | 643 | |
644 | 644 | <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). | |
648 | 648 | </div> |
649 | 649 | |
650 | 650 | </div> |
576 | 576 | <h4 id="label-Parameters-3A">Parameters:</h4> |
577 | 577 | <dl class="rdoc-list note-list"><dt><code>viewer</code> |
578 | 578 | <dd> |
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> | |
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> | |
580 | 580 | </dd><dt><code>fx</code> |
581 | 581 | <dd> |
582 | <p>x-coordinate for position we're dragging from [Integer]</p> | |
582 | <p>x-coordinate for position we’re dragging from [Integer]</p> | |
583 | 583 | </dd><dt><code>fy</code> |
584 | 584 | <dd> |
585 | <p>y-coordinate for position we're dragging from [Integer]</p> | |
585 | <p>y-coordinate for position we’re dragging from [Integer]</p> | |
586 | 586 | </dd><dt><code>tx</code> |
587 | 587 | <dd> |
588 | <p>x-coordinate for position we're dragging to [Integer]</p> | |
588 | <p>x-coordinate for position we’re dragging to [Integer]</p> | |
589 | 589 | </dd><dt><code>ty</code> |
590 | 590 | <dd> |
591 | <p>y-coordinate for position we're dragging to [Integer]</p> | |
591 | <p>y-coordinate for position we’re dragging to [Integer]</p> | |
592 | 592 | </dd></dl> |
593 | 593 | |
594 | 594 | |
631 | 631 | <h4 id="label-Parameters-3A">Parameters:</h4> |
632 | 632 | <dl class="rdoc-list note-list"><dt><code>viewer</code> |
633 | 633 | <dd> |
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> | |
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> | |
635 | 635 | </dd></dl> |
636 | 636 | |
637 | 637 | |
674 | 674 | <h4 id="label-Parameters-3A">Parameters:</h4> |
675 | 675 | <dl class="rdoc-list note-list"><dt><code>viewer</code> |
676 | 676 | <dd> |
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> | |
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> | |
678 | 678 | </dd></dl> |
679 | 679 | |
680 | 680 | |
748 | 748 | </div> |
749 | 749 | |
750 | 750 | <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). | |
754 | 754 | </div> |
755 | 755 | |
756 | 756 | </div> |
550 | 550 | </div> |
551 | 551 | |
552 | 552 | <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). | |
556 | 556 | </div> |
557 | 557 | |
558 | 558 | </div> |
703 | 703 | </div> |
704 | 704 | |
705 | 705 | <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). | |
709 | 709 | </div> |
710 | 710 | |
711 | 711 | </div> |
615 | 615 | </div> |
616 | 616 | |
617 | 617 | <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). | |
621 | 621 | </div> |
622 | 622 | |
623 | 623 | </div> |
3495 | 3495 | </div> |
3496 | 3496 | |
3497 | 3497 | <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). | |
3501 | 3501 | </div> |
3502 | 3502 | |
3503 | 3503 | </div> |
2136 | 2136 | </div> |
2137 | 2137 | |
2138 | 2138 | <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). | |
2142 | 2142 | </div> |
2143 | 2143 | |
2144 | 2144 | </div> |
551 | 551 | </div> |
552 | 552 | |
553 | 553 | <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). | |
557 | 557 | </div> |
558 | 558 | |
559 | 559 | </div> |
1057 | 1057 | |
1058 | 1058 | |
1059 | 1059 | <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'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> | |
1061 | 1061 | </div></span> |
1062 | 1062 | |
1063 | 1063 | </li> |
1463 | 1463 | </h3><div class="docstring"> |
1464 | 1464 | <div class="discussion"> |
1465 | 1465 | |
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> | |
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> | |
1467 | 1467 | |
1468 | 1468 | |
1469 | 1469 | </div> |
1500 | 1500 | </h3><div class="docstring"> |
1501 | 1501 | <div class="discussion"> |
1502 | 1502 | |
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> | |
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> | |
1504 | 1504 | |
1505 | 1505 | |
1506 | 1506 | </div> |
1981 | 1981 | </h3><div class="docstring"> |
1982 | 1982 | <div class="discussion"> |
1983 | 1983 | |
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> | |
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> | |
1985 | 1985 | |
1986 | 1986 | |
1987 | 1987 | </div> |
2018 | 2018 | </h3><div class="docstring"> |
2019 | 2019 | <div class="discussion"> |
2020 | 2020 | |
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> | |
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> | |
2022 | 2022 | |
2023 | 2023 | |
2024 | 2024 | </div> |
2055 | 2055 | </h3><div class="docstring"> |
2056 | 2056 | <div class="discussion"> |
2057 | 2057 | |
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> | |
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> | |
2059 | 2059 | |
2060 | 2060 | |
2061 | 2061 | </div> |
2092 | 2092 | </h3><div class="docstring"> |
2093 | 2093 | <div class="discussion"> |
2094 | 2094 | |
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> | |
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> | |
2096 | 2096 | |
2097 | 2097 | |
2098 | 2098 | </div> |
2129 | 2129 | </h3><div class="docstring"> |
2130 | 2130 | <div class="discussion"> |
2131 | 2131 | |
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> | |
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> | |
2133 | 2133 | |
2134 | 2134 | |
2135 | 2135 | </div> |
2253 | 2253 | </h3><div class="docstring"> |
2254 | 2254 | <div class="discussion"> |
2255 | 2255 | |
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> | |
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> | |
2257 | 2257 | |
2258 | 2258 | |
2259 | 2259 | </div> |
2290 | 2290 | </h3><div class="docstring"> |
2291 | 2291 | <div class="discussion"> |
2292 | 2292 | |
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> | |
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> | |
2294 | 2294 | |
2295 | 2295 | |
2296 | 2296 | </div> |
2327 | 2327 | </h3><div class="docstring"> |
2328 | 2328 | <div class="discussion"> |
2329 | 2329 | |
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> | |
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> | |
2331 | 2331 | |
2332 | 2332 | |
2333 | 2333 | </div> |
2364 | 2364 | </h3><div class="docstring"> |
2365 | 2365 | <div class="discussion"> |
2366 | 2366 | |
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> | |
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> | |
2368 | 2368 | |
2369 | 2369 | |
2370 | 2370 | </div> |
2401 | 2401 | </h3><div class="docstring"> |
2402 | 2402 | <div class="discussion"> |
2403 | 2403 | |
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> | |
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> | |
2405 | 2405 | |
2406 | 2406 | |
2407 | 2407 | </div> |
2438 | 2438 | </h3><div class="docstring"> |
2439 | 2439 | <div class="discussion"> |
2440 | 2440 | |
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> | |
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> | |
2442 | 2442 | |
2443 | 2443 | |
2444 | 2444 | </div> |
2468 | 2468 | </div> |
2469 | 2469 | |
2470 | 2470 | <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). | |
2474 | 2474 | </div> |
2475 | 2475 | |
2476 | 2476 | </div> |
328 | 328 | |
329 | 329 | |
330 | 330 | <span class="summary_desc"><div class='inline'> |
331 | <p>Return the group box's title text.</p> | |
331 | <p>Return the group box’s title text.</p> | |
332 | 332 | </div></span> |
333 | 333 | |
334 | 334 | </li> |
647 | 647 | </h3><div class="docstring"> |
648 | 648 | <div class="discussion"> |
649 | 649 | |
650 | <p>Return the group box's title text</p> | |
650 | <p>Return the group box’s title text</p> | |
651 | 651 | |
652 | 652 | |
653 | 653 | </div> |
677 | 677 | </div> |
678 | 678 | |
679 | 679 | <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). | |
683 | 683 | </div> |
684 | 684 | |
685 | 685 | </div> |
457 | 457 | |
458 | 458 | |
459 | 459 | <span class="summary_desc"><div class='inline'> |
460 | <p>Returns true if the specified header item's arrow points down.</p> | |
460 | <p>Returns true if the specified header item’s arrow points down.</p> | |
461 | 461 | </div></span> |
462 | 462 | |
463 | 463 | </li> |
505 | 505 | |
506 | 506 | |
507 | 507 | <span class="summary_desc"><div class='inline'> |
508 | <p>Returns true if the specified header item's arrow points up.</p> | |
508 | <p>Returns true if the specified header item’s arrow points up.</p> | |
509 | 509 | </div></span> |
510 | 510 | |
511 | 511 | </li> |
1179 | 1179 | |
1180 | 1180 | |
1181 | 1181 | <span class="summary_desc"><div class='inline'> |
1182 | <p>Changed button item's pressed state.</p> | |
1182 | <p>Changed button item’s pressed state.</p> | |
1183 | 1183 | </div></span> |
1184 | 1184 | |
1185 | 1185 | </li> |
1689 | 1689 | </h3><div class="docstring"> |
1690 | 1690 | <div class="discussion"> |
1691 | 1691 | |
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> | |
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> | |
1693 | 1693 | |
1694 | 1694 | |
1695 | 1695 | </div> |
1726 | 1726 | </h3><div class="docstring"> |
1727 | 1727 | <div class="discussion"> |
1728 | 1728 | |
1729 | <p>Returns true if the specified header item'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> | |
1730 | 1730 | |
1731 | 1731 | |
1732 | 1732 | </div> |
1850 | 1850 | </h3><div class="docstring"> |
1851 | 1851 | <div class="discussion"> |
1852 | 1852 | |
1853 | <p>Returns true if the specified header item'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> | |
1854 | 1854 | |
1855 | 1855 | |
1856 | 1856 | </div> |
1912 | 1912 | </h3><div class="docstring"> |
1913 | 1913 | <div class="discussion"> |
1914 | 1914 | |
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> | |
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> | |
1916 | 1916 | |
1917 | 1917 | |
1918 | 1918 | </div> |
1996 | 1996 | </h3><div class="docstring"> |
1997 | 1997 | <div class="discussion"> |
1998 | 1998 | |
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> | |
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> | |
2000 | 2000 | |
2001 | 2001 | |
2002 | 2002 | </div> |
2370 | 2370 | </h3><div class="docstring"> |
2371 | 2371 | <div class="discussion"> |
2372 | 2372 | |
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> | |
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> | |
2374 | 2374 | |
2375 | 2375 | |
2376 | 2376 | </div> |
2481 | 2481 | </h3><div class="docstring"> |
2482 | 2482 | <div class="discussion"> |
2483 | 2483 | |
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> | |
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> | |
2485 | 2485 | |
2486 | 2486 | |
2487 | 2487 | </div> |
2592 | 2592 | </h3><div class="docstring"> |
2593 | 2593 | <div class="discussion"> |
2594 | 2594 | |
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> | |
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> | |
2596 | 2596 | |
2597 | 2597 | |
2598 | 2598 | </div> |
2629 | 2629 | </h3><div class="docstring"> |
2630 | 2630 | <div class="discussion"> |
2631 | 2631 | |
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> | |
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> | |
2633 | 2633 | |
2634 | 2634 | |
2635 | 2635 | </div> |
2703 | 2703 | </h3><div class="docstring"> |
2704 | 2704 | <div class="discussion"> |
2705 | 2705 | |
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> | |
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> | |
2707 | 2707 | |
2708 | 2708 | |
2709 | 2709 | </div> |
2888 | 2888 | </h3><div class="docstring"> |
2889 | 2889 | <div class="discussion"> |
2890 | 2890 | |
2891 | <p>Changed button item'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> | |
2892 | 2892 | |
2893 | 2893 | |
2894 | 2894 | </div> |
3029 | 3029 | </div> |
3030 | 3030 | |
3031 | 3031 | <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). | |
3035 | 3035 | </div> |
3036 | 3036 | |
3037 | 3037 | </div> |
217 | 217 | |
218 | 218 | |
219 | 219 | <span class="summary_desc"><div class='inline'> |
220 | <p>Item's user data [Object].</p> | |
220 | <p>Item’s user data [Object].</p> | |
221 | 221 | </div></span> |
222 | 222 | |
223 | 223 | </li> |
244 | 244 | |
245 | 245 | |
246 | 246 | <span class="summary_desc"><div class='inline'> |
247 | <p>Item'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> | |
248 | 248 | </div></span> |
249 | 249 | |
250 | 250 | </li> |
379 | 379 | |
380 | 380 | |
381 | 381 | <span class="summary_desc"><div class='inline'> |
382 | <p>Item's text label [String].</p> | |
382 | <p>Item’s text label [String].</p> | |
383 | 383 | </div></span> |
384 | 384 | |
385 | 385 | </li> |
488 | 488 | |
489 | 489 | |
490 | 490 | <span class="summary_desc"><div class='inline'> |
491 | <p>Return the item's content height in the header.</p> | |
491 | <p>Return the item’s content height in the header.</p> | |
492 | 492 | </div></span> |
493 | 493 | |
494 | 494 | </li> |
512 | 512 | |
513 | 513 | |
514 | 514 | <span class="summary_desc"><div class='inline'> |
515 | <p>Return the item's content width in the header.</p> | |
515 | <p>Return the item’s content width in the header.</p> | |
516 | 516 | </div></span> |
517 | 517 | |
518 | 518 | </li> |
610 | 610 | |
611 | 611 | |
612 | 612 | <span class="summary_desc"><div class='inline'> |
613 | <p>Return the header item's text label.</p> | |
613 | <p>Return the header item’s text label.</p> | |
614 | 614 | </div></span> |
615 | 615 | |
616 | 616 | </li> |
734 | 734 | </h3><div class="docstring"> |
735 | 735 | <div class="discussion"> |
736 | 736 | |
737 | <p>Item's user data [Object]</p> | |
737 | <p>Item’s user data [Object]</p> | |
738 | 738 | |
739 | 739 | |
740 | 740 | </div> |
777 | 777 | </h3><div class="docstring"> |
778 | 778 | <div class="discussion"> |
779 | 779 | |
780 | <p>Item'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> | |
781 | 781 | |
782 | 782 | |
783 | 783 | </div> |
992 | 992 | </h3><div class="docstring"> |
993 | 993 | <div class="discussion"> |
994 | 994 | |
995 | <p>Item's text label [String]</p> | |
995 | <p>Item’s text label [String]</p> | |
996 | 996 | |
997 | 997 | |
998 | 998 | </div> |
1151 | 1151 | </h3><div class="docstring"> |
1152 | 1152 | <div class="discussion"> |
1153 | 1153 | |
1154 | <p>Return the item's content height in the header.</p> | |
1154 | <p>Return the item’s content height in the header.</p> | |
1155 | 1155 | |
1156 | 1156 | |
1157 | 1157 | </div> |
1188 | 1188 | </h3><div class="docstring"> |
1189 | 1189 | <div class="discussion"> |
1190 | 1190 | |
1191 | <p>Return the item's content width in the header.</p> | |
1191 | <p>Return the item’s content width in the header.</p> | |
1192 | 1192 | |
1193 | 1193 | |
1194 | 1194 | </div> |
1312 | 1312 | </h3><div class="docstring"> |
1313 | 1313 | <div class="discussion"> |
1314 | 1314 | |
1315 | <p>Return the header item's text label</p> | |
1315 | <p>Return the header item’s text label</p> | |
1316 | 1316 | |
1317 | 1317 | |
1318 | 1318 | </div> |
1342 | 1342 | </div> |
1343 | 1343 | |
1344 | 1344 | <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). | |
1348 | 1348 | </div> |
1349 | 1349 | |
1350 | 1350 | </div> |
793 | 793 | </div> |
794 | 794 | |
795 | 795 | <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). | |
799 | 799 | </div> |
800 | 800 | |
801 | 801 | </div> |
113 | 113 | <h2>Overview</h2><div class="docstring"> |
114 | 114 | <div class="discussion"> |
115 | 115 | |
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> | |
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> | |
117 | 117 | |
118 | 118 | |
119 | 119 | </div> |
348 | 348 | </div> |
349 | 349 | |
350 | 350 | <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). | |
354 | 354 | </div> |
355 | 355 | |
356 | 356 | </div> |
338 | 338 | </div> |
339 | 339 | |
340 | 340 | <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). | |
344 | 344 | </div> |
345 | 345 | |
346 | 346 | </div> |
439 | 439 | </div> |
440 | 440 | |
441 | 441 | <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). | |
445 | 445 | </div> |
446 | 446 | |
447 | 447 | </div> |
423 | 423 | </div> |
424 | 424 | |
425 | 425 | <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). | |
429 | 429 | </div> |
430 | 430 | |
431 | 431 | </div> |
373 | 373 | </div> |
374 | 374 | |
375 | 375 | <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). | |
379 | 379 | </div> |
380 | 380 | |
381 | 381 | </div> |
741 | 741 | </div> |
742 | 742 | |
743 | 743 | <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). | |
747 | 747 | </div> |
748 | 748 | |
749 | 749 | </div> |
638 | 638 | |
639 | 639 | |
640 | 640 | <span class="summary_desc"><div class='inline'> |
641 | <p>Return the icon item's text.</p> | |
641 | <p>Return the icon item’s text.</p> | |
642 | 642 | </div></span> |
643 | 643 | |
644 | 644 | </li> |
1477 | 1477 | </h3><div class="docstring"> |
1478 | 1478 | <div class="discussion"> |
1479 | 1479 | |
1480 | <p>Return the icon item's text</p> | |
1480 | <p>Return the icon item’s text</p> | |
1481 | 1481 | |
1482 | 1482 | |
1483 | 1483 | </div> |
1507 | 1507 | </div> |
1508 | 1508 | |
1509 | 1509 | <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). | |
1513 | 1513 | </div> |
1514 | 1514 | |
1515 | 1515 | </div> |
120 | 120 | <h2>Overview</h2><div class="docstring"> |
121 | 121 | <div class="discussion"> |
122 | 122 | |
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> | |
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> | |
124 | 124 | |
125 | 125 | <h3 id="label-Events">Events</h3> |
126 | 126 | |
2871 | 2871 | </h3><div class="docstring"> |
2872 | 2872 | <div class="discussion"> |
2873 | 2873 | |
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> | |
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> | |
2875 | 2875 | |
2876 | 2876 | |
2877 | 2877 | </div> |
2908 | 2908 | </h3><div class="docstring"> |
2909 | 2909 | <div class="discussion"> |
2910 | 2910 | |
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> | |
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> | |
2912 | 2912 | |
2913 | 2913 | |
2914 | 2914 | </div> |
2945 | 2945 | </h3><div class="docstring"> |
2946 | 2946 | <div class="discussion"> |
2947 | 2947 | |
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> | |
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> | |
2949 | 2949 | |
2950 | 2950 | |
2951 | 2951 | </div> |
3103 | 3103 | </h3><div class="docstring"> |
3104 | 3104 | <div class="discussion"> |
3105 | 3105 | |
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> | |
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> | |
3107 | 3107 | |
3108 | 3108 | |
3109 | 3109 | </div> |
3140 | 3140 | </h3><div class="docstring"> |
3141 | 3141 | <div class="discussion"> |
3142 | 3142 | |
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> | |
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> | |
3144 | 3144 | |
3145 | 3145 | |
3146 | 3146 | </div> |
3658 | 3658 | </h3><div class="docstring"> |
3659 | 3659 | <div class="discussion"> |
3660 | 3660 | |
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> | |
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> | |
3662 | 3662 | |
3663 | 3663 | |
3664 | 3664 | </div> |
3895 | 3895 | </h3><div class="docstring"> |
3896 | 3896 | <div class="discussion"> |
3897 | 3897 | |
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> | |
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> | |
3899 | 3899 | |
3900 | 3900 | |
3901 | 3901 | </div> |
3969 | 3969 | </h3><div class="docstring"> |
3970 | 3970 | <div class="discussion"> |
3971 | 3971 | |
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> | |
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> | |
3973 | 3973 | |
3974 | 3974 | |
3975 | 3975 | </div> |
4006 | 4006 | </h3><div class="docstring"> |
4007 | 4007 | <div class="discussion"> |
4008 | 4008 | |
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> | |
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> | |
4010 | 4010 | |
4011 | 4011 | |
4012 | 4012 | </div> |
4080 | 4080 | </h3><div class="docstring"> |
4081 | 4081 | <div class="discussion"> |
4082 | 4082 | |
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> | |
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> | |
4084 | 4084 | |
4085 | 4085 | |
4086 | 4086 | </div> |
4117 | 4117 | </h3><div class="docstring"> |
4118 | 4118 | <div class="discussion"> |
4119 | 4119 | |
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> | |
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> | |
4121 | 4121 | |
4122 | 4122 | |
4123 | 4123 | </div> |
4154 | 4154 | </h3><div class="docstring"> |
4155 | 4155 | <div class="discussion"> |
4156 | 4156 | |
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> | |
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> | |
4158 | 4158 | |
4159 | 4159 | |
4160 | 4160 | </div> |
4191 | 4191 | </h3><div class="docstring"> |
4192 | 4192 | <div class="discussion"> |
4193 | 4193 | |
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> | |
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> | |
4195 | 4195 | |
4196 | 4196 | |
4197 | 4197 | </div> |
4376 | 4376 | </h3><div class="docstring"> |
4377 | 4377 | <div class="discussion"> |
4378 | 4378 | |
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> | |
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> | |
4380 | 4380 | |
4381 | 4381 | |
4382 | 4382 | </div> |
4598 | 4598 | </h3><div class="docstring"> |
4599 | 4599 | <div class="discussion"> |
4600 | 4600 | |
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> | |
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> | |
4602 | 4602 | |
4603 | 4603 | |
4604 | 4604 | </div> |
4665 | 4665 | </div> |
4666 | 4666 | |
4667 | 4667 | <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). | |
4671 | 4671 | </div> |
4672 | 4672 | |
4673 | 4673 | </div> |
515 | 515 | </h3><div class="docstring"> |
516 | 516 | <div class="discussion"> |
517 | 517 | |
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> | |
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> | |
519 | 519 | |
520 | 520 | |
521 | 521 | </div> |
589 | 589 | </h3><div class="docstring"> |
590 | 590 | <div class="discussion"> |
591 | 591 | |
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> | |
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> | |
593 | 593 | |
594 | 594 | |
595 | 595 | </div> |
626 | 626 | </h3><div class="docstring"> |
627 | 627 | <div class="discussion"> |
628 | 628 | |
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> | |
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> | |
630 | 630 | |
631 | 631 | |
632 | 632 | </div> |
700 | 700 | </h3><div class="docstring"> |
701 | 701 | <div class="discussion"> |
702 | 702 | |
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> | |
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> | |
704 | 704 | |
705 | 705 | |
706 | 706 | </div> |
952 | 952 | </div> |
953 | 953 | |
954 | 954 | <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). | |
958 | 958 | </div> |
959 | 959 | |
960 | 960 | </div> |
701 | 701 | </div> |
702 | 702 | |
703 | 703 | <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). | |
707 | 707 | </div> |
708 | 708 | |
709 | 709 | </div> |
457 | 457 | |
458 | 458 | |
459 | 459 | <span class="summary_desc"><div class='inline'> |
460 | <p>Scan the image and return <code>false</code> if it's fully opaque.</p> | |
460 | <p>Scan the image and return <code>false</code> if it’s fully opaque.</p> | |
461 | 461 | </div></span> |
462 | 462 | |
463 | 463 | </li> |
1472 | 1472 | </h3><div class="docstring"> |
1473 | 1473 | <div class="discussion"> |
1474 | 1474 | |
1475 | <p>Scan the image and return <code>false</code> if it's fully opaque.</p> | |
1475 | <p>Scan the image and return <code>false</code> if it’s fully opaque.</p> | |
1476 | 1476 | |
1477 | 1477 | |
1478 | 1478 | </div> |
1974 | 1974 | </h3><div class="docstring"> |
1975 | 1975 | <div class="discussion"> |
1976 | 1976 | |
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> | |
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> | |
1978 | 1978 | |
1979 | 1979 | <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> |
1980 | 1980 | |
2317 | 2317 | </div> |
2318 | 2318 | |
2319 | 2319 | <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). | |
2323 | 2323 | </div> |
2324 | 2324 | |
2325 | 2325 | </div> |
478 | 478 | </div> |
479 | 479 | |
480 | 480 | <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). | |
484 | 484 | </div> |
485 | 485 | |
486 | 486 | </div> |
493 | 493 | </div> |
494 | 494 | |
495 | 495 | <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). | |
499 | 499 | </div> |
500 | 500 | |
501 | 501 | </div> |
407 | 407 | |
408 | 408 | |
409 | 409 | <span class="summary_desc"><div class='inline'> |
410 | <p>Return the input dialog's input string text.</p> | |
410 | <p>Return the input dialog’s input string text.</p> | |
411 | 411 | </div></span> |
412 | 412 | |
413 | 413 | </li> |
853 | 853 | </h3><div class="docstring"> |
854 | 854 | <div class="discussion"> |
855 | 855 | |
856 | <p>Return the input dialog's input string text</p> | |
856 | <p>Return the input dialog’s input string text</p> | |
857 | 857 | |
858 | 858 | |
859 | 859 | </div> |
883 | 883 | </div> |
884 | 884 | |
885 | 885 | <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). | |
889 | 889 | </div> |
890 | 890 | |
891 | 891 | </div> |
693 | 693 | |
694 | 694 | <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span> |
695 | 695 | <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> | |
699 | 699 | <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> |
700 | 700 | <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> |
701 | 701 | <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> |
931 | 931 | </div> |
932 | 932 | |
933 | 933 | <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). | |
937 | 937 | </div> |
938 | 938 | |
939 | 939 | </div> |
596 | 596 | </div> |
597 | 597 | |
598 | 598 | <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). | |
602 | 602 | </div> |
603 | 603 | |
604 | 604 | </div> |
580 | 580 | </div> |
581 | 581 | |
582 | 582 | <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). | |
586 | 586 | </div> |
587 | 587 | |
588 | 588 | </div> |
440 | 440 | |
441 | 441 | |
442 | 442 | <span class="summary_desc"><div class='inline'> |
443 | <p>Return the knob's current limits as a two-element array.</p> | |
443 | <p>Return the knob’s current limits as a two-element array.</p> | |
444 | 444 | </div></span> |
445 | 445 | |
446 | 446 | </li> |
490 | 490 | |
491 | 491 | |
492 | 492 | <span class="summary_desc"><div class='inline'> |
493 | <p>Change the knob'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> | |
494 | 494 | </div></span> |
495 | 495 | |
496 | 496 | </li> |
970 | 970 | </h3><div class="docstring"> |
971 | 971 | <div class="discussion"> |
972 | 972 | |
973 | <p>Return the knob's current limits as a two-element array.</p> | |
973 | <p>Return the knob’s current limits as a two-element array.</p> | |
974 | 974 | |
975 | 975 | |
976 | 976 | </div> |
1007 | 1007 | </h3><div class="docstring"> |
1008 | 1008 | <div class="discussion"> |
1009 | 1009 | |
1010 | <p>Change the knob'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> | |
1011 | 1011 | |
1012 | 1012 | |
1013 | 1013 | </div> |
1037 | 1037 | </div> |
1038 | 1038 | |
1039 | 1039 | <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). | |
1043 | 1043 | </div> |
1044 | 1044 | |
1045 | 1045 | </div> |
492 | 492 | |
493 | 493 | |
494 | 494 | <span class="summary_desc"><div class='inline'> |
495 | <p>Return the label's text.</p> | |
495 | <p>Return the label’s text.</p> | |
496 | 496 | </div></span> |
497 | 497 | |
498 | 498 | </li> |
972 | 972 | </h3><div class="docstring"> |
973 | 973 | <div class="discussion"> |
974 | 974 | |
975 | <p>Return the label's text</p> | |
975 | <p>Return the label’s text</p> | |
976 | 976 | |
977 | 977 | |
978 | 978 | </div> |
1002 | 1002 | </div> |
1003 | 1003 | |
1004 | 1004 | <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). | |
1008 | 1008 | </div> |
1009 | 1009 | |
1010 | 1010 | </div> |
909 | 909 | </div> |
910 | 910 | |
911 | 911 | <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). | |
915 | 915 | </div> |
916 | 916 | |
917 | 917 | </div> |
120 | 120 | <h2>Overview</h2><div class="docstring"> |
121 | 121 | <div class="discussion"> |
122 | 122 | |
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> | |
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> | |
124 | 124 | |
125 | 125 | <h3 id="label-Events">Events</h3> |
126 | 126 | |
598 | 598 | |
599 | 599 | |
600 | 600 | <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'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> | |
602 | 602 | </div></span> |
603 | 603 | |
604 | 604 | </li> |
1416 | 1416 | |
1417 | 1417 | |
1418 | 1418 | <span class="summary_desc"><div class='inline'> |
1419 | <p>Change item icon and mark the list'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> | |
1420 | 1420 | </div></span> |
1421 | 1421 | |
1422 | 1422 | </li> |
1440 | 1440 | |
1441 | 1441 | |
1442 | 1442 | <span class="summary_desc"><div class='inline'> |
1443 | <p>Change item text and mark the list'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> | |
1444 | 1444 | </div></span> |
1445 | 1445 | |
1446 | 1446 | </li> |
2147 | 2147 | <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'>"</span><span class='tstring_content'>pinky</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> |
2148 | 2148 | </code></pre> |
2149 | 2149 | |
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> | |
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> | |
2151 | 2151 | |
2152 | 2152 | |
2153 | 2153 | </div> |
2184 | 2184 | </h3><div class="docstring"> |
2185 | 2185 | <div class="discussion"> |
2186 | 2186 | |
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> | |
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> | |
2188 | 2188 | |
2189 | 2189 | |
2190 | 2190 | </div> |
2221 | 2221 | </h3><div class="docstring"> |
2222 | 2222 | <div class="discussion"> |
2223 | 2223 | |
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> | |
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> | |
2225 | 2225 | |
2226 | 2226 | |
2227 | 2227 | </div> |
2379 | 2379 | </h3><div class="docstring"> |
2380 | 2380 | <div class="discussion"> |
2381 | 2381 | |
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> | |
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> | |
2383 | 2383 | |
2384 | 2384 | |
2385 | 2385 | </div> |
2416 | 2416 | </h3><div class="docstring"> |
2417 | 2417 | <div class="discussion"> |
2418 | 2418 | |
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> | |
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> | |
2420 | 2420 | |
2421 | 2421 | |
2422 | 2422 | </div> |
2453 | 2453 | </h3><div class="docstring"> |
2454 | 2454 | <div class="discussion"> |
2455 | 2455 | |
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> | |
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> | |
2457 | 2457 | |
2458 | 2458 | |
2459 | 2459 | </div> |
2921 | 2921 | <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'>"</span><span class='tstring_content'>blinky</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> |
2922 | 2922 | </code></pre> |
2923 | 2923 | |
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> | |
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> | |
2925 | 2925 | |
2926 | 2926 | |
2927 | 2927 | </div> |
3168 | 3168 | </h3><div class="docstring"> |
3169 | 3169 | <div class="discussion"> |
3170 | 3170 | |
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> | |
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> | |
3172 | 3172 | |
3173 | 3173 | |
3174 | 3174 | </div> |
3242 | 3242 | </h3><div class="docstring"> |
3243 | 3243 | <div class="discussion"> |
3244 | 3244 | |
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> | |
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> | |
3246 | 3246 | |
3247 | 3247 | |
3248 | 3248 | </div> |
3284 | 3284 | <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'>"</span><span class='tstring_content'>clyde</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> |
3285 | 3285 | </code></pre> |
3286 | 3286 | |
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> | |
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> | |
3288 | 3288 | |
3289 | 3289 | |
3290 | 3290 | </div> |
3321 | 3321 | </h3><div class="docstring"> |
3322 | 3322 | <div class="discussion"> |
3323 | 3323 | |
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> | |
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> | |
3325 | 3325 | |
3326 | 3326 | |
3327 | 3327 | </div> |
3358 | 3358 | </h3><div class="docstring"> |
3359 | 3359 | <div class="discussion"> |
3360 | 3360 | |
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> | |
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> | |
3362 | 3362 | |
3363 | 3363 | |
3364 | 3364 | </div> |
3395 | 3395 | </h3><div class="docstring"> |
3396 | 3396 | <div class="discussion"> |
3397 | 3397 | |
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> | |
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> | |
3399 | 3399 | |
3400 | 3400 | |
3401 | 3401 | </div> |
3437 | 3437 | <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'>"</span><span class='tstring_content'>inky</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> |
3438 | 3438 | </code></pre> |
3439 | 3439 | |
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> | |
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> | |
3441 | 3441 | |
3442 | 3442 | |
3443 | 3443 | </div> |
3516 | 3516 | </h3><div class="docstring"> |
3517 | 3517 | <div class="discussion"> |
3518 | 3518 | |
3519 | <p>Change item icon and mark the list'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> | |
3520 | 3520 | |
3521 | 3521 | <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> |
3522 | 3522 | <span class='id identifier rubyid_recalc'>recalc</span> |
3559 | 3559 | </h3><div class="docstring"> |
3560 | 3560 | <div class="discussion"> |
3561 | 3561 | |
3562 | <p>Change item text and mark the list'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> | |
3563 | 3563 | |
3564 | 3564 | <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> |
3565 | 3565 | <span class='id identifier rubyid_recalc'>recalc</span> |
3639 | 3639 | </h3><div class="docstring"> |
3640 | 3640 | <div class="discussion"> |
3641 | 3641 | |
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> | |
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> | |
3643 | 3643 | |
3644 | 3644 | |
3645 | 3645 | </div> |
3706 | 3706 | </div> |
3707 | 3707 | |
3708 | 3708 | <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). | |
3712 | 3712 | </div> |
3713 | 3713 | |
3714 | 3714 | </div> |
210 | 210 | |
211 | 211 | |
212 | 212 | <span class="summary_desc"><div class='inline'> |
213 | <p>Current item's index, or -1 if no current item [Integer].</p> | |
213 | <p>Current item’s index, or -1 if no current item [Integer].</p> | |
214 | 214 | </div></span> |
215 | 215 | |
216 | 216 | </li> |
535 | 535 | |
536 | 536 | |
537 | 537 | <span class="summary_desc"><div class='inline'> |
538 | <p>Calls block once for each item in the list, passing the item'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> | |
539 | 539 | </div></span> |
540 | 540 | |
541 | 541 | </li> |
1227 | 1227 | </h3><div class="docstring"> |
1228 | 1228 | <div class="discussion"> |
1229 | 1229 | |
1230 | <p>Current item's index, or -1 if no current item [Integer]</p> | |
1230 | <p>Current item’s index, or -1 if no current item [Integer]</p> | |
1231 | 1231 | |
1232 | 1232 | |
1233 | 1233 | </div> |
1697 | 1697 | </h3><div class="docstring"> |
1698 | 1698 | <div class="discussion"> |
1699 | 1699 | |
1700 | <p>Calls block once for each item in the list, passing the item'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> | |
1701 | 1701 | |
1702 | 1702 | |
1703 | 1703 | </div> |
2507 | 2507 | </div> |
2508 | 2508 | |
2509 | 2509 | <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). | |
2513 | 2513 | </div> |
2514 | 2514 | |
2515 | 2515 | </div> |
616 | 616 | |
617 | 617 | |
618 | 618 | <span class="summary_desc"><div class='inline'> |
619 | <p>Return the list item's text.</p> | |
619 | <p>Return the list item’s text.</p> | |
620 | 620 | </div></span> |
621 | 621 | |
622 | 622 | </li> |
1418 | 1418 | </h3><div class="docstring"> |
1419 | 1419 | <div class="discussion"> |
1420 | 1420 | |
1421 | <p>Return the list item's text</p> | |
1421 | <p>Return the list item’s text</p> | |
1422 | 1422 | |
1423 | 1423 | |
1424 | 1424 | </div> |
1448 | 1448 | </div> |
1449 | 1449 | |
1450 | 1450 | <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). | |
1454 | 1454 | </div> |
1455 | 1455 | |
1456 | 1456 | </div> |
111 | 111 | <h2>Overview</h2><div class="docstring"> |
112 | 112 | <div class="discussion"> |
113 | 113 | |
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> | |
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> | |
115 | 115 | |
116 | 116 | <h3 id="label-Events">Events</h3> |
117 | 117 | |
136 | 136 | <p>sent when the right mouse button goes up; the message data is an FXEvent instance.</p> |
137 | 137 | </dd><dt><code>SEL_SELECTED</code> |
138 | 138 | <dd> |
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> | |
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> | |
140 | 140 | </dd><dt><code>SEL_DESELECTED</code> |
141 | 141 | <dd> |
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> | |
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> | |
143 | 143 | </dd><dt><code>SEL_MAXIMIZE</code> |
144 | 144 | <dd> |
145 | 145 | <p>sent when the window is maximized</p> |
2164 | 2164 | </div> |
2165 | 2165 | |
2166 | 2166 | <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). | |
2170 | 2170 | </div> |
2171 | 2171 | |
2172 | 2172 | </div> |
111 | 111 | <h2>Overview</h2><div class="docstring"> |
112 | 112 | <div class="discussion"> |
113 | 113 | |
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> | |
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> | |
115 | 115 | |
116 | 116 | <h3 id="label-Events">Events</h3> |
117 | 117 | |
770 | 770 | </div> |
771 | 771 | |
772 | 772 | <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). | |
776 | 776 | </div> |
777 | 777 | |
778 | 778 | </div> |
323 | 323 | </div> |
324 | 324 | |
325 | 325 | <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). | |
329 | 329 | </div> |
330 | 330 | |
331 | 331 | </div> |
323 | 323 | </div> |
324 | 324 | |
325 | 325 | <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). | |
329 | 329 | </div> |
330 | 330 | |
331 | 331 | </div> |
324 | 324 | </div> |
325 | 325 | |
326 | 326 | <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). | |
330 | 330 | </div> |
331 | 331 | |
332 | 332 | </div> |
323 | 323 | </div> |
324 | 324 | |
325 | 325 | <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). | |
329 | 329 | </div> |
330 | 330 | |
331 | 331 | </div> |
323 | 323 | </div> |
324 | 324 | |
325 | 325 | <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). | |
329 | 329 | </div> |
330 | 330 | |
331 | 331 | </div> |
323 | 323 | </div> |
324 | 324 | |
325 | 325 | <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). | |
329 | 329 | </div> |
330 | 330 | |
331 | 331 | </div> |
326 | 326 | </div> |
327 | 327 | |
328 | 328 | <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). | |
332 | 332 | </div> |
333 | 333 | |
334 | 334 | </div> |
559 | 559 | </div> |
560 | 560 | |
561 | 561 | <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). | |
565 | 565 | </div> |
566 | 566 | |
567 | 567 | </div> |
723 | 723 | </div> |
724 | 724 | |
725 | 725 | <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). | |
729 | 729 | </div> |
730 | 730 | |
731 | 731 | </div> |
461 | 461 | </div> |
462 | 462 | |
463 | 463 | <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). | |
467 | 467 | </div> |
468 | 468 | |
469 | 469 | </div> |
621 | 621 | </div> |
622 | 622 | |
623 | 623 | <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). | |
627 | 627 | </div> |
628 | 628 | |
629 | 629 | </div> |
336 | 336 | </div> |
337 | 337 | |
338 | 338 | <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). | |
342 | 342 | </div> |
343 | 343 | |
344 | 344 | </div> |
113 | 113 | <h2>Overview</h2><div class="docstring"> |
114 | 114 | <div class="discussion"> |
115 | 115 | |
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> | |
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> | |
117 | 117 | |
118 | 118 | <h3 id="label-Events">Events</h3> |
119 | 119 | |
151 | 151 | |
152 | 152 | <h3 id="label-Menu+Button+Popup+Style">Menu Button Popup Style</h3> |
153 | 153 | |
154 | <p>Any one of the following options can be assigned as the menu button's popup style.</p> | |
154 | <p>Any one of the following options can be assigned as the menu button’s popup style.</p> | |
155 | 155 | <dl class="rdoc-list note-list"><dt><code>MENUBUTTON_DOWN</code> |
156 | 156 | <dd> |
157 | 157 | <p>Popup window appears below menu button</p> |
168 | 168 | |
169 | 169 | <h3 id="label-Menu+Button+Attachment">Menu Button Attachment</h3> |
170 | 170 | |
171 | <p>Any combination of the following flags can be assigned as the menu button's attachment flags.</p> | |
171 | <p>Any combination of the following flags can be assigned as the menu button’s attachment flags.</p> | |
172 | 172 | <dl class="rdoc-list note-list"><dt><code>MENUBUTTON_ATTACH_LEFT</code> |
173 | 173 | <dd> |
174 | 174 | <p>Popup attaches to the left side of the menu button</p> |
818 | 818 | </div> |
819 | 819 | |
820 | 820 | <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). | |
824 | 824 | </div> |
825 | 825 | |
826 | 826 | </div> |
479 | 479 | |
480 | 480 | |
481 | 481 | <span class="summary_desc"><div class='inline'> |
482 | <p>Return the menu caption's text.</p> | |
482 | <p>Return the menu caption’s text.</p> | |
483 | 483 | </div></span> |
484 | 484 | |
485 | 485 | </li> |
1039 | 1039 | </h3><div class="docstring"> |
1040 | 1040 | <div class="discussion"> |
1041 | 1041 | |
1042 | <p>Return the menu caption's text</p> | |
1042 | <p>Return the menu caption’s text</p> | |
1043 | 1043 | |
1044 | 1044 | |
1045 | 1045 | </div> |
1069 | 1069 | </div> |
1070 | 1070 | |
1071 | 1071 | <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). | |
1075 | 1075 | </div> |
1076 | 1076 | |
1077 | 1077 | </div> |
377 | 377 | </div> |
378 | 378 | |
379 | 379 | <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). | |
383 | 383 | </div> |
384 | 384 | |
385 | 385 | </div> |
710 | 710 | </div> |
711 | 711 | |
712 | 712 | <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). | |
716 | 716 | </div> |
717 | 717 | |
718 | 718 | </div> |
389 | 389 | </div> |
390 | 390 | |
391 | 391 | <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). | |
395 | 395 | </div> |
396 | 396 | |
397 | 397 | </div> |
322 | 322 | </div> |
323 | 323 | |
324 | 324 | <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). | |
328 | 328 | </div> |
329 | 329 | |
330 | 330 | </div> |
710 | 710 | </div> |
711 | 711 | |
712 | 712 | <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). | |
716 | 716 | </div> |
717 | 717 | |
718 | 718 | </div> |
429 | 429 | </div> |
430 | 430 | |
431 | 431 | <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). | |
435 | 435 | </div> |
436 | 436 | |
437 | 437 | </div> |
394 | 394 | </div> |
395 | 395 | |
396 | 396 | <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). | |
400 | 400 | </div> |
401 | 401 | |
402 | 402 | </div> |
143 | 143 | <p>Message box has <strong>Skip</strong>, *Skip All* and <strong>Cancel</strong> buttons</p> |
144 | 144 | </dd><dt><code>MBOX_SAVE_CANCEL_DONTSAVE</code> |
145 | 145 | <dd> |
146 | <p>Message box has *Don'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> | |
147 | 147 | </dd></dl> |
148 | 148 | |
149 | 149 | <h3 id="label-Return+values">Return values</h3> |
173 | 173 | <p>The *Skip All* button was clicked</p> |
174 | 174 | </dd><dt><code>MBOX_CLICKED_DONTSAVE</code> |
175 | 175 | <dd> |
176 | <p>The *Don'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> | |
177 | 177 | </dd></dl> |
178 | 178 | |
179 | 179 | |
647 | 647 | </div> |
648 | 648 | |
649 | 649 | <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). | |
653 | 653 | </div> |
654 | 654 | |
655 | 655 | </div> |
103 | 103 | <h2>Overview</h2><div class="docstring"> |
104 | 104 | <div class="discussion"> |
105 | 105 | |
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> | |
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> | |
107 | 107 | |
108 | 108 | |
109 | 109 | </div> |
534 | 534 | </div> |
535 | 535 | |
536 | 536 | <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). | |
540 | 540 | </div> |
541 | 541 | |
542 | 542 | </div> |
480 | 480 | </div> |
481 | 481 | |
482 | 482 | <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). | |
486 | 486 | </div> |
487 | 487 | |
488 | 488 | </div> |
874 | 874 | </div> |
875 | 875 | |
876 | 876 | <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). | |
880 | 880 | </div> |
881 | 881 | |
882 | 882 | </div> |
439 | 439 | </div> |
440 | 440 | |
441 | 441 | <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). | |
445 | 445 | </div> |
446 | 446 | |
447 | 447 | </div> |
423 | 423 | </div> |
424 | 424 | |
425 | 425 | <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). | |
429 | 429 | </div> |
430 | 430 | |
431 | 431 | </div> |
513 | 513 | </div> |
514 | 514 | |
515 | 515 | <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). | |
519 | 519 | </div> |
520 | 520 | |
521 | 521 | </div> |
497 | 497 | </div> |
498 | 498 | |
499 | 499 | <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). | |
503 | 503 | </div> |
504 | 504 | |
505 | 505 | </div> |
439 | 439 | </div> |
440 | 440 | |
441 | 441 | <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). | |
445 | 445 | </div> |
446 | 446 | |
447 | 447 | </div> |
362 | 362 | </div> |
363 | 363 | |
364 | 364 | <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). | |
368 | 368 | </div> |
369 | 369 | |
370 | 370 | </div> |
489 | 489 | </div> |
490 | 490 | |
491 | 491 | <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). | |
495 | 495 | </div> |
496 | 496 | |
497 | 497 | </div> |
1218 | 1218 | </div> |
1219 | 1219 | |
1220 | 1220 | <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). | |
1224 | 1224 | </div> |
1225 | 1225 | |
1226 | 1226 | </div> |
334 | 334 | </div> |
335 | 335 | |
336 | 336 | <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). | |
340 | 340 | </div> |
341 | 341 | |
342 | 342 | </div> |
1088 | 1088 | </div> |
1089 | 1089 | |
1090 | 1090 | <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). | |
1094 | 1094 | </div> |
1095 | 1095 | |
1096 | 1096 | </div> |
474 | 474 | </div> |
475 | 475 | |
476 | 476 | <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). | |
480 | 480 | </div> |
481 | 481 | |
482 | 482 | </div> |
1319 | 1319 | </div> |
1320 | 1320 | |
1321 | 1321 | <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). | |
1325 | 1325 | </div> |
1326 | 1326 | |
1327 | 1327 | </div> |
1139 | 1139 | </div> |
1140 | 1140 | |
1141 | 1141 | <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). | |
1145 | 1145 | </div> |
1146 | 1146 | |
1147 | 1147 | </div> |
704 | 704 | </div> |
705 | 705 | |
706 | 706 | <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). | |
710 | 710 | </div> |
711 | 711 | |
712 | 712 | </div> |
417 | 417 | </div> |
418 | 418 | |
419 | 419 | <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). | |
423 | 423 | </div> |
424 | 424 | |
425 | 425 | </div> |
789 | 789 | </div> |
790 | 790 | |
791 | 791 | <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). | |
795 | 795 | </div> |
796 | 796 | |
797 | 797 | </div> |
461 | 461 | </div> |
462 | 462 | |
463 | 463 | <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). | |
467 | 467 | </div> |
468 | 468 | |
469 | 469 | </div> |
1366 | 1366 | </div> |
1367 | 1367 | |
1368 | 1368 | <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). | |
1372 | 1372 | </div> |
1373 | 1373 | |
1374 | 1374 | </div> |
1381 | 1381 | </div> |
1382 | 1382 | |
1383 | 1383 | <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). | |
1387 | 1387 | </div> |
1388 | 1388 | |
1389 | 1389 | </div> |
439 | 439 | </div> |
440 | 440 | |
441 | 441 | <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). | |
445 | 445 | </div> |
446 | 446 | |
447 | 447 | </div> |
423 | 423 | </div> |
424 | 424 | |
425 | 425 | <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). | |
429 | 429 | </div> |
430 | 430 | |
431 | 431 | </div> |
874 | 874 | </div> |
875 | 875 | |
876 | 876 | <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). | |
880 | 880 | </div> |
881 | 881 | |
882 | 882 | </div> |
1511 | 1511 | </div> |
1512 | 1512 | |
1513 | 1513 | <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). | |
1517 | 1517 | </div> |
1518 | 1518 | |
1519 | 1519 | </div> |
1511 | 1511 | </div> |
1512 | 1512 | |
1513 | 1513 | <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). | |
1517 | 1517 | </div> |
1518 | 1518 | |
1519 | 1519 | </div> |
1176 | 1176 | </div> |
1177 | 1177 | |
1178 | 1178 | <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). | |
1182 | 1182 | </div> |
1183 | 1183 | |
1184 | 1184 | </div> |
126 | 126 | <p>sent when a key goes up; the message data is an FXEvent instance.</p> |
127 | 127 | </dd><dt><code>SEL_COMMAND</code> |
128 | 128 | <dd> |
129 | <p>sent whenever the spinner'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> | |
130 | 130 | </dd><dt><code>SEL_CHANGED</code> |
131 | 131 | <dd> |
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> | |
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> | |
133 | 133 | </dd></dl> |
134 | 134 | |
135 | 135 | <h3 id="label-Spinner+options">Spinner options</h3> |
334 | 334 | |
335 | 335 | |
336 | 336 | <span class="summary_desc"><div class='inline'> |
337 | <p>Number of columns (i.e. width of spinner's text field, in terms of number of columns of 'm') [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> | |
338 | 338 | </div></span> |
339 | 339 | |
340 | 340 | </li> |
703 | 703 | |
704 | 704 | |
705 | 705 | <span class="summary_desc"><div class='inline'> |
706 | <p>Set the “editability” of this spinner's text field.</p> | |
706 | <p>Set the “editability” of this spinner’s text field.</p> | |
707 | 707 | </div></span> |
708 | 708 | |
709 | 709 | </li> |
727 | 727 | |
728 | 728 | |
729 | 729 | <span class="summary_desc"><div class='inline'> |
730 | <p>Return <code>true</code> if the spinner's text field is editable.</p> | |
730 | <p>Return <code>true</code> if the spinner’s text field is editable.</p> | |
731 | 731 | </div></span> |
732 | 732 | |
733 | 733 | </li> |
873 | 873 | |
874 | 874 | |
875 | 875 | <span class="summary_desc"><div class='inline'> |
876 | <p>Set the visibility of this spinner's text field.</p> | |
876 | <p>Set the visibility of this spinner’s text field.</p> | |
877 | 877 | </div></span> |
878 | 878 | |
879 | 879 | </li> |
897 | 897 | |
898 | 898 | |
899 | 899 | <span class="summary_desc"><div class='inline'> |
900 | <p>Return <code>true</code> if this spinner's text field is visible.</p> | |
900 | <p>Return <code>true</code> if this spinner’s text field is visible.</p> | |
901 | 901 | </div></span> |
902 | 902 | |
903 | 903 | </li> |
1296 | 1296 | </h3><div class="docstring"> |
1297 | 1297 | <div class="discussion"> |
1298 | 1298 | |
1299 | <p>Number of columns (i.e. width of spinner's text field, in terms of number of columns of 'm') [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> | |
1300 | 1300 | |
1301 | 1301 | |
1302 | 1302 | </div> |
1849 | 1849 | </h3><div class="docstring"> |
1850 | 1850 | <div class="discussion"> |
1851 | 1851 | |
1852 | <p>Set the “editability” of this spinner's text field.</p> | |
1852 | <p>Set the “editability” of this spinner’s text field.</p> | |
1853 | 1853 | |
1854 | 1854 | |
1855 | 1855 | </div> |
1886 | 1886 | </h3><div class="docstring"> |
1887 | 1887 | <div class="discussion"> |
1888 | 1888 | |
1889 | <p>Return <code>true</code> if the spinner's text field is editable.</p> | |
1889 | <p>Return <code>true</code> if the spinner’s text field is editable.</p> | |
1890 | 1890 | |
1891 | 1891 | |
1892 | 1892 | </div> |
2047 | 2047 | </h3><div class="docstring"> |
2048 | 2048 | <div class="discussion"> |
2049 | 2049 | |
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> | |
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> | |
2051 | 2051 | |
2052 | 2052 | |
2053 | 2053 | </div> |
2084 | 2084 | </h3><div class="docstring"> |
2085 | 2085 | <div class="discussion"> |
2086 | 2086 | |
2087 | <p>Set the visibility of this spinner's text field.</p> | |
2087 | <p>Set the visibility of this spinner’s text field.</p> | |
2088 | 2088 | |
2089 | 2089 | |
2090 | 2090 | </div> |
2121 | 2121 | </h3><div class="docstring"> |
2122 | 2122 | <div class="discussion"> |
2123 | 2123 | |
2124 | <p>Return <code>true</code> if this spinner's text field is visible.</p> | |
2124 | <p>Return <code>true</code> if this spinner’s text field is visible.</p> | |
2125 | 2125 | |
2126 | 2126 | |
2127 | 2127 | </div> |
2164 | 2164 | </div> |
2165 | 2165 | |
2166 | 2166 | <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). | |
2170 | 2170 | </div> |
2171 | 2171 | |
2172 | 2172 | </div> |
830 | 830 | </div> |
831 | 831 | |
832 | 832 | <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). | |
836 | 836 | </div> |
837 | 837 | |
838 | 838 | </div> |
191 | 191 | |
192 | 192 | |
193 | 193 | <span class="summary_desc"><div class='inline'> |
194 | <p>Upper left corner's x-coordinate [Integer].</p> | |
194 | <p>Upper left corner’s x-coordinate [Integer].</p> | |
195 | 195 | </div></span> |
196 | 196 | |
197 | 197 | </li> |
218 | 218 | |
219 | 219 | |
220 | 220 | <span class="summary_desc"><div class='inline'> |
221 | <p>Upper left corner's y-coordinate [Integer].</p> | |
221 | <p>Upper left corner’s y-coordinate [Integer].</p> | |
222 | 222 | </div></span> |
223 | 223 | |
224 | 224 | </li> |
329 | 329 | |
330 | 330 | |
331 | 331 | <span class="summary_desc"><div class='inline'> |
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> | |
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> | |
333 | 333 | </div></span> |
334 | 334 | |
335 | 335 | </li> |
382 | 382 | <h4 id="label-Parameters-3A">Parameters:</h4> |
383 | 383 | <dl class="rdoc-list note-list"><dt><code>topleft</code> |
384 | 384 | <dd> |
385 | <p>upper left corner's initial position FXPoint</p> | |
385 | <p>upper left corner’s initial position FXPoint</p> | |
386 | 386 | </dd><dt><code>bottomright</code> |
387 | 387 | <dd> |
388 | <p>bottom right corner's initial position FXPoint</p> | |
388 | <p>bottom right corner’s initial position FXPoint</p> | |
389 | 389 | </dd></dl> |
390 | 390 | |
391 | 391 | |
516 | 516 | </h3><div class="docstring"> |
517 | 517 | <div class="discussion"> |
518 | 518 | |
519 | <p>Upper left corner's x-coordinate [Integer]</p> | |
519 | <p>Upper left corner’s x-coordinate [Integer]</p> | |
520 | 520 | |
521 | 521 | |
522 | 522 | </div> |
559 | 559 | </h3><div class="docstring"> |
560 | 560 | <div class="discussion"> |
561 | 561 | |
562 | <p>Upper left corner's y-coordinate [Integer]</p> | |
562 | <p>Upper left corner’s y-coordinate [Integer]</p> | |
563 | 563 | |
564 | 564 | |
565 | 565 | </div> |
709 | 709 | </h3><div class="docstring"> |
710 | 710 | <div class="discussion"> |
711 | 711 | |
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> | |
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> | |
713 | 713 | |
714 | 714 | |
715 | 715 | </div> |
791 | 791 | </div> |
792 | 792 | |
793 | 793 | <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). | |
797 | 797 | </div> |
798 | 798 | |
799 | 799 | </div> |
830 | 830 | </div> |
831 | 831 | |
832 | 832 | <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). | |
836 | 836 | </div> |
837 | 837 | |
838 | 838 | </div> |
245 | 245 | |
246 | 246 | |
247 | 247 | <span class="summary_desc"><div class='inline'> |
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> | |
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> | |
249 | 249 | </div></span> |
250 | 250 | |
251 | 251 | </li> |
554 | 554 | </h3><div class="docstring"> |
555 | 555 | <div class="discussion"> |
556 | 556 | |
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> | |
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> | |
558 | 558 | |
559 | 559 | |
560 | 560 | </div> |
671 | 671 | </div> |
672 | 672 | |
673 | 673 | <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). | |
677 | 677 | </div> |
678 | 678 | |
679 | 679 | </div> |
637 | 637 | </div> |
638 | 638 | |
639 | 639 | <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). | |
643 | 643 | </div> |
644 | 644 | |
645 | 645 | </div> |
301 | 301 | </div> |
302 | 302 | |
303 | 303 | <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). | |
307 | 307 | </div> |
308 | 308 | |
309 | 309 | </div> |
1989 | 1989 | </div> |
1990 | 1990 | |
1991 | 1991 | <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). | |
1995 | 1995 | </div> |
1996 | 1996 | |
1997 | 1997 | </div> |
1320 | 1320 | |
1321 | 1321 | |
1322 | 1322 | <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'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> | |
1324 | 1324 | </div></span> |
1325 | 1325 | |
1326 | 1326 | </li> |
1560 | 1560 | |
1561 | 1561 | |
1562 | 1562 | <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'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> | |
1564 | 1564 | </div></span> |
1565 | 1565 | |
1566 | 1566 | </li> |
3216 | 3216 | </h3><div class="docstring"> |
3217 | 3217 | <div class="discussion"> |
3218 | 3218 | |
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> | |
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> | |
3220 | 3220 | |
3221 | 3221 | |
3222 | 3222 | </div> |
3253 | 3253 | </h3><div class="docstring"> |
3254 | 3254 | <div class="discussion"> |
3255 | 3255 | |
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> | |
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> | |
3257 | 3257 | |
3258 | 3258 | |
3259 | 3259 | </div> |
3290 | 3290 | </h3><div class="docstring"> |
3291 | 3291 | <div class="discussion"> |
3292 | 3292 | |
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> | |
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> | |
3294 | 3294 | |
3295 | 3295 | |
3296 | 3296 | </div> |
3327 | 3327 | </h3><div class="docstring"> |
3328 | 3328 | <div class="discussion"> |
3329 | 3329 | |
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> | |
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> | |
3331 | 3331 | |
3332 | 3332 | |
3333 | 3333 | </div> |
3364 | 3364 | </h3><div class="docstring"> |
3365 | 3365 | <div class="discussion"> |
3366 | 3366 | |
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> | |
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> | |
3368 | 3368 | |
3369 | 3369 | |
3370 | 3370 | </div> |
3401 | 3401 | </h3><div class="docstring"> |
3402 | 3402 | <div class="discussion"> |
3403 | 3403 | |
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> | |
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> | |
3405 | 3405 | |
3406 | 3406 | |
3407 | 3407 | </div> |
3438 | 3438 | </h3><div class="docstring"> |
3439 | 3439 | <div class="discussion"> |
3440 | 3440 | |
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> | |
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> | |
3442 | 3442 | |
3443 | 3443 | |
3444 | 3444 | </div> |
3475 | 3475 | </h3><div class="docstring"> |
3476 | 3476 | <div class="discussion"> |
3477 | 3477 | |
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> | |
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> | |
3479 | 3479 | |
3480 | 3480 | |
3481 | 3481 | </div> |
3512 | 3512 | </h3><div class="docstring"> |
3513 | 3513 | <div class="discussion"> |
3514 | 3514 | |
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> | |
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> | |
3516 | 3516 | |
3517 | 3517 | |
3518 | 3518 | </div> |
3549 | 3549 | </h3><div class="docstring"> |
3550 | 3550 | <div class="discussion"> |
3551 | 3551 | |
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> | |
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> | |
3553 | 3553 | |
3554 | 3554 | |
3555 | 3555 | </div> |
3586 | 3586 | </h3><div class="docstring"> |
3587 | 3587 | <div class="discussion"> |
3588 | 3588 | |
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> | |
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> | |
3590 | 3590 | |
3591 | 3591 | |
3592 | 3592 | </div> |
3623 | 3623 | </h3><div class="docstring"> |
3624 | 3624 | <div class="discussion"> |
3625 | 3625 | |
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> | |
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> | |
3627 | 3627 | |
3628 | 3628 | |
3629 | 3629 | </div> |
3660 | 3660 | </h3><div class="docstring"> |
3661 | 3661 | <div class="discussion"> |
3662 | 3662 | |
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> | |
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> | |
3664 | 3664 | |
3665 | 3665 | |
3666 | 3666 | </div> |
3697 | 3697 | </h3><div class="docstring"> |
3698 | 3698 | <div class="discussion"> |
3699 | 3699 | |
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> | |
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> | |
3701 | 3701 | |
3702 | 3702 | |
3703 | 3703 | </div> |
3734 | 3734 | </h3><div class="docstring"> |
3735 | 3735 | <div class="discussion"> |
3736 | 3736 | |
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> | |
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> | |
3738 | 3738 | |
3739 | 3739 | |
3740 | 3740 | </div> |
3771 | 3771 | </h3><div class="docstring"> |
3772 | 3772 | <div class="discussion"> |
3773 | 3773 | |
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> | |
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> | |
3775 | 3775 | |
3776 | 3776 | |
3777 | 3777 | </div> |
3808 | 3808 | </h3><div class="docstring"> |
3809 | 3809 | <div class="discussion"> |
3810 | 3810 | |
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> | |
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> | |
3812 | 3812 | |
3813 | 3813 | |
3814 | 3814 | </div> |
3845 | 3845 | </h3><div class="docstring"> |
3846 | 3846 | <div class="discussion"> |
3847 | 3847 | |
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> | |
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> | |
3849 | 3849 | |
3850 | 3850 | |
3851 | 3851 | </div> |
3882 | 3882 | </h3><div class="docstring"> |
3883 | 3883 | <div class="discussion"> |
3884 | 3884 | |
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> | |
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> | |
3886 | 3886 | |
3887 | 3887 | |
3888 | 3888 | </div> |
3919 | 3919 | </h3><div class="docstring"> |
3920 | 3920 | <div class="discussion"> |
3921 | 3921 | |
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> | |
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> | |
3923 | 3923 | |
3924 | 3924 | |
3925 | 3925 | </div> |
3956 | 3956 | </h3><div class="docstring"> |
3957 | 3957 | <div class="discussion"> |
3958 | 3958 | |
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> | |
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> | |
3960 | 3960 | |
3961 | 3961 | |
3962 | 3962 | </div> |
3986 | 3986 | </div> |
3987 | 3987 | |
3988 | 3988 | <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). | |
3992 | 3992 | </div> |
3993 | 3993 | |
3994 | 3994 | </div> |
115 | 115 | <h2>Overview</h2><div class="docstring"> |
116 | 116 | <div class="discussion"> |
117 | 117 | |
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> | |
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> | |
119 | 119 | |
120 | 120 | <h3 id="label-Events">Events</h3> |
121 | 121 | |
160 | 160 | |
161 | 161 | </div> |
162 | 162 | </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> | |
166 | 166 | |
167 | 167 | <dt id="SCI_START-constant" class="">SCI_START = |
168 | 168 | <div class="docstring"> |
12578 | 12578 | |
12579 | 12579 | |
12580 | 12580 | <span class="summary_desc"><div class='inline'> |
12581 | <p>Retrieve a 'n' 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> | |
12582 | 12582 | </div></span> |
12583 | 12583 | |
12584 | 12584 | </li> |
18434 | 18434 | |
18435 | 18435 | |
18436 | 18436 | <span class="summary_desc"><div class='inline'> |
18437 | <p>Move the caret inside current view if it's not there already.</p> | |
18437 | <p>Move the caret inside current view if it’s not there already.</p> | |
18438 | 18438 | </div></span> |
18439 | 18439 | |
18440 | 18440 | </li> |
19004 | 19004 | |
19005 | 19005 | |
19006 | 19006 | <span class="summary_desc"><div class='inline'> |
19007 | <p>Retrieve a 'n' 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> | |
19008 | 19008 | </div></span> |
19009 | 19009 | |
19010 | 19010 | </li> |
20610 | 20610 | |
20611 | 20611 | |
20612 | 20612 | <span class="summary_desc"><div class='inline'> |
20613 | <p>Limit hotspots to single line so hotspots on two lines don't merge.</p> | |
20613 | <p>Limit hotspots to single line so hotspots on two lines don’t merge.</p> | |
20614 | 20614 | </div></span> |
20615 | 20615 | |
20616 | 20616 | </li> |
21634 | 21634 | |
21635 | 21635 | |
21636 | 21636 | <span class="summary_desc"><div class='inline'> |
21637 | <p>Set the identifier for this widget's embedded Scintilla component.</p> | |
21637 | <p>Set the identifier for this widget’s embedded Scintilla component.</p> | |
21638 | 21638 | </div></span> |
21639 | 21639 | |
21640 | 21640 | </li> |
22346 | 22346 | |
22347 | 22347 | |
22348 | 22348 | <span class="summary_desc"><div class='inline'> |
22349 | <p>In palette mode, Scintilla uses the environment'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> | |
22350 | 22350 | </div></span> |
22351 | 22351 | |
22352 | 22352 | </li> |
26548 | 26548 | </h3><div class="docstring"> |
26549 | 26549 | <div class="discussion"> |
26550 | 26550 | |
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> | |
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> | |
26552 | 26552 | |
26553 | 26553 | |
26554 | 26554 | </div> |
28844 | 28844 | </h3><div class="docstring"> |
28845 | 28845 | <div class="discussion"> |
28846 | 28846 | |
28847 | <p>Retrieve a 'n' 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> | |
28848 | 28848 | |
28849 | 28849 | |
28850 | 28850 | </div> |
38745 | 38745 | </h3><div class="docstring"> |
38746 | 38746 | <div class="discussion"> |
38747 | 38747 | |
38748 | <p>Move the caret inside current view if it's not there already.</p> | |
38748 | <p>Move the caret inside current view if it’s not there already.</p> | |
38749 | 38749 | |
38750 | 38750 | |
38751 | 38751 | </div> |
39696 | 39696 | </h3><div class="docstring"> |
39697 | 39697 | <div class="discussion"> |
39698 | 39698 | |
39699 | <p>Retrieve a 'n' 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> | |
39700 | 39700 | |
39701 | 39701 | |
39702 | 39702 | </div> |
40598 | 40598 | </h3><div class="docstring"> |
40599 | 40599 | <div class="discussion"> |
40600 | 40600 | |
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> | |
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> | |
40602 | 40602 | |
40603 | 40603 | |
40604 | 40604 | </div> |
42428 | 42428 | </h3><div class="docstring"> |
42429 | 42429 | <div class="discussion"> |
42430 | 42430 | |
42431 | <p>Limit hotspots to single line so hotspots on two lines don't merge.</p> | |
42431 | <p>Limit hotspots to single line so hotspots on two lines don’t merge.</p> | |
42432 | 42432 | |
42433 | 42433 | |
42434 | 42434 | </div> |
44147 | 44147 | </h3><div class="docstring"> |
44148 | 44148 | <div class="discussion"> |
44149 | 44149 | |
44150 | <p>Set the identifier for this widget's embedded Scintilla component.</p> | |
44150 | <p>Set the identifier for this widget’s embedded Scintilla component.</p> | |
44151 | 44151 | |
44152 | 44152 | |
44153 | 44153 | </div> |
45329 | 45329 | </h3><div class="docstring"> |
45330 | 45330 | <div class="discussion"> |
45331 | 45331 | |
45332 | <p>In palette mode, Scintilla uses the environment'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> | |
45333 | 45333 | |
45334 | 45334 | |
45335 | 45335 | </div> |
49106 | 49106 | </div> |
49107 | 49107 | |
49108 | 49108 | <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). | |
49112 | 49112 | </div> |
49113 | 49113 | |
49114 | 49114 | </div> |
113 | 113 | <h2>Overview</h2><div class="docstring"> |
114 | 114 | <div class="discussion"> |
115 | 115 | |
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> | |
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> | |
117 | 117 | |
118 | 118 | <h3 id="label-Scrollbar+options">Scrollbar options</h3> |
119 | 119 | <dl class="rdoc-list note-list"><dt><code>SCROLLERS_NORMAL</code> |
148 | 148 | <p>Scrollers track continuously for smooth scrolling</p> |
149 | 149 | </dd><dt><code>SCROLLERS_DONT_TRACK</code> |
150 | 150 | <dd> |
151 | <p>Scrollers don't track continuously</p> | |
151 | <p>Scrollers don’t track continuously</p> | |
152 | 152 | </dd></dl> |
153 | 153 | |
154 | 154 | |
1352 | 1352 | </div> |
1353 | 1353 | |
1354 | 1354 | <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). | |
1358 | 1358 | </div> |
1359 | 1359 | |
1360 | 1360 | </div> |
1008 | 1008 | </div> |
1009 | 1009 | |
1010 | 1010 | <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). | |
1014 | 1014 | </div> |
1015 | 1015 | |
1016 | 1016 | </div> |
279 | 279 | </div> |
280 | 280 | |
281 | 281 | <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). | |
285 | 285 | </div> |
286 | 286 | |
287 | 287 | </div> |
488 | 488 | </div> |
489 | 489 | |
490 | 490 | <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). | |
494 | 494 | </div> |
495 | 495 | |
496 | 496 | </div> |
113 | 113 | <h2>Overview</h2><div class="docstring"> |
114 | 114 | <div class="discussion"> |
115 | 115 | |
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> | |
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> | |
117 | 117 | |
118 | 118 | |
119 | 119 | </div> |
398 | 398 | </div> |
399 | 399 | |
400 | 400 | <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). | |
404 | 404 | </div> |
405 | 405 | |
406 | 406 | </div> |
371 | 371 | </div> |
372 | 372 | |
373 | 373 | <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). | |
377 | 377 | </div> |
378 | 378 | |
379 | 379 | </div> |
411 | 411 | </div> |
412 | 412 | |
413 | 413 | <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). | |
417 | 417 | </div> |
418 | 418 | |
419 | 419 | </div> |
111 | 111 | <h2>Overview</h2><div class="docstring"> |
112 | 112 | <div class="discussion"> |
113 | 113 | |
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> | |
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> | |
115 | 115 | |
116 | 116 | <h3 id="label-Separator+options">Separator options</h3> |
117 | 117 | <dl class="rdoc-list note-list"><dt><code>SEPARATOR_NONE</code> |
391 | 391 | </div> |
392 | 392 | |
393 | 393 | <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). | |
397 | 397 | </div> |
398 | 398 | |
399 | 399 | </div> |
1850 | 1850 | </div> |
1851 | 1851 | |
1852 | 1852 | <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). | |
1856 | 1856 | </div> |
1857 | 1857 | |
1858 | 1858 | </div> |
222 | 222 | </div> |
223 | 223 | |
224 | 224 | <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). | |
228 | 228 | </div> |
229 | 229 | |
230 | 230 | </div> |
115 | 115 | <h2>Overview</h2><div class="docstring"> |
116 | 116 | <div class="discussion"> |
117 | 117 | |
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> | |
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> | |
119 | 119 | |
120 | 120 | <h3 id="label-Events">Events</h3> |
121 | 121 | |
461 | 461 | </div> |
462 | 462 | |
463 | 463 | <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). | |
467 | 467 | </div> |
468 | 468 | |
469 | 469 | </div> |
658 | 658 | </div> |
659 | 659 | |
660 | 660 | <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). | |
664 | 664 | </div> |
665 | 665 | |
666 | 666 | </div> |
581 | 581 | </div> |
582 | 582 | |
583 | 583 | <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). | |
587 | 587 | </div> |
588 | 588 | |
589 | 589 | </div> |
1118 | 1118 | </div> |
1119 | 1119 | |
1120 | 1120 | <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). | |
1124 | 1124 | </div> |
1125 | 1125 | |
1126 | 1126 | </div> |
895 | 895 | </div> |
896 | 896 | |
897 | 897 | <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). | |
901 | 901 | </div> |
902 | 902 | |
903 | 903 | </div> |
895 | 895 | </div> |
896 | 896 | |
897 | 897 | <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). | |
901 | 901 | </div> |
902 | 902 | |
903 | 903 | </div> |
126 | 126 | <p>sent when a key goes up; the message data is an FXEvent instance.</p> |
127 | 127 | </dd><dt><code>SEL_COMMAND</code> |
128 | 128 | <dd> |
129 | <p>sent whenever the spinner'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> | |
130 | 130 | </dd><dt><code>SEL_CHANGED</code> |
131 | 131 | <dd> |
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> | |
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> | |
133 | 133 | </dd></dl> |
134 | 134 | |
135 | 135 | <h3 id="label-Spinner+options">Spinner options</h3> |
304 | 304 | |
305 | 305 | |
306 | 306 | <span class="summary_desc"><div class='inline'> |
307 | <p>Number of columns (i.e. width of spinner's text field, in terms of number of columns of 'm') [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> | |
308 | 308 | </div></span> |
309 | 309 | |
310 | 310 | </li> |
673 | 673 | |
674 | 674 | |
675 | 675 | <span class="summary_desc"><div class='inline'> |
676 | <p>Set the “editability” of this spinner's text field.</p> | |
676 | <p>Set the “editability” of this spinner’s text field.</p> | |
677 | 677 | </div></span> |
678 | 678 | |
679 | 679 | </li> |
697 | 697 | |
698 | 698 | |
699 | 699 | <span class="summary_desc"><div class='inline'> |
700 | <p>Return <code>true</code> if the spinner's text field is editable.</p> | |
700 | <p>Return <code>true</code> if the spinner’s text field is editable.</p> | |
701 | 701 | </div></span> |
702 | 702 | |
703 | 703 | </li> |
843 | 843 | |
844 | 844 | |
845 | 845 | <span class="summary_desc"><div class='inline'> |
846 | <p>Set the visibility of this spinner's text field.</p> | |
846 | <p>Set the visibility of this spinner’s text field.</p> | |
847 | 847 | </div></span> |
848 | 848 | |
849 | 849 | </li> |
867 | 867 | |
868 | 868 | |
869 | 869 | <span class="summary_desc"><div class='inline'> |
870 | <p>Return <code>true</code> if this spinner's text field is visible.</p> | |
870 | <p>Return <code>true</code> if this spinner’s text field is visible.</p> | |
871 | 871 | </div></span> |
872 | 872 | |
873 | 873 | </li> |
1223 | 1223 | </h3><div class="docstring"> |
1224 | 1224 | <div class="discussion"> |
1225 | 1225 | |
1226 | <p>Number of columns (i.e. width of spinner's text field, in terms of number of columns of 'm') [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> | |
1227 | 1227 | |
1228 | 1228 | |
1229 | 1229 | </div> |
1776 | 1776 | </h3><div class="docstring"> |
1777 | 1777 | <div class="discussion"> |
1778 | 1778 | |
1779 | <p>Set the “editability” of this spinner's text field.</p> | |
1779 | <p>Set the “editability” of this spinner’s text field.</p> | |
1780 | 1780 | |
1781 | 1781 | |
1782 | 1782 | </div> |
1813 | 1813 | </h3><div class="docstring"> |
1814 | 1814 | <div class="discussion"> |
1815 | 1815 | |
1816 | <p>Return <code>true</code> if the spinner's text field is editable.</p> | |
1816 | <p>Return <code>true</code> if the spinner’s text field is editable.</p> | |
1817 | 1817 | |
1818 | 1818 | |
1819 | 1819 | </div> |
1974 | 1974 | </h3><div class="docstring"> |
1975 | 1975 | <div class="discussion"> |
1976 | 1976 | |
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> | |
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> | |
1978 | 1978 | |
1979 | 1979 | |
1980 | 1980 | </div> |
2011 | 2011 | </h3><div class="docstring"> |
2012 | 2012 | <div class="discussion"> |
2013 | 2013 | |
2014 | <p>Set the visibility of this spinner's text field.</p> | |
2014 | <p>Set the visibility of this spinner’s text field.</p> | |
2015 | 2015 | |
2016 | 2016 | |
2017 | 2017 | </div> |
2048 | 2048 | </h3><div class="docstring"> |
2049 | 2049 | <div class="discussion"> |
2050 | 2050 | |
2051 | <p>Return <code>true</code> if this spinner's text field is visible.</p> | |
2051 | <p>Return <code>true</code> if this spinner’s text field is visible.</p> | |
2052 | 2052 | |
2053 | 2053 | |
2054 | 2054 | </div> |
2091 | 2091 | </div> |
2092 | 2092 | |
2093 | 2093 | <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). | |
2097 | 2097 | </div> |
2098 | 2098 | |
2099 | 2099 | </div> |
486 | 486 | </div> |
487 | 487 | |
488 | 488 | <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). | |
492 | 492 | </div> |
493 | 493 | |
494 | 494 | </div> |
193 | 193 | |
194 | 194 | |
195 | 195 | <span class="summary_desc"><div class='inline'> |
196 | <p>The splash window'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> | |
197 | 197 | </div></span> |
198 | 198 | |
199 | 199 | </li> |
448 | 448 | </h3><div class="docstring"> |
449 | 449 | <div class="discussion"> |
450 | 450 | |
451 | <p>The splash window'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> | |
452 | 452 | |
453 | 453 | |
454 | 454 | </div> |
483 | 483 | </div> |
484 | 484 | |
485 | 485 | <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). | |
489 | 489 | </div> |
490 | 490 | |
491 | 491 | </div> |
632 | 632 | </div> |
633 | 633 | |
634 | 634 | <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). | |
638 | 638 | </div> |
639 | 639 | |
640 | 640 | </div> |
506 | 506 | </div> |
507 | 507 | |
508 | 508 | <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). | |
512 | 512 | </div> |
513 | 513 | |
514 | 514 | </div> |
582 | 582 | </div> |
583 | 583 | |
584 | 584 | <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). | |
588 | 588 | </div> |
589 | 589 | |
590 | 590 | </div> |
118 | 118 | <p>The following messages are sent by FXStatusLine to its target:</p> |
119 | 119 | <dl class="rdoc-list note-list"><dt><code>SEL_UPDATE</code> |
120 | 120 | <dd> |
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> | |
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> | |
122 | 122 | </dd></dl> |
123 | 123 | |
124 | 124 | |
743 | 743 | </div> |
744 | 744 | |
745 | 745 | <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). | |
749 | 749 | </div> |
750 | 750 | |
751 | 751 | </div> |
103 | 103 | <h2>Overview</h2><div class="docstring"> |
104 | 104 | <div class="discussion"> |
105 | 105 | |
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> | |
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> | |
107 | 107 | |
108 | 108 | <h3 id="label-Stream+status+codes">Stream status codes</h3> |
109 | 109 | <dl class="rdoc-list note-list"><dt><code>FXStreamOK</code> |
1361 | 1361 | </div> |
1362 | 1362 | |
1363 | 1363 | <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). | |
1367 | 1367 | </div> |
1368 | 1368 | |
1369 | 1369 | </div> |
137 | 137 | </div> |
138 | 138 | |
139 | 139 | <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). | |
143 | 143 | </div> |
144 | 144 | |
145 | 145 | </div> |
137 | 137 | </div> |
138 | 138 | |
139 | 139 | <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). | |
143 | 143 | </div> |
144 | 144 | |
145 | 145 | </div> |
248 | 248 | </div> |
249 | 249 | |
250 | 250 | <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). | |
254 | 254 | </div> |
255 | 255 | |
256 | 256 | </div> |
137 | 137 | </div> |
138 | 138 | |
139 | 139 | <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). | |
143 | 143 | </div> |
144 | 144 | |
145 | 145 | </div> |
137 | 137 | </div> |
138 | 138 | |
139 | 139 | <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). | |
143 | 143 | </div> |
144 | 144 | |
145 | 145 | </div> |
105 | 105 | <h2>Overview</h2><div class="docstring"> |
106 | 106 | <div class="discussion"> |
107 | 107 | |
108 | <p>Filled up a stream's internal buffer, or the disk is full</p> | |
108 | <p>Filled up a stream’s internal buffer, or the disk is full</p> | |
109 | 109 | |
110 | 110 | |
111 | 111 | </div> |
137 | 137 | </div> |
138 | 138 | |
139 | 139 | <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). | |
143 | 143 | </div> |
144 | 144 | |
145 | 145 | </div> |
137 | 137 | </div> |
138 | 138 | |
139 | 139 | <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). | |
143 | 143 | </div> |
144 | 144 | |
145 | 145 | </div> |
137 | 137 | </div> |
138 | 138 | |
139 | 139 | <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). | |
143 | 143 | </div> |
144 | 144 | |
145 | 145 | </div> |
137 | 137 | </div> |
138 | 138 | |
139 | 139 | <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). | |
143 | 143 | </div> |
144 | 144 | |
145 | 145 | </div> |
105 | 105 | <h2>Overview</h2><div class="docstring"> |
106 | 106 | <div class="discussion"> |
107 | 107 | |
108 | <p>An FXStringDict (string dictionary) object maps one string to another string. The inserted strings are copied when they'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> | |
109 | 109 | |
110 | 110 | |
111 | 111 | </div> |
541 | 541 | </div> |
542 | 542 | |
543 | 543 | <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). | |
547 | 547 | </div> |
548 | 548 | |
549 | 549 | </div> |
113 | 113 | <h2>Overview</h2><div class="docstring"> |
114 | 114 | <div class="discussion"> |
115 | 115 | |
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> | |
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> | |
117 | 117 | |
118 | 118 | <h3 id="label-Events">Events</h3> |
119 | 119 | |
120 | 120 | <p>The following messages are sent by FXSwitcher to its target:</p> |
121 | 121 | <dl class="rdoc-list note-list"><dt><code>SEL_COMMAND</code> |
122 | 122 | <dd> |
123 | <p>sent whenever the current (topmost) child window changes; the message data is an integer indicating the new current window'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> | |
124 | 124 | </dd></dl> |
125 | 125 | |
126 | 126 | <h3 id="label-Switcher+options">Switcher options</h3> |
202 | 202 | |
203 | 203 | |
204 | 204 | <span class="summary_desc"><div class='inline'> |
205 | <p>Current child window's index [Integer].</p> | |
205 | <p>Current child window’s index [Integer].</p> | |
206 | 206 | </div></span> |
207 | 207 | |
208 | 208 | </li> |
487 | 487 | </h3><div class="docstring"> |
488 | 488 | <div class="discussion"> |
489 | 489 | |
490 | <p>Current child window's index [Integer]</p> | |
490 | <p>Current child window’s index [Integer]</p> | |
491 | 491 | |
492 | 492 | |
493 | 493 | </div> |
578 | 578 | </h3><div class="docstring"> |
579 | 579 | <div class="discussion"> |
580 | 580 | |
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> | |
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> | |
582 | 582 | |
583 | 583 | |
584 | 584 | </div> |
608 | 608 | </div> |
609 | 609 | |
610 | 610 | <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). | |
614 | 614 | </div> |
615 | 615 | |
616 | 616 | </div> |
439 | 439 | </div> |
440 | 440 | |
441 | 441 | <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). | |
445 | 445 | </div> |
446 | 446 | |
447 | 447 | </div> |
423 | 423 | </div> |
424 | 424 | |
425 | 425 | <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). | |
429 | 429 | </div> |
430 | 430 | |
431 | 431 | </div> |
593 | 593 | </div> |
594 | 594 | |
595 | 595 | <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). | |
599 | 599 | </div> |
600 | 600 | |
601 | 601 | </div> |
577 | 577 | </div> |
578 | 578 | |
579 | 579 | <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). | |
583 | 583 | </div> |
584 | 584 | |
585 | 585 | </div> |
113 | 113 | <h2>Overview</h2><div class="docstring"> |
114 | 114 | <div class="discussion"> |
115 | 115 | |
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> | |
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> | |
117 | 117 | |
118 | 118 | <h3 id="label-Events">Events</h3> |
119 | 119 | |
120 | 120 | <p>The following messages are sent by FXTabBar to its target:</p> |
121 | 121 | <dl class="rdoc-list note-list"><dt><code>SEL_COMMAND</code> |
122 | 122 | <dd> |
123 | <p>sent whenever the current tab item changes; the message data is an integer indicating the new current tab item'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> | |
124 | 124 | </dd></dl> |
125 | 125 | |
126 | 126 | <h3 id="label-Tab+book+options">Tab book options</h3> |
221 | 221 | |
222 | 222 | |
223 | 223 | <span class="summary_desc"><div class='inline'> |
224 | <p>Currently active tab item's index [Integer].</p> | |
224 | <p>Currently active tab item’s index [Integer].</p> | |
225 | 225 | </div></span> |
226 | 226 | |
227 | 227 | </li> |
512 | 512 | </h3><div class="docstring"> |
513 | 513 | <div class="discussion"> |
514 | 514 | |
515 | <p>Currently active tab item's index [Integer]</p> | |
515 | <p>Currently active tab item’s index [Integer]</p> | |
516 | 516 | |
517 | 517 | |
518 | 518 | </div> |
603 | 603 | </h3><div class="docstring"> |
604 | 604 | <div class="discussion"> |
605 | 605 | |
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> | |
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> | |
607 | 607 | |
608 | 608 | |
609 | 609 | </div> |
633 | 633 | </div> |
634 | 634 | |
635 | 635 | <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). | |
639 | 639 | </div> |
640 | 640 | |
641 | 641 | </div> |
115 | 115 | <h2>Overview</h2><div class="docstring"> |
116 | 116 | <div class="discussion"> |
117 | 117 | |
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> | |
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> | |
119 | 119 | |
120 | 120 | |
121 | 121 | </div> |
362 | 362 | </div> |
363 | 363 | |
364 | 364 | <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). | |
368 | 368 | </div> |
369 | 369 | |
370 | 370 | </div> |
467 | 467 | </div> |
468 | 468 | |
469 | 469 | <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). | |
473 | 473 | </div> |
474 | 474 | |
475 | 475 | </div> |
4111 | 4111 | </h3><div class="docstring"> |
4112 | 4112 | <div class="discussion"> |
4113 | 4113 | |
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> | |
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> | |
4115 | 4115 | |
4116 | 4116 | <h4 id="label-Parameters-3A">Parameters:</h4> |
4117 | 4117 | <dl class="rdoc-list note-list"><dt><code>p</code> |
6250 | 6250 | </h3><div class="docstring"> |
6251 | 6251 | <div class="discussion"> |
6252 | 6252 | |
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> | |
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> | |
6254 | 6254 | |
6255 | 6255 | |
6256 | 6256 | </div> |
6884 | 6884 | </h3><div class="docstring"> |
6885 | 6885 | <div class="discussion"> |
6886 | 6886 | |
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> | |
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> | |
6888 | 6888 | |
6889 | 6889 | |
6890 | 6890 | </div> |
6921 | 6921 | </h3><div class="docstring"> |
6922 | 6922 | <div class="discussion"> |
6923 | 6923 | |
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> | |
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> | |
6925 | 6925 | |
6926 | 6926 | |
6927 | 6927 | </div> |
6958 | 6958 | </h3><div class="docstring"> |
6959 | 6959 | <div class="discussion"> |
6960 | 6960 | |
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> | |
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> | |
6962 | 6962 | |
6963 | 6963 | <h4 id="label-Parameters-3A">Parameters:</h4> |
6964 | 6964 | <dl class="rdoc-list note-list"><dt><code>startrow</code> |
7995 | 7995 | </h3><div class="docstring"> |
7996 | 7996 | <div class="discussion"> |
7997 | 7997 | |
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> | |
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> | |
7999 | 7999 | |
8000 | 8000 | |
8001 | 8001 | </div> |
8032 | 8032 | </h3><div class="docstring"> |
8033 | 8033 | <div class="discussion"> |
8034 | 8034 | |
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> | |
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> | |
8036 | 8036 | |
8037 | 8037 | |
8038 | 8038 | </div> |
8319 | 8319 | </h3><div class="docstring"> |
8320 | 8320 | <div class="discussion"> |
8321 | 8321 | |
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> | |
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> | |
8323 | 8323 | |
8324 | 8324 | |
8325 | 8325 | </div> |
8467 | 8467 | </h3><div class="docstring"> |
8468 | 8468 | <div class="discussion"> |
8469 | 8469 | |
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> | |
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> | |
8471 | 8471 | |
8472 | 8472 | <h4 id="label-Parameters-3A">Parameters:</h4> |
8473 | 8473 | <dl class="rdoc-list note-list"><dt><code>startrow</code> |
8528 | 8528 | </h3><div class="docstring"> |
8529 | 8529 | <div class="discussion"> |
8530 | 8530 | |
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> | |
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> | |
8532 | 8532 | |
8533 | 8533 | |
8534 | 8534 | </div> |
8565 | 8565 | </h3><div class="docstring"> |
8566 | 8566 | <div class="discussion"> |
8567 | 8567 | |
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> | |
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> | |
8569 | 8569 | |
8570 | 8570 | |
8571 | 8571 | </div> |
8602 | 8602 | </h3><div class="docstring"> |
8603 | 8603 | <div class="discussion"> |
8604 | 8604 | |
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> | |
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> | |
8606 | 8606 | |
8607 | 8607 | |
8608 | 8608 | </div> |
8639 | 8639 | </h3><div class="docstring"> |
8640 | 8640 | <div class="discussion"> |
8641 | 8641 | |
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> | |
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> | |
8643 | 8643 | |
8644 | 8644 | |
8645 | 8645 | </div> |
8850 | 8850 | </h3><div class="docstring"> |
8851 | 8851 | <div class="discussion"> |
8852 | 8852 | |
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> | |
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> | |
8854 | 8854 | |
8855 | 8855 | |
8856 | 8856 | </div> |
8887 | 8887 | </h3><div class="docstring"> |
8888 | 8888 | <div class="discussion"> |
8889 | 8889 | |
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> | |
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> | |
8891 | 8891 | |
8892 | 8892 | |
8893 | 8893 | </div> |
8928 | 8928 | </h3><div class="docstring"> |
8929 | 8929 | <div class="discussion"> |
8930 | 8930 | |
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> | |
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> | |
8932 | 8932 | |
8933 | 8933 | |
8934 | 8934 | </div> |
8965 | 8965 | </h3><div class="docstring"> |
8966 | 8966 | <div class="discussion"> |
8967 | 8967 | |
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> | |
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> | |
8969 | 8969 | |
8970 | 8970 | |
8971 | 8971 | </div> |
9261 | 9261 | </h3><div class="docstring"> |
9262 | 9262 | <div class="discussion"> |
9263 | 9263 | |
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> | |
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> | |
9265 | 9265 | |
9266 | 9266 | |
9267 | 9267 | </div> |
9411 | 9411 | </h3><div class="docstring"> |
9412 | 9412 | <div class="discussion"> |
9413 | 9413 | |
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> | |
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> | |
9415 | 9415 | |
9416 | 9416 | |
9417 | 9417 | </div> |
9563 | 9563 | </h3><div class="docstring"> |
9564 | 9564 | <div class="discussion"> |
9565 | 9565 | |
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> | |
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> | |
9567 | 9567 | |
9568 | 9568 | |
9569 | 9569 | </div> |
9787 | 9787 | |
9788 | 9788 | <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> |
9789 | 9789 | <ul><li> |
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> | |
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> | |
9791 | 9791 | </li><li> |
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> | |
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> | |
9793 | 9793 | </li><li> |
9794 | <p>a <code>SEL_CHANGED</code> message will be sent to the table'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> | |
9795 | 9795 | </li></ul> |
9796 | 9796 | |
9797 | 9797 | <p>Raises ArgError if either <em>numRows</em> or <em>numCols</em> is less than zero.</p> |
9905 | 9905 | </h3><div class="docstring"> |
9906 | 9906 | <div class="discussion"> |
9907 | 9907 | |
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> | |
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> | |
9909 | 9909 | |
9910 | 9910 | |
9911 | 9911 | </div> |
10096 | 10096 | </div> |
10097 | 10097 | |
10098 | 10098 | <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). | |
10102 | 10102 | </div> |
10103 | 10103 | |
10104 | 10104 | </div> |
311 | 311 | |
312 | 312 | |
313 | 313 | <span class="summary_desc"><div class='inline'> |
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> | |
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> | |
315 | 315 | </div></span> |
316 | 316 | |
317 | 317 | </li> |
1241 | 1241 | </h3><div class="docstring"> |
1242 | 1242 | <div class="discussion"> |
1243 | 1243 | |
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> | |
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> | |
1245 | 1245 | |
1246 | 1246 | |
1247 | 1247 | </div> |
2184 | 2184 | </div> |
2185 | 2185 | |
2186 | 2186 | <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). | |
2190 | 2190 | </div> |
2191 | 2191 | |
2192 | 2192 | </div> |
349 | 349 | </div> |
350 | 350 | |
351 | 351 | <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). | |
355 | 355 | </div> |
356 | 356 | |
357 | 357 | </div> |
349 | 349 | </div> |
350 | 350 | |
351 | 351 | <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). | |
355 | 355 | </div> |
356 | 356 | |
357 | 357 | </div> |
2274 | 2274 | |
2275 | 2275 | |
2276 | 2276 | <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'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> | |
2278 | 2278 | </div></span> |
2279 | 2279 | |
2280 | 2280 | </li> |
2610 | 2610 | |
2611 | 2611 | |
2612 | 2612 | <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'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> | |
2614 | 2614 | </div></span> |
2615 | 2615 | |
2616 | 2616 | </li> |
2634 | 2634 | |
2635 | 2635 | |
2636 | 2636 | <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'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> | |
2638 | 2638 | </div></span> |
2639 | 2639 | |
2640 | 2640 | </li> |
2730 | 2730 | |
2731 | 2731 | |
2732 | 2732 | <span class="summary_desc"><div class='inline'> |
2733 | <p>Return the text buffer's value.</p> | |
2733 | <p>Return the text buffer’s value.</p> | |
2734 | 2734 | </div></span> |
2735 | 2735 | |
2736 | 2736 | </li> |
4529 | 4529 | </h3><div class="docstring"> |
4530 | 4530 | <div class="discussion"> |
4531 | 4531 | |
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> | |
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> | |
4533 | 4533 | |
4534 | 4534 | |
4535 | 4535 | </div> |
4566 | 4566 | </h3><div class="docstring"> |
4567 | 4567 | <div class="discussion"> |
4568 | 4568 | |
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> | |
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> | |
4570 | 4570 | |
4571 | 4571 | |
4572 | 4572 | </div> |
4838 | 4838 | </h3><div class="docstring"> |
4839 | 4839 | <div class="discussion"> |
4840 | 4840 | |
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> | |
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> | |
4842 | 4842 | |
4843 | 4843 | |
4844 | 4844 | </div> |
5284 | 5284 | </h3><div class="docstring"> |
5285 | 5285 | <div class="discussion"> |
5286 | 5286 | |
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> | |
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> | |
5288 | 5288 | |
5289 | 5289 | |
5290 | 5290 | </div> |
5321 | 5321 | </h3><div class="docstring"> |
5322 | 5322 | <div class="discussion"> |
5323 | 5323 | |
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> | |
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> | |
5325 | 5325 | |
5326 | 5326 | |
5327 | 5327 | </div> |
5395 | 5395 | </h3><div class="docstring"> |
5396 | 5396 | <div class="discussion"> |
5397 | 5397 | |
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> | |
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> | |
5399 | 5399 | |
5400 | 5400 | |
5401 | 5401 | </div> |
6002 | 6002 | </h3><div class="docstring"> |
6003 | 6003 | <div class="discussion"> |
6004 | 6004 | |
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> | |
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> | |
6006 | 6006 | |
6007 | 6007 | |
6008 | 6008 | </div> |
6039 | 6039 | </h3><div class="docstring"> |
6040 | 6040 | <div class="discussion"> |
6041 | 6041 | |
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> | |
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> | |
6043 | 6043 | |
6044 | 6044 | |
6045 | 6045 | </div> |
6076 | 6076 | </h3><div class="docstring"> |
6077 | 6077 | <div class="discussion"> |
6078 | 6078 | |
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> | |
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> | |
6080 | 6080 | |
6081 | 6081 | |
6082 | 6082 | </div> |
6224 | 6224 | </h3><div class="docstring"> |
6225 | 6225 | <div class="discussion"> |
6226 | 6226 | |
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> | |
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> | |
6228 | 6228 | |
6229 | 6229 | |
6230 | 6230 | </div> |
6335 | 6335 | </h3><div class="docstring"> |
6336 | 6336 | <div class="discussion"> |
6337 | 6337 | |
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> | |
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> | |
6339 | 6339 | |
6340 | 6340 | |
6341 | 6341 | </div> |
6372 | 6372 | </h3><div class="docstring"> |
6373 | 6373 | <div class="discussion"> |
6374 | 6374 | |
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> | |
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> | |
6376 | 6376 | |
6377 | 6377 | |
6378 | 6378 | </div> |
6409 | 6409 | </h3><div class="docstring"> |
6410 | 6410 | <div class="discussion"> |
6411 | 6411 | |
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> | |
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> | |
6413 | 6413 | |
6414 | 6414 | |
6415 | 6415 | </div> |
6483 | 6483 | </h3><div class="docstring"> |
6484 | 6484 | <div class="discussion"> |
6485 | 6485 | |
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> | |
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> | |
6487 | 6487 | |
6488 | 6488 | |
6489 | 6489 | </div> |
6520 | 6520 | </h3><div class="docstring"> |
6521 | 6521 | <div class="discussion"> |
6522 | 6522 | |
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> | |
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> | |
6524 | 6524 | |
6525 | 6525 | |
6526 | 6526 | </div> |
6557 | 6557 | </h3><div class="docstring"> |
6558 | 6558 | <div class="discussion"> |
6559 | 6559 | |
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> | |
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> | |
6561 | 6561 | |
6562 | 6562 | |
6563 | 6563 | </div> |
6631 | 6631 | </h3><div class="docstring"> |
6632 | 6632 | <div class="discussion"> |
6633 | 6633 | |
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> | |
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> | |
6635 | 6635 | |
6636 | 6636 | |
6637 | 6637 | </div> |
6718 | 6718 | </h3><div class="docstring"> |
6719 | 6719 | <div class="discussion"> |
6720 | 6720 | |
6721 | <p>Return the text buffer's value</p> | |
6721 | <p>Return the text buffer’s value</p> | |
6722 | 6722 | |
6723 | 6723 | |
6724 | 6724 | </div> |
6859 | 6859 | </div> |
6860 | 6860 | |
6861 | 6861 | <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). | |
6865 | 6865 | </div> |
6866 | 6866 | |
6867 | 6867 | </div> |
481 | 481 | </div> |
482 | 482 | |
483 | 483 | <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). | |
487 | 487 | </div> |
488 | 488 | |
489 | 489 | </div> |
392 | 392 | |
393 | 393 | |
394 | 394 | <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 '8' [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> | |
396 | 396 | </div></span> |
397 | 397 | |
398 | 398 | </li> |
1284 | 1284 | </h3><div class="docstring"> |
1285 | 1285 | <div class="discussion"> |
1286 | 1286 | |
1287 | <p>Default width of this text field, in terms of a number of columns times the width of the numeral '8' [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> | |
1288 | 1288 | |
1289 | 1289 | |
1290 | 1290 | </div> |
2005 | 2005 | </div> |
2006 | 2006 | |
2007 | 2007 | <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). | |
2011 | 2011 | </div> |
2012 | 2012 | |
2013 | 2013 | </div> |
494 | 494 | <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> |
495 | 495 | </dd><dt><code>text1</code> |
496 | 496 | <dd> |
497 | <p>the text for this toggle button's first state [String]</p> | |
497 | <p>the text for this toggle button’s first state [String]</p> | |
498 | 498 | </dd><dt><code>text2</code> |
499 | 499 | <dd> |
500 | <p>the text for this toggle button's second state [String]</p> | |
500 | <p>the text for this toggle button’s second state [String]</p> | |
501 | 501 | </dd><dt><code>icon1</code> |
502 | 502 | <dd> |
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> | |
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> | |
504 | 504 | </dd><dt><code>icon2</code> |
505 | 505 | <dd> |
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> | |
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> | |
507 | 507 | </dd><dt><code>target</code> |
508 | 508 | <dd> |
509 | 509 | <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> |
833 | 833 | </div> |
834 | 834 | |
835 | 835 | <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). | |
839 | 839 | </div> |
840 | 840 | |
841 | 841 | </div> |
441 | 441 | </div> |
442 | 442 | |
443 | 443 | <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). | |
447 | 447 | </div> |
448 | 448 | |
449 | 449 | </div> |
573 | 573 | </div> |
574 | 574 | |
575 | 575 | <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). | |
579 | 579 | </div> |
580 | 580 | |
581 | 581 | </div> |
777 | 777 | </div> |
778 | 778 | |
779 | 779 | <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). | |
783 | 783 | </div> |
784 | 784 | |
785 | 785 | </div> |
130 | 130 | <p>Sent when a key goes up; the message data is an FXEvent instance.</p> |
131 | 131 | </dd><dt><code>SEL_COMMAND</code> |
132 | 132 | <dd> |
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> | |
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> | |
134 | 134 | </dd></dl> |
135 | 135 | |
136 | 136 | <h3 id="label-Toolbar+tab+styles">Toolbar tab styles</h3> |
638 | 638 | </h3><div class="docstring"> |
639 | 639 | <div class="discussion"> |
640 | 640 | |
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> | |
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> | |
642 | 642 | |
643 | 643 | |
644 | 644 | </div> |
718 | 718 | </div> |
719 | 719 | |
720 | 720 | <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). | |
724 | 724 | </div> |
725 | 725 | |
726 | 726 | </div> |
358 | 358 | |
359 | 359 | |
360 | 360 | <span class="summary_desc"><div class='inline'> |
361 | <p>Return the tool tip's text.</p> | |
361 | <p>Return the tool tip’s text.</p> | |
362 | 362 | </div></span> |
363 | 363 | |
364 | 364 | </li> |
720 | 720 | </h3><div class="docstring"> |
721 | 721 | <div class="discussion"> |
722 | 722 | |
723 | <p>Return the tool tip's text</p> | |
723 | <p>Return the tool tip’s text</p> | |
724 | 724 | |
725 | 725 | |
726 | 726 | </div> |
750 | 750 | </div> |
751 | 751 | |
752 | 752 | <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). | |
756 | 756 | </div> |
757 | 757 | |
758 | 758 | </div> |
115 | 115 | |
116 | 116 | <p>Abstract base class for all top-level windows.</p> |
117 | 117 | |
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> | |
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> | |
119 | 119 | |
120 | 120 | <h3 id="label-Events">Events</h3> |
121 | 121 | |
1705 | 1705 | </div> |
1706 | 1706 | |
1707 | 1707 | <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). | |
1711 | 1711 | </div> |
1712 | 1712 | |
1713 | 1713 | </div> |
470 | 470 | </div> |
471 | 471 | |
472 | 472 | <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). | |
476 | 476 | </div> |
477 | 477 | |
478 | 478 | </div> |
395 | 395 | |
396 | 396 | |
397 | 397 | <span class="summary_desc"><div class='inline'> |
398 | <p>Set this item'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> | |
399 | 399 | </div></span> |
400 | 400 | |
401 | 401 | </li> |
467 | 467 | |
468 | 468 | |
469 | 469 | <span class="summary_desc"><div class='inline'> |
470 | <p>Set this item'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> | |
471 | 471 | </div></span> |
472 | 472 | |
473 | 473 | </li> |
515 | 515 | |
516 | 516 | |
517 | 517 | <span class="summary_desc"><div class='inline'> |
518 | <p>Set this item'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> | |
519 | 519 | </div></span> |
520 | 520 | |
521 | 521 | </li> |
757 | 757 | |
758 | 758 | |
759 | 759 | <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'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> | |
761 | 761 | </div></span> |
762 | 762 | |
763 | 763 | </li> |
805 | 805 | |
806 | 806 | |
807 | 807 | <span class="summary_desc"><div class='inline'> |
808 | <p>Set this item'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> | |
809 | 809 | </div></span> |
810 | 810 | |
811 | 811 | </li> |
925 | 925 | |
926 | 926 | |
927 | 927 | <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'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> | |
929 | 929 | </div></span> |
930 | 930 | |
931 | 931 | </li> |
949 | 949 | |
950 | 950 | |
951 | 951 | <span class="summary_desc"><div class='inline'> |
952 | <p>Set this item'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> | |
953 | 953 | </div></span> |
954 | 954 | |
955 | 955 | </li> |
1117 | 1117 | |
1118 | 1118 | |
1119 | 1119 | <span class="summary_desc"><div class='inline'> |
1120 | <p>Returns the item's text.</p> | |
1120 | <p>Returns the item’s text.</p> | |
1121 | 1121 | </div></span> |
1122 | 1122 | |
1123 | 1123 | </li> |
1575 | 1575 | </h3><div class="docstring"> |
1576 | 1576 | <div class="discussion"> |
1577 | 1577 | |
1578 | <p>Set this item'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> | |
1579 | 1579 | |
1580 | 1580 | |
1581 | 1581 | </div> |
1715 | 1715 | </h3><div class="docstring"> |
1716 | 1716 | <div class="discussion"> |
1717 | 1717 | |
1718 | <p>Set this item'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> | |
1719 | 1719 | |
1720 | 1720 | |
1721 | 1721 | </div> |
1802 | 1802 | </h3><div class="docstring"> |
1803 | 1803 | <div class="discussion"> |
1804 | 1804 | |
1805 | <p>Set this item'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> | |
1806 | 1806 | |
1807 | 1807 | |
1808 | 1808 | </div> |
2174 | 2174 | </h3><div class="docstring"> |
2175 | 2175 | <div class="discussion"> |
2176 | 2176 | |
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> | |
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> | |
2178 | 2178 | |
2179 | 2179 | |
2180 | 2180 | </div> |
2248 | 2248 | </h3><div class="docstring"> |
2249 | 2249 | <div class="discussion"> |
2250 | 2250 | |
2251 | <p>Set this item'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> | |
2252 | 2252 | |
2253 | 2253 | |
2254 | 2254 | </div> |
2459 | 2459 | </h3><div class="docstring"> |
2460 | 2460 | <div class="discussion"> |
2461 | 2461 | |
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> | |
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> | |
2463 | 2463 | |
2464 | 2464 | |
2465 | 2465 | </div> |
2496 | 2496 | </h3><div class="docstring"> |
2497 | 2497 | <div class="discussion"> |
2498 | 2498 | |
2499 | <p>Set this item'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> | |
2500 | 2500 | |
2501 | 2501 | |
2502 | 2502 | </div> |
2768 | 2768 | </h3><div class="docstring"> |
2769 | 2769 | <div class="discussion"> |
2770 | 2770 | |
2771 | <p>Returns the item's text</p> | |
2771 | <p>Returns the item’s text</p> | |
2772 | 2772 | |
2773 | 2773 | |
2774 | 2774 | </div> |
2802 | 2802 | </div> |
2803 | 2803 | |
2804 | 2804 | <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). | |
2808 | 2808 | </div> |
2809 | 2809 | |
2810 | 2810 | </div> |
120 | 120 | <h2>Overview</h2><div class="docstring"> |
121 | 121 | <div class="discussion"> |
122 | 122 | |
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> | |
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> | |
124 | 124 | |
125 | 125 | <h3 id="label-Events">Events</h3> |
126 | 126 | |
839 | 839 | |
840 | 840 | |
841 | 841 | <span class="summary_desc"><div class='inline'> |
842 | <p>Set this item's state to closed.</p> | |
842 | <p>Set this item’s state to closed.</p> | |
843 | 843 | </div></span> |
844 | 844 | |
845 | 845 | </li> |
1175 | 1175 | |
1176 | 1176 | |
1177 | 1177 | <span class="summary_desc"><div class='inline'> |
1178 | <p>Return item's closed icon.</p> | |
1178 | <p>Return item’s closed icon.</p> | |
1179 | 1179 | </div></span> |
1180 | 1180 | |
1181 | 1181 | </li> |
1199 | 1199 | |
1200 | 1200 | |
1201 | 1201 | <span class="summary_desc"><div class='inline'> |
1202 | <p>Return item's user data.</p> | |
1202 | <p>Return item’s user data.</p> | |
1203 | 1203 | </div></span> |
1204 | 1204 | |
1205 | 1205 | </li> |
1247 | 1247 | |
1248 | 1248 | |
1249 | 1249 | <span class="summary_desc"><div class='inline'> |
1250 | <p>Return item's open icon.</p> | |
1250 | <p>Return item’s open icon.</p> | |
1251 | 1251 | </div></span> |
1252 | 1252 | |
1253 | 1253 | </li> |
1271 | 1271 | |
1272 | 1272 | |
1273 | 1273 | <span class="summary_desc"><div class='inline'> |
1274 | <p>Return item's text.</p> | |
1274 | <p>Return item’s text.</p> | |
1275 | 1275 | </div></span> |
1276 | 1276 | |
1277 | 1277 | </li> |
1681 | 1681 | |
1682 | 1682 | |
1683 | 1683 | <span class="summary_desc"><div class='inline'> |
1684 | <p>Set this item's state to opened.</p> | |
1684 | <p>Set this item’s state to opened.</p> | |
1685 | 1685 | </div></span> |
1686 | 1686 | |
1687 | 1687 | </li> |
1849 | 1849 | |
1850 | 1850 | |
1851 | 1851 | <span class="summary_desc"><div class='inline'> |
1852 | <p>Change item's closed icon, deleting the old icon if it's owned.</p> | |
1852 | <p>Change item’s closed icon, deleting the old icon if it’s owned.</p> | |
1853 | 1853 | </div></span> |
1854 | 1854 | |
1855 | 1855 | </li> |
1873 | 1873 | |
1874 | 1874 | |
1875 | 1875 | <span class="summary_desc"><div class='inline'> |
1876 | <p>Change item's user data.</p> | |
1876 | <p>Change item’s user data.</p> | |
1877 | 1877 | </div></span> |
1878 | 1878 | |
1879 | 1879 | </li> |
1897 | 1897 | |
1898 | 1898 | |
1899 | 1899 | <span class="summary_desc"><div class='inline'> |
1900 | <p>Change item's open icon, deleting the old icon if it's owned.</p> | |
1900 | <p>Change item’s open icon, deleting the old icon if it’s owned.</p> | |
1901 | 1901 | </div></span> |
1902 | 1902 | |
1903 | 1903 | </li> |
1921 | 1921 | |
1922 | 1922 | |
1923 | 1923 | <span class="summary_desc"><div class='inline'> |
1924 | <p>Change item's text.</p> | |
1924 | <p>Change item’s text.</p> | |
1925 | 1925 | </div></span> |
1926 | 1926 | |
1927 | 1927 | </li> |
3038 | 3038 | </h3><div class="docstring"> |
3039 | 3039 | <div class="discussion"> |
3040 | 3040 | |
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> | |
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> | |
3042 | 3042 | |
3043 | 3043 | |
3044 | 3044 | </div> |
3075 | 3075 | </h3><div class="docstring"> |
3076 | 3076 | <div class="discussion"> |
3077 | 3077 | |
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> | |
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> | |
3079 | 3079 | |
3080 | 3080 | |
3081 | 3081 | </div> |
3112 | 3112 | </h3><div class="docstring"> |
3113 | 3113 | <div class="discussion"> |
3114 | 3114 | |
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> | |
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> | |
3116 | 3116 | |
3117 | 3117 | |
3118 | 3118 | </div> |
3149 | 3149 | </h3><div class="docstring"> |
3150 | 3150 | <div class="discussion"> |
3151 | 3151 | |
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> | |
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> | |
3153 | 3153 | |
3154 | 3154 | |
3155 | 3155 | </div> |
3186 | 3186 | </h3><div class="docstring"> |
3187 | 3187 | <div class="discussion"> |
3188 | 3188 | |
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> | |
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> | |
3190 | 3190 | |
3191 | 3191 | |
3192 | 3192 | </div> |
3350 | 3350 | </h3><div class="docstring"> |
3351 | 3351 | <div class="discussion"> |
3352 | 3352 | |
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> | |
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> | |
3354 | 3354 | |
3355 | 3355 | |
3356 | 3356 | </div> |
3387 | 3387 | </h3><div class="docstring"> |
3388 | 3388 | <div class="discussion"> |
3389 | 3389 | |
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> | |
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> | |
3391 | 3391 | |
3392 | 3392 | |
3393 | 3393 | </div> |
3424 | 3424 | </h3><div class="docstring"> |
3425 | 3425 | <div class="discussion"> |
3426 | 3426 | |
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> | |
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> | |
3428 | 3428 | |
3429 | 3429 | |
3430 | 3430 | </div> |
3461 | 3461 | </h3><div class="docstring"> |
3462 | 3462 | <div class="discussion"> |
3463 | 3463 | |
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> | |
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> | |
3465 | 3465 | |
3466 | 3466 | |
3467 | 3467 | </div> |
3650 | 3650 | </h3><div class="docstring"> |
3651 | 3651 | <div class="discussion"> |
3652 | 3652 | |
3653 | <p>Return item's closed icon</p> | |
3653 | <p>Return item’s closed icon</p> | |
3654 | 3654 | |
3655 | 3655 | |
3656 | 3656 | </div> |
3687 | 3687 | </h3><div class="docstring"> |
3688 | 3688 | <div class="discussion"> |
3689 | 3689 | |
3690 | <p>Return item's user data</p> | |
3690 | <p>Return item’s user data</p> | |
3691 | 3691 | |
3692 | 3692 | |
3693 | 3693 | </div> |
3761 | 3761 | </h3><div class="docstring"> |
3762 | 3762 | <div class="discussion"> |
3763 | 3763 | |
3764 | <p>Return item's open icon</p> | |
3764 | <p>Return item’s open icon</p> | |
3765 | 3765 | |
3766 | 3766 | |
3767 | 3767 | </div> |
3798 | 3798 | </h3><div class="docstring"> |
3799 | 3799 | <div class="discussion"> |
3800 | 3800 | |
3801 | <p>Return item's text</p> | |
3801 | <p>Return item’s text</p> | |
3802 | 3802 | |
3803 | 3803 | |
3804 | 3804 | </div> |
3909 | 3909 | </h3><div class="docstring"> |
3910 | 3910 | <div class="discussion"> |
3911 | 3911 | |
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> | |
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> | |
3913 | 3913 | |
3914 | 3914 | |
3915 | 3915 | </div> |
4296 | 4296 | </h3><div class="docstring"> |
4297 | 4297 | <div class="discussion"> |
4298 | 4298 | |
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> | |
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> | |
4300 | 4300 | |
4301 | 4301 | |
4302 | 4302 | </div> |
4493 | 4493 | </h3><div class="docstring"> |
4494 | 4494 | <div class="discussion"> |
4495 | 4495 | |
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> | |
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> | |
4497 | 4497 | |
4498 | 4498 | |
4499 | 4499 | </div> |
4530 | 4530 | </h3><div class="docstring"> |
4531 | 4531 | <div class="discussion"> |
4532 | 4532 | |
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> | |
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> | |
4534 | 4534 | |
4535 | 4535 | |
4536 | 4536 | </div> |
4567 | 4567 | </h3><div class="docstring"> |
4568 | 4568 | <div class="discussion"> |
4569 | 4569 | |
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> | |
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> | |
4571 | 4571 | |
4572 | 4572 | |
4573 | 4573 | </div> |
4604 | 4604 | </h3><div class="docstring"> |
4605 | 4605 | <div class="discussion"> |
4606 | 4606 | |
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> | |
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> | |
4608 | 4608 | |
4609 | 4609 | |
4610 | 4610 | </div> |
4684 | 4684 | </h3><div class="docstring"> |
4685 | 4685 | <div class="discussion"> |
4686 | 4686 | |
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> | |
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> | |
4688 | 4688 | |
4689 | 4689 | |
4690 | 4690 | </div> |
4721 | 4721 | </h3><div class="docstring"> |
4722 | 4722 | <div class="discussion"> |
4723 | 4723 | |
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> | |
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> | |
4725 | 4725 | |
4726 | 4726 | |
4727 | 4727 | </div> |
4758 | 4758 | </h3><div class="docstring"> |
4759 | 4759 | <div class="discussion"> |
4760 | 4760 | |
4761 | <p>Change item's closed icon, deleting the old icon if it's owned</p> | |
4761 | <p>Change item’s closed icon, deleting the old icon if it’s owned</p> | |
4762 | 4762 | |
4763 | 4763 | |
4764 | 4764 | </div> |
4795 | 4795 | </h3><div class="docstring"> |
4796 | 4796 | <div class="discussion"> |
4797 | 4797 | |
4798 | <p>Change item's user data</p> | |
4798 | <p>Change item’s user data</p> | |
4799 | 4799 | |
4800 | 4800 | |
4801 | 4801 | </div> |
4832 | 4832 | </h3><div class="docstring"> |
4833 | 4833 | <div class="discussion"> |
4834 | 4834 | |
4835 | <p>Change item's open icon, deleting the old icon if it's owned</p> | |
4835 | <p>Change item’s open icon, deleting the old icon if it’s owned</p> | |
4836 | 4836 | |
4837 | 4837 | |
4838 | 4838 | </div> |
4869 | 4869 | </h3><div class="docstring"> |
4870 | 4870 | <div class="discussion"> |
4871 | 4871 | |
4872 | <p>Change item's text</p> | |
4872 | <p>Change item’s text</p> | |
4873 | 4873 | |
4874 | 4874 | |
4875 | 4875 | </div> |
5017 | 5017 | </h3><div class="docstring"> |
5018 | 5018 | <div class="discussion"> |
5019 | 5019 | |
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> | |
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> | |
5021 | 5021 | |
5022 | 5022 | |
5023 | 5023 | </div> |
5084 | 5084 | </div> |
5085 | 5085 | |
5086 | 5086 | <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). | |
5090 | 5090 | </div> |
5091 | 5091 | |
5092 | 5092 | </div> |
753 | 753 | |
754 | 754 | |
755 | 755 | <span class="summary_desc"><div class='inline'> |
756 | <p>Return item's closed icon.</p> | |
756 | <p>Return item’s closed icon.</p> | |
757 | 757 | </div></span> |
758 | 758 | |
759 | 759 | </li> |
777 | 777 | |
778 | 778 | |
779 | 779 | <span class="summary_desc"><div class='inline'> |
780 | <p>Return item's user data.</p> | |
780 | <p>Return item’s user data.</p> | |
781 | 781 | </div></span> |
782 | 782 | |
783 | 783 | </li> |
801 | 801 | |
802 | 802 | |
803 | 803 | <span class="summary_desc"><div class='inline'> |
804 | <p>Return item's open icon.</p> | |
804 | <p>Return item’s open icon.</p> | |
805 | 805 | </div></span> |
806 | 806 | |
807 | 807 | </li> |
825 | 825 | |
826 | 826 | |
827 | 827 | <span class="summary_desc"><div class='inline'> |
828 | <p>Return item's text.</p> | |
828 | <p>Return item’s text.</p> | |
829 | 829 | </div></span> |
830 | 830 | |
831 | 831 | </li> |
1091 | 1091 | |
1092 | 1092 | |
1093 | 1093 | <span class="summary_desc"><div class='inline'> |
1094 | <p>Change item's closed icon.</p> | |
1094 | <p>Change item’s closed icon.</p> | |
1095 | 1095 | </div></span> |
1096 | 1096 | |
1097 | 1097 | </li> |
1115 | 1115 | |
1116 | 1116 | |
1117 | 1117 | <span class="summary_desc"><div class='inline'> |
1118 | <p>Change item's user data.</p> | |
1118 | <p>Change item’s user data.</p> | |
1119 | 1119 | </div></span> |
1120 | 1120 | |
1121 | 1121 | </li> |
1139 | 1139 | |
1140 | 1140 | |
1141 | 1141 | <span class="summary_desc"><div class='inline'> |
1142 | <p>Change item's open icon.</p> | |
1142 | <p>Change item’s open icon.</p> | |
1143 | 1143 | </div></span> |
1144 | 1144 | |
1145 | 1145 | </li> |
1163 | 1163 | |
1164 | 1164 | |
1165 | 1165 | <span class="summary_desc"><div class='inline'> |
1166 | <p>Change item's text.</p> | |
1166 | <p>Change item’s text.</p> | |
1167 | 1167 | </div></span> |
1168 | 1168 | |
1169 | 1169 | </li> |
1981 | 1981 | </h3><div class="docstring"> |
1982 | 1982 | <div class="discussion"> |
1983 | 1983 | |
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> | |
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> | |
1985 | 1985 | |
1986 | 1986 | |
1987 | 1987 | </div> |
2018 | 2018 | </h3><div class="docstring"> |
2019 | 2019 | <div class="discussion"> |
2020 | 2020 | |
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> | |
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> | |
2022 | 2022 | |
2023 | 2023 | |
2024 | 2024 | </div> |
2145 | 2145 | </h3><div class="docstring"> |
2146 | 2146 | <div class="discussion"> |
2147 | 2147 | |
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> | |
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> | |
2149 | 2149 | |
2150 | 2150 | |
2151 | 2151 | </div> |
2297 | 2297 | </h3><div class="docstring"> |
2298 | 2298 | <div class="discussion"> |
2299 | 2299 | |
2300 | <p>Return item's closed icon</p> | |
2300 | <p>Return item’s closed icon</p> | |
2301 | 2301 | |
2302 | 2302 | |
2303 | 2303 | </div> |
2334 | 2334 | </h3><div class="docstring"> |
2335 | 2335 | <div class="discussion"> |
2336 | 2336 | |
2337 | <p>Return item's user data</p> | |
2337 | <p>Return item’s user data</p> | |
2338 | 2338 | |
2339 | 2339 | |
2340 | 2340 | </div> |
2371 | 2371 | </h3><div class="docstring"> |
2372 | 2372 | <div class="discussion"> |
2373 | 2373 | |
2374 | <p>Return item's open icon</p> | |
2374 | <p>Return item’s open icon</p> | |
2375 | 2375 | |
2376 | 2376 | |
2377 | 2377 | </div> |
2408 | 2408 | </h3><div class="docstring"> |
2409 | 2409 | <div class="discussion"> |
2410 | 2410 | |
2411 | <p>Return item's text</p> | |
2411 | <p>Return item’s text</p> | |
2412 | 2412 | |
2413 | 2413 | |
2414 | 2414 | </div> |
2445 | 2445 | </h3><div class="docstring"> |
2446 | 2446 | <div class="discussion"> |
2447 | 2447 | |
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> | |
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> | |
2449 | 2449 | |
2450 | 2450 | |
2451 | 2451 | </div> |
2669 | 2669 | </h3><div class="docstring"> |
2670 | 2670 | <div class="discussion"> |
2671 | 2671 | |
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> | |
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> | |
2673 | 2673 | |
2674 | 2674 | |
2675 | 2675 | </div> |
2706 | 2706 | </h3><div class="docstring"> |
2707 | 2707 | <div class="discussion"> |
2708 | 2708 | |
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> | |
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> | |
2710 | 2710 | |
2711 | 2711 | |
2712 | 2712 | </div> |
2743 | 2743 | </h3><div class="docstring"> |
2744 | 2744 | <div class="discussion"> |
2745 | 2745 | |
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> | |
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> | |
2747 | 2747 | |
2748 | 2748 | |
2749 | 2749 | </div> |
2780 | 2780 | </h3><div class="docstring"> |
2781 | 2781 | <div class="discussion"> |
2782 | 2782 | |
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> | |
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> | |
2784 | 2784 | |
2785 | 2785 | |
2786 | 2786 | </div> |
2817 | 2817 | </h3><div class="docstring"> |
2818 | 2818 | <div class="discussion"> |
2819 | 2819 | |
2820 | <p>Change item's closed icon</p> | |
2820 | <p>Change item’s closed icon</p> | |
2821 | 2821 | |
2822 | 2822 | |
2823 | 2823 | </div> |
2854 | 2854 | </h3><div class="docstring"> |
2855 | 2855 | <div class="discussion"> |
2856 | 2856 | |
2857 | <p>Change item's user data</p> | |
2857 | <p>Change item’s user data</p> | |
2858 | 2858 | |
2859 | 2859 | |
2860 | 2860 | </div> |
2891 | 2891 | </h3><div class="docstring"> |
2892 | 2892 | <div class="discussion"> |
2893 | 2893 | |
2894 | <p>Change item's open icon</p> | |
2894 | <p>Change item’s open icon</p> | |
2895 | 2895 | |
2896 | 2896 | |
2897 | 2897 | </div> |
2928 | 2928 | </h3><div class="docstring"> |
2929 | 2929 | <div class="discussion"> |
2930 | 2930 | |
2931 | <p>Change item's text</p> | |
2931 | <p>Change item’s text</p> | |
2932 | 2932 | |
2933 | 2933 | |
2934 | 2934 | </div> |
3069 | 3069 | </div> |
3070 | 3070 | |
3071 | 3071 | <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). | |
3075 | 3075 | </div> |
3076 | 3076 | |
3077 | 3077 | </div> |
411 | 411 | <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> |
412 | 412 | </dd><dt><code>text1</code> |
413 | 413 | <dd> |
414 | <p>the text for this tri-state button's first state [String]</p> | |
414 | <p>the text for this tri-state button’s first state [String]</p> | |
415 | 415 | </dd><dt><code>text2</code> |
416 | 416 | <dd> |
417 | <p>the text for this tri-state button's second state [String]</p> | |
417 | <p>the text for this tri-state button’s second state [String]</p> | |
418 | 418 | </dd><dt><code>text3</code> |
419 | 419 | <dd> |
420 | <p>the text for this tri-state button's third state [String]</p> | |
420 | <p>the text for this tri-state button’s third state [String]</p> | |
421 | 421 | </dd><dt><code>icon1</code> |
422 | 422 | <dd> |
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> | |
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> | |
424 | 424 | </dd><dt><code>icon2</code> |
425 | 425 | <dd> |
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> | |
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> | |
427 | 427 | </dd><dt><code>icon3</code> |
428 | 428 | <dd> |
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> | |
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> | |
430 | 430 | </dd><dt><code>target</code> |
431 | 431 | <dd> |
432 | 432 | <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> |
670 | 670 | </div> |
671 | 671 | |
672 | 672 | <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). | |
676 | 676 | </div> |
677 | 677 | |
678 | 678 | </div> |
112 | 112 | |
113 | 113 | <h2 id="label-Class+Constants">Class Constants</h2> |
114 | 114 | |
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> | |
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> | |
116 | 116 | |
117 | 117 | <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> |
118 | 118 | |
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> | |
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> | |
120 | 120 | |
121 | 121 | <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> |
122 | 122 | |
997 | 997 | <td> |
998 | 998 | <pre class="code"><span class="info file"># File 'lib/fox16/undolist.rb', line 94</span> |
999 | 999 | |
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> | |
1003 | 1003 | |
1004 | 1004 | <span class='comment'># Set up the message map for this instance |
1005 | 1005 | </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'>"</span><span class='tstring_content'>onCmdClear</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> |
2549 | 2549 | </div> |
2550 | 2550 | |
2551 | 2551 | <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). | |
2555 | 2555 | </div> |
2556 | 2556 | |
2557 | 2557 | </div> |
192 | 192 | |
193 | 193 | |
194 | 194 | <span class="summary_desc"><div class='inline'> |
195 | <p>Returns a new FXVec2d instance obtained by memberwise multiplication of this vector'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> | |
196 | 196 | </div></span> |
197 | 197 | |
198 | 198 | </li> |
288 | 288 | |
289 | 289 | |
290 | 290 | <span class="summary_desc"><div class='inline'> |
291 | <p>Returns a new FXVec2d instance obtained by memberwise division of this vector'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> | |
292 | 292 | </div></span> |
293 | 293 | |
294 | 294 | </li> |
783 | 783 | </h3><div class="docstring"> |
784 | 784 | <div class="discussion"> |
785 | 785 | |
786 | <p>Returns a new FXVec2d instance obtained by memberwise multiplication of this vector'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> | |
787 | 787 | |
788 | 788 | |
789 | 789 | </div> |
931 | 931 | </h3><div class="docstring"> |
932 | 932 | <div class="discussion"> |
933 | 933 | |
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> | |
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> | |
935 | 935 | |
936 | 936 | |
937 | 937 | </div> |
1439 | 1439 | </div> |
1440 | 1440 | |
1441 | 1441 | <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). | |
1445 | 1445 | </div> |
1446 | 1446 | |
1447 | 1447 | </div> |
192 | 192 | |
193 | 193 | |
194 | 194 | <span class="summary_desc"><div class='inline'> |
195 | <p>Returns a new FXVec2f instance obtained by memberwise multiplication of this vector'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> | |
196 | 196 | </div></span> |
197 | 197 | |
198 | 198 | </li> |
288 | 288 | |
289 | 289 | |
290 | 290 | <span class="summary_desc"><div class='inline'> |
291 | <p>Returns a new FXVec2f instance obtained by memberwise division of this vector'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> | |
292 | 292 | </div></span> |
293 | 293 | |
294 | 294 | </li> |
783 | 783 | </h3><div class="docstring"> |
784 | 784 | <div class="discussion"> |
785 | 785 | |
786 | <p>Returns a new FXVec2f instance obtained by memberwise multiplication of this vector'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> | |
787 | 787 | |
788 | 788 | |
789 | 789 | </div> |
931 | 931 | </h3><div class="docstring"> |
932 | 932 | <div class="discussion"> |
933 | 933 | |
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> | |
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> | |
935 | 935 | |
936 | 936 | |
937 | 937 | </div> |
1431 | 1431 | </div> |
1432 | 1432 | |
1433 | 1433 | <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). | |
1437 | 1437 | </div> |
1438 | 1438 | |
1439 | 1439 | </div> |
252 | 252 | |
253 | 253 | |
254 | 254 | <span class="summary_desc"><div class='inline'> |
255 | <p>Returns a new FXVec3d instance obtained by memberwise multiplication of this vector'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> | |
256 | 256 | </div></span> |
257 | 257 | |
258 | 258 | </li> |
348 | 348 | |
349 | 349 | |
350 | 350 | <span class="summary_desc"><div class='inline'> |
351 | <p>Returns a new FXVec3d instance obtained by memberwise division of this vector'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> | |
352 | 352 | </div></span> |
353 | 353 | |
354 | 354 | </li> |
953 | 953 | </h3><div class="docstring"> |
954 | 954 | <div class="discussion"> |
955 | 955 | |
956 | <p>Returns a new FXVec3d instance obtained by memberwise multiplication of this vector'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> | |
957 | 957 | |
958 | 958 | |
959 | 959 | </div> |
1101 | 1101 | </h3><div class="docstring"> |
1102 | 1102 | <div class="discussion"> |
1103 | 1103 | |
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> | |
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> | |
1105 | 1105 | |
1106 | 1106 | |
1107 | 1107 | </div> |
1638 | 1638 | </div> |
1639 | 1639 | |
1640 | 1640 | <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). | |
1644 | 1644 | </div> |
1645 | 1645 | |
1646 | 1646 | </div> |
252 | 252 | |
253 | 253 | |
254 | 254 | <span class="summary_desc"><div class='inline'> |
255 | <p>Returns a new FXVec3f instance obtained by memberwise multiplication of this vector'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> | |
256 | 256 | </div></span> |
257 | 257 | |
258 | 258 | </li> |
348 | 348 | |
349 | 349 | |
350 | 350 | <span class="summary_desc"><div class='inline'> |
351 | <p>Returns a new FXVec3f instance obtained by memberwise division of this vector'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> | |
352 | 352 | </div></span> |
353 | 353 | |
354 | 354 | </li> |
953 | 953 | </h3><div class="docstring"> |
954 | 954 | <div class="discussion"> |
955 | 955 | |
956 | <p>Returns a new FXVec3f instance obtained by memberwise multiplication of this vector'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> | |
957 | 957 | |
958 | 958 | |
959 | 959 | </div> |
1101 | 1101 | </h3><div class="docstring"> |
1102 | 1102 | <div class="discussion"> |
1103 | 1103 | |
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> | |
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> | |
1105 | 1105 | |
1106 | 1106 | |
1107 | 1107 | </div> |
1638 | 1638 | </div> |
1639 | 1639 | |
1640 | 1640 | <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). | |
1644 | 1644 | </div> |
1645 | 1645 | |
1646 | 1646 | </div> |
283 | 283 | |
284 | 284 | |
285 | 285 | <span class="summary_desc"><div class='inline'> |
286 | <p>Returns a new FXVec4d instance obtained by memberwise multiplication of this vector'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> | |
287 | 287 | </div></span> |
288 | 288 | |
289 | 289 | </li> |
379 | 379 | |
380 | 380 | |
381 | 381 | <span class="summary_desc"><div class='inline'> |
382 | <p>Returns a new FXVec4d instance obtained by memberwise division of this vector'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> | |
383 | 383 | </div></span> |
384 | 384 | |
385 | 385 | </li> |
1075 | 1075 | </h3><div class="docstring"> |
1076 | 1076 | <div class="discussion"> |
1077 | 1077 | |
1078 | <p>Returns a new FXVec4d instance obtained by memberwise multiplication of this vector'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> | |
1079 | 1079 | |
1080 | 1080 | |
1081 | 1081 | </div> |
1223 | 1223 | </h3><div class="docstring"> |
1224 | 1224 | <div class="discussion"> |
1225 | 1225 | |
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> | |
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> | |
1227 | 1227 | |
1228 | 1228 | |
1229 | 1229 | </div> |
1847 | 1847 | </div> |
1848 | 1848 | |
1849 | 1849 | <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). | |
1853 | 1853 | </div> |
1854 | 1854 | |
1855 | 1855 | </div> |
283 | 283 | |
284 | 284 | |
285 | 285 | <span class="summary_desc"><div class='inline'> |
286 | <p>Returns a new FXVec4f instance obtained by memberwise multiplication of this vector'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> | |
287 | 287 | </div></span> |
288 | 288 | |
289 | 289 | </li> |
379 | 379 | |
380 | 380 | |
381 | 381 | <span class="summary_desc"><div class='inline'> |
382 | <p>Returns a new FXVec4f instance obtained by memberwise division of this vector'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> | |
383 | 383 | </div></span> |
384 | 384 | |
385 | 385 | </li> |
1075 | 1075 | </h3><div class="docstring"> |
1076 | 1076 | <div class="discussion"> |
1077 | 1077 | |
1078 | <p>Returns a new FXVec4f instance obtained by memberwise multiplication of this vector'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> | |
1079 | 1079 | |
1080 | 1080 | |
1081 | 1081 | </div> |
1223 | 1223 | </h3><div class="docstring"> |
1224 | 1224 | <div class="discussion"> |
1225 | 1225 | |
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> | |
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> | |
1227 | 1227 | |
1228 | 1228 | |
1229 | 1229 | </div> |
1847 | 1847 | </div> |
1848 | 1848 | |
1849 | 1849 | <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). | |
1853 | 1853 | </div> |
1854 | 1854 | |
1855 | 1855 | </div> |
113 | 113 | <h2>Overview</h2><div class="docstring"> |
114 | 114 | <div class="discussion"> |
115 | 115 | |
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> | |
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> | |
117 | 117 | |
118 | 118 | |
119 | 119 | </div> |
348 | 348 | </div> |
349 | 349 | |
350 | 350 | <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). | |
354 | 354 | </div> |
355 | 355 | |
356 | 356 | </div> |
338 | 338 | </div> |
339 | 339 | |
340 | 340 | <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). | |
344 | 344 | </div> |
345 | 345 | |
346 | 346 | </div> |
769 | 769 | </div> |
770 | 770 | |
771 | 771 | <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). | |
775 | 775 | </div> |
776 | 776 | |
777 | 777 | </div> |
1012 | 1012 | </div> |
1013 | 1013 | |
1014 | 1014 | <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). | |
1018 | 1018 | </div> |
1019 | 1019 | |
1020 | 1020 | </div> |
127 | 127 | <p>sent when the window is unmapped; the message data is an FXEvent instance.</p> |
128 | 128 | </dd><dt><code>SEL_CONFIGURE</code> |
129 | 129 | <dd> |
130 | <p>sent when the window'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> | |
131 | 131 | </dd><dt><code>SEL_ENTER</code> |
132 | 132 | <dd> |
133 | 133 | <p>sent when the mouse cursor enters this window</p> |
193 | 193 | <p>sent when this window loses the selection</p> |
194 | 194 | </dd><dt><code>SEL_SELECTION_REQUEST</code> |
195 | 195 | <dd> |
196 | <p>sent when this window's selection is requested</p> | |
196 | <p>sent when this window’s selection is requested</p> | |
197 | 197 | </dd></dl> |
198 | 198 | |
199 | 199 | <p>For each of the following clipboard-related events, the message data is an FXEvent instance:</p> |
205 | 205 | <p>sent when this window loses the clipboard</p> |
206 | 206 | </dd><dt><code>SEL_CLIPBOARD_REQUEST</code> |
207 | 207 | <dd> |
208 | <p>sent when this window's clipboard data is requested</p> | |
208 | <p>sent when this window’s clipboard data is requested</p> | |
209 | 209 | </dd></dl> |
210 | 210 | |
211 | 211 | <p>For each of the following drag-and-drop events, the message data is an FXEvent instance:</p> |
644 | 644 | |
645 | 645 | |
646 | 646 | <span class="summary_desc"><div class='inline'> |
647 | <p>This window'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> | |
648 | 648 | </div></span> |
649 | 649 | |
650 | 650 | </li> |
729 | 729 | |
730 | 730 | |
731 | 731 | <span class="summary_desc"><div class='inline'> |
732 | <p>This window'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> | |
733 | 733 | </div></span> |
734 | 734 | |
735 | 735 | </li> |
843 | 843 | |
844 | 844 | |
845 | 845 | <span class="summary_desc"><div class='inline'> |
846 | <p>This window'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> | |
847 | 847 | </div></span> |
848 | 848 | |
849 | 849 | </li> |
872 | 872 | |
873 | 873 | |
874 | 874 | <span class="summary_desc"><div class='inline'> |
875 | <p>This window'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> | |
876 | 876 | </div></span> |
877 | 877 | |
878 | 878 | </li> |
1040 | 1040 | |
1041 | 1041 | |
1042 | 1042 | <span class="summary_desc"><div class='inline'> |
1043 | <p>This window's x-coordinate, in the parent's coordinate system [Integer].</p> | |
1043 | <p>This window’s x-coordinate, in the parent’s coordinate system [Integer].</p> | |
1044 | 1044 | </div></span> |
1045 | 1045 | |
1046 | 1046 | </li> |
1067 | 1067 | |
1068 | 1068 | |
1069 | 1069 | <span class="summary_desc"><div class='inline'> |
1070 | <p>This window's y-coordinate, in the parent's coordinate system [Integer].</p> | |
1070 | <p>This window’s y-coordinate, in the parent’s coordinate system [Integer].</p> | |
1071 | 1071 | </div></span> |
1072 | 1072 | |
1073 | 1073 | </li> |
1675 | 1675 | |
1676 | 1676 | |
1677 | 1677 | <span class="summary_desc"><div class='inline'> |
1678 | <p>Add this hot key to the closest ancestor's accelerator table.</p> | |
1678 | <p>Add this hot key to the closest ancestor’s accelerator table.</p> | |
1679 | 1679 | </div></span> |
1680 | 1680 | |
1681 | 1681 | </li> |
3165 | 3165 | |
3166 | 3166 | |
3167 | 3167 | <span class="summary_desc"><div class='inline'> |
3168 | <p>Relink this window after sibling window <em>other</em>, in the parent's window list.</p> | |
3168 | <p>Relink this window after sibling window <em>other</em>, in the parent’s window list.</p> | |
3169 | 3169 | </div></span> |
3170 | 3170 | |
3171 | 3171 | </li> |
3189 | 3189 | |
3190 | 3190 | |
3191 | 3191 | <span class="summary_desc"><div class='inline'> |
3192 | <p>Relink this window before sibling window <em>other</em>, in the parent's window list.</p> | |
3192 | <p>Relink this window before sibling window <em>other</em>, in the parent’s window list.</p> | |
3193 | 3193 | </div></span> |
3194 | 3194 | |
3195 | 3195 | </li> |
3237 | 3237 | |
3238 | 3238 | |
3239 | 3239 | <span class="summary_desc"><div class='inline'> |
3240 | <p>Move the window immediately, in the parent's coordinate system.</p> | |
3240 | <p>Move the window immediately, in the parent’s coordinate system.</p> | |
3241 | 3241 | </div></span> |
3242 | 3242 | |
3243 | 3243 | </li> |
3285 | 3285 | |
3286 | 3286 | |
3287 | 3287 | <span class="summary_desc"><div class='inline'> |
3288 | <p>Move and resize the window immediately, in the parent's coordinate system.</p> | |
3288 | <p>Move and resize the window immediately, in the parent’s coordinate system.</p> | |
3289 | 3289 | </div></span> |
3290 | 3290 | |
3291 | 3291 | </li> |
3333 | 3333 | |
3334 | 3334 | |
3335 | 3335 | <span class="summary_desc"><div class='inline'> |
3336 | <p>Mark this window's layout as dirty.</p> | |
3336 | <p>Mark this window’s layout as dirty.</p> | |
3337 | 3337 | </div></span> |
3338 | 3338 | |
3339 | 3339 | </li> |
3405 | 3405 | |
3406 | 3406 | |
3407 | 3407 | <span class="summary_desc"><div class='inline'> |
3408 | <p>Remove this hot key from the closest ancestor's accelerator table.</p> | |
3408 | <p>Remove this hot key from the closest ancestor’s accelerator table.</p> | |
3409 | 3409 | </div></span> |
3410 | 3410 | |
3411 | 3411 | </li> |
3815 | 3815 | |
3816 | 3816 | |
3817 | 3817 | <span class="summary_desc"><div class='inline'> |
3818 | <p>Translate coordinates (<em>fromX</em>, <em>fromY</em>) from <em>fromWindow</em>'s coordinate system to this window'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> | |
3819 | 3819 | </div></span> |
3820 | 3820 | |
3821 | 3821 | </li> |
3839 | 3839 | |
3840 | 3840 | |
3841 | 3841 | <span class="summary_desc"><div class='inline'> |
3842 | <p>Translate coordinates (<em>fromX</em>, <em>fromY</em>) from this window's coordinate system to <em>toWindow</em>'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> | |
3843 | 3843 | </div></span> |
3844 | 3844 | |
3845 | 3845 | </li> |
4312 | 4312 | </h3><div class="docstring"> |
4313 | 4313 | <div class="discussion"> |
4314 | 4314 | |
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> | |
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> | |
4316 | 4316 | |
4317 | 4317 | |
4318 | 4318 | </div> |
4441 | 4441 | </h3><div class="docstring"> |
4442 | 4442 | <div class="discussion"> |
4443 | 4443 | |
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> | |
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> | |
4445 | 4445 | |
4446 | 4446 | |
4447 | 4447 | </div> |
4613 | 4613 | </h3><div class="docstring"> |
4614 | 4614 | <div class="discussion"> |
4615 | 4615 | |
4616 | <p>This window'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> | |
4617 | 4617 | |
4618 | 4618 | |
4619 | 4619 | </div> |
4656 | 4656 | </h3><div class="docstring"> |
4657 | 4657 | <div class="discussion"> |
4658 | 4658 | |
4659 | <p>This window'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> | |
4660 | 4660 | |
4661 | 4661 | |
4662 | 4662 | </div> |
4914 | 4914 | </h3><div class="docstring"> |
4915 | 4915 | <div class="discussion"> |
4916 | 4916 | |
4917 | <p>This window's x-coordinate, in the parent's coordinate system [Integer]</p> | |
4917 | <p>This window’s x-coordinate, in the parent’s coordinate system [Integer]</p> | |
4918 | 4918 | |
4919 | 4919 | |
4920 | 4920 | </div> |
4957 | 4957 | </h3><div class="docstring"> |
4958 | 4958 | <div class="discussion"> |
4959 | 4959 | |
4960 | <p>This window's y-coordinate, in the parent's coordinate system [Integer]</p> | |
4960 | <p>This window’s y-coordinate, in the parent’s coordinate system [Integer]</p> | |
4961 | 4961 | |
4962 | 4962 | |
4963 | 4963 | </div> |
5920 | 5920 | </h3><div class="docstring"> |
5921 | 5921 | <div class="discussion"> |
5922 | 5922 | |
5923 | <p>Add this hot key to the closest ancestor's accelerator table.</p> | |
5923 | <p>Add this hot key to the closest ancestor’s accelerator table.</p> | |
5924 | 5924 | |
5925 | 5925 | |
5926 | 5926 | </div> |
8518 | 8518 | </h3><div class="docstring"> |
8519 | 8519 | <div class="discussion"> |
8520 | 8520 | |
8521 | <p>Relink this window after sibling window <em>other</em>, in the parent's window list.</p> | |
8521 | <p>Relink this window after sibling window <em>other</em>, in the parent’s window list.</p> | |
8522 | 8522 | |
8523 | 8523 | |
8524 | 8524 | </div> |
8559 | 8559 | </h3><div class="docstring"> |
8560 | 8560 | <div class="discussion"> |
8561 | 8561 | |
8562 | <p>Relink this window before sibling window <em>other</em>, in the parent's window list.</p> | |
8562 | <p>Relink this window before sibling window <em>other</em>, in the parent’s window list.</p> | |
8563 | 8563 | |
8564 | 8564 | |
8565 | 8565 | </div> |
8637 | 8637 | </h3><div class="docstring"> |
8638 | 8638 | <div class="discussion"> |
8639 | 8639 | |
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> | |
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> | |
8641 | 8641 | |
8642 | 8642 | |
8643 | 8643 | </div> |
8724 | 8724 | </h3><div class="docstring"> |
8725 | 8725 | <div class="discussion"> |
8726 | 8726 | |
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> | |
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> | |
8728 | 8728 | |
8729 | 8729 | |
8730 | 8730 | </div> |
8798 | 8798 | </h3><div class="docstring"> |
8799 | 8799 | <div class="discussion"> |
8800 | 8800 | |
8801 | <p>Mark this window's layout as dirty</p> | |
8801 | <p>Mark this window’s layout as dirty</p> | |
8802 | 8802 | |
8803 | 8803 | |
8804 | 8804 | </div> |
8909 | 8909 | </h3><div class="docstring"> |
8910 | 8910 | <div class="discussion"> |
8911 | 8911 | |
8912 | <p>Remove this hot key from the closest ancestor's accelerator table.</p> | |
8912 | <p>Remove this hot key from the closest ancestor’s accelerator table.</p> | |
8913 | 8913 | |
8914 | 8914 | |
8915 | 8915 | </div> |
9586 | 9586 | </h3><div class="docstring"> |
9587 | 9587 | <div class="discussion"> |
9588 | 9588 | |
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> | |
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> | |
9590 | 9590 | |
9591 | 9591 | |
9592 | 9592 | </div> |
9623 | 9623 | </h3><div class="docstring"> |
9624 | 9624 | <div class="discussion"> |
9625 | 9625 | |
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> | |
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> | |
9627 | 9627 | |
9628 | 9628 | |
9629 | 9629 | </div> |
9937 | 9937 | </div> |
9938 | 9938 | |
9939 | 9939 | <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). | |
9943 | 9943 | </div> |
9944 | 9944 | |
9945 | 9945 | </div> |
1041 | 1041 | </div> |
1042 | 1042 | |
1043 | 1043 | <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). | |
1047 | 1047 | </div> |
1048 | 1048 | |
1049 | 1049 | </div> |
442 | 442 | </div> |
443 | 443 | |
444 | 444 | <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). | |
448 | 448 | </div> |
449 | 449 | |
450 | 450 | </div> |
426 | 426 | </div> |
427 | 427 | |
428 | 428 | <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). | |
432 | 432 | </div> |
433 | 433 | |
434 | 434 | </div> |
439 | 439 | </div> |
440 | 440 | |
441 | 441 | <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). | |
445 | 445 | </div> |
446 | 446 | |
447 | 447 | </div> |
423 | 423 | </div> |
424 | 424 | |
425 | 425 | <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). | |
429 | 429 | </div> |
430 | 430 | |
431 | 431 | </div> |
275 | 275 | </div> |
276 | 276 | |
277 | 277 | <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). | |
281 | 281 | </div> |
282 | 282 | |
283 | 283 | </div> |
1427 | 1427 | </div> |
1428 | 1428 | |
1429 | 1429 | <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). | |
1433 | 1433 | </div> |
1434 | 1434 | |
1435 | 1435 | </div> |
270 | 270 | </div> |
271 | 271 | |
272 | 272 | <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). | |
276 | 276 | </div> |
277 | 277 | |
278 | 278 | </div> |
9100 | 9100 | </h3><div class="docstring"> |
9101 | 9101 | <div class="discussion"> |
9102 | 9102 | |
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> | |
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> | |
9104 | 9104 | |
9105 | 9105 | |
9106 | 9106 | </div> |
9192 | 9192 | </h3><div class="docstring"> |
9193 | 9193 | <div class="discussion"> |
9194 | 9194 | |
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> | |
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> | |
9196 | 9196 | |
9197 | 9197 | |
9198 | 9198 | </div> |
9862 | 9862 | </h3><div class="docstring"> |
9863 | 9863 | <div class="discussion"> |
9864 | 9864 | |
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> | |
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> | |
9866 | 9866 | |
9867 | 9867 | <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'>"</span><span class='tstring_content'>Ctrl+Alt+F7</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> |
9868 | 9868 | </code></pre> |
10143 | 10143 | <pre class="code"><span class="info file"># File 'lib/fox16/version.rb', line 2</span> |
10144 | 10144 | |
10145 | 10145 | <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'>"</span><span class='tstring_content'>1.6.43</span><span class='tstring_end'>"</span></span> | |
10146 | <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1.6.45</span><span class='tstring_end'>"</span></span> | |
10147 | 10147 | <span class='kw'>end</span></pre> |
10148 | 10148 | </td> |
10149 | 10149 | </tr> |
11173 | 11173 | </div> |
11174 | 11174 | |
11175 | 11175 | <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). | |
11179 | 11179 | </div> |
11180 | 11180 | |
11181 | 11181 | </div> |
193 | 193 | </div> |
194 | 194 | |
195 | 195 | <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). | |
199 | 199 | </div> |
200 | 200 | |
201 | 201 | </div> |
587 | 587 | </h3><div class="docstring"> |
588 | 588 | <div class="discussion"> |
589 | 589 | |
590 | <p>Generates identifiers as class constants. Originally submitted by Sean O'Halpin, slightly modified by Lyle.</p> | |
590 | <p>Generates identifiers as class constants. Originally submitted by Sean O’Halpin, slightly modified by Lyle.</p> | |
591 | 591 | |
592 | 592 | |
593 | 593 | </div> |
682 | 682 | </div> |
683 | 683 | |
684 | 684 | <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). | |
688 | 688 | </div> |
689 | 689 | |
690 | 690 | </div> |
214 | 214 | </div> |
215 | 215 | |
216 | 216 | <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). | |
220 | 220 | </div> |
221 | 221 | |
222 | 222 | </div> |
2090 | 2090 | </div> |
2091 | 2091 | |
2092 | 2092 | <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). | |
2096 | 2096 | </div> |
2097 | 2097 | |
2098 | 2098 | </div> |
51 | 51 | background: #fff; |
52 | 52 | padding: 1.2em; |
53 | 53 | padding-top: 0.2em; |
54 | box-sizing: border-box; | |
54 | 55 | } |
55 | 56 | |
56 | 57 | @media (max-width: 920px) { |
57 | 57 | </div> |
58 | 58 | |
59 | 59 | <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 | ||
60 | 74 | <h2 id="label-1.6.43+-2F+2020-11-27">1.6.43 / 2020-11-27</h2> |
61 | 75 | <ul><li> |
62 | 76 | <p>Make FXRuby compatible to ruby-3.0</p> |
183 | 197 | <ul><li> |
184 | 198 | <p>Avoid rb_* calls that are prohibited during GC. Fixes #23</p> |
185 | 199 | </li><li> |
186 | <p>Use copy'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> | |
187 | 201 | </li><li> |
188 | 202 | <p>Fix test suite, so that all tests pass.</p> |
189 | 203 | </li><li> |
196 | 210 | </li><li> |
197 | 211 | <p>Use release mode, unless extconf.rb is called with –enable-debug, so that all FXTRACE() and FXASSERT() calls are skiped, per default.</p> |
198 | 212 | </li><li> |
199 | <p>Remove self made GC detection by ruby's rb_during_gc().</p> | |
213 | <p>Remove self made GC detection by ruby’s rb_during_gc().</p> | |
200 | 214 | </li><li> |
201 | 215 | <p>Fix Windows binary x86-mingw32.gem for Ruby versions < 2.0</p> |
202 | 216 | </li></ul> |
212 | 226 | <ul><li> |
213 | 227 | <p>Fix crashes in rb_gc_mark(): 0x00000003f54af8 is T_ZOMBIE / T_NONE</p> |
214 | 228 | </li><li> |
215 | <p>Release Ruby'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> | |
216 | 230 | </li><li> |
217 | 231 | <p>Add a working version for FXApp#addInput event handling on Windows. This works for sockets only for now.</p> |
218 | 232 | </li><li> |
227 | 241 | </li><li> |
228 | 242 | <p>Use shared libs for Windows binary gems to reduce gem size.</p> |
229 | 243 | </li><li> |
230 | <p>Allow non owned assignment of image data to FXImage derivations without copy'ing pixel data.</p> | |
244 | <p>Allow non owned assignment of image data to FXImage derivations without copy’ing pixel data.</p> | |
231 | 245 | </li><li> |
232 | 246 | <p>Allow retrival of parts of the pixel data.</p> |
233 | 247 | </li><li> |
234 | 248 | <p>Fix namespace specifier for FXRGB in kwargs.rb.</p> |
235 | 249 | </li><li> |
236 | <p>Change GC'ing of TreeListBox and FXTreeItem. Fixes #10</p> | |
250 | <p>Change GC’ing of TreeListBox and FXTreeItem. Fixes #10</p> | |
237 | 251 | </li><li> |
238 | 252 | <p>Update to swig version 2.0 or newer. Fixes #13</p> |
239 | 253 | </li></ul> |
300 | 314 | </li><li> |
301 | 315 | <p>Fix double referenced foxObj when borrowed object registration is triggered from C++</p> |
302 | 316 | </li><li> |
303 | <p>Fix Segfault while GC'ing FXWindows</p> | |
304 | </li><li> | |
305 | <p>Fix 'object allocation not allowed while garbage collection' 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> | |
306 | 320 | </li><li> |
307 | 321 | <p>Fix clipboard handling on windows</p> |
308 | 322 | </li><li> |
325 | 339 | </li><li> |
326 | 340 | <p>Did some work to provide support for MinGW builds.</p> |
327 | 341 | </li><li> |
328 | <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> | |
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> | |
329 | 343 | </li></ul> |
330 | 344 | |
331 | 345 | <h2 id="label-Changes+For+Version+1.6.19+-28March+6-2C+2009-29">Changes For Version 1.6.19 (March 6, 2009)</h2> |
332 | 346 | <ul><li> |
333 | <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> | |
334 | </li><li> | |
335 | <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> | |
336 | </li><li> | |
337 | <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> | |
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> | |
338 | 352 | </li><li> |
339 | 353 | <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> |
340 | 354 | </li></ul> |
348 | 362 | <ul><li> |
349 | 363 | <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> |
350 | 364 | </li><li> |
351 | <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> | |
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> | |
352 | 366 | </li><li> |
353 | 367 | <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> |
354 | 368 | </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'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> | |
356 | 370 | </li><li> |
357 | 371 | <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> |
358 | 372 | </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'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> | |
360 | 374 | </li><li> |
361 | 375 | <p>Made a number of minor fixes for compatibility with Ruby 1.9.1.</p> |
362 | 376 | </li></ul> |
365 | 379 | <ul><li> |
366 | 380 | <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> |
367 | 381 | </li><li> |
368 | <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> | |
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> | |
369 | 383 | </li></ul> |
370 | 384 | |
371 | 385 | <h2 id="label-Changes+For+Version+1.6.15+-28June+4-2C+2008-29">Changes For Version 1.6.15 (June 4, 2008)</h2> |
374 | 388 | </li><li> |
375 | 389 | <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> |
376 | 390 | </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'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'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> | |
380 | 394 | </li><li> |
381 | 395 | <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> |
382 | 396 | </li><li> |
383 | <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> | |
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> | |
384 | 398 | </li><li> |
385 | 399 | <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> |
386 | 400 | </li><li> |
389 | 403 | |
390 | 404 | <h2 id="label-Changes+For+Version+1.6.14+-28March+29-2C+2008-29">Changes For Version 1.6.14 (March 29, 2008)</h2> |
391 | 405 | <ul><li> |
392 | <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> | |
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> | |
393 | 407 | </li><li> |
394 | 408 | <p>Corrected a little typo in the <code>gembrowser.rb</code> example program.</p> |
395 | 409 | </li><li> |
399 | 413 | </li><li> |
400 | 414 | <p>Made a number of minor fixes to support building FXRuby against Ruby 1.9.</p> |
401 | 415 | </li><li> |
402 | <p>Added a binary gem for OS X. This works with the Ruby that'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> | |
403 | 417 | </li><li> |
404 | 418 | <p>The binary gem for Windows was built with FOX version 1.6.32 and FXScintilla version 1.71.</p> |
405 | 419 | </li></ul> |
446 | 460 | </li><li> |
447 | 461 | <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> |
448 | 462 | </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'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> | |
450 | 464 | </li><li> |
451 | 465 | <p>The binary gem for Windows was built with FOX version 1.6.25 and FXScintilla version 1.71.</p> |
452 | 466 | </li></ul> |
488 | 502 | </li><li> |
489 | 503 | <p>Most of the FXRuby example programs have been updated to use the keyword arguments library.</p> |
490 | 504 | </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'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> | |
492 | 506 | </li><li> |
493 | 507 | <p>The binary gem for Windows was built with FOX version 1.6.20 and FXScintilla version 1.71.</p> |
494 | 508 | </li></ul> |
505 | 519 | </li><li> |
506 | 520 | <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> |
507 | 521 | </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'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> | |
509 | 523 | </li><li> |
510 | 524 | <p>The binary gem for Windows was built with FOX version 1.6.20 and FXScintilla version 1.71.</p> |
511 | 525 | </li></ul> |
519 | 533 | |
520 | 534 | <h2 id="label-Changes+For+Version+1.6.3+-28October+27-2C+2006-29">Changes For Version 1.6.3 (October 27, 2006)</h2> |
521 | 535 | <ul><li> |
522 | <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> | |
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> | |
523 | 537 | </li><li> |
524 | 538 | <p>The <code>getControlFor</code> method for the <code>FXComboTableItem</code> class was coded incorrectly (see RubyForge Bug #5906). This has been fixed.</p> |
525 | 539 | </li><li> |
544 | 558 | </li><li> |
545 | 559 | <p>The <code>FXDockTitle</code> class was not supported (see RubyForge Bug #5632). This has been fixed.</p> |
546 | 560 | </li><li> |
547 | <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> | |
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> | |
548 | 562 | </li><li> |
549 | 563 | <p>The <code>FXGradientBar</code> class was not supported (see RubyForge Bug #5746). This has been fixed.</p> |
550 | 564 | </li><li> |
561 | 575 | </li><li> |
562 | 576 | <p>The <code>FXDockTitle</code> class was not supported (see RubyForge Bug #5632). This has been fixed.</p> |
563 | 577 | </li><li> |
564 | <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> | |
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> | |
565 | 579 | </li><li> |
566 | 580 | <p>The <code>FXGradientBar</code> class was not supported (see RubyForge Bug #5746). This has been fixed.</p> |
567 | 581 | </li><li> |
572 | 586 | <ul><li> |
573 | 587 | <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> |
574 | 588 | </li><li> |
575 | <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> | |
576 | </li><li> | |
577 | <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> | |
578 | </li><li> | |
579 | <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> | |
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> | |
580 | 594 | </li><li> |
581 | 595 | <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> |
582 | 596 | </li><li> |
586 | 600 | </li><li> |
587 | 601 | <p>The <code>dilbert.rb</code> example program has been modified to use the RubyfulSoup HTML library instead of the html-parser library.</p> |
588 | 602 | </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 '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> | |
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> | |
590 | 604 | </li><li> |
591 | 605 | <p>The binary gem for Windows was built with FOX version 1.6.8 and FXScintilla version 1.67 (from CVS).</p> |
592 | 606 | </li></ul> |
616 | 630 | </li><li> |
617 | 631 | <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> |
618 | 632 | </li><li> |
619 | <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> | |
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> | |
620 | 634 | </li><li> |
621 | 635 | <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> |
622 | 636 | </li><li> |
637 | 651 | </li><li> |
638 | 652 | <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> |
639 | 653 | </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'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> | |
641 | 655 | </li><li> |
642 | 656 | <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> |
643 | 657 | </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'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> | |
645 | 659 | </li><li> |
646 | 660 | <p>The binary gem for Windows was built with FOX version 1.4.29 and FXScintilla version 1.63.</p> |
647 | 661 | </li></ul> |
671 | 685 | </li><li> |
672 | 686 | <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> |
673 | 687 | </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'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'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> | |
677 | 691 | </li><li> |
678 | 692 | <p>The binary gem for Windows was built with FOX version 1.4.21 and FXScintilla version 1.63.</p> |
679 | 693 | </li></ul> |
686 | 700 | </li><li> |
687 | 701 | <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> |
688 | 702 | </li><li> |
689 | <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> | |
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> | |
690 | 704 | </li><li> |
691 | 705 | <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> |
692 | 706 | </li><li> |
719 | 733 | <ul><li> |
720 | 734 | <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> |
721 | 735 | </li><li> |
722 | <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> | |
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> | |
723 | 737 | </li><li> |
724 | 738 | <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> |
725 | 739 | </li><li> |
729 | 743 | </li><li> |
730 | 744 | <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> |
731 | 745 | </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'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> | |
733 | 747 | </li><li> |
734 | 748 | <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> |
735 | 749 | </li><li> |
742 | 756 | <ul><li> |
743 | 757 | <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> |
744 | 758 | </li><li> |
745 | <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> | |
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> | |
746 | 760 | </li><li> |
747 | 761 | <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> |
748 | 762 | </li><li> |
750 | 764 | </li><li> |
751 | 765 | <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> |
752 | 766 | </li><li> |
753 | <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> | |
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> | |
754 | 768 | </li><li> |
755 | 769 | <p>The binary gem for Windows was built with FOX version 1.2.13 and FXScintilla version 1.62.</p> |
756 | 770 | </li></ul> |
757 | 771 | |
758 | 772 | <h2 id="label-Changes+For+Version+1.2.4+-28February+23-2C+2005-29">Changes For Version 1.2.4 (February 23, 2005)</h2> |
759 | 773 | <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'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> | |
761 | 775 | </li><li> |
762 | 776 | <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> |
763 | 777 | </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'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> | |
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'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> | |
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> | |
767 | 781 | </li><li> |
768 | 782 | <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> |
769 | 783 | </li><li> |
811 | 825 | |
812 | 826 | <h2 id="label-Changes+For+Version+1.2.2+-28October+1-2C+2004-29">Changes For Version 1.2.2 (October 1, 2004)</h2> |
813 | 827 | <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 'fox12'´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> | |
815 | 829 | </li><li> |
816 | 830 | <p>Made a number of updates to the documentation, to reflect API changes for FXRuby 1.2.</p> |
817 | 831 | </li><li> |
822 | 836 | <ul><li> |
823 | 837 | <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> |
824 | 838 | </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'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> | |
826 | 840 | </li><li> |
827 | 841 | <p>For this release, all of the RDoc-based online documentation has been brought up to date with the new APIs.</p> |
828 | 842 | </li><li> |
829 | <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> | |
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> | |
830 | 844 | </li><li> |
831 | 845 | <p>The <code>mditest.rb</code> example program was not up to date with the new APIs. This has been fixed.</p> |
832 | 846 | </li><li> |
838 | 852 | </li><li> |
839 | 853 | <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> |
840 | 854 | </li><li> |
841 | <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> | |
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> | |
842 | 856 | </li><li> |
843 | 857 | <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> |
844 | 858 | </li><li> |
845 | 859 | <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> |
846 | 860 | </li><li> |
847 | <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> | |
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> | |
848 | 862 | </li><li> |
849 | 863 | <p>The binary gem for Windows was built with FOX version 1.2.7 and FXScintilla version 1.61.</p> |
850 | 864 | </li></ul> |
851 | 865 | |
852 | 866 | <h2 id="label-Changes+For+Version+1.2a1+-28June+28-2C+2004-29">Changes For Version 1.2a1 (June 28, 2004)</h2> |
853 | 867 | <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'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> | |
855 | 869 | </li><li> |
856 | 870 | <p>The binary gem for Windows was built with FOX version 1.2.4 and FXScintilla version 1.57.</p> |
857 | 871 | </li></ul> |
858 | 872 | </div></div> |
859 | 873 | |
860 | 874 | <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). | |
864 | 878 | </div> |
865 | 879 | |
866 | 880 | </div> |
69 | 69 | <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> |
70 | 70 | </dd><dt><strong>Events</strong> |
71 | 71 | <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'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> | |
73 | 73 | </dd><dt><strong>Options</strong> |
74 | 74 | <dd> |
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> | |
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> | |
76 | 76 | </dd></dl> |
77 | 77 | |
78 | <h1 id="label-Where-27s+the+code-3F">Where's the code?</h1> | |
78 | <h1 id="label-Where-27s+the+code-3F">Where’s the code?</h1> | |
79 | 79 | |
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> | |
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> | |
81 | 81 | |
82 | 82 | <h1 id="label-TODO">TODO</h1> |
83 | 83 | |
93 | 93 | </div></div> |
94 | 94 | |
95 | 95 | <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). | |
99 | 99 | </div> |
100 | 100 | |
101 | 101 | </div> |
65 | 65 | </li><li> |
66 | 66 | <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> |
67 | 67 | </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> | |
69 | 69 | </li></ul> |
70 | 70 | |
71 | 71 | <h2 id="label-DESCRIPTION-3A">DESCRIPTION:</h2> |
95 | 95 | <ul><li> |
96 | 96 | <p>on Debian/Ubuntu: <code>sudo apt-get install g++ libxrandr-dev libfox-1.6-dev</code></p> |
97 | 97 | </li><li> |
98 | <p>on Mac: <code>sudo port install rb-fxruby</code> OR <code>brew install fox && 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> | |
98 | 102 | <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> | |
101 | 103 | </li></ul> |
102 | 104 | |
103 | 105 | <p>Then, install the gem:</p> |
105 | 107 | <p>gem install fxruby</p> |
106 | 108 | </li></ul> |
107 | 109 | |
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 | ||
108 | 114 | <h2 id="label-DIRECTORIES">DIRECTORIES</h2> |
109 | 115 | |
110 | 116 | <p>The directory structure is:</p> |
126 | 132 | <p>Contains a test battery for FXRuby.</p> |
127 | 133 | </li></ul> |
128 | 134 | |
129 | <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> | |
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> | |
130 | 136 | <ul><li> |
131 | 137 | <p>fox-includes/</p> |
132 | 138 | |
603 | 609 | </div></div> |
604 | 610 | |
605 | 611 | <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). | |
609 | 615 | </div> |
610 | 616 | |
611 | 617 | </div> |
203 | 203 | </div> |
204 | 204 | |
205 | 205 | <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). | |
209 | 209 | </div> |
210 | 210 | |
211 | 211 | </div> |
19 | 19 | !with_config("fxscintilla", true) |
20 | 20 | end |
21 | 21 | |
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' | |
24 | 23 | LIBZ_SOURCE_URI = "http://zlib.net/fossils/zlib-#{LIBZ_VERSION}.tar.gz" |
25 | 24 | |
26 | 25 | LIBPNG_VERSION = ENV['LIBPNG_VERSION'] || '1.6.37' |
29 | 28 | # LIBJPEG_VERSION = ENV['LIBJPEG_VERSION'] || '9b' |
30 | 29 | # LIBJPEG_SOURCE_URI = "http://www.ijg.org/files/jpegsrc.v#{LIBJPEG_VERSION}.tar.gz" |
31 | 30 | |
32 | LIBJPEG_VERSION = ENV['LIBJPEG_VERSION'] || '2.0.6' | |
31 | LIBJPEG_VERSION = ENV['LIBJPEG_VERSION'] || '2.1.2' | |
33 | 32 | LIBJPEG_SOURCE_URI = "https://downloads.sourceforge.net/libjpeg-turbo/libjpeg-turbo-#{LIBJPEG_VERSION}.tar.gz" |
34 | 33 | |
35 | LIBTIFF_VERSION = ENV['LIBTIFF_VERSION'] || '4.1.0' | |
34 | LIBTIFF_VERSION = ENV['LIBTIFF_VERSION'] || '4.3.0' | |
36 | 35 | LIBTIFF_SOURCE_URI = "http://download.osgeo.org/libtiff/tiff-#{LIBTIFF_VERSION}.tar.gz" |
37 | 36 | |
38 | 37 | LIBFOX_VERSION = ENV['LIBFOX_VERSION'] || '1.6.57' |
49 | 48 | self.files = files |
50 | 49 | rootdir = File.expand_path('../../..', __FILE__) |
51 | 50 | self.target = File.join(rootdir, "ports") |
52 | self.host = RbConfig::CONFIG["host"] | |
51 | self.host = RbConfig::CONFIG["CC"].match(/(.*)-/)[1] | |
53 | 52 | self.patch_files = Dir[File.join(rootdir, "patches", self.name, self.version, "*.diff")].sort |
54 | 53 | end |
55 | 54 | |
56 | 55 | def port_path |
57 | "#{target}/#{host}" | |
56 | "#{target}/#{RUBY_PLATFORM}" | |
58 | 57 | end |
59 | 58 | |
60 | 59 | # When using rake-compiler-dock on Windows, the underlying Virtualbox shared |
68 | 67 | end |
69 | 68 | |
70 | 69 | 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") | |
72 | 71 | unless File.exist?(checkpoint) |
73 | 72 | chdir_for_build do |
74 | 73 | self.cook |
177 | 176 | "--without-xft", |
178 | 177 | "--without-x", |
179 | 178 | 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", | |
181 | 180 | "LDFLAGS=-L#{libjpeg_recipe.path}/lib -L#{libpng_recipe.path}/lib -L#{libtiff_recipe.path}/lib -L#{libz_recipe.path}/lib #{debug ? "-ggdb" : ""}", |
182 | 181 | ] |
183 | 182 | recipe.cook_and_activate |
32 | 32 | spec.summary = %q{FXRuby is the Ruby binding to the FOX GUI toolkit.} |
33 | 33 | spec.homepage = "https://github.com/larskanis/fxruby" |
34 | 34 | 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" | |
35 | 37 | |
36 | 38 | spec.files = `git ls-files -z`.split("\x0").reject do |f| |
37 | 39 | f=~/^fox-includes|^web/ |
50 | 52 | spec.required_ruby_version = [">= 2.3", "< 4"] |
51 | 53 | |
52 | 54 | 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") | |
53 | 61 | end |
17 | 17 | end |
18 | 18 | end |
19 | 19 | |
20 | ruby_plat = RUBY_PLATFORM.gsub("i386", "x86") | |
20 | 21 | # 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__) | |
25 | 23 | add_dll_path.call(ports_bin) do |
26 | 24 | require "#{major_minor}/fox16_c" |
27 | 25 | end |
44 | 44 | |
45 | 45 | def assert_same_file_contents(expected, actual) |
46 | 46 | 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) } | |
48 | 48 | File.open(actual, 'rb') { |f| actual_contents = crlf_to_lf(f.read) } |
49 | 49 | assert_equal(expected_contents, actual_contents) |
50 | 50 | end |