text field working
[nikiroo-utils.git] / README.md
... / ...
CommitLineData
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
57Many tasks remain before calling this version 1.0:
58
590.0.1:
60
61- TDirectoryList
62- TMessageBox
63- THScroller / TVScroller
64- TText
65- TTreeView
66
670.0.2:
68
69- TEditor
70- TFileOpen
71- TTerminal
72
730.0.3:
74
75- Bugs
76 - TSubMenu keyboard mnemonic not working
77 - kbDel assertion failure in TMenu (MID_CLEAR)
78- TEditor
79 - Word wrap
80 - Forward/backward word
81 - Search
82 - Replace
83 - Cut/Copy/Paste
84
850.0.4:
86
87- ECMATerminal
88 - Mouse 1006 mode parsing
89- Bugs
90 - TDirectoryList cannot be navigated only with keyboard
91 - TTreeView cannot be navigated only with keyboard
92 - RangeViolation after dragging scrollbar up/down
93
94Wishlist features (2.0):
95
96- TTerminal
97 - Handle resize events (pass to child process)
98 - xterm mouse handling
99- TWindow
100 - "Smart placement" for new windows
101- Screen
102 - Allow complex characters in putCharXY() and detect them in putStrXY().
103- TComboBox
104- TListBox
105- TSpinner
106- TCalendar widget
107- TColorPicker widget
108- Drag and drop
109 - TEditor
110 - TField
111 - TText
112 - TTerminal
113 - TComboBox
114- AWTBackend