nuttx-apps/graphics/nxwidgets/doc/mainpage.h

84 lines
3.9 KiB
C
Raw Normal View History

/*! \mainpage NXWidgets Documentation
*
* 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 subystem in order to
* provide graphic objects, or "widgets", in the <a title="NX Graphics
* Subsystem" href="https://bitbucket.org/nuttx/documentation/src/master/NXGraphicsSubsystem.html">
* NX Graphics Subsystem</a>.
*
* \section feature Features
*
* \subsection conservative_cxx Conservative C++
*
* 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.
*
* \subsection nx_integration NX Integration
*
* Integrates seamlessly with the NX graphics subsytem. Think of the X
* server under Linux... the NX graphics subsystem is like a tiny X server
* that provides windowing under NuttX. By adding NXWidgets, you can
* support graphic objects like buttons and text boxes in the NX windows
* and toolbars.
*
* \subsection small_footprint Small Footprint
*
* 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.
*
* \subsection output_devices Output Devices
*
* NXWidgets will work on the high-end fram buffer devices as well as on
* LCDs connected via serial or parallel port to a small MCU.
*
* \subsection input_devices 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 a very special widget called
* CKeypad that will provide keyboard input via on-screen keypad that can
* be operated via mouse or touchscreen inputs.
*
* \subsection many_graphic_objects 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.
*
* \subsection NXWM\
*
* NxWM isthe tiny window manager based on NX and NxWidgets. NxWM is a true
* multiple window manager but only one window is displayed at a time. This
* simplification helps performance on LCD based products (in the same way
* that a tiled window manager helps) and also makes the best use of small
* displays. It is awkward from a human factors point-of-view trying to
* manage multiple windows on a small display.
*
* The window manager consists of a task bar with icons representing the
* running tasks. If you touch the task's icon, it comes to the top. Each
* window has a toolbar with (1) a title, (2) a minimize button, and (3) a
* stop application button using the standard icons for these things. User
* input via a touchscreen or mouse and keyboard is supported.
*
* There is always a start window that is available in the task bar. When
* you touch the start window icon, it brings up the start window containing
* icons representing all of the available applications. If you touch an
* icon in the start window, it will be started and added to the task bar.
*
* There is a base class that defines an add-on application and an interface
* that supports incorporation of new applications. The only application
2014-09-20 22:43:30 +02:00
* that is provided is NxTerm. This is an NSH session running in a window.
* You should be able to select the NX icon in the start menu and create as
* many NSH sessions in windows as you want. (keybard input still comes
* through serial).
*
* Note 1: The current release of NwWM requires NuttX-7.24 or above.
*
* Note 2: Many of the fundamental classes 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.
*/