Skip to content

Commit 7e2ad14

Browse files
larskanislarskanis
committed
[DOC] Add FXMDIClient#vertical etc.
1 parent e322c9c commit 7e2ad14

File tree

283 files changed

+3742
-3704
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

283 files changed

+3742
-3704
lines changed

‎docs/Fox.html‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9398,7 +9398,7 @@ <h3 class="signature " id="fxloadBMP-class_method">
93989398

93999399
<p>Load a BMP file from a stream. If successful, returns an array containing the image pixel data (as a String), the transparency color, the image width and the image height. If it fails, the function returns <code>nil</code>.</p>
94009400

9401-
<h4 id="label-Parameters-3A">Parameters:</h4>
9401+
<h4 id="parameters">Parameters:</h4>
94029402
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
94039403
<dd>
94049404
<p>stream from which to read the file data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -9441,7 +9441,7 @@ <h3 class="signature " id="fxloadGIF-class_method">
94419441

94429442
<p>Load a GIF file from a stream. If successful, returns an array containing the image pixel data (as a String), the transparency color, the image width and the image height. If it fails, the function returns <code>nil</code>.</p>
94439443

9444-
<h4 id="label-Parameters-3A">Parameters:</h4>
9444+
<h4 id="parameters">Parameters:</h4>
94459445
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
94469446
<dd>
94479447
<p>stream from which to read the file data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -9484,7 +9484,7 @@ <h3 class="signature " id="fxloadICO-class_method">
94849484

94859485
<p>Load a ICO file from <em>store</em> (an FXStream instance). On success, returns an array whose elements are the image data (a String), transparency color, icon width, icon height, and the icon hotspot x and y coordinates. If the operation fails, this method returns <code>nil</code>.</p>
94869486

9487-
<h4 id="label-Parameters-3A">Parameters:</h4>
9487+
<h4 id="parameters">Parameters:</h4>
94889488
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
94899489
<dd>
94909490
<p>stream from which to read the file data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -9527,7 +9527,7 @@ <h3 class="signature " id="fxloadJPG-class_method">
95279527

95289528
<p>Load a JPEG file from a stream. If successful, returns an array containing the image pixel data (as a String), transparency color, image width, image height and quality. If it fails, the function returns <code>nil</code>.</p>
95299529

9530-
<h4 id="label-Parameters-3A">Parameters:</h4>
9530+
<h4 id="parameters">Parameters:</h4>
95319531
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
95329532
<dd>
95339533
<p>stream from which to read the file data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -9570,7 +9570,7 @@ <h3 class="signature " id="fxloadPCX-class_method">
95709570

95719571
<p>Load a PCX file from a stream. If successful, returns an array containing the image pixel data (as a String), the transparency color, the image width and the image height. If it fails, the function returns <code>nil</code>.</p>
95729572

9573-
<h4 id="label-Parameters-3A">Parameters:</h4>
9573+
<h4 id="parameters">Parameters:</h4>
95749574
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
95759575
<dd>
95769576
<p>stream from which to read the file data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -9613,7 +9613,7 @@ <h3 class="signature " id="fxloadPNG-class_method">
96139613

96149614
<p>Load a PNG file from a stream. If successful, returns an array containing the image pixel data (as a String), the transparency color, the image width and the image height. If it fails, the function returns <code>nil</code>.</p>
96159615

9616-
<h4 id="label-Parameters-3A">Parameters:</h4>
9616+
<h4 id="parameters">Parameters:</h4>
96179617
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
96189618
<dd>
96199619
<p>stream from which to read the file data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -9656,7 +9656,7 @@ <h3 class="signature " id="fxloadRGB-class_method">
96569656

96579657
<p>Load a RGB file from a stream. If successful, returns an array containing the image pixel data (as a String), the transparency color, the image width and the image height. If it fails, the function returns <code>nil</code>.</p>
96589658

9659-
<h4 id="label-Parameters-3A">Parameters:</h4>
9659+
<h4 id="parameters">Parameters:</h4>
96609660
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
96619661
<dd>
96629662
<p>stream from which to read the file data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -9699,7 +9699,7 @@ <h3 class="signature " id="fxloadTGA-class_method">
96999699

97009700
<p>Load a Targa file from a stream. If successful, returns an array containing the image pixel data (as a String), the number of channels (either 3 or 4), the image width and the image height. If it fails, the function returns <code>nil</code>.</p>
97019701

9702-
<h4 id="label-Parameters-3A">Parameters:</h4>
9702+
<h4 id="parameters">Parameters:</h4>
97039703
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
97049704
<dd>
97059705
<p>stream from which to read the file data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -9742,7 +9742,7 @@ <h3 class="signature " id="fxloadTIF-class_method">
97429742

97439743
<p>Load a TIFF file from a stream. If successful, returns an array containing the image pixel data (as a String), transparency color, width, height and codec setting. If it fails, the function returns <code>nil</code>.</p>
97449744

9745-
<h4 id="label-Parameters-3A">Parameters:</h4>
9745+
<h4 id="parameters">Parameters:</h4>
97469746
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
97479747
<dd>
97489748
<p>stream from which to read the file data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -9785,7 +9785,7 @@ <h3 class="signature " id="fxloadXPM-class_method">
97859785

97869786
<p>Load a XPM file from a stream. If successful, returns an array containing the image pixel data (as an array of FXColor values), the transparency color (another FXColor) and the image width and the image height. If it fails, the function returns <code>nil</code>.</p>
97879787

9788-
<h4 id="label-Parameters-3A">Parameters:</h4>
9788+
<h4 id="parameters">Parameters:</h4>
97899789
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
97909790
<dd>
97919791
<p>stream from which to read the file data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -10165,7 +10165,7 @@ <h3 class="signature " id="fxsaveBMP-class_method">
1016510165

1016610166
<p>Save a BMP image to a stream. Returns <code>true</code> on success, <code>false</code> on failure.</p>
1016710167

10168-
<h4 id="label-Parameters-3A">Parameters:</h4>
10168+
<h4 id="parameters">Parameters:</h4>
1016910169
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
1017010170
<dd>
1017110171
<p>stream to which to write the image data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -10220,7 +10220,7 @@ <h3 class="signature " id="fxsaveGIF-class_method">
1022010220

1022110221
<p>Save a GIF (Graphics Interchange Format) image to a stream. If <em>fast</em> is <code>true</code>, the faster Floyd-Steinberg dither method will be used instead of the slower Wu quantization algorithm. Returns <code>true</code> on success, <code>false</code> on failure.</p>
1022210222

10223-
<h4 id="label-Parameters-3A">Parameters:</h4>
10223+
<h4 id="parameters">Parameters:</h4>
1022410224
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
1022510225
<dd>
1022610226
<p>stream to which to write the image data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -10275,7 +10275,7 @@ <h3 class="signature " id="fxsaveICO-class_method">
1027510275

1027610276
<p>Save a ICO image to <em>store</em> (an FXStream instance). Returns <code>true</code> on success, <code>false</code> on failure.</p>
1027710277

10278-
<h4 id="label-Parameters-3A">Parameters:</h4>
10278+
<h4 id="parameters">Parameters:</h4>
1027910279
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
1028010280
<dd>
1028110281
<p>stream to which to write the image data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -10336,7 +10336,7 @@ <h3 class="signature " id="fxsaveJPG-class_method">
1033610336

1033710337
<p>Save a JPEG image to a stream. Returns <code>true</code> on success, <code>false</code> on failure.</p>
1033810338

10339-
<h4 id="label-Parameters-3A">Parameters:</h4>
10339+
<h4 id="parameters">Parameters:</h4>
1034010340
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
1034110341
<dd>
1034210342
<p>stream to which to write the image data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -10394,7 +10394,7 @@ <h3 class="signature " id="fxsavePCX-class_method">
1039410394

1039510395
<p>Save a PCX image to a stream. Returns <code>true</code> on success, <code>false</code> on failure.</p>
1039610396

10397-
<h4 id="label-Parameters-3A">Parameters:</h4>
10397+
<h4 id="parameters">Parameters:</h4>
1039810398
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
1039910399
<dd>
1040010400
<p>stream to which to write the image data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -10449,7 +10449,7 @@ <h3 class="signature " id="fxsavePNG-class_method">
1044910449

1045010450
<p>Save a PNG image to a stream. Returns <code>true</code> on success, <code>false</code> on failure.</p>
1045110451

10452-
<h4 id="label-Parameters-3A">Parameters:</h4>
10452+
<h4 id="parameters">Parameters:</h4>
1045310453
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
1045410454
<dd>
1045510455
<p>stream to which to write the image data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -10504,7 +10504,7 @@ <h3 class="signature " id="fxsaveRGB-class_method">
1050410504

1050510505
<p>Save a RGB image to a stream. Returns <code>true</code> on success, <code>false</code> on failure.</p>
1050610506

10507-
<h4 id="label-Parameters-3A">Parameters:</h4>
10507+
<h4 id="parameters">Parameters:</h4>
1050810508
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
1050910509
<dd>
1051010510
<p>stream to which to write the file data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -10562,7 +10562,7 @@ <h3 class="signature " id="fxsaveTGA-class_method">
1056210562

1056310563
<p>Save a Targa image to a stream. Returns <code>true</code> on success, <code>false</code> on failure.</p>
1056410564

10565-
<h4 id="label-Parameters-3A">Parameters:</h4>
10565+
<h4 id="parameters">Parameters:</h4>
1056610566
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
1056710567
<dd>
1056810568
<p>stream to which to write the image data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -10617,7 +10617,7 @@ <h3 class="signature " id="fxsaveTIF-class_method">
1061710617

1061810618
<p>Save a TIFF image to a stream. Returns <code>true</code> on success, <code>false</code> on failure.</p>
1061910619

10620-
<h4 id="label-Parameters-3A">Parameters:</h4>
10620+
<h4 id="parameters">Parameters:</h4>
1062110621
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
1062210622
<dd>
1062310623
<p>stream to which to write the image data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -10977,7 +10977,7 @@ <h3 class="signature " id="fxsaveXPM-instance_method">
1097710977

1097810978
<p>Save an XPM image to <em>store</em> (an FXStream instance). Returns <code>true</code> on success, <code>false</code> on failure.</p>
1097910979

10980-
<h4 id="label-Parameters-3A">Parameters:</h4>
10980+
<h4 id="parameters">Parameters:</h4>
1098110981
<dl class="rdoc-list note-list"><dt><code>store</code></dt>
1098210982
<dd>
1098310983
<p>stream to which to write the file data <span class='object_link'><a href="Fox/FXStream.html" title="Fox::FXStream (class)">FXStream</a></span></p>
@@ -11174,7 +11174,7 @@ <h3 class="signature " id="unparseAccel-instance_method">
1117411174
</div>
1117511175

1117611176
<div id="footer">
11177-
Generated on Fri Jan 2 19:58:55 2026 by
11177+
Generated on Thu Mar 26 09:48:23 2026 by
1117811178
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1117911179
0.9.38 (ruby-4.0.0).
1118011180
</div>

‎docs/Fox/Canvas.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ <h2>Overview</h2><div class="docstring">
9090

9191
<p>Links</p>
9292

93-
<h5 id="label-"></h5>
93+
<h5 id=""></h5>
9494

9595
<p>Tk’s Canvas Widget</p>
9696

@@ -131,7 +131,7 @@ <h5 id="label-"></h5>
131131
</div>
132132

133133
<div id="footer">
134-
Generated on Fri Jan 2 19:58:55 2026 by
134+
Generated on Thu Mar 26 09:48:23 2026 by
135135
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
136136
0.9.38 (ruby-4.0.0).
137137
</div>

‎docs/Fox/Canvas/CanvasError.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@
114114
</div>
115115

116116
<div id="footer">
117-
Generated on Fri Jan 2 19:59:21 2026 by
117+
Generated on Thu Mar 26 09:49:31 2026 by
118118
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
119119
0.9.38 (ruby-4.0.0).
120120
</div>

‎docs/Fox/Canvas/CircleShape.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -467,7 +467,7 @@ <h3 class="signature " id="width-instance_method">
467467
</div>
468468

469469
<div id="footer">
470-
Generated on Fri Jan 2 19:59:21 2026 by
470+
Generated on Thu Mar 26 09:49:31 2026 by
471471
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
472472
0.9.38 (ruby-4.0.0).
473473
</div>

‎docs/Fox/Canvas/ImageShape.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -467,7 +467,7 @@ <h3 class="signature " id="width-instance_method">
467467
</div>
468468

469469
<div id="footer">
470-
Generated on Fri Jan 2 19:59:21 2026 by
470+
Generated on Thu Mar 26 09:49:31 2026 by
471471
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
472472
0.9.38 (ruby-4.0.0).
473473
</div>

‎docs/Fox/Canvas/LineShape.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -995,7 +995,7 @@ <h3 class="signature " id="width-instance_method">
995995
</div>
996996

997997
<div id="footer">
998-
Generated on Fri Jan 2 19:59:21 2026 by
998+
Generated on Thu Mar 26 09:49:31 2026 by
999999
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
10001000
0.9.38 (ruby-4.0.0).
10011001
</div>

‎docs/Fox/Canvas/PolygonShape.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ <h2>Constructor Details</h2>
135135
</div>
136136

137137
<div id="footer">
138-
Generated on Fri Jan 2 19:59:21 2026 by
138+
Generated on Thu Mar 26 09:49:31 2026 by
139139
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
140140
0.9.38 (ruby-4.0.0).
141141
</div>

‎docs/Fox/Canvas/RectangleShape.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@ <h3 class="signature first" id="draw-instance_method">
429429
</div>
430430

431431
<div id="footer">
432-
Generated on Fri Jan 2 19:59:21 2026 by
432+
Generated on Thu Mar 26 09:49:31 2026 by
433433
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
434434
0.9.38 (ruby-4.0.0).
435435
</div>

‎docs/Fox/Canvas/SelectionPolicy.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ <h3 class="signature " id="selectShape-instance_method">
342342
</div>
343343

344344
<div id="footer">
345-
Generated on Fri Jan 2 19:59:21 2026 by
345+
Generated on Thu Mar 26 09:49:31 2026 by
346346
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
347347
0.9.38 (ruby-4.0.0).
348348
</div>

‎docs/Fox/Canvas/Shape.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -816,7 +816,7 @@ <h3 class="signature first" id="initialize-instance_method">
816816
<span class='ivar'>@draggable</span> <span class='op'>=</span> <span class='kw'>false</span>
817817
<span class='ivar'>@x</span> <span class='op'>=</span> <span class='id identifier rubyid_x'>x</span>
818818
<span class='ivar'>@y</span> <span class='op'>=</span> <span class='id identifier rubyid_y'>y</span>
819-
<span class='ivar'>@foreground</span> <span class='op'>=</span> <span class='const'>FXRGB</span><span class='lparen'>(</span><span class='int'>0</span><span class='comma'>,</span> <span class='int'>0</span><span class='comma'>,</span> <span class='int'>0</span><span class='rparen'>)</span>
819+
<span class='ivar'>@foreground</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../Fox.html" title="Fox (module)">Fox</a></span></span><span class='period'>.</span><span class='const'>FXRGB</span><span class='lparen'>(</span><span class='int'>0</span><span class='comma'>,</span> <span class='int'>0</span><span class='comma'>,</span> <span class='int'>0</span><span class='rparen'>)</span>
820820
<span class='ivar'>@target</span> <span class='op'>=</span> <span class='kw'>nil</span>
821821
<span class='ivar'>@selector</span> <span class='op'>=</span> <span class='int'>0</span>
822822
<span class='kw'>end</span></pre>
@@ -1945,7 +1945,7 @@ <h3 class="signature " id="visible?-instance_method">
19451945
</div>
19461946

19471947
<div id="footer">
1948-
Generated on Fri Jan 2 19:59:21 2026 by
1948+
Generated on Thu Mar 26 09:49:31 2026 by
19491949
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
19501950
0.9.38 (ruby-4.0.0).
19511951
</div>

0 commit comments

Comments
 (0)