NxWidgets::CStickyImage: New image class

5 files changed, 368 insertions, 9 deletions

diff --git a/NxWidgets/libnxwidgets/Makefile b/NxWidgets/libnxwidgets/Makefile
index 5ef061339..30b4b8583 100644
--- a/NxWidgets/libnxwidgets/Makefile
+++ b/NxWidgets/libnxwidgets/Makefile
@@ -1,7 +1,7 @@
 #################################################################################
 # NxWidgets/libnxwidgets/Makefile
 #
-#   Copyright (C) 2012-2013 Gregory Nutt. All rights reserved.
+#   Copyright (C) 2012-2014 Gregory Nutt. All rights reserved.
 #   Author: Gregory Nutt <gnutt@nuttx.org>
 #
 # Redistribution and use in source and binary forms, with or without
@@ -64,7 +64,8 @@ CXXSRCS += cprogressbar.cxx cradiobutton.cxx cradiobuttongroup.cxx cscrollbarhor
 CXXSRCS += cscrollbarpanel.cxx cscrollbarvertical.cxx cscrollinglistbox.cxx
 CXXSRCS += cscrollingpanel.cxx cscrollingtextbox.cxx csliderhorizontal.cxx
 CXXSRCS += csliderhorizontalgrip.cxx cslidervertical.cxx csliderverticalgrip.cxx
-CXXSRCS += cstickybutton.cxx cstickybuttonarray.cxx ctabpanel.cxx ctextbox.cxx
+CXXSRCS += cstickybutton.cxx cstickybuttonarray.cxx cstickyimage.cxx ctabpanel.cxx
+CXXSRCS += ctextbox.cxx
 # Images
 CXXSRCS += glyph_nxlogo160x160.cxx glyph_nxlogo320x320.cxx
 CXXSRCS += glyph_arrowdown.cxx glyph_checkboxon.cxx glyph_screendepthup.cxx
diff --git a/NxWidgets/libnxwidgets/include/cimage.hxx b/NxWidgets/libnxwidgets/include/cimage.hxx
index 9daf9f260..e485f6d9d 100644
--- a/NxWidgets/libnxwidgets/include/cimage.hxx
+++ b/NxWidgets/libnxwidgets/include/cimage.hxx
@@ -115,13 +115,14 @@ namespace NXWidgets
 
     /**
      * Draw the area of this widget that falls within the clipping region.
-     * Called by the redraw() function to draw all visible regions.
+     * Called by the drawContents(port) and by classes that inherit from
+     * CImage.
      *
      * @param port The CGraphicsPort to draw to.
      * @see redraw()
      */
 
-    virtual void drawContents(CGraphicsPort *port);
+    void drawContents(CGraphicsPort *port, bool selected);
 
     /**
      * Draw the area of this widget that falls within the clipping region.
@@ -131,6 +132,26 @@ namespace NXWidgets
      * @see redraw()
      */
 
+    virtual void drawContents(CGraphicsPort *port);
+
+    /**
+     * Draw the border of this widget.  Called by the indirectly via
+     * drawBoard(port) and also by classes that inherit from CImage.
+     *
+     * @param port The CGraphicsPort to draw to.
+     * @see redraw()
+     */
+
+    void drawBorder(CGraphicsPort *port, bool selected);
+
+    /**
+     * Draw the border of this widget. Called by the redraw() function to draw
+     * all visible regions.
+     *
+     * @param port The CGraphicsPort to draw to.
+     * @see redraw()
+     */
+
     virtual void drawBorder(CGraphicsPort *port);
 
     /**
diff --git a/NxWidgets/libnxwidgets/include/cstickyimage.hxx b/NxWidgets/libnxwidgets/include/cstickyimage.hxx
new file mode 100644
index 000000000..d89069453
--- /dev/null
+++ b/NxWidgets/libnxwidgets/include/cstickyimage.hxx
@@ -0,0 +1,190 @@
+/****************************************************************************
+ * NxWidgets/libnxwidgets/include/cimagebutton.hxx
+ *
+ *   Copyright (C) 2014 Gregory Nutt. All rights reserved.
+ *   Author: Gregory Nutt <gnutt@nuttx.org>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name NuttX, NxWidgets, nor the names of its contributors
+ *    me be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ ****************************************************************************/
+
+#ifndef __INCLUDE_CSTICKIMAGE_HXX
+#define __INCLUDE_CSTICKIMAGE_HXX
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/config.h>
+
+#include <stdint.h>
+#include <stdbool.h>
+
+#include <nuttx/nx/nxglib.h>
+
+#include "cimage.hxx"
+#include "cwidgetstyle.hxx"
+
+/****************************************************************************
+ * Pre-Processor Definitions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Implementation Classes
+ ****************************************************************************/
+
+#if defined(__cplusplus)
+
+namespace NXWidgets
+{
+  class CWidgetControl;
+
+  /**
+   * CImage that sticks in the selected selected state when clicked.
+   */
+
+  class CStickyImage : public CImage
+  {
+  protected:
+    bool m_stuckSelection;  /**< True if the image is stuck in the selected */
+
+    /**
+     * Draw the area of this widget that falls within the clipping region.
+     * Called by the redraw() function to draw all visible regions.
+     *
+     * @param port The CGraphicsPort to draw to.
+     * @see redraw()
+     */
+
+    virtual void drawContents(CGraphicsPort *port);
+
+    /**
+     * Draw the area of this widget that falls within the clipping region.
+     * Called by the redraw() function to draw all visible regions.
+     *
+     * @param port The CGraphicsPort to draw to.
+     * @see redraw()
+     */
+
+    virtual void drawBorder(CGraphicsPort *port);
+
+    /**
+     * Don't redraw on click events.  The image state is completely controlled
+     * by the m_stuckSelection state.
+     *
+     * @param x The x coordinate of the click.
+     * @param y The y coordinate of the click.
+     */
+
+    virtual void onClick(nxgl_coord_t x, nxgl_coord_t y) {}
+
+    /**
+     * Don't redraw on release events.  The image state is completely controlled
+     * by the m_stuckSelection state.
+     *
+     * @param x The x coordinate of the mouse.
+     * @param y The y coordinate of the mouse.
+     */
+
+    virtual void onRelease(nxgl_coord_t x, nxgl_coord_t y) { }
+
+    /**
+     * Don't redraw on release events.  The image state is completely controlled
+     * by the m_stuckSelection state.
+     *
+     * @param x The x coordinate of the mouse.
+     * @param y The y coordinate of the mouse.
+     */
+
+    virtual void onReleaseOutside(nxgl_coord_t x, nxgl_coord_t y) { }
+
+    /**
+     * Copy constructor is protected to prevent usage.
+     */
+
+    inline CStickyImage(const CStickyImage &button) : CImage(button) { }
+
+  public:
+
+    /**
+     * Constructor for an image.
+     *
+     * @param pWidgetControl The controlling widget for the display
+     * @param x The x coordinate of the image box, relative to its parent.
+     * @param y The y coordinate of the image box, relative to its parent.
+     * @param width The width of the image box.
+     * @param height The height of the image box.
+     * @param bitmap The source bitmap image.
+     * @param style The style that the widget should use.  If this is not
+     *        specified, the button will use the global default widget
+     *        style.
+     */
+
+    CStickyImage(CWidgetControl *pWidgetControl, nxgl_coord_t x, nxgl_coord_t y,
+                 nxgl_coord_t width, nxgl_coord_t height, FAR IBitmap *bitmap,
+                 CWidgetStyle *style = (CWidgetStyle *)NULL);
+
+    /**
+     * Destructor.
+     */
+
+    virtual inline ~CStickyImage(void) { }
+
+    /**
+     * Sets the image's stuck selection state.
+     *
+     * @param selection The new stuck selection state.
+     */
+
+    void setStuckSelection(bool selection);
+
+    /**
+     * Toggles the images stuck selection state.
+     */
+
+    inline void toggleStuckSelection(void)
+      {
+        setStuckSelection(!m_stuckSelection);
+      }
+
+   /**
+     * Returns the stuck selection state.
+     *
+     * @return True is the button is in the stuck selection state.
+     */
+
+    inline const bool isStuckSelection(void) const
+      {
+        return m_stuckSelection;
+      }
+  };
+}
+
+#endif // __cplusplus
+
+#endif // __INCLUDE_CSTICKIMAGE_HXX
diff --git a/NxWidgets/libnxwidgets/src/cimage.cxx b/NxWidgets/libnxwidgets/src/cimage.cxx
index eb7e5157f..1140df35d 100644
--- a/NxWidgets/libnxwidgets/src/cimage.cxx
+++ b/NxWidgets/libnxwidgets/src/cimage.cxx
@@ -165,13 +165,14 @@ void CImage::getPreferredDimensions(CRect &rect) const
 
 /**
  * Draw the area of this widget that falls within the clipping region.
- * Called by the redraw() function to draw all visible regions.
+ * Called by the drawContents(port) and by classes that inherit from
+ * CImage.
  *
  * @param port The CGraphicsPort to draw to.
  * @see redraw()
  */
 
-void CImage::drawContents(CGraphicsPort *port)
+void CImage::drawContents(CGraphicsPort *port, bool selected)
 {
   if (!m_bitmap)
     {
@@ -201,7 +202,7 @@ void CImage::drawContents(CGraphicsPort *port)
 
   // Select the correct colorization
 
-  m_bitmap->setSelected(isClicked() || m_highlighted);
+  m_bitmap->setSelected(selected || m_highlighted);
 
   // This is the end row + 1 that we can write into
 
@@ -349,7 +350,20 @@ void CImage::drawContents(CGraphicsPort *port)
  * @see redraw()
  */
 
-void CImage::drawBorder(CGraphicsPort *port)
+void CImage::drawContents(CGraphicsPort *port)
+{
+  drawContents(port, isClicked());
+}
+
+/**
+ * Draw the border of this widget.  Called by the indirectly via
+ * drawBoard(port) and also by classes that inherit from CImage.
+ *
+ * @param port The CGraphicsPort to draw to.
+ * @see redraw()
+ */
+
+void CImage::drawBorder(CGraphicsPort *port, bool selected)
 {
   // Stop drawing if the widget indicates it should not have an outline
 
@@ -363,7 +377,7 @@ void CImage::drawBorder(CGraphicsPort *port)
   nxgl_coord_t color1;
   nxgl_coord_t color2;
 
-  if (isClicked())
+  if (selected)
     {
       // Bevelled into the screen
 
@@ -382,6 +396,19 @@ void CImage::drawBorder(CGraphicsPort *port)
 }
 
 /**
+ * Draw the border of this widget. Called by the redraw() function to draw
+ * all visible regions.
+ *
+ * @param port The CGraphicsPort to draw to.
+ * @see redraw()
+ */
+
+void CImage::drawBorder(CGraphicsPort *port)
+{
+  drawBorder(port, isClicked());
+}
+
+/**
  * Control the highlight state.
  *
  * @param highlightOn True(1), the image will be highlighted
diff --git a/NxWidgets/libnxwidgets/src/cstickyimage.cxx b/NxWidgets/libnxwidgets/src/cstickyimage.cxx
new file mode 100644
index 000000000..a4f9c6849
--- /dev/null
+++ b/NxWidgets/libnxwidgets/src/cstickyimage.cxx
@@ -0,0 +1,120 @@
+/****************************************************************************
+ * NxWidgets/libnxwidgets/src/cstickyimage.cxx
+ *
+ *   Copyright (C) 2014 Gregory Nutt. All rights reserved.
+ *   Author: Gregory Nutt <gnutt@nuttx.org>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name NuttX, NxWidgets, nor the names of its contributors
+ *    me be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ ****************************************************************************/
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/config.h>
+
+#include <sys/types.h>
+#include <stdint.h>
+#include <stdbool.h>
+
+#include <nuttx/nx/nxglib.h>
+
+#include "cstickyimage.hxx"
+#include "cgraphicsport.hxx"
+
+/****************************************************************************
+ * Pre-Processor Definitions
+ ****************************************************************************/
+
+/****************************************************************************
+ * CImage Method Implementations
+ ****************************************************************************/
+
+using namespace NXWidgets;
+
+/**
+ * Constructor for an image.
+ *
+ * @param pWidgetControl The controlling widget for the display
+ * @param x The x coordinate of the image box, relative to its parent.
+ * @param y The y coordinate of the image box, relative to its parent.
+ * @param width The width of the image box.
+ * @param height The height of the image box.
+ * @param bitmap The source bitmap image.
+ * @param style The style that the widget should use.  If this is not
+ *        specified, the button will use the global default widget
+ *        style.
+ */
+
+CStickyImage::CStickyImage(CWidgetControl *pWidgetControl,
+                           nxgl_coord_t x, nxgl_coord_t y,
+                           nxgl_coord_t width, nxgl_coord_t height,
+                           FAR IBitmap *bitmap, CWidgetStyle *style)
+: CImage(pWidgetControl, x, y, width, height, bitmap, style)
+{
+  m_stuckSelection = false;
+}
+
+/**
+ * Sets the image's stuck selection state.
+ *
+ * @param selection The new stuck selection state.
+ */
+
+void CStickyImage::setStuckSelection(bool selection)
+{
+  m_stuckSelection = selection;
+  redraw();
+}
+
+/**
+ * Draw the area of this widget that falls within the clipping region.
+ * Called by the redraw() function to draw all visible regions.
+ *
+ * @param port The CGraphicsPort to draw to.
+ * @see redraw()
+ */
+
+void CStickyImage::drawContents(CGraphicsPort *port)
+{
+  CImage::drawContents(port, m_stuckSelection);
+}
+
+/**
+ * Draw the area of this widget that falls within the clipping region.
+ * Called by the redraw() function to draw all visible regions.
+ *
+ * @param port The CGraphicsPort to draw to.
+ * @see redraw()
+ */
+
+void CStickyImage::drawBorder(CGraphicsPort *port)
+{
+  CImage::drawBorder(port, m_stuckSelection);
+}