-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
87 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| <!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> | ||
|
|
||
| <ul> | ||
| <li><a href="../index.html">Index</a></li> | ||
| </ul> | ||
|
|
||
|
|
||
|
|
||
| <h2>Topics</h2> | ||
| <ul class="$(kind=='Topics' and '' or 'nowrap'"> | ||
| <li><strong>Hacking</strong></li> | ||
| <li><a href="../topics/README.md.html">README</a></li> | ||
| </ul> | ||
| <h2>Modules</h2> | ||
| <ul class="$(kind=='Topics' and '' or 'nowrap'"> | ||
| <li><a href="../modules/MD5.html">MD5</a></li> | ||
| <li><a href="../modules/optmath.html">optmath</a></li> | ||
| <li><a href="../modules/ui.font.html">ui.font</a></li> | ||
| <li><a href="../modules/ui.rendertext.html">ui.rendertext</a></li> | ||
| <li><a href="../modules/ui.widget.closebutton.html">ui.widget.closebutton</a></li> | ||
| <li><a href="../modules/ui.widget.keyvaluepage.html">ui.widget.keyvaluepage</a></li> | ||
| <li><a href="../modules/util.html">util</a></li> | ||
| </ul> | ||
|
|
||
| </div> | ||
|
|
||
| <div id="content"> | ||
|
|
||
|
|
||
| <h1>Hacking</h1> | ||
|
|
||
| <h2>Developing UI Widgets</h2> | ||
|
|
||
| <p>If you need to create new UI widgets, <code>utils/wbuilder.lua</code> is your friend. It | ||
| sets up a minimal environment to bootstrap KOReader's UI framework to avoid | ||
| starting the whole reader. This gives you quick feedback loop while iterating | ||
| through your widget changes.</p> | ||
|
|
||
| <p>To get a taste of how it works, try running this command at the root of | ||
| KOReader's source tree:</p> | ||
|
|
||
| <pre><code> ./kodev wbuilder | ||
| </code></pre> | ||
|
|
||
|
|
||
| <p>It will spawn up an emulator window with a grid and simple timer widget for | ||
| demonstration.</p> | ||
|
|
||
| <p>You can add your own <code>UIManager:show</code> show call at the end of | ||
| <code>utils/wbuilder.lua</code> to test your new widget.</p> | ||
|
|
||
|
|
||
| </div> <!-- id="content" --> | ||
| </div> <!-- id="main" --> | ||
| <div id="about"> | ||
| <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i> | ||
| <i style="float:right;">Last updated 2016-02-18 22:05:53 </i> | ||
| </div> <!-- id="about" --> | ||
| </div> <!-- id="container" --> | ||
| </body> | ||
| </html> |