|
| 1 | +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" |
| 2 | + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| 3 | +<html> |
| 4 | +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> |
| 5 | +<head> |
| 6 | + <title>KOReader Documentation</title> |
| 7 | + <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" /> |
| 8 | +</head> |
| 9 | +<body> |
| 10 | + |
| 11 | +<div id="container"> |
| 12 | + |
| 13 | +<div id="product"> |
| 14 | + <div id="product_logo"></div> |
| 15 | + <div id="product_name"><big><b></b></big></div> |
| 16 | + <div id="product_description"></div> |
| 17 | +</div> <!-- id="product" --> |
| 18 | + |
| 19 | + |
| 20 | +<div id="main"> |
| 21 | + |
| 22 | + |
| 23 | +<!-- Menu --> |
| 24 | + |
| 25 | +<div id="navigation"> |
| 26 | +<br/> |
| 27 | +<h1>KOReader</h1> |
| 28 | + |
| 29 | +<ul> |
| 30 | + <li><a href="../index.html">Index</a></li> |
| 31 | +</ul> |
| 32 | + |
| 33 | + |
| 34 | + |
| 35 | +<h2>Topics</h2> |
| 36 | +<ul class="$(kind=='Topics' and '' or 'nowrap'"> |
| 37 | + <li><strong>Hacking</strong></li> |
| 38 | + <li><a href="../topics/README.md.html">README</a></li> |
| 39 | +</ul> |
| 40 | +<h2>Modules</h2> |
| 41 | +<ul class="$(kind=='Topics' and '' or 'nowrap'"> |
| 42 | + <li><a href="../modules/MD5.html">MD5</a></li> |
| 43 | + <li><a href="../modules/optmath.html">optmath</a></li> |
| 44 | + <li><a href="../modules/ui.font.html">ui.font</a></li> |
| 45 | + <li><a href="../modules/ui.rendertext.html">ui.rendertext</a></li> |
| 46 | + <li><a href="../modules/ui.widget.closebutton.html">ui.widget.closebutton</a></li> |
| 47 | + <li><a href="../modules/ui.widget.keyvaluepage.html">ui.widget.keyvaluepage</a></li> |
| 48 | + <li><a href="../modules/util.html">util</a></li> |
| 49 | +</ul> |
| 50 | + |
| 51 | +</div> |
| 52 | + |
| 53 | +<div id="content"> |
| 54 | + |
| 55 | + |
| 56 | +<h1>Hacking</h1> |
| 57 | + |
| 58 | +<h2>Developing UI Widgets</h2> |
| 59 | + |
| 60 | +<p>If you need to create new UI widgets, <code>utils/wbuilder.lua</code> is your friend. It |
| 61 | +sets up a minimal environment to bootstrap KOReader's UI framework to avoid |
| 62 | +starting the whole reader. This gives you quick feedback loop while iterating |
| 63 | +through your widget changes.</p> |
| 64 | + |
| 65 | +<p>To get a taste of how it works, try running this command at the root of |
| 66 | +KOReader's source tree:</p> |
| 67 | + |
| 68 | +<pre><code> ./kodev wbuilder |
| 69 | +</code></pre> |
| 70 | + |
| 71 | + |
| 72 | +<p>It will spawn up an emulator window with a grid and simple timer widget for |
| 73 | +demonstration.</p> |
| 74 | + |
| 75 | +<p>You can add your own <code>UIManager:show</code> show call at the end of |
| 76 | +<code>utils/wbuilder.lua</code> to test your new widget.</p> |
| 77 | + |
| 78 | + |
| 79 | +</div> <!-- id="content" --> |
| 80 | +</div> <!-- id="main" --> |
| 81 | +<div id="about"> |
| 82 | +<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i> |
| 83 | +<i style="float:right;">Last updated 2016-02-18 22:05:53 </i> |
| 84 | +</div> <!-- id="about" --> |
| 85 | +</div> <!-- id="container" --> |
| 86 | +</body> |
| 87 | +</html> |
0 commit comments