Skip to content

Commit 3ae97ee

Browse files
rajdeeprajdeep
committed
Updated documentation
1 parent ca9668b commit 3ae97ee

File tree

191 files changed

+647
-232
lines changed

Some content is hidden

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

191 files changed

+647
-232
lines changed

Diff for: ‎docs/Classes.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -932,7 +932,7 @@ <h4>Declaration</h4>
932932
</section>
933933
</section>
934934
<section id="footer">
935-
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-06)</p>
935+
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-12)</p>
936936
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
937937
</section>
938938
</article>

Diff for: ‎docs/Classes/Attachment.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1371,7 +1371,7 @@ <h4>Declaration</h4>
13711371
</section>
13721372
</section>
13731373
<section id="footer">
1374-
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-06)</p>
1374+
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-12)</p>
13751375
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
13761376
</section>
13771377
</article>

Diff for: ‎docs/Classes/AttributesToggleCommand.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -472,7 +472,7 @@ <h4>Declaration</h4>
472472
</section>
473473
</section>
474474
<section id="footer">
475-
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-06)</p>
475+
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-12)</p>
476476
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
477477
</section>
478478
</article>

Diff for: ‎docs/Classes/BackgroundStyle.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -639,7 +639,7 @@ <h4>Declaration</h4>
639639
</section>
640640
</section>
641641
<section id="footer">
642-
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-06)</p>
642+
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-12)</p>
643643
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
644644
</section>
645645
</article>

Diff for: ‎docs/Classes/BoldCommand.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,7 @@ <h4>Declaration</h4>
393393
</section>
394394
</section>
395395
<section id="footer">
396-
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-06)</p>
396+
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-12)</p>
397397
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
398398
</section>
399399
</article>

Diff for: ‎docs/Classes/BorderStyle.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -447,7 +447,7 @@ <h4>Declaration</h4>
447447
</section>
448448
</section>
449449
<section id="footer">
450-
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-06)</p>
450+
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-12)</p>
451451
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
452452
</section>
453453
</article>

Diff for: ‎docs/Classes/EditorCommandExecutor.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -489,7 +489,7 @@ <h4>Parameters</h4>
489489
</section>
490490
</section>
491491
<section id="footer">
492-
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-06)</p>
492+
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-12)</p>
493493
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
494494
</section>
495495
</article>

Diff for: ‎docs/Classes/EditorView.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -5184,7 +5184,7 @@ <h4>Return Value</h4>
51845184
</section>
51855185
</section>
51865186
<section id="footer">
5187-
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-06)</p>
5187+
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-12)</p>
51885188
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
51895189
</section>
51905190
</article>

Diff for: ‎docs/Classes/EditorViewContext.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -592,7 +592,7 @@ <h4>Parameters</h4>
592592
</section>
593593
</section>
594594
<section id="footer">
595-
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-06)</p>
595+
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-12)</p>
596596
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
597597
</section>
598598
</article>

Diff for: ‎docs/Classes/FontTraitToggleCommand.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -472,7 +472,7 @@ <h4>Declaration</h4>
472472
</section>
473473
</section>
474474
<section id="footer">
475-
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-06)</p>
475+
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-12)</p>
476476
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
477477
</section>
478478
</article>

Diff for: ‎docs/Classes/GridCell.html

+82-1
Original file line numberDiff line numberDiff line change
@@ -526,6 +526,87 @@ <h4>Declaration</h4>
526526
</section>
527527
</div>
528528
</li>
529+
<li class="item">
530+
<div>
531+
<code>
532+
<a name="/s:6Proton8GridCellC12isSelectableSbvp"></a>
533+
<a name="//apple_ref/swift/Property/isSelectable" class="dashAnchor"></a>
534+
<a class="token" href="#/s:6Proton8GridCellC12isSelectableSbvp">isSelectable</a>
535+
</code>
536+
</div>
537+
<div class="height-container">
538+
<div class="pointer-container"></div>
539+
<section class="section">
540+
<div class="pointer"></div>
541+
<div class="abstract">
542+
<p>Controls if the cell can be selected or not.</p>
543+
544+
</div>
545+
<div class="declaration">
546+
<h4>Declaration</h4>
547+
<div class="language">
548+
<p class="aside-title">Swift</p>
549+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isSelectable</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
550+
551+
</div>
552+
</div>
553+
</section>
554+
</div>
555+
</li>
556+
<li class="item">
557+
<div>
558+
<code>
559+
<a name="/s:6Proton8GridCellC19onEditorInitializedyAC_AA0E4ViewCtcSgvp"></a>
560+
<a name="//apple_ref/swift/Property/onEditorInitialized" class="dashAnchor"></a>
561+
<a class="token" href="#/s:6Proton8GridCellC19onEditorInitializedyAC_AA0E4ViewCtcSgvp">onEditorInitialized</a>
562+
</code>
563+
</div>
564+
<div class="height-container">
565+
<div class="pointer-container"></div>
566+
<section class="section">
567+
<div class="pointer"></div>
568+
<div class="abstract">
569+
<p>Invoked when Editor in contained in the Cell is initialized.</p>
570+
571+
</div>
572+
<div class="declaration">
573+
<h4>Declaration</h4>
574+
<div class="language">
575+
<p class="aside-title">Swift</p>
576+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">onEditorInitialized</span><span class="p">:</span> <span class="p">((</span><span class="kt">GridCell</span><span class="p">,</span> <span class="kt"><a href="../Classes/EditorView.html">EditorView</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)?</span></code></pre>
577+
578+
</div>
579+
</div>
580+
</section>
581+
</div>
582+
</li>
583+
<li class="item">
584+
<div>
585+
<code>
586+
<a name="/s:6Proton8GridCellC19isEditorInitializedSbvp"></a>
587+
<a name="//apple_ref/swift/Property/isEditorInitialized" class="dashAnchor"></a>
588+
<a class="token" href="#/s:6Proton8GridCellC19isEditorInitializedSbvp">isEditorInitialized</a>
589+
</code>
590+
</div>
591+
<div class="height-container">
592+
<div class="pointer-container"></div>
593+
<section class="section">
594+
<div class="pointer"></div>
595+
<div class="abstract">
596+
<p>Confirms if Editor within Cell has been initialized or not.</p>
597+
598+
</div>
599+
<div class="declaration">
600+
<h4>Declaration</h4>
601+
<div class="language">
602+
<p class="aside-title">Swift</p>
603+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isEditorInitialized</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
604+
605+
</div>
606+
</div>
607+
</section>
608+
</div>
609+
</li>
529610
<li class="item">
530611
<div>
531612
<code>
@@ -1134,7 +1215,7 @@ <h4>Declaration</h4>
11341215
</section>
11351216
</section>
11361217
<section id="footer">
1137-
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-06)</p>
1218+
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-12)</p>
11381219
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
11391220
</section>
11401221
</article>

Diff for: ‎docs/Classes/GridView.html

+106-1
Original file line numberDiff line numberDiff line change
@@ -392,6 +392,33 @@ <h4>Declaration</h4>
392392
</section>
393393
</div>
394394
</li>
395+
<li class="item">
396+
<div>
397+
<code>
398+
<a name="/s:6Proton8GridViewC19containerAttachmentAA0E0CSgvp"></a>
399+
<a name="//apple_ref/swift/Property/containerAttachment" class="dashAnchor"></a>
400+
<a class="token" href="#/s:6Proton8GridViewC19containerAttachmentAA0E0CSgvp">containerAttachment</a>
401+
</code>
402+
</div>
403+
<div class="height-container">
404+
<div class="pointer-container"></div>
405+
<section class="section">
406+
<div class="pointer"></div>
407+
<div class="abstract">
408+
<p>Gets the attachment containing the <code>GridView</code></p>
409+
410+
</div>
411+
<div class="declaration">
412+
<h4>Declaration</h4>
413+
<div class="language">
414+
<p class="aside-title">Swift</p>
415+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">containerAttachment</span><span class="p">:</span> <span class="kt"><a href="../Classes/Attachment.html">Attachment</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
416+
417+
</div>
418+
</div>
419+
</section>
420+
</div>
421+
</li>
395422
<li class="item">
396423
<div>
397424
<code>
@@ -956,6 +983,84 @@ <h4>Return Value</h4>
956983
</section>
957984
</div>
958985
</li>
986+
<li class="item">
987+
<div>
988+
<code>
989+
<a name="/s:6Proton8GridViewC11selectCellsyySayAA0B4CellCGF"></a>
990+
<a name="//apple_ref/swift/Method/selectCells(_:)" class="dashAnchor"></a>
991+
<a class="token" href="#/s:6Proton8GridViewC11selectCellsyySayAA0B4CellCGF">selectCells(_:<wbr>)</a>
992+
</code>
993+
</div>
994+
<div class="height-container">
995+
<div class="pointer-container"></div>
996+
<section class="section">
997+
<div class="pointer"></div>
998+
<div class="abstract">
999+
<p>Selects given cells. Also, deselects any previously selected cells</p>
1000+
<div class="aside aside-note">
1001+
<p class="aside-title">Note</p>
1002+
Any combination of cells can be passed in, and will be selected, if possible.
1003+
1004+
</div>
1005+
1006+
</div>
1007+
<div class="declaration">
1008+
<h4>Declaration</h4>
1009+
<div class="language">
1010+
<p class="aside-title">Swift</p>
1011+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">selectCells</span><span class="p">(</span><span class="n">_</span> <span class="nv">cells</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/GridCell.html">GridCell</a></span><span class="p">])</span></code></pre>
1012+
1013+
</div>
1014+
</div>
1015+
<div>
1016+
<h4>Parameters</h4>
1017+
<table class="graybox">
1018+
<tbody>
1019+
<tr>
1020+
<td>
1021+
<code>
1022+
<em>cells</em>
1023+
</code>
1024+
</td>
1025+
<td>
1026+
<div>
1027+
<p>Cells to select.</p>
1028+
</div>
1029+
</td>
1030+
</tr>
1031+
</tbody>
1032+
</table>
1033+
</div>
1034+
</section>
1035+
</div>
1036+
</li>
1037+
<li class="item">
1038+
<div>
1039+
<code>
1040+
<a name="/s:6Proton8GridViewC13deselectCellsyyF"></a>
1041+
<a name="//apple_ref/swift/Method/deselectCells()" class="dashAnchor"></a>
1042+
<a class="token" href="#/s:6Proton8GridViewC13deselectCellsyyF">deselectCells()</a>
1043+
</code>
1044+
</div>
1045+
<div class="height-container">
1046+
<div class="pointer-container"></div>
1047+
<section class="section">
1048+
<div class="pointer"></div>
1049+
<div class="abstract">
1050+
<p>Deselects any selected cell.</p>
1051+
1052+
</div>
1053+
<div class="declaration">
1054+
<h4>Declaration</h4>
1055+
<div class="language">
1056+
<p class="aside-title">Swift</p>
1057+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">deselectCells</span><span class="p">()</span></code></pre>
1058+
1059+
</div>
1060+
</div>
1061+
</section>
1062+
</div>
1063+
</li>
9591064
<li class="item">
9601065
<div>
9611066
<code>
@@ -1774,7 +1879,7 @@ <h4>Declaration</h4>
17741879
</section>
17751880
</section>
17761881
<section id="footer">
1777-
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-06)</p>
1882+
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-12)</p>
17781883
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
17791884
</section>
17801885
</article>

Diff for: ‎docs/Classes/ItalicsCommand.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,7 @@ <h4>Declaration</h4>
393393
</section>
394394
</section>
395395
<section id="footer">
396-
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-06)</p>
396+
<p>&copy; 2023 <a class="link" href="" target="_blank" rel="external noopener">Rajdeep Kwatra</a>. All rights reserved. (Last updated: 2023-12-12)</p>
397397
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
398398
</section>
399399
</article>

0 commit comments

Comments
 (0)