summaryrefslogtreecommitdiff
path: root/NxWidgets/nxwm/include/nxwmconfig.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'NxWidgets/nxwm/include/nxwmconfig.hxx')
-rw-r--r--NxWidgets/nxwm/include/nxwmconfig.hxx97
1 files changed, 95 insertions, 2 deletions
diff --git a/NxWidgets/nxwm/include/nxwmconfig.hxx b/NxWidgets/nxwm/include/nxwmconfig.hxx
index a683dbd5f..d76b08098 100644
--- a/NxWidgets/nxwm/include/nxwmconfig.hxx
+++ b/NxWidgets/nxwm/include/nxwmconfig.hxx
@@ -50,11 +50,41 @@
****************************************************************************/
/* General Configuration ****************************************************/
/**
+ * Required settings:
+ *
+ * CONFIG_HAVE_CXX : C++ support is required
+ * CONFIG_NX : NX must enabled
+ * CONFIG_NX_MULTIUSER=y : NX must be configured in multiuse mode
+ * CONFIG_NXCONSOLE=y : For NxConsole support
+ *
+ * General settings:
+ *
+ * CONFIG_NXWM_DEFAULT_FONTID - the NxWM default font ID. Default:
+ * NXFONT_DEFAULT
+ */
+
+#ifndef CONFIG_HAVE_CXX
+# error "C++ support is required (CONFIG_HAVE_CXX)"
+#endif
+
+/**
* NX Multi-user support is required
*/
+#ifndef CONFIG_NX
+# error "NX support is required (CONFIG_NX)"
+#endif
+
#ifndef CONFIG_NX_MULTIUSER
-# warning "NX multi-user support is required (CONFIG_NX_MULTIUSER)"
+# error "NX multi-user support is required (CONFIG_NX_MULTIUSER)"
+#endif
+
+/**
+ * NxConsole support is (probably) required
+ */
+
+#ifndef CONFIG_NXCONSOLE
+# warning "NxConsole support may be needed (CONFIG_NXCONSOLE)"
#endif
/**
@@ -67,6 +97,27 @@
/* Colors *******************************************************************/
/**
+ * Color configuration
+ *
+ * CONFIG_NXWM_DEFAULT_BACKGROUNDCOLOR - Normal background color. Default:
+ * MKRGB(160,160,160)
+ * CONFIG_NXWM_DEFAULT_SELECTEDBACKGROUNDCOLOR - Select background color.
+ * Default: MKRGB(120,192,192)
+ * CONFIG_NXWM_DEFAULT_FOREGROUNDCOLOR - Normal "foreground" color. Default:
+ * MKRGB(192,192,192)
+ * CONFIG_NXWM_DEFAULT_SELECTEDFOREGROUNDCOLOR - Selected "foreground" color.
+ * Default: MKRGB(192,192,192)
+ * CONFIG_NXWM_DEFAULT_SHINEEDGECOLOR - Color of the bright edge of a border.
+ * Default: MKRGB(255,255,255)
+ * CONFIG_NXWM_DEFAULT_SHADOWEDGECOLOR - Color of the shadowed edge of a border.
+ * Default: MKRGB(0,0,0)
+ * CONFIG_NXWM_DEFAULT_FONTCOLOR - Default fong color. Default:
+ * MKRGB(0,0,0)
+ * CONFIG_NXWM_TRANSPARENT_COLOR - The "transparent" color. Default:
+ * MKRGB(0,0,0)
+ */
+
+/**
* Normal background color
*/
@@ -129,6 +180,23 @@
/* Task Bar Configuation ***************************************************/
/**
* Horizontal and vertical spacing of icons in the task bar.
+ *
+ * CONFIG_NXWM_TASKBAR_VSPACING - Vertical spacing. Default: 2 pixels
+ * CONFIG_NXWM_TASKBAR_HSPACING - Horizontal spacing. Default: 2 rows
+ *
+ * Task bar location. Default is CONFIG_NXWM_TASKBAR_TOP.
+ *
+ * CONFIG_NXWM_TASKBAR_TOP - Task bar is at the top of the display
+ * CONFIG_NXWM_TASKBAR_BOTTOM - Task bar is at the bottom of the display
+ * CONFIG_NXWM_TASKBAR_LEFT - Task bar is on the left side of the display
+ * CONFIG_NXWM_TASKBAR_RIGHT - Task bar is on the right side of the display
+ *
+ * CONFIG_NXWM_TASKBAR_WIDTH - Task bar thickness (either vertical or
+ * horizontal). Default: 25 + 2*spacing
+ */
+
+/**
+ * Horizontal and vertical spacing of icons in the task bar.
*/
#ifndef CONFIG_NXWM_TASKBAR_VSPACING
@@ -152,7 +220,7 @@
# warning "Multiple task bar positions specified"
# endif
#elif defined(CONFIG_NXWM_TASKBAR_LEFT)
-# if defined defined (CONFIG_NXWM_TASKBAR_RIGHT)
+# if defined (CONFIG_NXWM_TASKBAR_RIGHT)
# warning "Multiple task bar positions specified"
# endif
#elif !defined(CONFIG_NXWM_TASKBAR_RIGHT)
@@ -174,12 +242,20 @@
#endif
/* Tool Bar Configuration ***************************************************/
+/**
+ * CONFIG_NXWM_TOOLBAR_HEIGHT. The height of the tool bar in each
+ * application window. Default: Same as the thickness of the task bar.
+ */
#ifndef CONFIG_NXWM_TOOLBAR_HEIGHT
# define CONFIG_NXWM_TOOLBAR_HEIGHT CONFIG_NXWM_TASKBAR_WIDTH
#endif
/* Background Image **********************************************************/
+/**
+ * CONFIG_NXWM_BACKGROUND_IMAGE - The name of the image to use in the
+ * background window. Default:NXWidgets::g_nuttxBitmap
+ */
#ifndef CONFIG_NXWM_BACKGROUND_IMAGE
# define CONFIG_NXWM_BACKGROUND_IMAGE NXWidgets::g_nuttxBitmap
@@ -188,6 +264,9 @@
/* Start Window Configuration ***********************************************/
/**
* Horizontal and vertical spacing of icons in the task bar.
+ *
+ * CONFIG_NXWM_STARTWINDOW_VSPACING - Vertical spacing. Default: 2 pixels
+ * CONFIG_NXWM_STARTWINDOW_HSPACING - Horizontal spacing. Default: 2 rows
*/
#ifndef CONFIG_NXWM_STARTWINDOW_VSPACING
@@ -199,6 +278,20 @@
#endif
/* NxConsole Window *********************************************************/
+/**
+ * NxConsole Window Configuration
+ *
+ * CONFIG_NXWM_NXCONSOLE_PRIO - Priority of the NxConsole task. Default:
+ * SCHED_PRIORITY_DEFAULT
+ * CONFIG_NXWM_NXCONSOLE_STACKSIZE - The stack size to use when starting the
+ * NxConsole task. Default: 2048 bytes.
+ * CONFIG_NXWM_NXCONSOLE_WCOLOR - The color of the NxConsole window background.
+ * Default: MKRGB(192,192,192)
+ * CONFIG_NXWM_NXCONSOLE_FONTCOLOR - The color of the fonts to use in the
+ * NxConsole window. Default: MKRGB(0,0,0)
+ * CONFIG_NXWM_NXCONSOLE_FONTID - The ID of the font to use in the NxConsole
+ * window. Default: CONFIG_NXWM_DEFAULT_FONTID
+ */
#ifndef CONFIG_NXWM_NXCONSOLE_PRIO
# define CONFIG_NXWM_NXCONSOLE_PRIO SCHED_PRIORITY_DEFAULT