Initial build stubs
[nikiroo-utils.git] / README.md
CommitLineData
7d4115a5
KL
1Jexer - Java Text User Interface library
2========================================
3
4This library is currently in design, but when finished it is intended
5to implement a text-based windowing system loosely reminiscient of
6Borland's [Turbo Vision](http://en.wikipedia.org/wiki/Turbo_Vision)
7library. For those wishing to use the actual C++ Turbo Vision
8library, see [Sergio Sigala's updated
9version](http://tvision.sourceforge.net/) that runs on many more
10platforms.
11
12
13License
14-------
15
16This library is licensed LGPL ("GNU Lesser General Public License")
17version 3 or greater. See the file LICENSE for the full license text,
18which includes both the GPL v3 and the LGPL supplemental terms.
19
20
21Usage
22-----
23
24The library is currently under initial development, usage patterns are
25still being worked on. Generally the goal will be to build
26applications somewhat as follows:
27
28```Java
29import jexer.*;
30
31public class MyApplication extends TApplication {
32
33 public MyApplication() {
34 super();
35
36 // Create an editor window that has support for
37 // copy/paste, search text, arrow keys, horizontal
38 // and vertical scrollbar, etc.
39 addEditor();
40
41 // Create standard menus for File and Window
42 addFileMenu();
43 addWindowMenu();
44 }
45
46 public static void main(String [] args) {
47 MyApplication app = new MyApplication();
48 app.run();
49 }
50}
51```
52
53
54Roadmap
55-------
56
57This is a work in progress. Many tasks remain before calling this
58version 1.0:
59
600.0.1:
61
62- Base classes:
63 - Events
64 - Codepage
65 - TApplication loop
66
670.0.2:
68
69- Get modal messagebox running without fibers
70- Port remaining d-tui functionality over
71 - All widgets
72
730.0.3:
74
75- ECMATerminal
76 - Mouse 1006 mode parsing
77 - Win32 support (used for reading/writing sockets)
78- Bugs
79 - TDirectoryList cannot be navigated only with keyboard
80 - TTreeView cannot be navigated only with keyboard
81 - RangeViolation after dragging scrollbar up/down
82
83Wishlist features (2.0):
84
85- TTerminal
86 - Handle resize events (pass to child process)
87 - xterm mouse handling
88- TWindow
89 - "Smart placement" for new windows
90- Screen
91 - Allow complex characters in putCharXY() and detect them in putStrXY().
92- TComboBox
93- TListBox
94- TSpinner
95- TCalendar widget
96- TColorPicker widget
97- Drag and drop
98 - TEditor
99 - TField
100 - TText
101 - TTerminal
102 - TComboBox
103- AWTBackend
104- ECMABackend
105 - libgpm support