-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathindex.html
942 lines (912 loc) · 45.8 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>KOReader Documentation</title>
<link rel="stylesheet" href="ldoc_fixed.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>KOReader</h1>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="modules/android.html">android</a></li>
<li><a href="modules/apps.filemanager.filemanagerbookinfo.html">apps.filemanager.filemanagerbookinfo</a></li>
<li><a href="modules/apps.filemanager.filemanagerconverter.html">apps.filemanager.filemanagerconverter</a></li>
<li><a href="modules/apps.filemanager.filemanagerutil.html">apps.filemanager.filemanagerutil</a></li>
<li><a href="modules/apps.filemanager.lib.md.html">apps.filemanager.lib.md</a></li>
<li><a href="modules/apps.reader.modules.readerlink.html">apps.reader.modules.readerlink</a></li>
<li><a href="modules/apps.reader.modules.readerview.html">apps.reader.modules.readerview</a></li>
<li><a href="modules/apps.reader.readerui.html">apps.reader.readerui</a></li>
<li><a href="modules/baseexporter.html">baseexporter</a></li>
<li><a href="modules/cache.html">cache</a></li>
<li><a href="modules/cacheitem.html">cacheitem</a></li>
<li><a href="modules/cachesqlite.html">cachesqlite</a></li>
<li><a href="modules/datetime.html">datetime</a></li>
<li><a href="modules/dbg.html">dbg</a></li>
<li><a href="modules/depgraph.html">depgraph</a></li>
<li><a href="modules/device.generic.device.html">device.generic.device</a></li>
<li><a href="modules/device.gesturedetector.html">device.gesturedetector</a></li>
<li><a href="modules/device.input.html">device.input</a></li>
<li><a href="modules/device.kindle.mockrtc.html">device.kindle.mockrtc</a></li>
<li><a href="modules/device.kobo.nickel_conf.html">device.kobo.nickel_conf</a></li>
<li><a href="modules/device.sysfs_light.html">device.sysfs_light</a></li>
<li><a href="modules/device.wakeupmgr.html">device.wakeupmgr</a></li>
<li><a href="modules/dispatcher.html">dispatcher</a></li>
<li><a href="modules/docsettings.html">docsettings</a></li>
<li><a href="modules/document.doccache.html">document.doccache</a></li>
<li><a href="modules/document.documentregistry.html">document.documentregistry</a></li>
<li><a href="modules/document.koptinterface.html">document.koptinterface</a></li>
<li><a href="modules/dump.html">dump</a></li>
<li><a href="modules/ffi.blitbuffer.html">ffi.blitbuffer</a></li>
<li><a href="modules/ffi.crypto.html">ffi.crypto</a></li>
<li><a href="modules/ffi.framebuffer.html">ffi.framebuffer</a></li>
<li><a href="modules/ffi.freetype.html">ffi.freetype</a></li>
<li><a href="modules/ffi.jpeg.html">ffi.jpeg</a></li>
<li><a href="modules/ffi.koptcontext.html">ffi.koptcontext</a></li>
<li><a href="modules/ffi.loadlib.html">ffi.loadlib</a></li>
<li><a href="modules/ffi.md5.html">ffi.md5</a></li>
<li><a href="modules/ffi.mupdf.html">ffi.mupdf</a></li>
<li><a href="modules/ffi.png.html">ffi.png</a></li>
<li><a href="modules/ffi.rtc.html">ffi.rtc</a></li>
<li><a href="modules/ffi.sdl2_0.html">ffi.sdl2_0</a></li>
<li><a href="modules/ffi.utf8proc.html">ffi.utf8proc</a></li>
<li><a href="modules/ffi.util.html">ffi.util</a></li>
<li><a href="modules/ffi.webp.html">ffi.webp</a></li>
<li><a href="modules/ffi.zipwriter.html">ffi.zipwriter</a></li>
<li><a href="modules/ffi.zlib.html">ffi.zlib</a></li>
<li><a href="modules/ffi.zstd.html">ffi.zstd</a></li>
<li><a href="modules/gettext.html">gettext</a></li>
<li><a href="modules/koplugin.HelloWorld.html">koplugin.HelloWorld</a></li>
<li><a href="modules/koplugin.QRClipboard.html">koplugin.QRClipboard</a></li>
<li><a href="modules/koplugin.autodim.html">koplugin.autodim</a></li>
<li><a href="modules/koplugin.autowarmth.html">koplugin.autowarmth</a></li>
<li><a href="modules/koplugin.calibre.metadata.html">koplugin.calibre.metadata</a></li>
<li><a href="modules/koplugin.coverimage.html">koplugin.coverimage</a></li>
<li><a href="modules/koplugin.exporter.html">koplugin.exporter</a></li>
<li><a href="modules/koplugin.japanese.html">koplugin.japanese</a></li>
<li><a href="modules/koplugin.japanese.deinflector.html">koplugin.japanese.deinflector</a></li>
<li><a href="modules/koplugin.terminal.html">koplugin.terminal</a></li>
<li><a href="modules/koplugin.terminal.html">koplugin.terminal</a></li>
<li><a href="modules/koplugin.vocabbuilder.html">koplugin.vocabbuilder</a></li>
<li><a href="modules/koplugin.wallabag.html">koplugin.wallabag</a></li>
<li><a href="modules/languagesupport.html">languagesupport</a></li>
<li><a href="modules/logger.html">logger</a></li>
<li><a href="modules/luadata.html">luadata</a></li>
<li><a href="modules/luadefaults.html">luadefaults</a></li>
<li><a href="modules/luasettings.html">luasettings</a></li>
<li><a href="modules/optmath.html">optmath</a></li>
<li><a href="modules/provider.html">provider</a></li>
<li><a href="modules/random.html">random</a></li>
<li><a href="modules/socketutil.html">socketutil</a></li>
<li><a href="modules/sort.html">sort</a></li>
<li><a href="modules/suntime.html">suntime</a></li>
<li><a href="modules/time.html">time</a></li>
<li><a href="modules/ui.bidi.html">ui.bidi</a></li>
<li><a href="modules/ui.data.css_tweaks.html">ui.data.css_tweaks</a></li>
<li><a href="modules/ui.data.keyboardlayouts.generic_ime.html">ui.data.keyboardlayouts.generic_ime</a></li>
<li><a href="modules/ui.data.keyboardlayouts.ja_keyboard.html">ui.data.keyboardlayouts.ja_keyboard</a></li>
<li><a href="modules/ui.data.keyboardlayouts.ja_keyboard_keys.html">ui.data.keyboardlayouts.ja_keyboard_keys</a></li>
<li><a href="modules/ui.data.keyboardlayouts.ko_KR_helper.html">ui.data.keyboardlayouts.ko_KR_helper</a></li>
<li><a href="modules/ui.data.keyboardlayouts.zh_keyboard.html">ui.data.keyboardlayouts.zh_keyboard</a></li>
<li><a href="modules/ui.data.optionsutil.html">ui.data.optionsutil</a></li>
<li><a href="modules/ui.downloadmgr.html">ui.downloadmgr</a></li>
<li><a href="modules/ui.event.html">ui.event</a></li>
<li><a href="modules/ui.font.html">ui.font</a></li>
<li><a href="modules/ui.geometry.html">ui.geometry</a></li>
<li><a href="modules/ui.hook_container.html">ui.hook_container</a></li>
<li><a href="modules/ui.menusorter.html">ui.menusorter</a></li>
<li><a href="modules/ui.network.wpa_supplicant.html">ui.network.wpa_supplicant</a></li>
<li><a href="modules/ui.otamanager.html">ui.otamanager</a></li>
<li><a href="modules/ui.plugin.background_task_plugin.html">ui.plugin.background_task_plugin</a></li>
<li><a href="modules/ui.plugin.switch_plugin.html">ui.plugin.switch_plugin</a></li>
<li><a href="modules/ui.quickstart.html">ui.quickstart</a></li>
<li><a href="modules/ui.renderimage.html">ui.renderimage</a></li>
<li><a href="modules/ui.rendertext.html">ui.rendertext</a></li>
<li><a href="modules/ui.size.html">ui.size</a></li>
<li><a href="modules/ui.translator.html">ui.translator</a></li>
<li><a href="modules/ui.trapper.html">ui.trapper</a></li>
<li><a href="modules/ui.uimanager.html">ui.uimanager</a></li>
<li><a href="modules/ui.viewhtml.html">ui.viewhtml</a></li>
<li><a href="modules/ui.widget.bboxwidget.html">ui.widget.bboxwidget</a></li>
<li><a href="modules/ui.widget.button.html">ui.widget.button</a></li>
<li><a href="modules/ui.widget.buttondialog.html">ui.widget.buttondialog</a></li>
<li><a href="modules/ui.widget.checkbutton.html">ui.widget.checkbutton</a></li>
<li><a href="modules/ui.widget.checkmark.html">ui.widget.checkmark</a></li>
<li><a href="modules/ui.widget.confirmbox.html">ui.widget.confirmbox</a></li>
<li><a href="modules/ui.widget.container.alphacontainer.html">ui.widget.container.alphacontainer</a></li>
<li><a href="modules/ui.widget.container.bottomcontainer.html">ui.widget.container.bottomcontainer</a></li>
<li><a href="modules/ui.widget.container.centercontainer.html">ui.widget.container.centercontainer</a></li>
<li><a href="modules/ui.widget.container.framecontainer.html">ui.widget.container.framecontainer</a></li>
<li><a href="modules/ui.widget.container.inputcontainer.html">ui.widget.container.inputcontainer</a></li>
<li><a href="modules/ui.widget.container.leftcontainer.html">ui.widget.container.leftcontainer</a></li>
<li><a href="modules/ui.widget.container.movablecontainer.html">ui.widget.container.movablecontainer</a></li>
<li><a href="modules/ui.widget.container.rightcontainer.html">ui.widget.container.rightcontainer</a></li>
<li><a href="modules/ui.widget.container.scrollablecontainer.html">ui.widget.container.scrollablecontainer</a></li>
<li><a href="modules/ui.widget.container.topcontainer.html">ui.widget.container.topcontainer</a></li>
<li><a href="modules/ui.widget.container.underlinecontainer.html">ui.widget.container.underlinecontainer</a></li>
<li><a href="modules/ui.widget.container.widgetcontainer.html">ui.widget.container.widgetcontainer</a></li>
<li><a href="modules/ui.widget.datetimewidget.html">ui.widget.datetimewidget</a></li>
<li><a href="modules/ui.widget.eventlistener.html">ui.widget.eventlistener</a></li>
<li><a href="modules/ui.widget.horizontalgroup.html">ui.widget.horizontalgroup</a></li>
<li><a href="modules/ui.widget.htmlboxwidget.html">ui.widget.htmlboxwidget</a></li>
<li><a href="modules/ui.widget.iconbutton.html">ui.widget.iconbutton</a></li>
<li><a href="modules/ui.widget.iconwidget.html">ui.widget.iconwidget</a></li>
<li><a href="modules/ui.widget.imageviewer.html">ui.widget.imageviewer</a></li>
<li><a href="modules/ui.widget.imagewidget.html">ui.widget.imagewidget</a></li>
<li><a href="modules/ui.widget.infomessage.html">ui.widget.infomessage</a></li>
<li><a href="modules/ui.widget.inputdialog.html">ui.widget.inputdialog</a></li>
<li><a href="modules/ui.widget.keyboardlayoutdialog.html">ui.widget.keyboardlayoutdialog</a></li>
<li><a href="modules/ui.widget.keyvaluepage.html">ui.widget.keyvaluepage</a></li>
<li><a href="modules/ui.widget.linewidget.html">ui.widget.linewidget</a></li>
<li><a href="modules/ui.widget.listview.html">ui.widget.listview</a></li>
<li><a href="modules/ui.widget.multiconfirmbox.html">ui.widget.multiconfirmbox</a></li>
<li><a href="modules/ui.widget.multiinputdialog.html">ui.widget.multiinputdialog</a></li>
<li><a href="modules/ui.widget.networksetting.html">ui.widget.networksetting</a></li>
<li><a href="modules/ui.widget.notification.html">ui.widget.notification</a></li>
<li><a href="modules/ui.widget.numberpickerwidget.html">ui.widget.numberpickerwidget</a></li>
<li><a href="modules/ui.widget.openwithdialog.html">ui.widget.openwithdialog</a></li>
<li><a href="modules/ui.widget.overlapgroup.html">ui.widget.overlapgroup</a></li>
<li><a href="modules/ui.widget.progresswidget.html">ui.widget.progresswidget</a></li>
<li><a href="modules/ui.widget.qrmessage.html">ui.widget.qrmessage</a></li>
<li><a href="modules/ui.widget.radiobuttontable.html">ui.widget.radiobuttontable</a></li>
<li><a href="modules/ui.widget.radiobuttonwidget.html">ui.widget.radiobuttonwidget</a></li>
<li><a href="modules/ui.widget.scrollhtmlwidget.html">ui.widget.scrollhtmlwidget</a></li>
<li><a href="modules/ui.widget.scrolltextwidget.html">ui.widget.scrolltextwidget</a></li>
<li><a href="modules/ui.widget.textboxwidget.html">ui.widget.textboxwidget</a></li>
<li><a href="modules/ui.widget.textviewer.html">ui.widget.textviewer</a></li>
<li><a href="modules/ui.widget.textwidget.html">ui.widget.textwidget</a></li>
<li><a href="modules/ui.widget.toggleswitch.html">ui.widget.toggleswitch</a></li>
<li><a href="modules/ui.widget.touchmenu.html">ui.widget.touchmenu</a></li>
<li><a href="modules/ui.widget.trapwidget.html">ui.widget.trapwidget</a></li>
<li><a href="modules/ui.widget.verticalgroup.html">ui.widget.verticalgroup</a></li>
<li><a href="modules/ui.widget.widget.html">ui.widget.widget</a></li>
<li><a href="modules/userpatch.html">userpatch</a></li>
<li><a href="modules/util.html">util</a></li>
<li><a href="modules/version.html">version</a></li>
</ul>
<h2>Topics</h2>
<ul class="">
<li><a href="topics/Collaborating_with_Git.md.html">Collaborating with Git</a></li>
<li><a href="topics/DataStore.md.html">DataStore</a></li>
<li><a href="topics/Development_guide.md.html">Development Guide</a></li>
<li><a href="topics/Events.md.html">Events</a></li>
<li><a href="topics/Hacking.md.html">Hacking</a></li>
<li><a href="topics/Porting.md.html">Porting</a></li>
<li><a href="topics/README.md.html">README</a></li>
<li><a href="topics/Unit_tests.md.html">Unit Tests</a></li>
</ul>
</div>
<div id="content">
<h2>Multi-platform ebook reader</h2>
<p>An ebook reader application supports PDF, DJVU, EPUB, FB2 and many more formats, running on Kindle, Kobo, PocketBook, Ubuntu Touch and Android devices.</p>
<h2>Modules</h2>
<table class="module_list">
<tr>
<td class="name" nowrap><a href="modules/android.html">android</a></td>
<td class="summary">FFI bindings for android native APIs and Java Native Interface (JNI).</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/apps.filemanager.filemanagerbookinfo.html">apps.filemanager.filemanagerbookinfo</a></td>
<td class="summary">This module provides a way to display book information (filename and book metadata)</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/apps.filemanager.filemanagerconverter.html">apps.filemanager.filemanagerconverter</a></td>
<td class="summary">This module is responsible for converting files.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/apps.filemanager.filemanagerutil.html">apps.filemanager.filemanagerutil</a></td>
<td class="summary">This module contains miscellaneous helper functions for FileManager</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/apps.filemanager.lib.md.html">apps.filemanager.lib.md</a></td>
<td class="summary">Stream Utils</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/apps.reader.modules.readerlink.html">apps.reader.modules.readerlink</a></td>
<td class="summary">ReaderLink is an abstraction for document-specific link interfaces.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/apps.reader.modules.readerview.html">apps.reader.modules.readerview</a></td>
<td class="summary">ReaderView module handles all the screen painting for document browsing.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/apps.reader.readerui.html">apps.reader.readerui</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/baseexporter.html">baseexporter</a></td>
<td class="summary">Base for highlight exporters.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/cache.html">cache</a></td>
<td class="summary">An LRU cache, based on https://github.com/starius/lua-lru</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/cacheitem.html">cacheitem</a></td>
<td class="summary">
<p>NOTE: As far as size estimations go, the assumption is that a key, value pair should roughly take two words,</p>
<pre>
<span class="keyword">and</span> the most common items we cache are Geom-like <span class="function-name">tables</span> (i.e., <span class="number">4</span> key-value <span class="global">pairs</span>).
</pre>
</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/cachesqlite.html">cachesqlite</a></td>
<td class="summary">An SQLite-based cache implementation, with an interface similar to <a href="modules/cache.html#">Cache</a>.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/datetime.html">datetime</a></td>
<td class="summary">This module contains date translations and helper functions for the KOReader frontend.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/dbg.html">dbg</a></td>
<td class="summary">This module provides development-only asserts and other debug guards.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/depgraph.html">depgraph</a></td>
<td class="summary">DepGraph module.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/device.generic.device.html">device.generic.device</a></td>
<td class="summary">Generic device abstraction.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/device.gesturedetector.html">device.gesturedetector</a></td>
<td class="summary">This module detects gestures.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/device.input.html">device.input</a></td>
<td class="summary">An interface to get input events.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/device.kindle.mockrtc.html">device.kindle.mockrtc</a></td>
<td class="summary">Checks if the alarm we set matches the current time.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/device.kobo.nickel_conf.html">device.kobo.nickel_conf</a></td>
<td class="summary">Access and modify values in <code>Kobo eReader.conf</code> used by Nickel.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/device.sysfs_light.html">device.sysfs_light</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/device.wakeupmgr.html">device.wakeupmgr</a></td>
<td class="summary">RTC wakeup interface.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/dispatcher.html">dispatcher</a></td>
<td class="summary">This module is responsible for dispatching events.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/docsettings.html">docsettings</a></td>
<td class="summary">This module is responsible for reading and writing <code>metadata.lua</code> files
in the so-called sidecar directory
(<a href="https://en.wikipedia.org/wiki/Sidecar_file">Wikipedia definition</a>).</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/document.doccache.html">document.doccache</a></td>
<td class="summary">...otherwise, effectively disable the cache by making it single slot...</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/document.documentregistry.html">document.documentregistry</a></td>
<td class="summary">This is a registry for document providers</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/document.koptinterface.html">document.koptinterface</a></td>
<td class="summary">Interface to k2pdfoptlib backend.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/dump.html">dump</a></td>
<td class="summary">A simple serialization function which won't do uservalues, functions, or loops.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ffi.blitbuffer.html">ffi.blitbuffer</a></td>
<td class="summary">Generic blitbuffer/GFX stuff that works on memory buffers</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ffi.crypto.html">ffi.crypto</a></td>
<td class="summary">LuaJIT FFI wrapper for libcrypto (OpenSSL).</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ffi.framebuffer.html">ffi.framebuffer</a></td>
<td class="summary">Framebuffer API.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ffi.freetype.html">ffi.freetype</a></td>
<td class="summary">Freetype library interface (text rendering)</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ffi.jpeg.html">ffi.jpeg</a></td>
<td class="summary">Module for JPEG decoding/encoding.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ffi.koptcontext.html">ffi.koptcontext</a></td>
<td class="summary">
<p>Leptonica cheatsheet:</p>
<pre>
<span class="comment">-- Data structures:
</span>PIX <span class="comment">-- basic data structure - stores image
</span>BOX <span class="comment">-- stores rectangle (x, y, w, h)
</span>BOXA <span class="comment">-- array of BOX
</span>NUMA <span class="comment">-- array of numbers</span>
</pre>
</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ffi.loadlib.html">ffi.loadlib</a></td>
<td class="summary">Helper for loading native libraries.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ffi.md5.html">ffi.md5</a></td>
<td class="summary">MD5 hash library.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ffi.mupdf.html">ffi.mupdf</a></td>
<td class="summary">MuPDF API</p>
<p>This is a FFI wrapper for what was a Lua-based API in the past
Some kind of C wrapper is needed for muPDF since muPDF uses
a setjmp/longjmp based approach to error/exception handling.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ffi.png.html">ffi.png</a></td>
<td class="summary">Module for PNG decoding/encoding.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ffi.rtc.html">ffi.rtc</a></td>
<td class="summary">Module for interfacing with the RTC (real time clock).</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ffi.sdl2_0.html">ffi.sdl2_0</a></td>
<td class="summary">Module for interfacing SDL 2.0 video/input facilities</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ffi.utf8proc.html">ffi.utf8proc</a></td>
<td class="summary">Module for utf8 string operations.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ffi.util.html">ffi.util</a></td>
<td class="summary">Module for various utility functions.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ffi.webp.html">ffi.webp</a></td>
<td class="summary">Module for WebP decoding.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ffi.zipwriter.html">ffi.zipwriter</a></td>
<td class="summary">Zip packing workflow & code from luarocks' zip.lua :
https://github.com/luarocks/luarocks/blob/master/src/luarocks/tools/zip.lua
Modified to not require lua-zlib (we can wrap zlib with ffi)
cf: http://luajit.org/ext<em>ffi</em>tutorial.html, which uses zlib as an example !
Simplified to take filename and content from strings and not from disk</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ffi.zlib.html">ffi.zlib</a></td>
<td class="summary">LuaJIT FFI wrapper for zlib.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ffi.zstd.html">ffi.zstd</a></td>
<td class="summary">LuaJIT FFI wrapper for ZSTD.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/gettext.html">gettext</a></td>
<td class="summary">A pure Lua implementation of a gettext subset.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/koplugin.HelloWorld.html">koplugin.HelloWorld</a></td>
<td class="summary">This is a debug plugin to test Plugin functionality.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/koplugin.QRClipboard.html">koplugin.QRClipboard</a></td>
<td class="summary">This plugin generates a QR code from clipboard content.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/koplugin.autodim.html">koplugin.autodim</a></td>
<td class="summary">Plugin for automatic dimming of the frontlight after an idle period.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/koplugin.autowarmth.html">koplugin.autowarmth</a></td>
<td class="summary">Plugin for setting screen warmth based on the sun position and/or a time schedule</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/koplugin.calibre.metadata.html">koplugin.calibre.metadata</a></td>
<td class="summary">This module implements functions for loading, saving and editing calibre metadata files.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/koplugin.coverimage.html">koplugin.coverimage</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/koplugin.exporter.html">koplugin.exporter</a></td>
<td class="summary">Export highlights to different targets.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/koplugin.japanese.html">koplugin.japanese</a></td>
<td class="summary">Japanese language support for KOReader, modelled after Yomichan.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/koplugin.japanese.deinflector.html">koplugin.japanese.deinflector</a></td>
<td class="summary">Yomichan deinflector implementation in pure Lua.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/koplugin.terminal.html">koplugin.terminal</a></td>
<td class="summary">This plugin provides a terminal emulator (VT52 (+some ANSI and some VT100))</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/koplugin.terminal.html">koplugin.terminal</a></td>
<td class="summary">module used for terminal emulator to override InputText</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/koplugin.vocabbuilder.html">koplugin.vocabbuilder</a></td>
<td class="summary">This plugin processes dictionary word lookups and uses spaced repetition to help you remember new words.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/koplugin.wallabag.html">koplugin.wallabag</a></td>
<td class="summary">This plugin downloads a set number of the newest arcticles in your Wallabag "Unread" list.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/languagesupport.html">languagesupport</a></td>
<td class="summary">Language-specific handling module.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/logger.html">logger</a></td>
<td class="summary">Logger module.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/luadata.html">luadata</a></td>
<td class="summary">Handles append-mostly data such as KOReader's bookmarks and dictionary search history.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/luadefaults.html">luadefaults</a></td>
<td class="summary">Subclass of LuaSettings dedicated to handling the legacy global constants.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/luasettings.html">luasettings</a></td>
<td class="summary">This module handles generic settings as well as KOReader's global settings system.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/optmath.html">optmath</a></td>
<td class="summary">Simple math helper functions</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/provider.html">provider</a></td>
<td class="summary">Registers an implementation of a feature.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/random.html">random</a></td>
<td class="summary">A set of functions to extend math.random and math.randomseed.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/socketutil.html">socketutil</a></td>
<td class="summary">This module contains miscellaneous helper functions specific to our usage of LuaSocket/LuaSec.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/sort.html">sort</a></td>
<td class="summary">This module contains a collection of comparison functions (or factories for comparison functions) for <a href="https://www.lua.org/manual/5.1/manual.html#pdf-table.sort">table.sort</a>.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/suntime.html">suntime</a></td>
<td class="summary">-- Author: Martin Zwicknagl (zwim)
-- Date: 2021-10-29
-- The current source code of this file can be found on https://github.com/zwim/suntime.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/time.html">time</a></td>
<td class="summary">A runtime optimized module to compare and do simple arithmetic with fixed point time values (which are called fts in here).</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.bidi.html">ui.bidi</a></td>
<td class="summary">Bidirectional text and UI mirroring setup and helpers.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.data.css_tweaks.html">ui.data.css_tweaks</a></td>
<td class="summary">CSS tweaks must have the following attributes:
- id: unique ID identifying this tweak, to be stored in settings
- title: menu item title (must not be too long)
- css: stylesheet text to append to external stylesheet
They may have the following optional attributes:
- description: text displayed when holding on menu item
- priority: higher numbers are appended after lower numbers
(if not specified, default to 0)
- conflicts<em>with: a string with the id of another tweak that should be
disabled when this tweak is enabled, or an array/table of tweaks ids,
or a function(other</em>id) return true for ids conflicting.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.data.keyboardlayouts.generic_ime.html">ui.data.keyboardlayouts.generic_ime</a></td>
<td class="summary">Generic input method engine --</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.data.keyboardlayouts.ja_keyboard.html">ui.data.keyboardlayouts.ja_keyboard</a></td>
<td class="summary">Japanese 12-key flick keyboard layout, modelled after Android's flick
keyboard.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.data.keyboardlayouts.ja_keyboard_keys.html">ui.data.keyboardlayouts.ja_keyboard_keys</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.data.keyboardlayouts.ko_KR_helper.html">ui.data.keyboardlayouts.ko_KR_helper</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.data.keyboardlayouts.zh_keyboard.html">ui.data.keyboardlayouts.zh_keyboard</a></td>
<td class="summary">Chinese stroke-based input method for Lua/KOReader.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.data.optionsutil.html">ui.data.optionsutil</a></td>
<td class="summary">This module contains miscellaneous helper functions for the creoptions and koptoptions.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.downloadmgr.html">ui.downloadmgr</a></td>
<td class="summary">This module displays a PathChooser widget to choose a download directory.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.event.html">ui.event</a></td>
<td class="summary">Events are messages that are passed through the widget tree.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.font.html">ui.font</a></td>
<td class="summary">Font module.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.geometry.html">ui.geometry</a></td>
<td class="summary">Utilities for 2D geometry.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.hook_container.html">ui.hook_container</a></td>
<td class="summary">HookContainer allows listeners to register and unregister a hook for speakers to execute.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.menusorter.html">ui.menusorter</a></td>
<td class="summary">This module is responsible for constructing the KOReader menu based on a list of
menu_items and a separate menu order.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.network.wpa_supplicant.html">ui.network.wpa_supplicant</a></td>
<td class="summary">WPA client helper for Kobo.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.otamanager.html">ui.otamanager</a></td>
<td class="summary">Checks for updates on the specified nightly build server.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.plugin.background_task_plugin.html">ui.plugin.background_task_plugin</a></td>
<td class="summary">BackgroundTaskPlugin creates a plugin with a switch to enable or disable it and executes a
background task.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.plugin.switch_plugin.html">ui.plugin.switch_plugin</a></td>
<td class="summary">SwitchPlugin creates a plugin with a switch to enable or disable it.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.quickstart.html">ui.quickstart</a></td>
<td class="summary">This module is responsible for generating the quickstart guide.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.renderimage.html">ui.renderimage</a></td>
<td class="summary">Image rendering module.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.rendertext.html">ui.rendertext</a></td>
<td class="summary">Text rendering module.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.size.html">ui.size</a></td>
<td class="summary">This module provides a standardized set of sizes for use in widgets.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.translator.html">ui.translator</a></td>
<td class="summary">This module translates text using Google Translate.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.trapper.html">ui.trapper</a></td>
<td class="summary">Trapper module: provides methods for simple interaction with UI,
without the need for explicit callbacks, for use by linear jobs
between their steps.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.uimanager.html">ui.uimanager</a></td>
<td class="summary">This module manages widgets.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.viewhtml.html">ui.viewhtml</a></td>
<td class="summary">This module shows HTML code and CSS content from crengine documents.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.bboxwidget.html">ui.widget.bboxwidget</a></td>
<td class="summary">BBoxWidget shows a bbox for page cropping.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.button.html">ui.widget.button</a></td>
<td class="summary">A button widget that shows text or an icon and handles callback when tapped.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.buttondialog.html">ui.widget.buttondialog</a></td>
<td class="summary">A button dialog widget that shows a grid of buttons.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.checkbutton.html">ui.widget.checkbutton</a></td>
<td class="summary">Button widget that shows a checkmark (<code>✓</code>) when checked and an empty box (<code>□</code>)
when unchecked.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.checkmark.html">ui.widget.checkmark</a></td>
<td class="summary">Widget that shows a checkmark (<code>✓</code>), an empty box (<code>□</code>)
or nothing of the same size.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.confirmbox.html">ui.widget.confirmbox</a></td>
<td class="summary">Widget that shows a confirmation alert with a message and Cancel/OK buttons.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.container.alphacontainer.html">ui.widget.container.alphacontainer</a></td>
<td class="summary">AlphaContainer will paint its content (a single widget) at the specified opacity level (0..1)</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.container.bottomcontainer.html">ui.widget.container.bottomcontainer</a></td>
<td class="summary">BottomContainer contains its content (1 widget) at the bottom of its own
dimensions</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.container.centercontainer.html">ui.widget.container.centercontainer</a></td>
<td class="summary">CenterContainer centers its content (1 widget) within its own dimensions</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.container.framecontainer.html">ui.widget.container.framecontainer</a></td>
<td class="summary">A FrameContainer is some graphics content (1 widget) that is surrounded by a
frame</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.container.inputcontainer.html">ui.widget.container.inputcontainer</a></td>
<td class="summary">An InputContainer is a WidgetContainer that handles user input events including multi touches and key presses.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.container.leftcontainer.html">ui.widget.container.leftcontainer</a></td>
<td class="summary">LeftContainer aligns its content (1 widget) at the left of its own dimensions</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.container.movablecontainer.html">ui.widget.container.movablecontainer</a></td>
<td class="summary">A MovableContainer can have its content moved on screen
with Swipe/Hold/Pan.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.container.rightcontainer.html">ui.widget.container.rightcontainer</a></td>
<td class="summary">RightContainer aligns its content (1 widget) at the right of its own dimensions</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.container.scrollablecontainer.html">ui.widget.container.scrollablecontainer</a></td>
<td class="summary">ScrollableContainer allows scrolling its content (1 widget) within its own dimensions</p>
<p>This scrollable container needs to be known as widget.cropping_widget in
the widget using it that is passed to UIManager:show() for UIManager to
ensure proper interception of inner widget self-repainting/invert (mostly
used when flashing for UI feedback that we want to limit to the cropped
area).</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.container.topcontainer.html">ui.widget.container.topcontainer</a></td>
<td class="summary">TopContainer contains its content (1 widget) at the top of its own dimensions</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.container.underlinecontainer.html">ui.widget.container.underlinecontainer</a></td>
<td class="summary">An UnderlineContainer is a WidgetContainer that is able to paint
a line under its child node.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.container.widgetcontainer.html">ui.widget.container.widgetcontainer</a></td>
<td class="summary">WidgetContainer is a container for one or multiple Widgets.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.datetimewidget.html">ui.widget.datetimewidget</a></td>
<td class="summary">Widget for setting the date or time.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.eventlistener.html">ui.widget.eventlistener</a></td>
<td class="summary">The EventListener is an interface that handles events.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.horizontalgroup.html">ui.widget.horizontalgroup</a></td>
<td class="summary">A layout widget that puts objects besides each other.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.htmlboxwidget.html">ui.widget.htmlboxwidget</a></td>
<td class="summary">HTML widget (without scroll bars).</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.iconbutton.html">ui.widget.iconbutton</a></td>
<td class="summary">Button with a big icon image! Designed for touch devices.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.iconwidget.html">ui.widget.iconwidget</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.imageviewer.html">ui.widget.imageviewer</a></td>
<td class="summary">ImageViewer displays an image with some simple manipulation options.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.imagewidget.html">ui.widget.imagewidget</a></td>
<td class="summary">ImageWidget shows an image from a file or memory.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.infomessage.html">ui.widget.infomessage</a></td>
<td class="summary">Widget that displays an informational message.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.inputdialog.html">ui.widget.inputdialog</a></td>
<td class="summary">Widget for taking user input.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.keyboardlayoutdialog.html">ui.widget.keyboardlayoutdialog</a></td>
<td class="summary">This widget displays a keyboard layout dialog.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.keyvaluepage.html">ui.widget.keyvaluepage</a></td>
<td class="summary">Widget that presents a multi-page to show key value pairs.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.linewidget.html">ui.widget.linewidget</a></td>
<td class="summary">Widget that displays a line.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.listview.html">ui.widget.listview</a></td>
<td class="summary">Widget component that handles pagination for a list of items.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.multiconfirmbox.html">ui.widget.multiconfirmbox</a></td>
<td class="summary">Widget that shows a message and cancel/choice1/choice2 buttons</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.multiinputdialog.html">ui.widget.multiinputdialog</a></td>
<td class="summary">Widget for taking multiple user inputs.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.networksetting.html">ui.widget.networksetting</a></td>
<td class="summary">Network setting widget.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.notification.html">ui.widget.notification</a></td>
<td class="summary">Widget that displays a tiny notification at the top of the screen.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.numberpickerwidget.html">ui.widget.numberpickerwidget</a></td>
<td class="summary">A customizable number picker.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.openwithdialog.html">ui.widget.openwithdialog</a></td>
<td class="summary">This widget displays an open with dialog.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.overlapgroup.html">ui.widget.overlapgroup</a></td>
<td class="summary">A layout widget that puts objects above each other.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.progresswidget.html">ui.widget.progresswidget</a></td>
<td class="summary">Widget for displaying progress bar.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.qrmessage.html">ui.widget.qrmessage</a></td>
<td class="summary">Widget that displays a qr code.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.radiobuttontable.html">ui.widget.radiobuttontable</a></td>
<td class="summary">A button table to be used in dialogs and widgets.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.radiobuttonwidget.html">ui.widget.radiobuttonwidget</a></td>
<td class="summary">Widget that allows selecting an entry from a <a href="modules/ui.widget.radiobuttontable.html#">RadioButton</a> list.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.scrollhtmlwidget.html">ui.widget.scrollhtmlwidget</a></td>
<td class="summary">HTML widget with vertical scroll bar.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.scrolltextwidget.html">ui.widget.scrolltextwidget</a></td>
<td class="summary">Text widget with vertical scroll bar.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.textboxwidget.html">ui.widget.textboxwidget</a></td>
<td class="summary">A TextWidget that handles long text wrapping</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.textviewer.html">ui.widget.textviewer</a></td>
<td class="summary">Displays some text in a scrollable view.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.textwidget.html">ui.widget.textwidget</a></td>
<td class="summary">A TextWidget puts a string on a single line.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.toggleswitch.html">ui.widget.toggleswitch</a></td>
<td class="summary">Displays a button that toggles between states.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.touchmenu.html">ui.widget.touchmenu</a></td>
<td class="summary">TouchMenu widget for hierarchical menus.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.trapwidget.html">ui.widget.trapwidget</a></td>
<td class="summary">Invisible full screen widget for catching UI events.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.verticalgroup.html">ui.widget.verticalgroup</a></td>
<td class="summary">A layout widget that puts objects under each other.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ui.widget.widget.html">ui.widget.widget</a></td>
<td class="summary">This is a generic Widget interface, which is the base class for all other widgets.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/userpatch.html">userpatch</a></td>
<td class="summary">Allows applying developer patches while running KOReader.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/util.html">util</a></td>
<td class="summary">This module contains miscellaneous helper functions for the KOReader frontend.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/version.html">version</a></td>
<td class="summary">This module helps with retrieving version information.</td>
</tr>
</table>
<h2>Topics</h2>
<table class="module_list">
<tr>
<td class="name" nowrap><a href="topics/Collaborating_with_Git.md.html">Collaborating_with_Git.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" nowrap><a href="topics/DataStore.md.html">DataStore.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" nowrap><a href="topics/Development_guide.md.html">Development_guide.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" nowrap><a href="topics/Events.md.html">Events.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" nowrap><a href="topics/Hacking.md.html">Hacking.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" nowrap><a href="topics/Porting.md.html">Porting.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" nowrap><a href="topics/README.md.html">README.md</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name" nowrap><a href="topics/Unit_tests.md.html">Unit_tests.md</a></td>
<td class="summary"></td>
</tr>
</table>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2025-02-15 09:40:25 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>