OrgGo/clui
1
0
Fork 0
mirror of https://github.com/VladimirMarkelov/clui.git synced 2025-05-08 19:29:42 +08:00
Code Issues Projects Releases Wiki Activity

readme clean up

Browse Source
This commit is contained in:
Vladimir Markelov 2017-04-04 11:21:29 -07:00
parent ee96e7722c
commit b94add7920
2 changed files with 14 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,11 +1,10 @@
# clui # CLUI
Command Line User Interface (Console UI inspired by TurboVision) with built-in theme support. Command Line User Interface (Console UI inspired by TurboVision) with built-in theme support. Please see screenshots of working examples at the end of the README.
## Current version ## Current version
The current version is 0.5 and it has a lot of breaking changes comparing to previous one. The library was refactored and added support for new termbox features like mouse move event. Some constants and function changes their names. Please see details in [changelog](./changelog). The current version is 0.5 and it has a lot of breaking changes comparing to previous one. Please see details in [changelog](./changelog).
## Introduction ## The list of available controls
The list of available controls:
* View (Main control container - with maximize, window order and other window features) * View (Main control container - with maximize, window order and other window features)
* Label (Horizontal and Vertical with basic color control tags) * Label (Horizontal and Vertical with basic color control tags)
* Button (Simple push button control) * Button (Simple push button control)
@ -23,9 +22,6 @@ The list of available controls:
* SparkChart (Show tabular data as a bar graph) * SparkChart (Show tabular data as a bar graph)
* GridView (Table to show structured data - only virtual and readonly mode with scroll support) * GridView (Table to show structured data - only virtual and readonly mode with scroll support)
#### TODO
* More to come
## Screenshots ## Screenshots
The main demo (theme changing and radio group control) The main demo (theme changing and radio group control)

21
changelog
View File

@ -3,7 +3,7 @@
[+] Added mouse move and mouse button release support: [+] Added mouse move and mouse button release support:
Now all windows can be dragged and resized with mouse Now all windows can be dragged and resized with mouse
[+] Added constants for dragging events - new type DragType [+] Added constants for dragging events - new type DragType
[+] Added new type of Event MouseClick: it generates if a user does mouse [+] Added new type of Event MouseClick: it is generated if a user does mouse
button down and mouse release at the same coordinates. In this case a button down and mouse release at the same coordinates. In this case a
control recieves 3 events: mouse down, mouse release, and mouse click control recieves 3 events: mouse down, mouse release, and mouse click
[+] Main loop moved to separate source file [+] Main loop moved to separate source file
@ -11,20 +11,20 @@
[*] Logger moved to separate source file and it is global object now [*] Logger moved to separate source file and it is global object now
[*] Windows do not have their own interface - all objects are derived from the [*] Windows do not have their own interface - all objects are derived from the
same interface. It simplifies things like container objects same interface
[*] Library initialization is made simpler: only one call is required, there [*] Library initialization is made simpler: only one call is required, there
is no need to create composer, theme manager etc manually - everything is is no need to create composer, theme manager etc manually - everything is
created inside library initialization created inside library initialization
[*] Because composer, theme manager and some other objects are hidden now then [*] Because composer, theme manager and some other objects are hidden now then
a set of methods are just global library functions: a set of methods are just global library functions:
Event processing functions like Stop(), PutEvent() etc - Event processing functions like Stop(), PutEvent() etc
Theme manager related functions like SysColor(), SysObject() etc - Theme manager related functions like SysColor(), SysObject() etc
[*] All functions to create new objects New* are renamed to Create* functions. [*] All functions to create new objects New* are renamed to Create* functions.
CreateWindow now is for internal use only: it creates a window but it does Exclusion: CreateWindow is for internal use only: it creates a window but it
not do anything else, so the window is not displayed and a user cannot does not do anything else, so the window is not displayed and a user cannot
interact with it. Use AddWindow function instead of CreateWindows. interact with it. Use AddWindow function instead of CreateWindow.
[*] All text output is colorized by default. So, Multicolor property is [*] All text output is colorized by default. Multicolor property is removed.
removed. If you want to draw text as is then use DrawRaw* functions. If you want to draw text as is then use DrawRaw* functions.
[*] Now all drawing function uses the current canvas colors, so all color [*] Now all drawing function uses the current canvas colors, so all color
function arguments of all drawing functions are removed. Use global function arguments of all drawing functions are removed. Use global
functions SetTextColor and SetBackColor to change colors before drawing. functions SetTextColor and SetBackColor to change colors before drawing.
@ -36,5 +36,4 @@
[-] The first argument view of all Create* functions is removed as obsolete. [-] The first argument view of all Create* functions is removed as obsolete.
Now library does not require to set parent Window. It is sufficient to set Now library does not require to set parent Window. It is sufficient to set
only control's parent. It made some functions more complex but it seems only control's parent
easier for developer