A text-based widget toolkit
Go to file
Markus Gans 838ba23c46 Integration of an output filter to replace missing characters 2019-01-03 07:36:18 +01:00
debian Better handling of the scrollbar maximum 2018-12-09 18:24:31 +01:00
doc Add a "signals and callbacks" chapter into the first steps document 2018-12-28 09:42:28 +01:00
examples Integration of an output filter to replace missing characters 2019-01-03 07:36:18 +01:00
fonts some fixes 2018-12-22 15:33:23 +01:00
icon FWidget now inherits directly from FObject 2017-10-27 23:28:37 +02:00
logo change from int to std::size_t for width or height 2018-10-14 06:25:33 +02:00
m4 Easier handling of fc::SpecialCharacter 2018-12-06 03:55:32 +01:00
scripts Reduce the use of the new operators in the examples 2018-10-03 22:23:55 +02:00
src Integration of an output filter to replace missing characters 2019-01-03 07:36:18 +01:00
test Integration of an output filter to replace missing characters 2019-01-03 07:36:18 +01:00
.bettercodehub.yml Better Code Hub - component_depth: 1 2018-09-21 07:18:48 +02:00
.codedocs some fixes 2018-12-22 15:33:23 +01:00
.gitignore FListViewItem now provides checkable list view items 2018-11-18 01:15:38 +01:00
.lgtm.yml .lgtm.yml 2018-12-08 05:30:53 +01:00
.travis.yml .lgtm.yml 2018-12-07 19:58:26 +01:00
AUTHORS upload 2015-05-23 13:35:12 +02:00
COPYING license information 2018-02-17 20:58:07 +01:00
COPYING.LESSER license information 2018-02-17 20:58:07 +01:00
ChangeLog Integration of an output filter to replace missing characters 2019-01-03 07:36:18 +01:00
Makefile.am some fixes 2018-12-22 15:33:23 +01:00
README.md Improved Sun Microsystems workstation console quirks 2018-11-24 02:59:56 +01:00
autogen.sh Moved FTerm debug access methods to FTermDebugData 2018-11-01 21:29:54 +01:00
build.sh memory management + handling environment variables with numbers 2018-11-24 23:43:09 +01:00
configure.ac some fixes 2018-12-22 15:33:23 +01:00
finalcut.changes packaging update 2018-11-29 23:31:01 +01:00
finalcut.pc.in some fixes 2018-12-22 15:33:23 +01:00
finalcut.spec.in Improved PC encoding for Cygwin and Linux 2019-01-02 03:00:07 +01:00

README.md

FINAL CUT

Building and code analysis

Latest release:
     Latest Release
Travis CI:
     Build Status
Coverity Scan:
     Coverity Scan Status
LGTM:
     Language grade: C/C++
Class Reference:
     documented

Description

The FINAL CUT is a C++ class library and widget toolkit with full mouse support for creating a text-based user interface. The library supports the programmer to develop an application for the text console. It allows the simultaneous handling of multiple text windows on the screen.

The structure of the Qt framework was originally the inspiration for the C++ class design of FINAL CUT. It provides common controls like dialog boxes, push buttons, check boxes, radio buttons, input lines, list boxes, status bars and so on.

Installation

> git clone git://github.com/gansm/finalcut.git
> cd finalcut
> autoreconf --install --force
> ./configure --prefix=/usr
> make
> su -c "make install"

Supported platforms

  • Linux
  • FreeBSD
  • NetBSD
  • OpenBSD
  • macOS
  • Cygwin
  • Solaris

First steps

How to use the library

Screenshots

The FFileDialog widget:

FFileDialog

The Final Cut FProgressbar widget:

FProgressbar

Scrollable text in the FTextView widget:

FTextView

The Mandelbrot set example:

Mandelbrot set

newfont

A graphical text font for X11 and the Linux console.

ui example in newfont mode

Newfont drive symbols:

drive symbols

The calculator example in newfont mode:

calculator

Virtual terminal

It uses a virtual terminal to print the character via an update method on the screen. The virtual windows are an overlying layer to realizing window movements. The update method transmits only the changes to the virtual terminal or the screen.

 print(...)
printf(...)
  │
  │           ╔═════════════════════════[ vterm ]═════════════════════════╗
  │           ║createVTerm()                                              ║
  │           ║                                 ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐ ║
  │           ║                                                           ║
  │           ║                                 │ restoreVTerm(x,y,w,h) │ ║
  │           ║                                                           ║
  │           ║                                 └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘ ║
  │           ║                                                           ║
  │   ┌───────╨─────[ vwin ]─────────────┐                                ║
  │   │createArea(area)                  │                                ║
  │   │                                  │                                ║
  │   │                                  │                                ║
  └───┼─────────────►     ──────► updateVTerm(area) ────►                 ║
      │                                  │                                ║
      │                           putArea(x,y,area)                       ║
      │                         ────────────────────►                     ║
      │                           getArea(x,y,area)                       ║
      │                        ◄────────────────────                      ║
      │                                  │                                ║
      │                                  │                                ║
      │                  resizeArea(area)│                                ║
      └───────╥──────────────────────────┘                                ║
              ║                                                           ║
              ║                                                           ║
              ║                                                           ║
              ║   │                                          resizeVTerm()║
              ╚═══▼═══════════════════════════════════════════════════════╝
                  │
                  │    putVTerm()
                  └──────────────────► updateTerminalLine(y)
                    updateTerminal()             │
                                                 ▼
                                         ┌───────────────┐
                                         │ output_buffer │
                                         └───────────────┘
                                                 │
                                                 │ flush_out()
                                                 │     +
                                                 │ Fputchar(char)
                                                 │
                                                 ▼
                                         ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
                                         ▌               ▐
                                         ▌    screen     ▐
                                         ▌ ───────────── ▐
                                         ▌ real terminal ▐
                                         ▌               ▐
                                         ▀▀▀▀▀▀▀███▀▀▀▀▀▀▀
                                                ███
                                             ▀▀▀▀▀▀▀▀▀

Class digramm

              1┌──────────────┐
   ┌-----------┤ FTermFreeBSD │
   :           └──────────────┘
   :          1┌──────────────┐         ┌───────────┐
   ┌-----------┤ FTermOpenBSD │    ┌────┤ FKeyEvent │
   :           └──────────────┘    │    └───────────┘
   :          1┌────────────────┐  │    ┌─────────────┐
   ┌-----------┤ FTermDetection │  ├────┤ FMouseEvent │
   :           └────────────────┘  │    └─────────────┘
   :          1┌────────────────┐  │    ┌─────────────┐
   ┌-----------┤ FTermcapQuirks │  ├────┤ FWheelEvent │
   :           └────────────────┘  │    └─────────────┘
   :          1┌────────────────┐  │    ┌─────────────┐
   ┌-----------┤ FTermXTerminal │  ├────┤ FFocusEvent │
   :           └────────────────┘  │    └─────────────┘
   :          1┌──────────┐        │    ┌─────────────┐
   ┌-----------┤ FTermcap │        ├────┤ FAccelEvent │
   :           └──────────┘        │    └─────────────┘
   :          1┌──────────┐        │    ┌──────────────┐
   ┌-----------┤ FTermios │        ├────┤ FResizeEvent │
   :           └──────────┘        │    └──────────────┘
   :          1┌───────────────┐   │    ┌────────────┐
   ┌-----------┤ FColorPalette │   ├────┤ FShowEvent │
   :           └───────────────┘   │    └────────────┘
   :          1┌───────────┐       │    ┌────────────┐
   ┌-----------┤ FOptiMove │       ├────┤ FHideEvent │
   :           └───────────┘       │    └────────────┘
   :          1┌───────────┐       │    ┌─────────────┐
   ┌-----------┤ FOptiAttr │       ├────┤ FCloseEvent │
   :           └───────────┘       │    └─────────────┘
   :          1┌───────────┐       │    ┌─────────────┐
   ┌-----------┤ FKeyboard │       ├────┤ FTimerEvent │
   :           └───────────┘       │    └─────────────┘
   :          1┌───────────────┐   │
   ┌-----------┤ FMouseControl │   │       ┌──────────────┐
   :           └───────────────┘   │  ┌────┤ FApplication │
   :          *┌─────────┐         │  │    └──────────────┘
   :  ┌--------┤ FString │         │  │    ┌─────────┐
   :  :        └─────────┘         │  ├────┤ FButton │
   :  :       *┌────────┐          │  │    └─────────┘
   :  ┌--------┤ FPoint │          │  │    ┌────────┐
   :  :        └────────┘          │  ├────┤ FLabel │
   :  :       *┌───────┐           │  │    └────────┘
   :  ┌--------┤ FRect │           │  │    ┌───────────┐
   :  :        └───────┘           │  ├────┤ FLineEdit │
   :1 :1                           │  │    └───────────┘
 ┌─┴──┴──┐                         │  │    ┌──────────────┐      ┌──────────────┐
 │ FTerm │                         │  ├────┤ FButtonGroup │   ┌──┤ FRadioButton │
 └───┬───┘         ┌────────┐      │  │    └──────────────┘   │  └──────────────┘
     :1            │ FEvent │◄─────┘  │    ┌───────────────┐  │  ┌───────────┐
 ┌───┴────┐        └────┬───┘         ├────┤ FToggleButton │◄─┼──┤ FCheckBox │
 │ FVTerm │◄──┐         :1            │    └───────────────┘  │  └───────────┘
 └────────┘   │    ┌────┴────┐        │    ┌──────────────┐   │  ┌─────────┐
              ├────┤ FWidget │◄───────┼────┤ FProgressbar │   └──┤ FSwitch │
┌─────────┐   │    └─────────┘        │    └──────────────┘      └─────────┘
│ FObject │◄──┘                       │    ┌────────────┐
└─────────┘                           ├────┤ FScrollbar │
                                      │    └────────────┘
                                      │    ┌───────────┐
                                      ├────┤ FTextView │
                                      │    └───────────┘
                                      │    ┌──────────┐1     *┌──────────────┐
                                      ├────┤ FListBox ├-------┤ FListBoxItem │
                                      │    └──────────┘       └──────────────┘
 ┌─────────────┐1                     │   1┌───────────┐1    *┌───────────────┐
 │ FTermBuffer ├----------------------├────┤ FListView ├------┤ FListViewItem │
 └─────────────┘                      │    └───────────┘      └───────────────┘
                                      │    ┌─────────────┐
                                      ├────┤ FScrollView │
                                      │    └─────────────┘
                                      │    ┌────────────┐1   *┌────────────┐
                                      │ ┌──┤ FStatusBar ├-----┤ FStatusKey │
                                      │ │  └────────────┘     └────────────┘
                                      │ │
                                      │ ▼                       ┌─────────────┐
                                  ┌───┴─┴───┐  ┌─────────┐   ┌──┤ FFileDialog │
                                  │ FWindow │◄─┤ FDialog │◄──┤  └─────────────┘
                                  └──┬──┬───┘  └─────────┘   │  ┌─────────────┐
                                     ▲  ▲                    └──┤ FMessageBox │
                                     │  │                       └─────────────┘
                                     │  │      ┌──────────┐
                                     │  └──────┤ FToolTip │
                                     │         └──────────┘
                                     └───────────────┐          ┌──────────┐
                                                     │      ┌───┤ FMenuBar │
                                    ┌───────────┐    └──────┤   └──────────┘
                                    │ FMenuList │◄──────────┤   ┌───────┐
                                    └────┬──────┘           └───┤ FMenu │◄──┐
                                         :1                     └───────┘   │
                                         :            ┌─────────────────┐   │
                                         :            │ FDialogListMenu ├───┘
                                         :            └─────────────────┘
                                         └--------------------------------┐
                                         :*          ┌────────────────┐*  :
                                    ┌────┴─────┐  ┌──┤ FCheckMenuItem ├---┘
                                    │FMenuItem │◄─┤  └────────────────┘   :
                                    └──────────┘  │  ┌────────────────┐*  :
                                                  └──┤ FRadioMenuItem ├---┘
                                                     └────────────────┘

License

GNU Lesser General Public License Version 3

Frequently Asked Questions

If you have any problems, please read the FAQ before you give up.

Please send bug reports to

https://github.com/gansm/finalcut/issues