nuttx-apps/graphics/nxwidgets/README.md

# Graphics / `nxwidgets` NXWidgets

In order to better support NuttX based platforms, a special graphical user
interface has been created called NXWidgets. NXWidgets is written in C++ and
integrates seamlessly with the NuttX NX graphics subsystem in order to provide
graphic objects, or _widgets_, in the NX Graphics Subsystem

Some of the features of NXWidgets include:

- Conservative C++

  NXWidgets is written entirely in C++ but using only selected _embedded
  friendly_ C++ constructs that are fully supported under NuttX. No additional
  C++ support libraries are required.

- NX Integration

  NXWidgets integrate seamlessly with the NX graphics system. Think of the X
  server under Linux – the NX graphics system is like a tiny X server that
  provides windowing under NuttX. By adding NXWidgets, you can support graphics
  objects like buttons and text boxes in the NX windows and toolbars.

- Small Footprint

  NXWidgets is tailored for use MCUs in embedded applications. It is ideally
  suited for mid- and upper-range of most MCU families. A complete NXWidgets is
  possible in as little as 40Kb of FLASH and maybe 4Kb of SRAM.

- Output Devices

  NXWidgets will work on the high-end frame buffer devices as well as on LCDs
  connected via serial or parallel ports to a small MCU.

- Input Devices

  NXWidgets will accept position and selection inputs from a mouse or a
  touchscreen. It will also support character input from a keyboard such as a
  USB keyboard. NXWidgets supports on very special widget called `CKeypad` that
  will provide keyboard input via an on-screen keypad that can be operated via
  mouse or touchscreen inputs.

- Many Graphic Objects

  Some of the graphic objects supported by NXWidgets include labels, buttons,
  text boxes, button arrays, check boxes, cycle buttons, images, sliders,
  scrollable list boxes, progress bars, and more.

**Note**: Many of the fundamental classed in NxWidgets derive from the Antony
Dzeryn's _Woopsi_ project: http://woopsi.org/ which also has a BSD style
license. See the `COPYING` file for details.

## Directory Structure

- `Kconfig`

  This is a `Kconfig` file that should be provided at `apps/NxWidgets/Kconfig`.
  When copied to that location, it will be used by the NuttX configuration
  systems to configure settings for NxWidgets and NxWM

- `nxwidgets`

  The source code, header files, and build environment for NxWidgets is provided
  in this directory.

- `UnitTests`

  Provides a collection of unit-level tests for many of the individual widgets
  provided by `nxwidgets`.