summaryrefslogtreecommitdiff
path: root/NxWidgets/libnxwidgets/doc/mainpage.h
diff options
context:
space:
mode:
Diffstat (limited to 'NxWidgets/libnxwidgets/doc/mainpage.h')
-rw-r--r--NxWidgets/libnxwidgets/doc/mainpage.h33
1 files changed, 33 insertions, 0 deletions
diff --git a/NxWidgets/libnxwidgets/doc/mainpage.h b/NxWidgets/libnxwidgets/doc/mainpage.h
index 9eb5ded83..ccd399e6a 100644
--- a/NxWidgets/libnxwidgets/doc/mainpage.h
+++ b/NxWidgets/libnxwidgets/doc/mainpage.h
@@ -47,4 +47,37 @@
* 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
+ * that is provided is NxConsole. 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: NwWM requires NuttX-6.18 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.
*/